APIs.json API Properties Examples Info (Edit)

This property ensures that an API has a reference to a examples for individual APIs or as part of common properties, providing examples and synthentic data that can be used for APIs.

APIs.jsonAPIsPropertiesSandboxExamples

Rule Definition

apis-json-apis-properties-examples-info.yaml
{"apis-json-apis-properties-examples-info":{"description":"This property ensures that an API has a reference to a examples for individual APIs or as part of common properties, providing examples and synthentic data that can be used for APIs.","message":"Has a Blog","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(examples|Examples)\\b"}}]}}

Back to All of the Rules