oas 3.1 - test for siblings ref ticket

Author: gracekarina

modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/OpenAPIDeserializer.java

@@ -956,7 +956,6 @@ public PathItem getPathItem(ObjectNode obj, String location, ParseResult result)
 					if (StringUtils.isNotBlank(value)) {
 						pathItem.setSummary(value);
 					}
-
 					value = getString("description", obj, false, location, result);
 					if (StringUtils.isNotBlank(value)) {
 						pathItem.setDescription(value);
@@ -2171,9 +2170,7 @@ public Header getHeader(ObjectNode headerNode, String location, ParseResult resu
 		return header;
 	}
 
-
 	public Object getAnyExample(String nodeKey, ObjectNode node, String location, ParseResult result) {
-		//TODO: Examples now allows Ref
 		JsonNode example = node.get(nodeKey);
 		if (example != null) {
 			if (example.getNodeType().equals(JsonNodeType.STRING)) {
@@ -2246,7 +2243,6 @@ public SecurityScheme getSecurityScheme(ObjectNode node, String location, ParseR
 		if (node == null) {
 			return null;
 		}
-
 		SecurityScheme securityScheme = new SecurityScheme();
 
 		JsonNode ref = node.get("$ref");
@@ -3137,18 +3133,6 @@ public Example getExample(ObjectNode node, String location, ParseResult result)
 				} else {
 					example.set$ref(ref.textValue());
 				}
-				if (result.isOpenapi31()) {
-					String desc = getString("summary", node, false, location, result);
-					if (StringUtils.isNotBlank(desc)) {
-						example.setSummary(desc);
-					}
-				}
-				if (result.isOpenapi31()) {
-					String desc = getString("description", node, false, location, result);
-					if (StringUtils.isNotBlank(desc)) {
-						example.setDescription(desc);
-					}
-				}
 				return example;
 			} else {
 				result.invalidType(location, "$ref", "string", node);
@@ -3279,8 +3263,7 @@ public ApiResponse getResponse(ObjectNode node, String location, ParseResult res
 					apiResponse.set$ref(ref.textValue());
 				}
 				if(result.isOpenapi31()){
-					String value = getString("summary", node, false, location, result);
-					value = getString("description", node, false, location, result);
+					String value = getString("description", node, false, location, result);
 					if (StringUtils.isNotBlank(value)) {
 						apiResponse.setDescription(value);
 					}

modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/OAI31DeserializationTest.java

@@ -197,4 +197,42 @@ public void testReservedExtensionsOaiAuthorTrue() {
         assertFalse(result.getMessages().contains("attribute x-oas-internal is reserved by The OpenAPI Initiative"));
         assertFalse(result.getMessages().contains("attribute x-oai-extension is reserved by The OpenAPI Initiative"));
     }
+
+    @Test
+    public void testSiblingsReferenceObjects() {
+        ParseOptions options = new ParseOptions();
+        options.setOaiAuthor(true);
+        SwaggerParseResult result = new OpenAPIV3Parser().readLocation( "3.1.0/siblings31.yaml", null, options);
+        OpenAPI openAPI = result.getOpenAPI();
+        assertNotNull(openAPI);
+
+        //PathItems
+        assertTrue(openAPI.getPaths().get("/pets").get$ref() != null
+                && openAPI.getPaths().get("/pets").getDescription() != null
+                && openAPI.getPaths().get("/pets").getSummary() != null);
+
+        //Parameters
+        assertTrue(openAPI.getPaths().get("/pets/{petId}").getGet().getParameters().get(0).get$ref() != null
+                && openAPI.getPaths().get("/pets/{petId}").getGet().getParameters().get(0).getDescription() != null);
+
+        //Responses
+        assertTrue(openAPI.getPaths().get("/pets/{petId}").getGet().getResponses().get("200").get$ref() != null
+                && openAPI.getPaths().get("/pets/{petId}").getGet().getResponses().get("200").getDescription() != null);
+
+        //RequestBody
+        assertTrue(openAPI.getPaths().get("/pets/requestBody").getPost().getRequestBody().get$ref() != null
+                && openAPI.getPaths().get("/pets/requestBody").getPost().getRequestBody().getDescription() != null);
+
+        //Headers
+        assertTrue(openAPI.getPaths().get("/pets/requestBody").getPost().getResponses().get("200").getHeaders().get("X-Rate-Limit").get$ref() != null
+                && openAPI.getPaths().get("/pets/requestBody").getPost().getResponses().get("200").getHeaders().get("X-Rate-Limit").getDescription() != null);
+
+        //Links
+        assertTrue(openAPI.getPaths().get("/pets/requestBody").getPost().getResponses().get("200").getLinks().get("userRepository").get$ref() != null
+                && openAPI.getPaths().get("/pets/requestBody").getPost().getResponses().get("200").getLinks().get("userRepository").getDescription() != null);
+
+        //SecuritySchemes
+        assertTrue(openAPI.getComponents().getSecuritySchemes().get("api_key").get$ref() != null
+                && openAPI.getComponents().getSecuritySchemes().get("api_key").getDescription() != null);
+    }
 }

modules/swagger-parser-v3/src/test/resources/3.1.0/siblings31.yaml

@@ -0,0 +1,46 @@
+openapi: "3.1.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+paths:
+  /pets:
+      $ref: "#/components/pathItems/Pets"
+      summary: List all pets
+      description: description
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      security:
+        -  apiKey: [ ]
+      tags:
+        - pets
+      parameters:
+        - $ref: "#/components/parameters/Pets"
+          description: The id of the pet to retrieve
+      responses:
+        "200":
+          $ref: "#/components/responses/Pets"
+          description: Expected response to a valid request
+  /pets/requestBody:
+    post:
+      description: It gets pets
+      responses:
+        '200':
+          description: successful operation
+          headers:
+            X-Rate-Limit:
+              $ref: "#/components/headers/Pets"
+              description: header sibling description
+          links:
+            userRepository:
+              $ref: '#/components/links/userRepository'
+              description: link sibling description
+      requestBody:
+        $ref: "#/components/requestBodies/Pets"
+        description: request body description
+components:
+  securitySchemes:
+    api_key:
+      $ref: "#/components/securitySchemes/security"
+      description: This is another description