Merge pull request #1216 from swagger-api/callback-issue

callback with $ref not being resolved

Author: gracekarina

modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/processors/OperationProcessor.java

@@ -75,13 +75,13 @@ public void processOperation(Operation operation) {
             for (String name : callbacks.keySet()) {
                 Callback callback = callbacks.get(name);
                 if(callback != null) {
-                    if (callback.get("$ref") != null){
-                        String $ref = callback.get("$ref").get$ref();
+                    if (callback.get$ref() != null){
+                        String $ref = callback.get$ref();
                         RefFormat refFormat = computeRefFormat($ref);
                         if (isAnExternalRefFormat(refFormat)){
                             final String newRef = externalRefProcessor.processRefToExternalCallback($ref, refFormat);
                             if (newRef != null) {
-                                callback.get("$ref").set$ref(newRef);
+                                callback.set$ref(newRef);
                             }
                         }
                     }

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

@@ -66,6 +66,17 @@ public class OpenAPIV3ParserTest {
     protected int serverPort = getDynamicPort();
     protected WireMockServer wireMockServer;
 
+    @Test
+    public void testIssueResolveCallBacks() {
+        ParseOptions options = new ParseOptions();
+        options.setResolve(true);
+        options.setFlatten(true);
+        SwaggerParseResult parseResult = new OpenAPIV3Parser().readLocation("callbacks-issue/swagger.yaml", null, options);
+        OpenAPI spec = parseResult.getOpenAPI();
+        assertNotNull(spec);
+        assertEquals(spec.getPaths().get("/webhook").getPost().getCallbacks().get("WebhookVerificationEvent").get$ref(),"#/components/callbacks/WebhookVerificationEvent");
+    }
+
     @Test
     public void testIssue1190() {
         OpenAPIV3Parser openApiParser = new OpenAPIV3Parser();

modules/swagger-parser-v3/src/test/resources/callbacks-issue/domain.yaml

@@ -0,0 +1,34 @@
+# OpenAPI version identifier - required for OpenAPI 3.0 domains
+openapi: 3.0.0
+
+#######################
+# Optional info section
+#######################
+info:
+  title:   Common
+  description: Common Components for REST API's
+  version: '1.0.1'
+
+components:
+
+  #########################
+  # Common callback definitions
+  # See: https://swagger.io/docs/specification/callbacks/
+  #########################
+  callbacks:
+    #### Webhooks ####
+    WebhookVerificationEvent:
+      'https://yourdomain.com/css/yourCallbackEndpoint':
+        post:
+          parameters:
+            - $ref: '#/components/parameters/x-api-key'
+          requestBody:
+            required: true
+            description: description
+            content:
+              application/json:
+                schema:
+                  $ref: '#/components/schemas/WebhookVerification'
+          responses:
+            '202':
+              description: Your server returns this code if it accepts the message it was sent

modules/swagger-parser-v3/src/test/resources/callbacks-issue/swagger.yaml

@@ -0,0 +1,22 @@
+openapi: 3.0.2
+servers:
+  - description:  Dev server
+    url: 'https://api.net'
+info:
+  title:  API
+  version: 1.0.0
+  description:
+tags:
+  - name: Webhook API
+    description: Endpoints related to the subscription and management of Webhooks
+paths:
+  '/webhook':
+    post:
+      tags:
+        - Webhook API
+      summary: Subscribe to events for a Market Participant
+      description: description
+      operationId: subscribe-webhook
+      callbacks:
+        WebhookVerificationEvent:
+          $ref: 'domain.yaml#/components/callbacks/WebhookVerificationEvent'