Merge pull request #2910 from seratch/fix-typo

Fix typo detected by github.com/client9/misspell
swagger-api · Oct 23, 2018 · c18deed · c18deed
2 parents 2b89514 + 34f1bdc
commit c18deed
Show file tree

Hide file tree

Showing 14 changed files with 25 additions and 25 deletions.
diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/headers/Header.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/headers/Header.java
@@ -25,7 +25,7 @@
 
 /**
  * The annotation may be used to add one or more headers to the definition of a response or as attribute of content
- * encoding by definining it as field {@link io.swagger.v3.oas.annotations.responses.ApiResponse#headers()} or {@link io.swagger.v3.oas.annotations.media.Content#encoding()}.
+ * encoding by defining it as field {@link io.swagger.v3.oas.annotations.responses.ApiResponse#headers()} or {@link io.swagger.v3.oas.annotations.media.Content#encoding()}.
  * <p>Please note that request headers are defined as Header {@link io.swagger.v3.oas.annotations.Parameter}.</p>
  *
  * @see <a target="_new" href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#headerObject">Header (OpenAPI specification)</a>

diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Content.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Content.java
@@ -25,7 +25,7 @@
 import java.lang.annotation.Target;
 
 /**
- * The annotation may be used to define the content/media type  of a parameter, request or response, by definining it as
+ * The annotation may be used to define the content/media type  of a parameter, request or response, by defining it as
  * field {@link io.swagger.v3.oas.annotations.Parameter#content()}, {@link io.swagger.v3.oas.annotations.parameters.RequestBody#content()} or {@link io.swagger.v3.oas.annotations.responses.ApiResponse#content()}.
  * <p>If {@link Content#schema()} is defined, swagger-jaxrs2 reader engine will consider it along with
  * JAX-RS annotations, element type and context as input to resolve the annotated element into an OpenAPI schema

diff --git a/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Encoding.java b/modules/swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/Encoding.java
@@ -26,7 +26,7 @@
 
 /**
  * The annotation may be used to add encoding details to the definition of a parameter, request or response content,
- * by definining it as field {@link Content#encoding()}
+ * by defining it as field {@link Content#encoding()}
  *
  * @see <a target="_new" href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#encodingObject">Encoding (OpenAPI specification)</a>
  * @see Content

diff --git a/.../swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ExampleObject.java b/.../swagger-annotations/src/main/java/io/swagger/v3/oas/annotations/media/ExampleObject.java
@@ -26,7 +26,7 @@
 
 /**
  * The annotation may be used to add one or more examples to the definition of a parameter, request or response content,
- * by definining it as field {@link io.swagger.v3.oas.annotations.Parameter#examples()} or {@link Content#examples()}
+ * by defining it as field {@link io.swagger.v3.oas.annotations.Parameter#examples()} or {@link Content#examples()}
  *
  * @see <a target="_new" href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#exampleObject">Example (OpenAPI specification)</a>
  **/

diff --git a/modules/swagger-core/src/test/resources/specFiles/oas3.yaml b/modules/swagger-core/src/test/resources/specFiles/oas3.yaml
@@ -358,7 +358,7 @@ paths:
       tags:
       - pet
       summary: Finds Pets by tags
-      description: Muliple tags can be provided with comma separated strings. Use
+      description: Multiple tags can be provided with comma separated strings. Use
         tag1, tag2, tag3 for testing.
       operationId: findPetsByTags
       parameters:

diff --git a/modules/swagger-core/src/test/resources/specFiles/petstore-3.0-referred-schemas.json b/modules/swagger-core/src/test/resources/specFiles/petstore-3.0-referred-schemas.json
@@ -92,7 +92,7 @@
                     "pet"
                 ],
                 "summary": "Finds Pets by tags",
-                "description": "Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.",
+                "description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
                 "operationId": "findPetsByTags",
                 "parameters": [
                     {
@@ -333,4 +333,4 @@
             }
         }
     }
