Add endpoints and parameters description #123
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bdoubrov
requested changes
Sep 28, 2023
| @@ -40,7 +42,15 @@ public class ProfileResource { | |||
| * @return the set of validation profile details | |||
| */ | |||
| @GET | |||
| @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML }) | |||
| @Operation(summary = "Get set of validation profile details") | |||
There was a problem hiding this comment.
Get the set of validation profile details
| @@ -50,7 +60,15 @@ public static Set<ProfileDetails> getProfileDetails() { | |||
| */ | |||
| @GET | |||
| @Path("/ids") | |||
| @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML }) | |||
| @Operation(summary = "Get set of validation profile ids") | |||
There was a problem hiding this comment.
Get the set of validation profile ids
| @@ -60,7 +78,15 @@ public static Set<String> getProfileIds() { | |||
| */ | |||
| @GET | |||
| @Path("/flavours") | |||
| @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML }) | |||
| @Operation(summary = "Get set of flavours") | |||
There was a problem hiding this comment.
Get the set of supported PDF/A and PDF/UA flavours
| @@ -73,8 +99,18 @@ public static Set<PDFAFlavour> getFlavours() { | |||
| */ | |||
| @GET | |||
| @Path("/{profileId}") | |||
| @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML }) | |||
| public static ValidationProfile getProfile(@PathParam("profileId") String profileId) { | |||
| @Operation(summary = "Get validation profile selected by id") | |||
There was a problem hiding this comment.
Get the validation profile selected by id (validation flavour)
| @@ -88,8 +124,18 @@ public static ValidationProfile getProfile(@PathParam("profileId") String profil | |||
| */ | |||
| @GET | |||
| @Path("/{profileId}/ruleids") | |||
| @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML }) | |||
| public static Set<RuleId> getProfileRules(@PathParam("profileId") String profileId) { | |||
| @Operation(summary = "Get set of rule ids for the selected validation profiles") | |||
There was a problem hiding this comment.
Get the set of rule id's for the selected validation profiles
| @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML }) | ||
| public static Set<Rule> getRulesForClause(@PathParam("profileId") String profileId, | ||
| @PathParam("clause") String clause) { | ||
| @Operation(summary = "Get set of rules for the selected profile and clause") |
There was a problem hiding this comment.
Get the set of rules for the selected profile and clause
| @Parameter(description = "the hex String representation of the file's SHA-1 hash") | ||
| @FormDataParam("sha1Hex") String sha1Hex, | ||
| @Parameter(name = "file", schema = @Schema(implementation = File.class), | ||
| style = ParameterStyle.FORM, description = "an InputStream to the PDF to be validated") |
There was a problem hiding this comment.
an InputStream of the PDF to be validated
| public static InputStream validateJson(@Parameter(description = "the String id of the Validation profile" + | ||
| "(auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a. 3u, 4, 4e, 4f or ua1)") | ||
| @PathParam("profileId") String profileId, | ||
| @Parameter(description = "an URL of PDF to be validated") |
There was a problem hiding this comment.
a URL of PDF to be validated
EkaterinaKomar
force-pushed
the
feature/swagger
branch
from
4995143 to
fa72885
Compare
EkaterinaKomar
force-pushed
the
feature/swagger
branch
from
fa72885 to
d937851
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.