Skip to content

feat(core) add @SegmentParameter annotation #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nawarian wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat(core) add @SegmentParameter annotation #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c73a9c
feat(core) add @SegmentParameter annotation
Apr 18, 2025
8b66474
fix(SegmentParameter) default required=false
Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions restler-core/src/main/java/net/researchgate/restdsl/annotations/SegmentParameter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package net.researchgate.restdsl.annotations;

import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.media.Schema;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.PARAMETER, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Parameter(
name = "segment",
in = ParameterIn.PATH,
schema = @Schema(type = "string", example = "-"),
description = "A rest-dsl query, See https://github.com/researchgate/restler#get",
required = false
)
public @interface SegmentParameter {
String name() default "segment";
String description() default "A rest-dsl query, See https://github.com/researchgate/restler#get";
ParameterIn in() default ParameterIn.PATH;
boolean required() default false;
}
5 changes: 3 additions & 2 deletions restler-core/src/main/java/net/researchgate/restdsl/resources/BaseServiceResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.media.Schema;
import net.researchgate.restdsl.annotations.SegmentParameter;
import net.researchgate.restdsl.domain.EntityInfo;
import net.researchgate.restdsl.exceptions.RestDslException;
import net.researchgate.restdsl.model.BaseServiceModel;
Expand Down Expand Up @@ -68,7 +69,7 @@ public BaseServiceResource(BaseServiceModel<V, K> serviceModel) throws RestDslEx
}

@Operation(summary = "Retrieve entities using the generic researchgate 'restler' query-language: https://github.com/researchgate/restler#get")
@Parameter(name = "segment", in = ParameterIn.PATH, schema = @Schema(type = "string", example = "-"), description = "A rest-dsl query, See https://github.com/researchgate/restler#get")
@SegmentParameter
@Parameter(name = "fields", in = ParameterIn.QUERY, description = "Only return this list of comma-separated fields. Use '*' to return all", example = "*")
@Parameter(name = "limit", in = ParameterIn.QUERY, schema = @Schema(type = "integer", format = "int32"), description = "Limit the number of returned records")
@Parameter(name = "offset", in = ParameterIn.QUERY, schema = @Schema(type = "integer", format = "int32"), description = "Skip this many records. Use this together with limit to implement pagination.")
Expand All @@ -84,7 +85,7 @@ public EntityResult<V> getEntityResult(@PathParam("segment") PathSegment segment
}

@Operation(summary = "Returns a human readable description of the generated database operations. This is intended for client to develop and debug rest-dsl queries")
@Parameter(name = "segment", in = ParameterIn.PATH, schema = @Schema(type = "string", example = "-"), description = "A rest-dsl query, See https://github.com/researchgate/restler#get")
@SegmentParameter
@Parameter(name = "fields", in = ParameterIn.QUERY, description = "Only return this list of comma-separated fields. Use '*' to return all", example = "*")
@Parameter(name = "limit", in = ParameterIn.QUERY, schema = @Schema(type = "integer", format = "int32"), description = "Limit the number of returned records")
@Parameter(name = "offset", in = ParameterIn.QUERY, schema = @Schema(type = "integer", format = "int32"), description = "Skip this many records. Use this together with limit to implement pagination.")
Expand Down