Skip to content

Commit

Permalink
Fix typos in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MaximPlusov committed Feb 19, 2024
1 parent 1ea5037 commit eb8923f
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion src/main/java/org/verapdf/rest/resources/ApiResource.java
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public static ReleaseDetails getReleaseDetails() {
*/
@GET
@Path("/info")
@Operation(summary = "Returns relavent server information, such as JDK version, OS, etc.")
@Operation(summary = "Returns relevant server information, such as JDK version, OS, etc.")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Server environment details successfully returned.", content = {
@Content(mediaType = "application/json", schema = @Schema(implementation = Environment.class)),
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/verapdf/rest/resources/ProfileResource.java
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,9 @@ public static ValidationProfile getProfile(
}) })
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
public static Set<RuleId> getProfileRules(
@Parameter(description = "The String id of the Validation profile that the rule IDs should be retrieved from, "
@Parameter(description = "The String id of the Validation profile that the rule IDs should be retrieved from "
+
"(1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2") @PathParam("profileId") String profileId) {
"(1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)") @PathParam("profileId") String profileId) {
SortedSet<RuleId> ids = new TreeSet<>(new Profiles.RuleIdComparator());
for (Rule rule : DIRECTORY.getValidationProfileById(profileId).getRules()) {
ids.add(rule.getRuleId());
Expand Down Expand Up @@ -168,7 +168,7 @@ public static Set<RuleId> getProfileRules(
}) })
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
public static Set<Rule> getRulesForClause(@Parameter(description = "The string id of the validation profile " +
"(1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2") @PathParam("profileId") String profileId,
"(1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2)") @PathParam("profileId") String profileId,
@Parameter(description = "A string identifying the profile clause to return the rules for.") @PathParam("clause") String clause) {
SortedSet<Rule> rules = new TreeSet<>(new Profiles.RuleComparator());
for (Rule rule : DIRECTORY.getValidationProfileById(profileId).getRules()) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public class ValidateResource {
"must be one of: (auto, 1b, 1a, 2b, 2a, 2u, 3b, 3a, 3u, 4, 4e, 4f, ua1 or ua2). " +
"Selecting 'auto' allows the validator to detect and apply the appropriate specification from the PDF metadata.";
private static final String PARAM_FILE_SIZE_DESC = "the size of the PDF to be validated in bytes, read from the request header.";
private static final String VALIDATION_OP_DESC = "against the selected PDF Specification/Validaton profile and return a report comprising the valdiation results.";
private static final String VALIDATION_OP_DESC = "against the selected PDF Specification/Validation profile and return a report comprising the validation results.";
// java.security.digest name for the SHA-1 algorithm
private static final String SHA1_NAME = "SHA-1"; //$NON-NLS-1$
private static final String FILE_SIZE_HEADER = "X-File-Size";
Expand Down

0 comments on commit eb8923f

Please sign in to comment.