chore: change rhoas regex (#47)

* fix: fixes the regex pattern that APIs are using to pass more

* docs: updated docs surrounding the regex pattern for endpoint definitions

* refactor: change the severity of rules which fail

* test: testing the pipeline

* fix: update the regex to suit new format

* docs: doc updates reflecting the new regex

Author: dimakis

spectral/README.md

@@ -92,10 +92,10 @@ info:
 
 ### rhoas-path-regexp
 
-All paths must match the specified regular expression: `\/api\/.*\/v.*\/?.*$`.
+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 segement denotes the service name (e.g. `/api/kafkas_mgmt`)
+- The second segement denotes the service name (e.g. `/api/kafkas_mgmt`) and may only be `snake_case`.
 - 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`) 
 

spectral/ruleset.yaml

@@ -58,7 +58,7 @@ rules:
     then:
       function: pattern
       functionOptions:
-        match: "\/api\/.*\/v.*\/?.*$"
+        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