Resolve ref in parameters

Author: SamyPesse

README.md

@@ -16,17 +16,12 @@ openapi-static-validator spec.json > validate.js
 
 ## TODOs
 
--   Path/Operations
-    -   [ ] Validate parameters
+-   Parameters:
+    -   [ ] in `cookie`
+    -   [ ] in `header`
+    -   [ ] in `query`
 -   JSONSchema `string` validation of:
-    -   [x] `minLength`
-    -   [x] `maxLength`
     -   [ ] `format`
-    -   [x] `pattern`
--   JSONSchema `array` validation of:
-    -   [x] `minItems`
-    -   [x] `maxItems`
-    -   [x] `uniqueItems`
 -   JSONSchema `integer`
     -   [ ] no float
 

src/compileOperation.ts

@@ -47,7 +47,7 @@ export function compileOperation(
 
         // Extract and validate path params
         const pathParameters = (operation.parameters ?? []).filter(
-            (parameter) => parameter.in === 'path',
+            (parameter) => compiler.resolveMaybeRef(parameter).in === 'path',
         );
         nodes.push(
             builders.expressionStatement(
@@ -56,7 +56,9 @@ export function compileOperation(
                     builders.memberExpression(requestIdentifier, builders.identifier('params')),
                     builders.objectExpression(
                         pathParameters
-                            .map((parameter, index) => {
+                            .map((refParameter, index) => {
+                                const parameter = compiler.resolveMaybeRef(refParameter);
+
                                 const identifier = builders.identifier(`pathParam${index}`);
                                 const schemaFn = compileValueSchema(compiler, parameter.schema);
                                 const regexMatchIndex = getPathParamIndex(path, parameter.name);
@@ -109,7 +111,7 @@ export function compileOperation(
 
         // Validate query parameters
         const queryParameters = (operation.parameters ?? []).filter(
-            (parameter) => parameter.in === 'path',
+            (parameter) => compiler.resolveMaybeRef(parameter).in === 'path',
         );
         queryParameters.forEach((parameter) => {});
 

src/compileParameter.ts

@@ -189,4 +189,15 @@ export class Compiler {
 
         return value;
     }
+
+    /**
+     * Resolve a potential ref to a value.
+     */
+    public resolveMaybeRef<T>(value: T | OpenAPIRef): T {
+        if (typeof value === 'object' && value !== null && '$ref' in value) {
+            return this.resolveRef(value);
+        }
+
+        return value;
+    }
 }

src/compiler.ts

@@ -18,7 +18,7 @@ export interface OpenAPIPath {
 
 export interface OpenAPIOperation {
     operationId?: string;
-    parameters?: OpenAPIParameter[];
+    parameters?: Array<OpenAPIParameter | OpenAPIRef>;
     requestBody?: OpenAPIRequestBody;
 }
 

src/types.ts

@@ -10,5 +10,33 @@ test('POST /spaces/1234/hive/token', () => {
         },
         query: {},
     });
-    expect(result).toMatchSnapshot();
+    expect(result).toMatchObject({
+        headers: {
+            'content-type': 'application/json',
+        },
+        method: 'post',
+        operationId: 'generateSpaceHiveReadAccessToken',
+        params: {
+            spaceId: '1234',
+        },
+        path: '/spaces/1234/hive/token',
+        query: {},
+    });
+});
+
+test('POST orgs/appleId/custom-fields', () => {
+    const result = validateRequest({
+        path: '/orgs/appleId/custom-fields',
+        method: 'post',
+        headers: {
+            'content-type': 'application/json',
+        },
+        query: {},
+        body: { name: 'jira_board', type: 'number' },
+    });
+    expect(result).toMatchObject({
+        params: {
+            organizationId: 'appleId',
+        },
+    });
 });