chore: change rhoas regex (#46)

Author: dimakis

.github/workflows/build.yaml

@@ -1,5 +1,5 @@
+---
 name: PR verification and build
-
 on:
   push:
     branches: [ main ]
@@ -28,8 +28,8 @@ jobs:
     - working-directory: ./spectral
       run: yarn lint
   # Disabled until we have single API passing tests.
-  #  - working-directory: ./spectral
-  #    run: yarn cli-integration-tests
+    - working-directory: ./spectral
+      run: yarn cli-integration-tests
 
 
 

spectral/README.md

@@ -92,11 +92,12 @@ info:
 
 ### rhoas-path-regexp
 
-All paths must match the specified regular expression: `\/api\/v.*\/.*$`.
+All paths must match the specified regular expression: `\/api\/.*\/v.*\/?.*$`.
 
 - The first segment must be `/api`
-- 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.
+- The second segement denotes the service name (e.g. `/api/kafkas_mgmt`)
+- 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 `snake_case` and can only contain alphabetical characters along and underscores but can be repeated (e.g. `/api/kafkas_mgmt/v1/kafkas/{id}/useful_metrics`) 
 
 **Recommended**: Yes
 **Severity**: warning

spectral/ruleset.yaml

@@ -7,6 +7,10 @@ functions:
 rules:
   openapi-tags: off
   operation-tags: off
+  oas3-valid-schema-example: warn
+  no-$ref-siblings: warn
+  oas3-valid-media-example: warn
+
 
   rhoas-external-$ref:
     given: "$..['$ref']"
@@ -50,11 +54,11 @@ rules:
     severity: warn
     description:
       OpenAPI paths must start with `/api/`, followed by a version. All paths
-      must follow camel_case
+      must follow snake_case
     then:
       function: pattern
       functionOptions:
-        match: "\/api\/v.*\/.*$"
+        match: "\/api\/.*\/v.*\/?.*$"
   rhoas-response-media-type:
     given: "$.paths.*.*.responses.*.content"
     description: application/json is the only acceptable content type