Allow pattern matching on key

[pderaaij]

This PR makes it possible to create rules that does pattern matching on the key of an object.

For example, for the key of a path you can create the following rule:

   {
       "name":"path-item-lowercased-hyphens",
       "object": "pathItem",
       "enabled": true,
       "description": "path items must be lowercase and separated with hyphens",
       "pattern": { "property": "$key", "split": "/", "value": "^{[^}]*}$|^([a-z-\/]*)$" }
   }

This relates to #214

[pderaaij]

Unsure what I can do about the breaking builds. Seems circleci related.

[MikeRalphson]

@pderaaij I think you're right. Also patch LGTM for the approach.

[bottoy]

I have been testing this new rule together with the linter update (Mermade/oas-kit@310fd30) for the 'responses' object.

'{
"name": "response_number",
"object": "responses",
"enabled": true,
"description": "The response needs to be a number value",
"pattern": { "property": "$key", "value": "^([0-9])*$"}
}'

I think code in speccy - linter.js should be
'const target = (property === '$key') ? Object.keys(object)[0] : object[property];'

With 'response' object only I do not get the key value, but the string referring to the pattern (eg. response)

generic question:

• When the OAS has an object to validate the key (eg response key, path key, ...) you do it from the parent object (paths, responses) or from within each item (pathItem, response) - or we allow the both

Cheers,
Bram

[MikeRalphson]

Hi @bottoy I think @pderaaij has just fixed this over in oas-kit in Mermade/oas-kit#134