-}
+}
diff --git a/modules/swagger-core/src/test/resources/specFiles/petstore-3.0-v2.json b/modules/swagger-core/src/test/resources/specFiles/petstore-3.0-v2.json
@@ -158,7 +158,7 @@
         "/pet/findByStatus": {
             "get": {
                 "summary": "Finds Pets by status",
-                "description": "Multiple status values can be provided with comma seperated strings",
+                "description": "Multiple status values can be provided with comma separated strings",
                 "operationId": "findPetsByStatus",
                 "parameters": [
                     {
@@ -206,7 +206,7 @@
         "/pet/findByTags": {
             "get": {
                 "summary": "Finds Pets by tags",
-                "description": "Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.",
+                "description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
                 "operationId": "findPetsByTags",
                 "parameters": [
                     {
@@ -335,4 +335,4 @@
             }
         }
     }
-}
+}
diff --git a/modules/swagger-core/src/test/resources/specFiles/petstore-3.0-v2_withoutModels.json b/modules/swagger-core/src/test/resources/specFiles/petstore-3.0-v2_withoutModels.json
@@ -69,7 +69,7 @@
         "/pet/findByStatus": {
             "get": {
                 "summary": "Finds Pets by status",
-                "description": "Multiple status values can be provided with comma seperated strings",
+                "description": "Multiple status values can be provided with comma separated strings",
                 "operationId": "findPetsByStatus",
                 "parameters": [
                     {
@@ -97,7 +97,7 @@
         "/pet/findByTags": {
             "get": {
                 "summary": "Finds Pets by tags",
-                "description": "Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.",
+                "description": "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
                 "operationId": "findPetsByTags",
                 "parameters": [
                     {
@@ -115,4 +115,4 @@
             }
         }
     }
-}
+}
diff --git a/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/PetResourceTest.java b/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/PetResourceTest.java
@@ -250,7 +250,7 @@ private static List<Class> findClasses(final File directory, final String packag
     }
 
     /**
-     * Compare a class that were read and parsed to a yaml aginst a yaml file.
+     * Compare a class that were read and parsed to a yaml against a yaml file.
      *
      * @param clazz  to read.
      * @param source where is the yaml.
@@ -264,4 +264,4 @@ private void compare(final Class clazz, final String source) {
             fail();
         }
     }
-}
+}
diff --git a/...c/test/java/io/swagger/v3/jaxrs2/annotations/operations/AnnotatedOperationMethodTest.java b/...c/test/java/io/swagger/v3/jaxrs2/annotations/operations/AnnotatedOperationMethodTest.java
@@ -394,7 +394,7 @@ public void testCompletePetResource() throws IOException {
                 "  /pet/findByTags:\n" +
                 "    get:\n" +
                 "      summary: Finds Pets by tags\n" +
-                "      description: Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.\n" +
+                "      description: Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.\n" +
                 "      operationId: findPetsByTags\n" +
                 "      parameters:\n" +
                 "      - name: tags\n" +
@@ -557,7 +557,7 @@ public void testCompletePetResource() throws IOException {
                 "  /pet/findByStatus:\n" +
                 "    get:\n" +
                 "      summary: Finds Pets by status\n" +
-                "      description: Multiple status values can be provided with comma seperated strings\n" +
+                "      description: Multiple status values can be provided with comma separated strings\n" +
                 "      operationId: findPetsByStatus\n" +
                 "      parameters:\n" +
                 "      - name: status\n" +

diff --git a/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/petstore/PetResource.java b/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/petstore/PetResource.java
@@ -130,7 +130,7 @@ public Response updatePet(
     @Path("/findByStatus")
     @Produces("application/xml")
     @Operation(summary = "Finds Pets by status",
-            description = "Multiple status values can be provided with comma seperated strings",
+            description = "Multiple status values can be provided with comma separated strings",
             responses = {
                     @ApiResponse(
                             content = @Content(mediaType = "application/json",
@@ -150,7 +150,7 @@ public Response findPetsByStatus(
     @Path("/findByTags")
     @Produces("application/json")
     @Operation(summary = "Finds Pets by tags",
-            description = "Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.",
+            description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
             responses = {
                     @ApiResponse(description = "Pets matching criteria",
                             content = @Content(schema = @Schema(implementation = Pet.class))

diff --git a/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/PetResource.java b/modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/PetResource.java
@@ -131,7 +131,7 @@ public Response updatePet(
     @Path("/findByStatus")
     @Produces("application/xml")
     @Operation(summary = "Finds Pets by status",
-            description = "Multiple status values can be provided with comma seperated strings",
+            description = "Multiple status values can be provided with comma separated strings",
             responses = {
                     @ApiResponse(
                             content = @Content(mediaType = "application/json",
@@ -170,7 +170,7 @@ public Response findPetsByCategory(
     @Path("/findByTags")
     @Produces("application/json")
     @Operation(summary = "Finds Pets by tags",
-            description = "Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.",
+            description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
             responses = {
                     @ApiResponse(description = "Pets matching criteria",
                             content = @Content(schema = @Schema(implementation = Pet.class))

diff --git a/...swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/PetResourceSlashesinPath.java b/...swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/PetResourceSlashesinPath.java
@@ -131,7 +131,7 @@ public Response updatePet(
     @Path("/findByStatus")
     @Produces("application/xml")
     @Operation(summary = "Finds Pets by status",
-            description = "Multiple status values can be provided with comma seperated strings",
+            description = "Multiple status values can be provided with comma separated strings",
             responses = {
                     @ApiResponse(
                             content = @Content(mediaType = "application/json",
@@ -151,7 +151,7 @@ public Response findPetsByStatus(
     @Path("/findByTags")
     @Produces("application/json")
     @Operation(summary = "Finds Pets by tags",
-            description = "Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.",
+            description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
             responses = {
                     @ApiResponse(description = "Pets matching criteria",
                             content = @Content(schema = @Schema(implementation = Pet.class))

diff --git a/modules/swagger-jaxrs2/src/test/resources/petstore/FullPetResource.yaml b/modules/swagger-jaxrs2/src/test/resources/petstore/FullPetResource.yaml
@@ -163,7 +163,7 @@ paths:
   /pet/findByStatus:
     get:
       summary: Finds Pets by status
-      description: Multiple status values can be provided with comma seperated strings
+      description: Multiple status values can be provided with comma separated strings
       operationId: findPetsByStatus
       parameters:
       - name: status
@@ -193,7 +193,7 @@ paths:
   /pet/findByTags:
     get:
       summary: Finds Pets by tags
-      description: Muliple tags can be provided with comma seperated strings. Use
+      description: Multiple tags can be provided with comma separated strings. Use
         tag1, tag2, tag3 for testing.
       operationId: findPetsByTags
       parameters: