Merge pull request #37 from dimakis/migrate_funcs_to_v6

feat: api validation with spectral v6 and validators for API compilance and KCP integration

Author: dimakis

spectral/README.md

@@ -21,10 +21,16 @@ echo "extends: '@rhoas/spectral-ruleset'" > .spectral.yaml
 Run the Spectral CLI:
 
 ```shell
-npm install -g @stoplight/spectral@5.9.0
+npm install -g @stoplight/spectral[email protected]
 spectral lint ./path/to/openapi.yaml
 ```
 
+or with yarn:
+```shell
+yarn add global @stoplight/[email protected]
+yarn spectral lint ./path/to/openapi.yaml
+```
+
 ## 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)
@@ -86,12 +92,11 @@ info:
 
 ### rhoas-path-regexp
 
-All paths must match the specified regular expression: `\/api\/([a-z_]*){1,}(\/v[0-9]*(alpha|beta)?)(\/{?[a-z_]*}?){0,}$`.
+All paths must match the specified regular expression: `\/api\/v.*\/.*$`.
 
 - The first segment must be `/api`
-- The second segment can only contain alphabetical characters and underscores "_"
-- The third segment must specify the API version. This can be a major version such as `v1` or a channel-version such as `v1beta`, `v1alpha`.
-- All following segments must follow `camel_case` and can only contain alphabetical characters.
+- The second segment must specify the API version. This can be a major version such as `v1` or a channel-version such as `v1beta`, `v1alpha`.
+- All following segments must follow `snake_case` and can only contain alphabetical characters.
 
 **Recommended**: Yes
 **Severity**: warning
@@ -102,7 +107,7 @@ The content type for all responses must be `application/json`.
 
 **Recommended**: Yes
 
-**Severity**: error
+**Severity**: warning
 
 ### rhoas-error-response
 
@@ -132,16 +137,16 @@ properties:
 
 **Severity**: error
 
-### rhoas-schema-name-camel-case
+### rhoas-schema-name-pascal-case
 
-All JSON schema objects defined in `components.schemas` must follow `CamelCase`.
+All JSON schema objects defined in `components.schemas` must follow `PascalCase`.
 
 **Recommended**: Yes
 
 **Severity**: warning
 ### rhoas-schema-properties-snake-case
 
-All JSON schema properties defined must follow `camel_case`.
+All JSON schema properties defined must follow `snake_case`.
 
 **Recommended**: Yes
 

spectral/package.json

@@ -14,7 +14,8 @@
     "cli-integration-tests": "./scripts/rules.sh"
   },
   "dependencies": {
-    "@stoplight/spectral": "5.9.2"
+    "@stoplight/spectral-cli": "^6.4.1",
+    "@stoplight/spectral-core": "^1.12.3"
   },
   "devDependencies": {
     "@types/node": "15.14.1",
@@ -45,4 +46,4 @@
     "url": "https://github.com/redhat-developer/app-services-api-guidelines/issues"
   },
   "homepage": "https://github.com/redhat-developer/app-services-api-guidelines#readme"
-}
+}

spectral/ruleset.yaml

@@ -1,8 +1,6 @@
-extends: spectral:oas
+extends: spectral:oas 
 functions:
   - expectServersConfig
-  - objectReferenceSchema
-  - securitySchemes
   - infoLicenseApache2
   - schemaDefinition
   - externalRefs
@@ -60,13 +58,13 @@ rules:
   rhoas-response-media-type:
     given: "$.paths.*.*.responses.*.content"
     description: application/json is the only acceptable content type
-    severity: error
+    severity: warn
     then:
       function: truthy
       field: application/json
   rhoas-error-response:
     given: "$.paths..responses[?( @property >= 300)].content.*"
-    severity: error
+    severity: error 
     then:
       field: schema
       function: schema
@@ -82,9 +80,9 @@ rules:
       functionOptions:
         schema:
           "$ref": "#/components/schemas/ObjectReference"
-  rhoas-schema-name-camel-case:
-    description: JSON Schema names should use CamelCase
-    message: "`{{property}}` object name must follow CamelCase"
+  rhoas-schema-name-pascal-case:
+    description: JSON Schema names should use PascalCase
+    message: "`{{property}}` object name must follow PascalCase"
     severity: error
     given: "$.components.schemas[*]~"
     then:

spectral/src/functions/expectServersConfig.ts

