feat(rulesets): use aliases in ruleset

stoplightio · Jan 6, 2022 · a2019f1 · a2019f1
1 parent bba4b41
commit a2019f1
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 28 deletions.
diff --git a/packages/rulesets/src/oas/__tests__/oas2-parameter-description.test.ts b/packages/rulesets/src/oas/__tests__/oas2-parameter-description.test.ts
@@ -125,6 +125,11 @@ testRule('oas2-parameter-description', [
           ],
         },
       },
+      parameters: {
+        limit: {
+          description: 'This is how it works.',
+        },
+      },
     },
     errors: [],
   },

diff --git a/packages/rulesets/src/oas/functions/oasExample.ts b/packages/rulesets/src/oas/functions/oasExample.ts
@@ -93,6 +93,11 @@ function* getMediaValidationItems(
   }
 }
 
+function isSubschema(givenPath: JsonPath) {
+  // todo: add more
+  return givenPath.length > 1 && !['properties', 'items', 'contains'].includes(String(givenPath[givenPath.length - 1]));
+}
+
 function* getSchemaValidationItems(
   fields: string[],
   targetVal: Record<string, unknown>,
@@ -103,6 +108,10 @@ function* getSchemaValidationItems(
       continue;
     }
 
+    if (!isSubschema(givenPath)) {
+      continue;
+    }
+
     yield {
       value: targetVal[field],
       path: [...givenPath, field],

diff --git a/packages/rulesets/src/oas/index.ts b/packages/rulesets/src/oas/index.ts
@@ -33,7 +33,60 @@ const ruleset = {
   formats: [oas2, oas3, oas3_0, oas3_1],
   aliases: {
     PathItem: '$.paths[*]',
+    ResponsesObject: {
+      targets: [
+        { formats: [oas2], given: ['$.responses', '#OperationObject.responses'] },
+        { formats: [oas3], given: ['$.components.responses', '#OperationObject.responses'] },
+      ],
+    },
+    ResponseObject: '#ResponsesObject[*]', // [(@ && !@.$ref)]
+    ParametersDefinitionsObject: {
+      targets: [
+        { formats: [oas2], given: ['$.parameters'] },
+        { formats: [oas3], given: ['$.components.parameters'] },
+      ],
+    },
+    ParametersObject: {
+      targets: [
+        { formats: [oas2], given: ['#PathItem.parameters', '#OperationObject.parameters'] },
+        {
+          formats: [oas3],
+          given: ['#PathItem.parameters', '#OperationObject.parameters'],
+        },
+      ],
+    },
+    ParameterObject: {
+      targets: [
+        { formats: [oas2], given: ['#ParametersDefinitionsObject[*]', '#ParametersObject[*]'] }, // ?(@ && !@.$ref)
+        {
+          formats: [oas3],
+          given: ['#ParametersDefinitionsObject[*]', '#ParametersObject[*]'], // [?(@ && !@.$ref)]
+        },
+      ],
+    },
+    EncodingObject: '#MediaTypeObject.encoding',
+    MediaTypeObject: ['#RequestBodyObject.content', '#ParameterObject.content', '#ResponseObject.content'],
+    HeadersObject: {
+      targets: [
+        { formats: [oas2], given: ['#ResponseObject.headers'] },
+        {
+          formats: [oas3],
+          given: ['$.components.headers', '#EncodingObject.headers', '#ResponseObject.headers'],
+        },
+      ],
+    },
+    HeaderObject: {
+      targets: [
+        { formats: [oas2], given: ['#ResponseObject.headers[*]'] },
+        {
+          formats: [oas3],
+          given: ['#HeadersObject[*]'], // ?(@ && !$.ref)
+        },
+      ],
+    },
+    RequestBodyObject: ['#OperationObject.requestBody', '$.components.requestBodies[*]'],
     OperationObject: '#PathItem[get,put,post,delete,options,head,patch,trace]',
+    SchemaObject: ['#MediaTypeObject.schema', '#ParameterObject.schema', '$.components.schemas[*]'],
   },
   rules: {
     'operation-success-response': {
@@ -441,7 +494,7 @@ const ruleset = {
       description: 'Parameter objects must have "description".',
       recommended: false,
       formats: [oas2],
-      given: '$..parameters[?(@ && @.in)]',
+      given: '#ParameterObject',
       type: 'style',
       then: {
         field: 'description',
@@ -468,11 +521,7 @@ const ruleset = {
       formats: [oas2],
       severity: 0,
       type: 'validation',
-      given: [
-        "$..definitions..[?(@property !== 'properties' && @ && (@.example !== void 0 || @['x-example'] !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
-        "$..parameters..[?(@property !== 'properties' && @ && (@.example !== void 0 || @['x-example'] !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
-        "$..responses..[?(@property !== 'properties' && @ && (@.example !== void 0 || @['x-example'] !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
-      ],
+      given: ['#SchemaObject..[?(@ && @.example)]'],
       then: {
         function: oasExample,
         functionOptions: {
@@ -489,7 +538,7 @@ const ruleset = {
       formats: [oas2],
       severity: 0,
       type: 'validation',
-      given: '$..responses..[?(@ && @.schema && @.examples)]',
+      given: '#MediaTypeObject',
       then: {
         function: oasExample,
         functionOptions: {
@@ -575,11 +624,9 @@ const ruleset = {
       type: 'style',
       given: [
         '$.components.examples[*]',
-        '$.paths[*][*]..content[*].examples[*]',
-        '$.paths[*][*]..parameters[*].examples[*]',
-        '$.components.parameters[*].examples[*]',
-        '$.paths[*][*]..headers[*].examples[*]',
-        '$.components.headers[*].examples[*]',
+        '#MediaTypeObject.examples[*]',
+        '#ParameterObject.examples[*]',
+        '#HeaderObject.examples[*]',
       ],
       then: {
         function: xor,
@@ -607,11 +654,7 @@ const ruleset = {
       recommended: false,
       formats: [oas3],
       type: 'style',
-      given: [
-        '#PathItem.parameters[?(@ && @.in)]',
-        '#OperationObject.parameters[?(@ && @.in)]',
-        '$.components.parameters[?(@ && @.in)]',
-      ],
+      given: '#ParameterObject',
       then: {
         field: 'description',
         function: truthy,
@@ -650,11 +693,7 @@ const ruleset = {
       severity: 0,
       formats: [oas3],
       type: 'validation',
-      given: [
-        '$..content..[?(@ && @.schema && (@.example !== void 0 || @.examples))]',
-        '$..headers..[?(@ && @.schema && (@.example !== void 0 || @.examples))]',
-        '$..parameters..[?(@ && @.schema && (@.example !== void 0 || @.examples))]',
-      ],
+      given: '#MediaTypeObject',
       then: {
         function: oasExample,
         functionOptions: {
@@ -671,12 +710,7 @@ const ruleset = {
       formats: [oas3],
       recommended: true,
       type: 'validation',
-      given: [
-        "$.components.schemas..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
-        "$..content..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
-        "$..headers..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
-        "$..parameters..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]",
-      ],
+      given: ['#SchemaObject', '#SchemaObject..[?(@ && @.example)]'],
       then: {
         function: oasExample,
         functionOptions: {