Merge branch 'master' into errors-details

Author: aorban-isp

entrypoint.js

@@ -4,7 +4,7 @@ const fs = require('fs');
 const yaml = require('js-yaml');
 
 const { Spectral, isOpenApiv3 } = require('@stoplight/spectral');
-const { stylish } = require('@stoplight/spectral/dist/formatters/stylish');
+const { stylish } = require('@stoplight/spectral/dist/cli/formatters/stylish');
 
 const SPECTRAL_CONFIG = '.spectral.yaml';
 const ISP_RULES_PREFIX = process.env.ISP_RULES_PREFIX || './';

fixtures/disable/openapi.yaml

@@ -1,4 +1,4 @@
-openapi: '3.0.0'
+openapi: "3.0.0"
 info:
   version: 1.0.0
   title: API Fixture
@@ -21,7 +21,7 @@ paths:
       tags:
         - Test
       parameters:
-        - name: startedUtc
+        - name: started_utc
           in: query
           description: Some query param
           schema:
@@ -39,5 +39,5 @@ paths:
             format: date-time
             example: 2020-01-01T12:00:00Z
       responses:
-        '204':
+        "204":
           description: Response description

fixtures/lint/casing-fail.yaml

@@ -1,4 +1,4 @@
-openapi: '3.0.0'
+openapi: "3.0.0"
 info:
   version: 1.0.0
   title: API Fixture
@@ -21,11 +21,11 @@ paths:
       tags:
         - Test
       parameters:
-        - name: some_query_param
+        - name: someQueryParam
           in: query
           description: Some query param
           schema:
             type: string
       responses:
-        '204':
+        "204":
           description: Response description

fixtures/lint/casing-pass.yaml

@@ -1,4 +1,4 @@
-openapi: '3.0.0'
+openapi: "3.0.0"
 info:
   version: 1.0.0
   title: API Fixture
@@ -21,11 +21,11 @@ paths:
       tags:
         - Test
       parameters:
-        - name: someQueryParam
+        - name: some_query_param
           in: query
           description: Some query param
           schema:
             type: string
       responses:
-        '204':
+        "204":
           description: Response description

fixtures/lint/casing-properties-fail.yaml

@@ -1,4 +1,4 @@
-openapi: '3.0.0'
+openapi: "3.0.0"
 info:
   version: 1.0.0
   title: API Fixture
@@ -21,13 +21,13 @@ paths:
       tags:
         - Test
       responses:
-        '200':
+        "200":
           description: Response description
           content:
             application/json:
               schema:
                 type: object
                 properties:
-                  foo_bar:
+                  fooBar:
                     type: string
-                    description: foo_bar property
+                    description: fooBar property

fixtures/lint/casing-properties-pass.yaml

@@ -1,4 +1,4 @@
-openapi: '3.0.0'
+openapi: "3.0.0"
 info:
   version: 1.0.0
   title: API Fixture
@@ -21,7 +21,7 @@ paths:
       tags:
         - Test
       responses:
-        '200':
+        "200":
           description: Response description
           content:
             application/json:
@@ -30,6 +30,6 @@ paths:
                 items:
                   type: object
                   properties:
-                    fooBar:
+                    foo_bar:
                       type: string
-                      description: fooBar property
+                      description: foo_bar property

fixtures/lint/version-pass.yaml

@@ -0,0 +1,25 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: API Fixture
+  description: API fixture description
+  license:
+    name: Apache2
+  contact:
+    email: [email protected]
+servers:
+  - url: https://api.example.com/v1
+tags:
+  - name: Test
+    description: Test tag
+paths:
+  /v2/tests:
+    get:
+      summary: Test operation
+      description: Test operation description
+      operationId: test
+      tags:
+        - Test
+      responses:
+        "204":
+          description: Response description

isp-functions/noun-deps.js

@@ -59,6 +59,10 @@ module.exports = targetValue => {
   for (const value of pieces.slice(0, -1)) {
     if (value.startsWith('{')) continue;
 
+    // our api version is in the url as a resource
+    // this does not need to be plural
+    if (value.match(/v[0-9]+/)) continue;
+
     // Ensure words are plural if later paths exist.
     const plural = inflection.pluralize(value);
     if (value !== plural) {

isp-rules.yaml

@@ -86,13 +86,13 @@ rules:
       field: description
       function: truthy
   # Resource field casing
-  properties-lower-camel-case:
+  properties-lower-snake-case:
     severity: error
     given: $..properties.*~
     then:
       function: casing
       functionOptions:
-        type: camel
+        type: snake
   # Don't POST with identifier
   post-with-id:
     severity: error
@@ -154,15 +154,15 @@ rules:
     then:
       function: pattern
       functionOptions:
-        match: "/^([A-Z][a-z0-9]-)*([A-Z][a-z0-9])+/"
-  params-lower-camel-case:
+        match: '/^([A-Z][a-z0-9]-)*([A-Z][a-z0-9])+/'
+  params-lower-snake-case:
     severity: error
-    message: "`{{value}}` must follow `lowerCamelCase` notation"
+    message: '`{{value}}` must follow `snake` notation'
     given: "$..parameters[?(@.in == 'query' || @ == 'path')].name"
     then:
       function: casing
       functionOptions:
-        type: camel
+        type: snake
   # Parameter location constraints
   params-location:
     severity: error