test(openapi_3.1): ensure that an API with webhooks and no routes is supported

Author: SF97

test/openapi_3.1/README.md

@@ -0,0 +1,3 @@
+# Open API 3.1 tests
+
+This folder, and its subfolders, contain tests for OpenAPI specification 3.1

test/openapi_3.1/resources/webhook.yaml

@@ -0,0 +1,35 @@
+# From https://github.com/OAI/OpenAPI-Specification/blob/main/examples/v3.1/webhook-example.yaml
+openapi: 3.1.0
+info:
+  title: Webhook Example
+  version: 1.0.0
+# Since OAS 3.1.0 the paths element isn't necessary. Now a valid OpenAPI Document can describe only paths, webhooks, or even only reusable components
+webhooks:
+  # Each webhook needs a name
+  newPet:
+    # This is a Path Item Object, the only difference is that the request is initiated by the API provider
+    post:
+      requestBody:
+        description: Information about a new pet in the system
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Pet"
+      responses:
+        "200":
+          description: Return a 200 status to indicate that the data was received successfully
+
+components:
+  schemas:
+    Pet:
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string

test/openapi_3.1/webhook.spec.ts

@@ -0,0 +1,31 @@
+import { expect } from "chai";
+import * as request from 'supertest';
+import { createApp } from "../common/app";
+import { join } from "path";
+
+describe('webhook support - OpenAPI 3.1', () => {
+  let app;
+
+  before(async () => {
+    const apiSpec = join('test', 'openapi_3.1', 'resources', 'webhook.yaml');
+    app = await createApp(
+      { apiSpec, validateRequests: true },
+      3005,
+      undefined,
+      false,
+    );
+  });
+
+  after(() => {
+    app.server.close();
+  });
+
+  it('should support an API that only has webhooks defined, but provides no routes', () => {
+    // The webhook is not made available by the provider API, so the request will return 404
+    // This test ensures that the request flow happens normally without any interruptions due to being a webhook
+    return request(app)
+      .get(`${app.basePath}/webhook`)
+      .expect(404);
+  });
+
+})