Improvements to rules (#7)

Author: Enda

.gitignore

@@ -10,6 +10,9 @@
 .env.test.local
 .env.production.local
 
+# Editor settings
+.vscode
+
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*

spectral/README.md

@@ -16,7 +16,7 @@ rules:
 
 The RHOAS ruleset extends the Spectral built-in "oas" ruleset (except `operation-tags`, `openapi-tags`). You can see the full list of rules from that ruleset [here](https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md)
 
-### oas3minimum
+### rhoas-oas3minimum
 
 OpenAPI schemas should be a minimum of v3.
 
@@ -25,9 +25,10 @@ openapi: 3.0
 ```
 
 **Recommended**: Yes
+
 **Severity**: warning
 
-### servers-config
+### rhoas-servers-config
 
 The `servers` OpenAPI object must be defined and must specify at minimum the following URLs:
 
@@ -40,9 +41,10 @@ servers:
 ```
 
 **Recommended**: Yes
+
 **Severity**: warning
 
-### info-license-apache2.0:
+### rhoas-info-license-apache2.0:
 
 The `info.license.name` field must be "Apache 2.0".
 
@@ -55,7 +57,7 @@ info:
 **Recommended**: Yes
 **Severity**: warning
 
-### info-license-apache2.0-url:
+### rhoas-info-license-apache2.0-url:
 
 The `info.license.url` field must have the correct link for Apache 2.0.
 
@@ -66,11 +68,12 @@ info:
 ```
 
 **Recommended**: Yes
+
 **Severity**: warning
 
-### invalid-path-regexp
+### rhoas-path-regexp
 
-All paths must match the specified regular expression: `/api/([a-z_]*){1,}(/v[0-9]*(alpha|beta)?)(/{?[a-z_]*}?){1,}$"`.
+All paths must match the specified regular expression: `\/api\/([a-z_]*){1,}(\/v[0-9]*(alpha|beta)?)(\/{?[a-z_]*}?){0,}$`.
 
 - The first segment must be `/api`
 - The second segment can only contain alphabetical characters and underscores "_"
@@ -80,21 +83,23 @@ All paths must match the specified regular expression: `/api/([a-z_]*){1,}(/v[0-
 **Recommended**: Yes
 **Severity**: warning
 
-### invalid-response-media-type
+### rhoas-response-media-type
 
 The content type for all responses must be `application/json`.
 
 **Recommended**: Yes
+
 **Severity**: error
 
-### invalid-error-response-object
+### rhoas-error-response
 
 All error response bodies must reference `#/components/Schemas/Error`
 
 **Recommended**: Yes
+
 **Severity**: error
 
-### invalid-object-resource-schema
+### rhoas-object-resource-schema
 
 All API response bodies must be an `object` with three required properties:
 
@@ -111,22 +116,25 @@ properties:
 ```
 
 **Recommended**: Yes
+
 **Severity**: error
 
-### schema-name-camel-case
+### rhoas-schema-name-camel-case
 
 All JSON schema objects defined in `components.schemas` must follow `CamelCase`.
 
 **Recommended**: Yes
+
 **Severity**: warning
-### properties-snake-case
+### rhoas-schema-properties-snake-case
 
 All JSON schema properties defined must follow `camel_case`.
 
 **Recommended**: Yes
+
 **Severity**: error
 
-### invalid-error-schema
+### rhoas-error-schema
 
 `components.schema` MUST have a valid `Error` object.
 
@@ -148,9 +156,10 @@ Error:
 ```
 
 **Recommended**: Yes
+
 **Severity**: warning
 
-### invalid-object-schema
+### rhoas-object-schema
 
 `components.schema` MUST have a valid `ObjectReference` object.
 
@@ -168,9 +177,10 @@ ObjectReference:
 ```
 
 **Recommended**: Yes
+
 **Severity**: warning
 
-### invalid-list-schema
+### rhoas-list-schema
 
 `components.schema` MUST have a valid `List` object.
 
@@ -197,6 +207,7 @@ List:
 ```
 
 **Recommended**: Yes
+
 **Severity**: warning
 
 ## Development
@@ -217,8 +228,9 @@ yarn build
 
 **Running examples**
 
-Validate OpenAPI files using the uncompiled TypeScript CLI:
+Validate OpenAPI files using the uncompiled ruleset:
 
 ```shell
-yarn validate-dev ./examples/openapi-valid.yaml
+yarn build
+yarn spectral-lint ./examples/openapi-valid.yaml
 ```

spectral/package.json

@@ -10,8 +10,7 @@
     "lint": "eslint src/**/*.ts",
     "publish": "npm publish dist",
     "copy-ruleset": "cp ./ruleset.yaml ./dist/ruleset.yaml && cp ./package.json ./dist/package.json",
-    "spectral-lint:local": "spectral lint --ruleset ./examples/.spectral-local.yaml",
-    "spectral-lint": "spectral lint --ruleset ./examples/.spectral.yaml"
+    "spectral-lint": "spectral lint --ruleset ./examples/.spectral-local.yaml"
   },
   "dependencies": {
     "@stoplight/spectral": "^5.3.0"
@@ -34,7 +33,7 @@
   },
   "keywords": [
     "openapi",
-	"spectral",
+    "spectral",
     "validator",
     "rhoas",
     "app-services-sdk"

spectral/ruleset.yaml

@@ -9,7 +9,7 @@ rules:
   openapi-tags: off
   operation-tags: off
 
-  oas3minimum:
+  rhoas-oas3minimum:
     given: "$"
     description: OpenAPI version must be >= 3
     recommended: true
@@ -19,7 +19,7 @@ rules:
       function: pattern
       functionOptions:
         match: 3.[0-9]?.[0-9]
-  servers-config:
+  rhoas-servers-config:
     given: "$"
     severity: warn
     recommended: true
@@ -32,14 +32,14 @@ rules:
           - https://api.stage.openshift.com
           - http://localhost:8000
           - "/"
-  info-license-apache2.0:
+  rhoas-info-license-apache2.0:
     severity: warn
     recommended: true
     given: "$"
     then:
       function: infoLicenseApache2
       field: info.license
-  invalid-path-regexp:
+  rhoas-path-regexp:
     given: "$.paths[*]~"
     severity: warn
     description:
@@ -48,15 +48,15 @@ rules:
     then:
       function: pattern
       functionOptions:
-        match: "/api/([a-z_]*){1,}(/v[0-9]*(alpha|beta)?)(/{?[a-z_]*}?){1,}$"
-  invalid-response-media-type:
+        match: "\/api\/([a-z_]*){1,}(\/v[0-9]*(alpha|beta)?)(\/{?[a-z_]*}?){0,}$"
+  rhoas-response-media-type:
     given: "$.paths.*.*.responses.*.content"
     description: application/json is the only acceptable content type
     severity: error
     then:
       function: truthy
       field: application/json
-  invalid-error-response-object:
+  rhoas-error-response:
     given: "$.paths..responses[?( @property >= 300)].content.*"
     severity: error
     then:
@@ -65,7 +65,7 @@ rules:
       functionOptions:
         schema:
           "$ref": "#/components/schemas/Error"
-  invalid-object-resource-schema:
+  rhoas-object-resource-schema:
     given: "$.paths..responses[?( @property < 300)].content.*"
     severity: error
     then:
@@ -74,7 +74,7 @@ rules:
       functionOptions:
         schema:
           "$ref": "#/components/schemas/ObjectReference"
-  schema-name-camel-case:
+  rhoas-schema-name-camel-case:
     description: JSON Schema names should use CamelCase
     message: "`{{property}}` object name must follow CamelCase"
     severity: error
@@ -83,7 +83,7 @@ rules:
       function: pattern
       functionOptions:
         match: "^([A-Z]{1}[a-z]{1,}){1,}$"
-  properties-snake-case:
+  rhoas-schema-properties-snake-case:
     description:
       All JSON Schema properties MUST follow snake_case and be ASCII alphanumeric
       characters.
@@ -95,7 +95,7 @@ rules:
       function: pattern
       functionOptions:
         match: "/^[a-z0-9_]{1,}/"
-  invalid-error-schema:
+  rhoas-error-schema:
     severity: error
     recommended: true
     given: "$.components.schemas"
@@ -118,7 +118,7 @@ rules:
             reason:
               type: string
               required: true
-  invalid-object-schema:
+  rhoas-object-schema:
     severity: error
     recommended: true
     given: "$.components.schemas"
@@ -138,7 +138,7 @@ rules:
             href:
               type: string
               required: true
-  invalid-list-schema:
+  rhoas-list-schema:
     severity: error
     recommended: true
     given: "$.components.schemas"
@@ -163,4 +163,4 @@ rules:
               required: true
             total:
               type: integer
-              required: true
+              required: true