@@ -1,6 +1,6 @@
-import { IFunctionPaths, IFunctionResult } from "@stoplight/spectral";
+import { IFunctionResult } from "@stoplight/spectral-core";
 
-export default (targetVal: any, opts: any, paths: IFunctionPaths): IFunctionResult[] => {
+export default (targetVal: any, opts: any, context: any ): IFunctionResult[] => {
     if (!targetVal) {
         return [
             {
@@ -15,9 +15,8 @@ export default (targetVal: any, opts: any, paths: IFunctionPaths): IFunctionResu
             }
         ]
     }
-    const rootPath = paths.target !== void 0 ? paths.target : paths.given
+    const paths = context.path;
     const results: IFunctionResult[] = [];
-
     const expectedUrls = opts.required
     const missingUrls = [];
     for (const u of expectedUrls) {
@@ -29,7 +28,7 @@ export default (targetVal: any, opts: any, paths: IFunctionPaths): IFunctionResu
         return [
             {
                 message: `OpenAPI \`servers\` object is missing the following required URLs: ${missingUrls.join(', ')}`,
-                path: [...rootPath, 0]
+                path: [...paths, 0]
             }
         ]
     }

spectral/src/functions/externalRefs.ts

@@ -1,4 +1,4 @@
-import { IFunctionResult } from "@stoplight/spectral";
+import { IFunctionResult } from "@stoplight/spectral-core";
 
 export default (targetVal: any): IFunctionResult[] => {
     if (!targetVal || !targetVal.length) {
@@ -12,4 +12,4 @@ export default (targetVal: any): IFunctionResult[] => {
             message: 'Only local relative `$ref` or absolute external URL `$ref` is allowed'
         }]
     }
-}
+};

spectral/src/functions/infoLicenseApache2.ts

@@ -1,28 +1,32 @@
-import { IFunctionPaths, IFunctionResult } from "@stoplight/spectral";
+import { IFunctionResult } from "@stoplight/spectral-core";
+import type { JsonPath } from '@stoplight/types';
 
-export default (targetVal: any, _: any, paths: IFunctionPaths): IFunctionResult[] => {
-	const path = paths.target;
+
+export default (targetVal: any, _: any, context: any): IFunctionResult[] => {
+	let p: JsonPath = ['info']
 	if (!targetVal) {
 		return [
 			{
-				message: "OpenAPI `license` object is required",
-				path: path,
+				message: "OpenAPI `license` object is required\n in path: ",
+				path: p
 			}
 		]
 	}
+
 	const results: IFunctionResult[] = [];
 	const expectName = 'Apache 2.0'
+	p = context.path[1];
 	if (targetVal?.name != expectName) {
 		results.push({
 			message: '`name` must be "' + expectName + '"',
-			path: [...path, 'license']
+			path: [...p, 'license']
 		})
 	}	
 	const expectUrl = 'https://www.apache.org/licenses/LICENSE-2.0';
 	if (targetVal?.url !== expectUrl) {
 		results.push({
-			message: '`url` must be "' + expectUrl + '"',
-			path: [...path, 'license']
+			message: '`url` must be "' + expectUrl + '" not "' + targetVal?.url + '"',
+			path: [...p, 'license']
 		})
 	}																	
 

spectral/src/functions/objectReferenceSchema.ts

@@ -1,8 +1,8 @@
-import { IFunctionPaths, IFunctionResult, JSONSchema } from "@stoplight/spectral";
+import { IFunctionResult, JSONSchema } from "@stoplight/spectral-core";
 
 // Recursively compare the target value of the OpenAPI document with an expected value
-export default (targetVal: any, { definition }: { definition: SchemaMetadata }, paths: IFunctionPaths): IFunctionResult[] => {
-	const path = [...paths.target] as string[]
+export default (targetVal: any, { definition }: { definition: SchemaMetadata }, context: any): IFunctionResult[] => {
+	const path = [...context.path] as string[]
 	const targetSchema = path[path.length-1]
 
 	if (!targetVal) {
@@ -15,7 +15,7 @@ export default (targetVal: any, { definition }: { definition: SchemaMetadata },
 	}
 
 	return compareSchemas(definition, targetVal, path)
-}
+};
 
 type JsonSchemaType = 'string' | 'number' | 'integer' | 'object' | 'array' | 'boolean' | 'null' | 'any';
 interface SchemaMetadata {