APIs.json Apis Properties OpenAPI Rules Info (Edit)

This property ensures that an OpenAPI has support governance rules, that can be applied during design time via editors, development time via IDE, and run-time via CI/CD pipelines

APIs.jsonAPIsProperties

Rule Definition

apis-json-apis-properties-openapi-rules-info.yaml 
{"apis-json-apis-properties-openapi-rules-info":{"description":"This property ensures that an OpenAPI has support governance rules, that can be applied during design time via editors, development time via IDE, and run-time via CI/CD pipelines","message":"Has API Rules","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-rules|ApiRules)\\b"}}]}}

Back to All of the Rules