fix: fix callbacks type def

fixes #171

src/rules/common/path-not-include-query.ts

@@ -3,13 +3,15 @@ import { UserContext } from '../../walk';
 
 export const PathNotIncludeQuery: Oas3Rule | Oas2Rule = () => {
   return {
-    PathItem(_operation: object, { report, key }: UserContext) {
-      if (key.toString().includes('?')) {
-        report({
-          message: `Don't put query string items in the path, they belong in parameters with \`in: query\`.`,
-          location: { reportOnKey: true },
-        });
-      }
-    },
+    PathMap: {
+      PathItem(_operation: object, { report, key }: UserContext) {
+        if (key.toString().includes('?')) {
+          report({
+            message: `Don't put query string items in the path, they belong in parameters with \`in: query\`.`,
+            location: { reportOnKey: true },
+          });
+        }
+      },
+    }
   };
 };

src/rules/oas3/__tests__/spec/callbacks.test.ts

@@ -0,0 +1,41 @@
+import { outdent } from 'outdent';
+import { validateDoc } from './utils';
+
+it('should not fail on valid callbacks object', async () => {
+  const source = outdent`
+    openapi: 3.0.2
+    info:
+      title: Test
+      version: '1.0'
+
+    servers:
+      - url: http://google.com
+
+    paths:
+      '/ping':
+        summary: test
+        get:
+          callbacks:
+            test:
+              'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}':
+                post:
+                  requestBody:
+                    description: Callback payload
+                    content:
+                      'application/json':
+                        schema:
+                          $ref: '#/components/schemas/SomePayload'
+                  responses:
+                    '200':
+                      description: webhook successfully processed and no retries will be performed
+          responses:
+            '200':
+              description: example description
+  `;
+
+  expect(
+    await validateDoc(source, {
+      spec: 'error',
+    }),
+  ).toMatchInlineSnapshot(`Array []`);
+});

src/types/oas3.ts

@@ -182,6 +182,11 @@ const Parameter: NodeType = {
   required: ['name', 'in'],
 };
 
+const Callback = {
+  properties: {},
+  additionalProperties: 'PathItem'
+}
+
 const Operation: NodeType = {
   properties: {
     tags: {
@@ -207,7 +212,7 @@ const Operation: NodeType = {
     deprecated: {
       type: 'boolean',
     },
-    callbacks: 'PathMap',
+    callbacks: mapOf('Callback'),
     'x-codeSamples': listOf('XCodeSample'),
     'x-code-samples': listOf('XCodeSample'), // deprecated
   },
@@ -536,6 +541,7 @@ export const Oas3Types: Record<string, NodeType> = {
   PathItem,
   Parameter,
   Operation,
+  Callback,
   RequestBody,
   MediaTypeMap,
   MediaType,

src/visitors.ts

@@ -133,6 +133,7 @@ type Oas3FlatVisitor = {
   License?: VisitFunctionOrObject<Oas3License>;
   PathMap?: VisitFunctionOrObject<Record<string, Oas3PathItem>>;
   PathItem?: VisitFunctionOrObject<Oas3PathItem>;
+  Callback?: VisitFunctionOrObject<Record<string, Oas3PathItem>>;
   Parameter?: VisitFunctionOrObject<Oas3Parameter>;
   Operation?: VisitFunctionOrObject<Oas3Operation>;
   RequestBody?: VisitFunctionOrObject<Oas3RequestBody>;