diff --git a/src/all-rules.json b/src/all-rules.json
index 6340015..cf70f5e 100644
--- a/src/all-rules.json
+++ b/src/all-rules.json
@@ -1 +1 @@
-{"openapi":{"array-items":{"title":"Array Items","reference":"https://spotlight-rules.com/spec/rules/openapi/array-items/","description":"Array Items.","source":"builtin","message":"Schemas with \"type: array\", require a sibling \"items\" field","severity":"info","given":"#ArrayProperties","then":{"function":"truthy","field":"items"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'array-items' (Array Items). Requirement: Array Items. To fix: Ensure `items` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `#ArrayProperties` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"channel-parameter-require-examples":{"title":"Channel Parameter Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/channel-parameter-require-examples/","source":"compiled","description":"Parameter must have examples.","message":"Parameter must have examples","severity":"info","given":"$.channels.*.parameters.*.schema","then":{"field":"examples","function":"truthy"},"formats":["aas2"],"tags":["format:openapi","spec:channels","spec:parameters","spec:schemas","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'channel-parameter-require-examples' (Channel Parameter Require Examples). Requirement: Parameter must have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.channels.*.parameters.*.schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"component-example-keys-snake-case":{"title":"Component Example Keys Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/component-example-keys-snake-case/","source":"compiled","description":"example key must be snake cased (e.g. snake_case).","message":"{{error}}","severity":"info","given":"$.components['examples'].*~","then":{"function":"digitalocean:ensureSnakeCaseWithDigits"},"tags":["format:openapi","spec:components","spec:examples","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'component-example-keys-snake-case' (Component Example Keys Snake Case). Requirement: example key must be snake cased (e.g. snake_case). This rule is evaluated at the JSONPath `$.components['examples'].*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"component-message-require-examples":{"title":"Component Message Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/component-message-require-examples/","source":"compiled","description":"Message must have examples.","message":"Message must have examples","severity":"info","given":"$.components.messages.*","then":{"field":"examples","function":"truthy"},"formats":["aas3"],"tags":["format:openapi","spec:messages","spec:components","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'component-message-require-examples' (Component Message Require Examples). Requirement: Message must have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"component-require-security-schemes":{"title":"Component Require Security Schemes","reference":"https://spotlight-rules.com/spec/rules/openapi/component-require-security-schemes/","source":"compiled","description":"The API contract MUST include a 'securitySchemes' subsection under the 'components' section.","message":"{{description}}: {{error}}","severity":"info","given":"$.components","then":{"field":"securitySchemes","function":"truthy"},"formats":["oas3"],"tags":["owasp:api2","format:openapi","spec:components","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'component-require-security-schemes' (Component Require Security Schemes). Requirement: The API contract MUST include a 'securitySchemes' subsection under the 'components' section. To fix: Ensure `securitySchemes` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"contact-properties":{"title":"Contact Properties","reference":"https://spotlight-rules.com/spec/rules/openapi/contact-properties/","source":"builtin","description":"Contact object must have \"name\", \"url\" and \"email\".","message":"Contact object must have \"name\", \"url\" and \"email\".","severity":"info","given":"$.info.contact","then":[{"field":"name","function":"truthy"},{"field":"url","function":"truthy"},{"field":"email","function":"truthy"}],"tags":["format:openapi","spec:info","experience:documentation","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'contact-properties' (Contact Properties). Requirement: Contact object must have \"name\", \"url\" and \"email\". To fix: Ensure `name` is present and non-empty at each matching location. Also: Ensure `url` is present and non-empty at each matching location. Also: Ensure `email` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.contact` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-cache-control-parameter":{"title":"Document Cache Control Parameter","reference":"https://spotlight-rules.com/spec/rules/openapi/document-cache-control-parameter/","source":"compiled","description":"Cache usage SHOULD be extensively detailed in the `description` property to avoid data leaks or the usage of stale data. This rule should ensure in some way that the api provider documented extensively the cache usage to avoid data leaks or usage of stale data. For now this ruleset tests: * the presence of following keywords in the `description`: `max-age`, `private`, `no-store`, `no-cache`. * that one and only one between Expires and Cache-Control is used. `Cache-Control` and `Expires` should not be used in conjuction, because `Cache-Control` overrides `Expires` when `max-age` is set. Instead if neither `Cache-Control` or `Expires` are set, clients MAY use euristic cache like described in RFC7234.","message":"Cache usage SHOULD be documented when used.","severity":"info","given":"$..[parameters][?(@.in == \"header\" && @.name.match(/Cache-Control/i))]","then":[{"field":"description","function":"truthy"},{"field":"description","function":"pattern","functionOptions":{"match":".*(max-age|private|no-store|no-cache).*"}}],"formats":["oas3"],"tags":["format:openapi","spec:parameters","spec:headers","topic:caching","experience:documentation","experience:reliability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-cache-control-parameter' (Document Cache Control Parameter). Requirement: Cache usage SHOULD be extensively detailed in the `description` property to avoid data leaks or the usage of stale data. This rule should ensure in some way that the api provider documented extensively the cache usage to avoid data leaks or usage of stale data. For now this ruleset tests: * the presence of following keywords in the `description`: `max-age`, `private`, `no-store`, `no-cache`. * that one and only one between Expires and Cache-Control is used. `Cache-Control` and `Expires` should not be used in conjuction, because `Cache-Control` overrides `Expires` when `max-age` is set. Instead if neither `Cache-Control` or `Expires` are set, clients MAY use euristic cache like described in RFC7234. To fix: Ensure `description` is present and non-empty at each matching location. Also: Ensure `description` matches the regular expression `.*(max-age|private|no-store|no-cache).*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[parameters][?(@.in == \"header\" && @.name.match(/Cache-Control/i))]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-cache-response-header":{"title":"Document Cache Response Header","reference":"https://spotlight-rules.com/spec/rules/openapi/document-cache-response-header/","source":"compiled","description":"Cache usage SHOULD be extensively detailed in the `description` property to avoid data leaks or the usage of stale data. This rule should ensure in some way that the api provider documented extensively the cache usage to avoid data leaks or usage of stale data. For now this ruleset tests: * the presence of following keywords in the `description`: `max-age`, `private`, `no-store`, `no-cache`. * that one and only one between Expires and Cache-Control is used. `Cache-Control` and `Expires` should not be used in conjuction, because `Cache-Control` overrides `Expires` when `max-age` is set. Instead if neither `Cache-Control` or `Expires` are set, clients MAY use euristic cache like described in RFC7234.","message":"Cache usage in responses SHOULD be documented in Cache-Control and/or Expires. {{error}}","severity":"info","given":"$.[responses][?(@property[0] == \"2\" )][headers].[?(@property.match(/Cache-Control|Expires/i))]]","then":[{"field":"description","function":"truthy"},{"field":"description","function":"pattern","functionOptions":{"match":".*(max-age|private|no-store|no-cache).*"}}],"formats":["oas3"],"tags":["format:openapi","spec:responses","spec:headers","topic:caching","experience:documentation","experience:reliability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-cache-response-header' (Document Cache Response Header). Requirement: Cache usage SHOULD be extensively detailed in the `description` property to avoid data leaks or the usage of stale data. This rule should ensure in some way that the api provider documented extensively the cache usage to avoid data leaks or usage of stale data. For now this ruleset tests: * the presence of following keywords in the `description`: `max-age`, `private`, `no-store`, `no-cache`. * that one and only one between Expires and Cache-Control is used. `Cache-Control` and `Expires` should not be used in conjuction, because `Cache-Control` overrides `Expires` when `max-age` is set. Instead if neither `Cache-Control` or `Expires` are set, clients MAY use euristic cache like described in RFC7234. To fix: Ensure `description` is present and non-empty at each matching location. Also: Ensure `description` matches the regular expression `.*(max-age|private|no-store|no-cache).*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.[responses][?(@property[0] == \"2\" )][headers].[?(@property.match(/Cache-Control|Expires/i))]]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-owasp-api9-server":{"title":"Document OWASP API9 Server","reference":"https://spotlight-rules.com/spec/rules/openapi/document-owasp-api9-server/","source":"spotlight","description":"The API should declare its servers so all hosts and environments are inventoried — undocumented or stray non-production hosts are a common inventory-management risk (OWASP API9).","message":"API should declare its servers (host/environment inventory).","given":"$","severity":"info","then":{"field":"servers","function":"truthy"},"tags":["format:openapi","spec:servers","experience:security","experience:governance","owasp:api9"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-owasp-api9-server' (Document OWASP API9 Server). Requirement: The API should declare its servers so all hosts and environments are inventoried — undocumented or stray non-production hosts are a common inventory-management risk (OWASP API9). To fix: Ensure `servers` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-component-section":{"title":"Document Require Component Section","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-component-section/","source":"compiled","description":"The API contract MUST include a 'components' section.","message":"{{description}}: {{error}}","severity":"info","given":"$","then":{"field":"components","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:document","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-component-section' (Document Require Component Section). Requirement: The API contract MUST include a 'components' section. To fix: Ensure `components` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-external-docs":{"title":"Document Require External Docs","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-external-docs/","source":"compiled","description":"Defining external documentation provides a link to detailed API guides, tutorials, and reference material beyond the OpenAPI spec. Analysis shows 57.1% of APIs include external docs.","message":"External Docs MUST Be Defined","severity":"info","given":"$","then":{"field":"externalDocs","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-external-docs' (Document Require External Docs). Requirement: Defining external documentation provides a link to detailed API guides, tutorials, and reference material beyond the OpenAPI spec. Analysis shows 57.1% of APIs include external docs. To fix: Ensure `externalDocs` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-jsonschemadialect":{"title":"Document Require Jsonschemadialect","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-jsonschemadialect/","source":"spotlight","description":"openapi document should declare a `jsonSchemaDialect` property.","message":"Missing `jsonSchemaDialect`.","given":"$","severity":"info","then":{"field":"jsonSchemaDialect","function":"truthy"},"tags":["format:openapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-jsonschemadialect' (Document Require Jsonschemadialect). Requirement: openapi document should declare a `jsonSchemaDialect` property. To fix: Ensure `jsonSchemaDialect` is present and non-empty at each matching location. Guidance: Missing `jsonSchemaDialect`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-openapi":{"title":"Document Require Openapi","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-openapi/","source":"spotlight","description":"openapi document should declare a `openapi` property.","message":"Missing `openapi`.","given":"$","severity":"info","then":{"field":"openapi","function":"truthy"},"tags":["format:openapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-openapi' (Document Require Openapi). Requirement: openapi document should declare a `openapi` property. To fix: Ensure `openapi` is present and non-empty at each matching location. Guidance: Missing `openapi`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-path":{"title":"Document Require Path","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-path/","source":"spotlight","description":"openapi document should declare a `paths` property.","message":"Missing `paths`.","given":"$","severity":"info","then":{"field":"paths","function":"truthy"},"tags":["format:openapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-path' (Document Require Path). Requirement: openapi document should declare a `paths` property. To fix: Ensure `paths` is present and non-empty at each matching location. Guidance: Missing `paths`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-realistic-examples":{"title":"Document Require Realistic Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-realistic-examples/","source":"compiled","description":"API design SHOULD include real-like examples for request and response definitions.","message":"The {{property}} SHOULD include a real-like example. Add realistic examples to improve API usability.","severity":"info","given":"$..[?(@.example || @.examples)]","then":{"field":"example","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:examples","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-realistic-examples' (Document Require Realistic Examples). Requirement: API design SHOULD include real-like examples for request and response definitions. To fix: Ensure `example` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..[?(@.example || @.examples)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-server-defined":{"title":"Document Require Server Defined","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-server-defined/","source":"compiled","description":"Every OpenAPI should define at least one server URL. Analysis shows 97.2% of APIs define servers, providing consumers with the base URL needed to make requests.","message":"Servers MUST Be Defined","severity":"info","given":"$","then":{"field":"servers","function":"truthy"},"tags":["format:openapi","spec:document","experience:usability","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-server-defined' (Document Require Server Defined). Requirement: Every OpenAPI should define at least one server URL. Analysis shows 97.2% of APIs define servers, providing consumers with the base URL needed to make requests. To fix: Ensure `servers` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-webhooks":{"title":"Document Require Webhooks","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-webhooks/","source":"spotlight","description":"openapi document should declare a `webhooks` property.","message":"Missing `webhooks`.","given":"$","severity":"info","then":{"field":"webhooks","function":"truthy"},"tags":["format:openapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-webhooks' (Document Require Webhooks). Requirement: openapi document should declare a `webhooks` property. To fix: Ensure `webhooks` is present and non-empty at each matching location. Guidance: Missing `webhooks`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-spec-must-not-be-empty":{"title":"Document Spec Must Not Be Empty","reference":"https://spotlight-rules.com/spec/rules/openapi/document-spec-must-not-be-empty/","source":"compiled","description":"Spec should not be empty.","message":"{{error}}","severity":"info","given":"$","then":{"function":"trimble:is-valid-spec"},"tags":["format:openapi","spec:document","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-spec-must-not-be-empty' (Document Spec Must Not Be Empty). Requirement: Spec should not be empty. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"duplicated-entry-in-enum":{"title":"Duplicated Entry In Enum","reference":"https://spotlight-rules.com/spec/rules/openapi/duplicated-entry-in-enum/","source":"builtin","description":"Enum values must not have duplicate entry.","message":"{{error}}","severity":"info","given":["$..[?(@property !== 'properties' && @.enum && @.enum.constructor.name === 'Array')]"],"then":{"field":"enum","function":"oasSchema","functionOptions":{"schema":{"type":"array","uniqueItems":true}}},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'duplicated-entry-in-enum' (Duplicated Entry In Enum). Requirement: Enum values must not have duplicate entry. This rule is evaluated at the JSONPath `$..[?(@property !== 'properties' && @.enum && @.enum.constructor.name === 'Array')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"header-names-hyphenated-pascal-case":{"title":"Header Names Hyphenated Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/header-names-hyphenated-pascal-case/","source":"compiled","description":"All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation.","message":"'HTTP' headers MUST follow 'Hyphenated-Pascal-Case' notation","severity":"info","given":"$..parameters[?(@.in == 'header')].name","then":{"function":"pattern","functionOptions":{"match":"/^([A-Z][a-z0-9]-)*([A-Z][a-z0-9])+/"}},"tags":["format:openapi","spec:parameters","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'header-names-hyphenated-pascal-case' (Header Names Hyphenated Pascal Case). Requirement: All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation. To fix: Ensure the targeted value matches the regular expression `/^([A-Z][a-z0-9]-)*([A-Z][a-z0-9])+/`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'header')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"header-no-x-prefix":{"title":"Header No X Prefix","reference":"https://spotlight-rules.com/spec/rules/openapi/header-no-x-prefix/","source":"compiled","description":"'HTTP' headers SHOULD NOT start with 'X-' RFC6648.","message":"HTTP header '{{value}}' SHOULD NOT start with 'X-' in {{path}}","severity":"info","given":["$..parameters[?(@.in == 'header')].name"],"then":{"function":"pattern","functionOptions":{"match":"/^([^x]|.[^-])|RateLimit-/i"}},"tags":["format:openapi","spec:parameters","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'header-no-x-prefix' (Header No X Prefix). Requirement: 'HTTP' headers SHOULD NOT start with 'X-' RFC6648. To fix: Ensure the targeted value matches the regular expression `/^([^x]|.[^-])|RateLimit-/i`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'header')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"header-require-examples":{"title":"Header Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/header-require-examples/","source":"compiled","description":"Headers must include examples.","message":"{{description}}; missing {{property}}","severity":"info","given":"$..headers.*","then":{"function":"digitalocean:ensurePropertiesExample"},"tags":["format:openapi","spec:headers","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'header-require-examples' (Header Require Examples). Requirement: Headers must include examples. This rule is evaluated at the JSONPath `$..headers.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-contact":{"title":"Info Contact","reference":"https://spotlight-rules.com/spec/rules/openapi/info-contact/","source":"builtin","description":"Info object must have \"contact\" object.","message":"Info object must have \"contact\" object.","severity":"info","given":"$","then":{"field":"info.contact","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-contact' (Info Contact). Requirement: Info object must have \"contact\" object. To fix: Ensure `info.contact` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-contact-require-email":{"title":"Info Contact Require Email","reference":"https://spotlight-rules.com/spec/rules/openapi/info-contact-require-email/","source":"compiled","description":"Having a contact email address associated with the technical contract ensures that anyone who comes across the API has someone to email and get more information.","message":"Info MUST Have Contact Email","severity":"info","given":"$.info.contact","then":{"field":"email","function":"truthy"},"tags":["format:openapi","spec:info","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-contact-require-email' (Info Contact Require Email). Requirement: Having a contact email address associated with the technical contract ensures that anyone who comes across the API has someone to email and get more information. To fix: Ensure `email` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.contact` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-contact-require-name":{"title":"Info Contact Require Name","reference":"https://spotlight-rules.com/spec/rules/openapi/info-contact-require-name/","source":"compiled","description":"Having a contact name associated with the technical contract ensures that anyone who comes across the API knows who to contact.","message":"Info MUST Have Contact Name","severity":"info","given":"$.info.contact","then":{"field":"name","function":"truthy"},"tags":["format:openapi","spec:info","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-contact-require-name' (Info Contact Require Name). Requirement: Having a contact name associated with the technical contract ensures that anyone who comes across the API knows who to contact. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.contact` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-contact-require-url":{"title":"Info Contact Require URL","reference":"https://spotlight-rules.com/spec/rules/openapi/info-contact-require-url/","source":"compiled","description":"Having a contact url associated with the technical contract ensures that anyone who comes across the API knows where to go to contact someone.","message":"Info MUST Have Contact URL","severity":"info","given":"$.info.contact","then":{"field":"url","function":"truthy"},"tags":["format:openapi","spec:info","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-contact-require-url' (Info Contact Require URL). Requirement: Having a contact url associated with the technical contract ensures that anyone who comes across the API knows where to go to contact someone. To fix: Ensure `url` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.contact` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-description":{"title":"Info Description","reference":"https://spotlight-rules.com/spec/rules/openapi/info-description/","source":"builtin","description":"Info \"description\" must be present and non-empty string.","message":"Info \"description\" must be present and non-empty string.","severity":"info","given":"$","then":{"field":"info.description","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-description' (Info Description). Requirement: Info \"description\" must be present and non-empty string. To fix: Ensure `info.description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-description-length-limit":{"title":"Info Description Length Limit","reference":"https://spotlight-rules.com/spec/rules/openapi/info-description-length-limit/","source":"compiled","description":"Having a restriction on the length of the API description expressed as the OpenAPI info description helps provide constraints for consumers when adding a description, and keeps portals, landing pages, documentation, and discovery results more consistent.","message":"Info description MUST be less than 500 characters.","severity":"info","given":"$.info","then":{"field":"description","function":"length","functionOptions":{"max":500}},"tags":["format:openapi","spec:info","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-description-length-limit' (Info Description Length Limit). Requirement: Having a restriction on the length of the API description expressed as the OpenAPI info description helps provide constraints for consumers when adding a description, and keeps portals, landing pages, documentation, and discovery results more consistent. To fix: Ensure the length of `description` is at most 500. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-description-no-eval-tag":{"title":"Info Description No Eval Tag","reference":"https://spotlight-rules.com/spec/rules/openapi/info-description-no-eval-tag/","source":"compiled","description":"Eval functions MUST not be included in the description of an API, keeping descriptions to just the text that is needed, and relying on the rest of the OpenAPI to describe what is possible.","message":"Info Description MUST NOT Have Eval Tag","severity":"info","given":"$.info","then":{"field":"description","function":"pattern","functionOptions":{"notMatch":"^\\b(<eval)\\b"}},"tags":["format:openapi","spec:info","experience:security","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-description-no-eval-tag' (Info Description No Eval Tag). Requirement: Eval functions MUST not be included in the description of an API, keeping descriptions to just the text that is needed, and relying on the rest of the OpenAPI to describe what is possible. To fix: Ensure `description` does NOT match the regular expression `^\\b(<eval)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-description-no-script-tag":{"title":"Info Description No Script Tag","reference":"https://spotlight-rules.com/spec/rules/openapi/info-description-no-script-tag/","source":"compiled","description":"Script tags MUST not be included in the description of an API, keeping descriptions to just the text that is needed, and relying on the rest of the OpenAPI to describe what is possible.","message":"Info Description MUST NOT Have Script Tag","severity":"info","given":"$.info","then":{"field":"description","function":"pattern","functionOptions":{"notMatch":"^\\b(<script)\\b"}},"tags":["format:openapi","spec:info","experience:security","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-description-no-script-tag' (Info Description No Script Tag). Requirement: Script tags MUST not be included in the description of an API, keeping descriptions to just the text that is needed, and relying on the rest of the OpenAPI to describe what is possible. To fix: Ensure `description` does NOT match the regular expression `^\\b(<script)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-license":{"title":"Info License","reference":"https://spotlight-rules.com/spec/rules/openapi/info-license/","source":"builtin","description":"Info object must have \"license\" object.","message":"Info object must have \"license\" object.","severity":"info","given":"$","then":{"field":"info.license","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-license' (Info License). Requirement: Info object must have \"license\" object. To fix: Ensure `info.license` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-license-require-name":{"title":"Info License Require Name","reference":"https://spotlight-rules.com/spec/rules/openapi/info-license-require-name/","source":"compiled","description":"The license object should include a name property identifying the license type, such as Apache 2.0, MIT, or a proprietary license.","message":"Info License MUST Have Name","severity":"info","given":"$.info.license","then":{"field":"name","function":"truthy"},"tags":["format:openapi","spec:info","experience:governance","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-license-require-name' (Info License Require Name). Requirement: The license object should include a name property identifying the license type, such as Apache 2.0, MIT, or a proprietary license. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.license` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-license-require-url":{"title":"Info License Require URL","reference":"https://spotlight-rules.com/spec/rules/openapi/info-license-require-url/","source":"compiled","description":"The license object should include a URL linking to the full license text so API consumers can review the terms.","message":"Info License MUST Have URL","severity":"info","given":"$.info.license","then":{"field":"url","function":"truthy"},"tags":["format:openapi","spec:info","experience:governance","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-license-require-url' (Info License Require URL). Requirement: The license object should include a URL linking to the full license text so API consumers can review the terms. To fix: Ensure `url` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.license` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-microcks-extension-valid":{"title":"Info Microcks Extension Valid","reference":"https://spotlight-rules.com/spec/rules/openapi/info-microcks-extension-valid/","source":"compiled","description":"x-microcks extension must be valid.","message":"x-microcks extension must be valid","severity":"info","given":"$.info.x-microcks","then":{"function":"schema","functionOptions":{"schema":{"type":"object","properties":{"labels":{"type":"object","additionalProperties":{"type":"string"}}},"required":["labels"],"additionalProperties":false}}},"formats":["oas3","aas2","aas3"],"tags":["format:openapi","spec:info","experience:governance","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-microcks-extension-valid' (Info Microcks Extension Valid). Requirement: x-microcks extension must be valid. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.info.x-microcks` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-owasp-api9-document-version":{"title":"Info OWASP API9 Document Version","reference":"https://spotlight-rules.com/spec/rules/openapi/info-owasp-api9-document-version/","source":"spotlight","description":"The API should declare a version in info.version so every published version is inventoried and retired versions can be tracked (OWASP API9 — improper inventory management).","message":"API should declare info.version for inventory management.","given":"$.info","severity":"info","then":{"field":"version","function":"truthy"},"tags":["format:openapi","spec:info","experience:security","experience:governance","owasp:api9"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-owasp-api9-document-version' (Info OWASP API9 Document Version). Requirement: The API should declare a version in info.version so every published version is inventoried and retired versions can be tracked (OWASP API9 — improper inventory management). To fix: Ensure `version` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-api-identifier":{"title":"Info Require API Identifier","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-api-identifier/","source":"compiled","description":"The `#/info/x-api-id` field can be used to associate an identifier to an API. This is useful to track an API even when its `#/info/title` changes.","message":"API must have an unique identifier in x-api-id in #/info/x-api-id.","severity":"info","given":"$","then":{"field":"info.x-api-id","function":"truthy"},"tags":["format:openapi","spec:document","experience:discoverability","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-api-identifier' (Info Require API Identifier). Requirement: The `#/info/x-api-id` field can be used to associate an identifier to an API. This is useful to track an API even when its `#/info/title` changes. To fix: Ensure `info.x-api-id` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-contact-2":{"title":"Info Require Contact 2","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-contact-2/","source":"compiled","description":"Having a contact object associated with the technical contract ensures that anyone who comes across the API has someone to contact and get more information.","message":"Info MUST Have Contact Object","severity":"info","given":"$.info","then":{"field":"contact","function":"truthy"},"tags":["format:openapi","spec:info","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-contact-2' (Info Require Contact 2). Requirement: Having a contact object associated with the technical contract ensures that anyone who comes across the API has someone to contact and get more information. To fix: Ensure `contact` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-description":{"title":"Info Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-description/","source":"compiled","description":"Info section is missing a description.","message":"Info section is missing a description.","severity":"info","given":"$.info","then":{"field":"description","function":"truthy"},"formats":["oas3","oas3_1"],"tags":["format:openapi","spec:info","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-description' (Info Require Description). Requirement: Info section is missing a description. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-license":{"title":"Info Require License","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-license/","source":"compiled","description":"Having a license defined in the info object clarifies the terms under which the API can be used. Analysis shows only 44.4% of APIs define a license, but it is essential for API governance and compliance.","message":"Info MUST Have License","severity":"info","given":"$.info","then":{"field":"license","function":"truthy"},"tags":["format:openapi","spec:info","experience:governance","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-license' (Info Require License). Requirement: Having a license defined in the info object clarifies the terms under which the API can be used. Analysis shows only 44.4% of APIs define a license, but it is essential for API governance and compliance. To fix: Ensure `license` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-openapi-version-3x":{"title":"Info Require Openapi Version 3x","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-openapi-version-3x/","source":"compiled","description":"APIs should use OpenAPI 3.x specification. Analysis of 773 API specs shows 97% use OpenAPI 3.x, with 86% on 3.1.0, making it the dominant standard for modern API definitions.","message":"OpenAPI MUST Be Version 3.x","severity":"info","given":"$","then":{"field":"openapi","function":"pattern","functionOptions":{"match":"^3\\."}},"tags":["format:openapi","spec:document","experience:versioning","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-openapi-version-3x' (Info Require Openapi Version 3x). Requirement: APIs should use OpenAPI 3.x specification. Analysis of 773 API specs shows 97% use OpenAPI 3.x, with 86% on 3.1.0, making it the dominant standard for modern API definitions. To fix: Ensure `openapi` matches the regular expression `^3\\.`; rewrite any value that does not. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-summary":{"title":"Info Require Summary","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-summary/","source":"compiled","description":"The `#/info/x-summary` can be used to specify a brief, one-liner description of your API: this is very useful for catalog purposes (eg. this can be shown as your API subtitle in catalogs and developer portals). In OAS3.1 you can use the standard `#/info/summary` field.","message":"API MUST have an one-liner #/info/x-summary field containing a brief description.","severity":"info","given":"$","then":{"field":"info.x-summary","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:document","experience:documentation","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-summary' (Info Require Summary). Requirement: The `#/info/x-summary` can be used to specify a brief, one-liner description of your API: this is very useful for catalog purposes (eg. this can be shown as your API subtitle in catalogs and developer portals). In OAS3.1 you can use the standard `#/info/summary` field. To fix: Ensure `info.x-summary` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-terms-of-service":{"title":"Info Require Terms Of Service","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-terms-of-service/","source":"compiled","description":"API MUST reference the URL of the Terms of Service in `#/info/termsOfService`.","message":"API MUST reference the URL of the Terms of Service  in #/info/termsOfService.","severity":"info","given":"$","then":{"field":"info.termsOfService","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-terms-of-service' (Info Require Terms Of Service). Requirement: API MUST reference the URL of the Terms of Service in `#/info/termsOfService`. To fix: Ensure `info.termsOfService` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-title":{"title":"Info Require Title","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-title/","source":"compiled","description":"Having a intuitive and helpful title for your API using the OpenAPI info title is the first impression you will make on the consumers of your API.","message":"Info MUST Have Title","severity":"info","given":"$.info","then":{"field":"title","function":"truthy"},"tags":["format:openapi","spec:info","experience:documentation","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-title' (Info Require Title). Requirement: Having a intuitive and helpful title for your API using the OpenAPI info title is the first impression you will make on the consumers of your API. To fix: Ensure `title` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-skill-require-version":{"title":"Info Require Version","reference":"https://spotlight-rules.com/spec/rules/openapi/info-skill-require-version/","source":"compiled","description":"Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using Semantic or date-based versioning published to the info version property.","message":"Info MUST Have Version","severity":"info","given":"$.info","then":{"field":"version","function":"truthy"},"tags":["format:openapi","spec:info","experience:versioning"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-skill-require-version' (Info Require Version). Requirement: Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using Semantic or date-based versioning published to the info version property. To fix: Ensure `version` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-title-capitalized":{"title":"Info Title Capitalized","reference":"https://spotlight-rules.com/spec/rules/openapi/info-title-capitalized/","source":"compiled","description":"Having a consistent casing for the title for your API helps provide constraints for teams naming the API, but also keep consistent with other APIs from across teams.","message":"Info Title Has First Characters Capitalized","severity":"info","given":"$.info.title","then":{"function":"pattern","functionOptions":{"match":"[A-Z]\\w*"}},"tags":["format:openapi","spec:info","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-title-capitalized' (Info Title Capitalized). Requirement: Having a consistent casing for the title for your API helps provide constraints for teams naming the API, but also keep consistent with other APIs from across teams. To fix: Ensure the targeted value matches the regular expression `[A-Z]\\w*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.info.title` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-title-max-length":{"title":"Info Title Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/info-title-max-length/","source":"compiled","description":"Having a limitation on the length of the title for your API helps provide constraints for teams naming it, but also keep consistent with other APIs from across teams.","message":"Info Title MUST Be Less Than 50 Characters","severity":"info","given":"$.info","then":{"field":"title","function":"length","functionOptions":{"max":50}},"tags":["format:openapi","spec:info","experience:consistency","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-title-max-length' (Info Title Max Length). Requirement: Having a limitation on the length of the title for your API helps provide constraints for teams naming it, but also keep consistent with other APIs from across teams. To fix: Ensure the length of `title` is at most 50. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-version-must-be-semver":{"title":"Info Version Must Be Semver","reference":"https://spotlight-rules.com/spec/rules/openapi/info-version-must-be-semver/","source":"compiled","description":"The API version field should follow [semantic versioning](https://semver.org/#semantic-versioning-specification-semver).","message":"Specs should follow semantic versioning. {{value}} is not a valid version.","severity":"info","given":"$.info.version","then":{"function":"pattern","functionOptions":{"match":"^[0-9]+.[0-9]+.[0-9]+(-[a-z0-9+.-]+)?"}},"tags":["format:openapi","spec:info","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-version-must-be-semver' (Info Version Must Be Semver). Requirement: The API version field should follow [semantic versioning](https://semver.org/#semantic-versioning-specification-semver). To fix: Ensure the targeted value matches the regular expression `^[0-9]+.[0-9]+.[0-9]+(-[a-z0-9+.-]+)?`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.info.version` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-version-must-use-semver":{"title":"Info Version Must Use Semver","reference":"https://spotlight-rules.com/spec/rules/openapi/info-version-must-use-semver/","source":"compiled","description":"Version should use semantic versioning. {{value}} is not a valid version.","message":"Version should use semantic versioning. {{value}} is not a valid version.","severity":"info","given":"$.info.version","then":{"function":"pattern","functionOptions":{"match":"^([0-9]+.[0-9]+.[0-9]+)$"}},"tags":["format:openapi","spec:info","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-version-must-use-semver' (Info Version Must Use Semver). Requirement: Version should use semantic versioning. {{value}} is not a valid version. To fix: Ensure the targeted value matches the regular expression `^([0-9]+.[0-9]+.[0-9]+)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.info.version` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-version-semantic-and-stable":{"title":"Info Version Semantic And Stable","reference":"https://spotlight-rules.com/spec/rules/openapi/info-version-semantic-and-stable/","source":"compiled","description":"The API contract MUST have a stable version and MUST follow semantic versioning (e.g., '1.0.0'). Words like 'SNAPSHOT' or 'RELEASE' are not allowed.","message":"{{description}}: {{error}}","severity":"info","given":"$.info.version","then":{"function":"pattern","functionOptions":{"match":"^(?!.*\\b(SNAPSHOT|RELEASE)\\b)(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$"}},"formats":["oas3"],"tags":["format:openapi","spec:info","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-version-semantic-and-stable' (Info Version Semantic And Stable). Requirement: The API contract MUST have a stable version and MUST follow semantic versioning (e.g., '1.0.0'). Words like 'SNAPSHOT' or 'RELEASE' are not allowed. To fix: Ensure the targeted value matches the regular expression `^(?!.*\\b(SNAPSHOT|RELEASE)\\b)(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.info.version` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"license-url":{"title":"License URL","reference":"https://spotlight-rules.com/spec/rules/openapi/license-url/","source":"builtin","description":"License object must include \"url\".","message":"License object must include \"url\".","severity":"info","given":"$","then":{"field":"info.license.url","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'license-url' (License URL). Requirement: License object must include \"url\". To fix: Ensure `info.license.url` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"limit-nested-sub-resources":{"title":"Limit Nested Sub Resources","reference":"https://spotlight-rules.com/spec/rules/openapi/limit-nested-sub-resources/","source":"compiled","description":"The hierarchy of nested resources SHOULD NOT contain more than 8 resource names in the path.","message":"The hierarchy of nested resources SHOULD NOT contain more than 8 resource names in the path.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^([^/]*/){9,}"}},"tags":["format:openapi","spec:paths","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'limit-nested-sub-resources' (Limit Nested Sub Resources). Requirement: The hierarchy of nested resources SHOULD NOT contain more than 8 resource names in the path. To fix: Ensure the targeted value does NOT match the regular expression `^([^/]*/){9,}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"limit-path-length":{"title":"Limit Path Length","reference":"https://spotlight-rules.com/spec/rules/openapi/limit-path-length/","source":"compiled","description":"APIs SHOULD NOT expand their total URL length beyond a few hundred characters.","message":"APIs SHOULD NOT expand their total URL length beyond a few hundred characters.","severity":"info","given":"$.paths.*~","then":{"function":"length","functionOptions":{"max":100}},"tags":["format:openapi","spec:paths","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'limit-path-length' (Limit Path Length). Requirement: APIs SHOULD NOT expand their total URL length beyond a few hundred characters. To fix: Ensure the length of the targeted value is at most 100. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"limit-path-parameter":{"title":"Limit Path Parameter","reference":"https://spotlight-rules.com/spec/rules/openapi/limit-path-parameter/","source":"compiled","description":"The URL path should not contain more than 3 dynamic path parameters.","message":"The URL path should not contain more than 3 dynamic path parameters.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^(.*{{1}.*){4,}"}},"tags":["format:openapi","spec:paths","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'limit-path-parameter' (Limit Path Parameter). Requirement: The URL path should not contain more than 3 dynamic path parameters. To fix: Ensure the targeted value does NOT match the regular expression `^(.*{{1}.*){4,}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"message-examples-form-complete-mocks":{"title":"Message Examples Form Complete Mocks","reference":"https://spotlight-rules.com/spec/rules/openapi/message-examples-form-complete-mocks/","source":"compiled","description":"Message example must match params examples to form full mocks.","message":"{{error}}","severity":"info","given":"$.channels.*","then":{"function":"microcks:aas-verify-mocks"},"formats":["aas2"],"tags":["format:openapi","spec:channels","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'message-examples-form-complete-mocks' (Message Examples Form Complete Mocks). Requirement: Message example must match params examples to form full mocks. This rule is evaluated at the JSONPath `$.channels.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"message-require-examples":{"title":"Message Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/message-require-examples/","source":"compiled","description":"Message must have examples.","message":"Message must have examples","severity":"info","given":"$.channels.*.[publish,subscribe].message","then":{"field":"examples","function":"truthy"},"formats":["aas2"],"tags":["format:openapi","spec:channels","spec:messages","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'message-require-examples' (Message Require Examples). Requirement: Message must have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.channels.*.[publish,subscribe].message` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"no-$ref-siblings":{"title":"No $ref Siblings","reference":"https://spotlight-rules.com/spec/rules/openapi/no-$ref-siblings/","source":"builtin","description":"Property must not be placed among $ref.","message":"{{error}}","severity":"info","given":"$..[?(@property === '$ref')]","then":{"function":"refSiblings"},"tags":["format:openapi","spec:schemas","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'no-$ref-siblings' (No $ref Siblings). Requirement: Property must not be placed among $ref. This rule is evaluated at the JSONPath `$..[?(@property === '$ref')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"no-eval-in-markdown":{"title":"No Eval In Markdown","reference":"https://spotlight-rules.com/spec/rules/openapi/no-eval-in-markdown/","source":"builtin","description":"Markdown descriptions must not have \"eval(\".","message":"Markdown descriptions must not have \"eval(\".","severity":"info","given":"$..[description,title]","then":{"function":"pattern","functionOptions":{"notMatch":"eval\\("}},"tags":["format:openapi","spec:document","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'no-eval-in-markdown' (No Eval In Markdown). Requirement: Markdown descriptions must not have \"eval(\". To fix: Ensure the targeted value does NOT match the regular expression `eval\\(`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..[description,title]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"no-script-tags-in-markdown":{"title":"No Script Tags In Markdown","reference":"https://spotlight-rules.com/spec/rules/openapi/no-script-tags-in-markdown/","source":"builtin","description":"Markdown descriptions must not have \"<script>\" tags.","message":"Markdown descriptions must not have \"<script>\" tags.","severity":"info","given":"$..[description,title]","then":{"function":"pattern","functionOptions":{"notMatch":"<script"}},"tags":["format:openapi","spec:document","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'no-script-tags-in-markdown' (No Script Tags In Markdown). Requirement: Markdown descriptions must not have \"<script>\" tags. To fix: Ensure the targeted value does NOT match the regular expression `<script`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..[description,title]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3_1-callbacks-in-webhook":{"title":"OAS3.1 Callbacks In Webhook","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3_1-callbacks-in-webhook/","description":"OAS3.1 Callbacks In Webhook.","source":"builtin","message":"Callbacks should not be defined in a webhook.","severity":"info","given":["$.webhooks[*][*].callbacks"],"then":{"function":"undefined"},"tags":["format:openapi","spec:document","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3_1-callbacks-in-webhook' (OAS3.1 Callbacks In Webhook). Requirement: OAS3.1 Callbacks In Webhook. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `$.webhooks[*][*].callbacks` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3_1-servers-in-webhook":{"title":"OAS3.1 Servers In Webhook","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3_1-servers-in-webhook/","description":"OAS3.1 Servers In Webhook.","source":"builtin","message":"Servers should not be defined in a webhook.","severity":"info","given":["$.webhooks.servers","$.webhooks[*][*].servers"],"then":{"function":"undefined"},"tags":["format:openapi","spec:servers","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3_1-servers-in-webhook' (OAS3.1 Servers In Webhook). Requirement: OAS3.1 Servers In Webhook. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `$.webhooks.servers | $.webhooks[*][*].servers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-api-servers":{"title":"OAS3 API Servers","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-api-servers/","source":"builtin","description":"OpenAPI \"servers\" must be present and non-empty array.","message":"OpenAPI \"servers\" must be present and non-empty array.","severity":"info","given":"$","then":{"field":"servers","function":"schema","functionOptions":{"dialect":"draft7","schema":{"items":{"type":"object"},"minItems":1,"type":"array"}}},"tags":["format:openapi","spec:document","experience:usability","experience:reliability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-api-servers' (OAS3 API Servers). Requirement: OpenAPI \"servers\" must be present and non-empty array. To fix: Adjust `servers` so it conforms to the schema this rule requires. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-callbacks-in-callbacks":{"title":"OAS3 Callbacks In Callbacks","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-callbacks-in-callbacks/","description":"OAS3 Callbacks In Callbacks.","source":"builtin","message":"Callbacks should not be defined within a callback","severity":"info","given":["#OperationObject.callbacks[*][*][*].callbacks"],"then":{"function":"undefined"},"tags":["format:openapi","spec:document","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-callbacks-in-callbacks' (OAS3 Callbacks In Callbacks). Requirement: OAS3 Callbacks In Callbacks. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `#OperationObject.callbacks[*][*][*].callbacks` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-examples-value-or-externalValue":{"title":"OAS3 Examples Value Or ExternalValue","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-examples-value-or-externalValue/","source":"builtin","description":"Examples must have either \"value\" or \"externalValue\" field.","message":"Examples must have either \"value\" or \"externalValue\" field.","severity":"info","given":["$.components.examples[*]","$.paths[*][*]..content[*].examples[*]","$.paths[*][*]..parameters[*].examples[*]","$.components.parameters[*].examples[*]","$.paths[*][*]..headers[*].examples[*]","$.components.headers[*].examples[*]"],"then":{"function":"xor","functionOptions":{"properties":["externalValue","value"]}},"tags":["format:openapi","spec:paths","spec:parameters","spec:headers","spec:media-types","spec:components","spec:examples","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-examples-value-or-externalValue' (OAS3 Examples Value Or ExternalValue). Requirement: Examples must have either \"value\" or \"externalValue\" field. To fix: Include exactly one of: externalValue, value. This rule is evaluated at the JSONPath `$.components.examples[*] | $.paths[*][*]..content[*].examples[*] | $.paths[*][*]..parameters[*].examples[*] | $.components.parameters[*].examples[*] | $.paths[*][*]..headers[*].examples[*] | $.components.headers[*].examples[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-operation-security-defined":{"title":"OAS3 Operation Security Defined","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-operation-security-defined/","source":"builtin","description":"Operation \"security\" values must match a scheme defined in the \"components.securitySchemes\" object.","message":"{{error}}","severity":"info","given":"#SecurityRequirementObject","then":{"function":"oasSecurityDefined","functionOptions":{"oasVersion":3}},"tags":["owasp:api5","format:openapi","spec:security","experience:security","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-operation-security-defined' (OAS3 Operation Security Defined). Requirement: Operation \"security\" values must match a scheme defined in the \"components.securitySchemes\" object. This rule is evaluated at the JSONPath `#SecurityRequirementObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-parameter-description":{"title":"OAS3 Parameter Description","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-parameter-description/","source":"builtin","description":"Parameter objects must have \"description\".","message":"Parameter objects must have \"description\".","severity":"info","given":["#PathItem.parameters[?(@ && @.in)]","#OperationObject.parameters[?(@ && @.in)]","$.components.parameters[?(@ && @.in)]"],"then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:components","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-parameter-description' (OAS3 Parameter Description). Requirement: Parameter objects must have \"description\". To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `#PathItem.parameters[?(@ && @.in)] | #OperationObject.parameters[?(@ && @.in)] | $.components.parameters[?(@ && @.in)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-schema":{"title":"OAS3 Schema","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-schema/","source":"builtin","description":"Validate structure of OpenAPI v3 specification.","message":"{{error}}.","severity":"info","given":"$","then":{"function":"oasDocumentSchema"},"tags":["format:openapi","spec:document","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-schema' (OAS3 Schema). Requirement: Validate structure of OpenAPI v3 specification. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-server-not-example.com":{"title":"OAS3 Server Not Example.com","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-server-not-example.com/","source":"builtin","description":"Server URL must not point at example.com.","message":"Server URL must not point at example.com.","severity":"info","given":"$.servers[*].url","then":{"function":"pattern","functionOptions":{"notMatch":"example\\.com"}},"tags":["format:openapi","spec:servers","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-server-not-example.com' (OAS3 Server Not Example.com). Requirement: Server URL must not point at example.com. To fix: Ensure the targeted value does NOT match the regular expression `example\\.com`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers[*].url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-server-trailing-slash":{"title":"OAS3 Server Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-server-trailing-slash/","source":"builtin","description":"Server URL must not have trailing slash.","message":"Server URL must not have trailing slash.","severity":"info","given":"$.servers[*].url","then":{"function":"pattern","functionOptions":{"notMatch":"./$"}},"tags":["format:openapi","spec:servers","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-server-trailing-slash' (OAS3 Server Trailing Slash). Requirement: Server URL must not have trailing slash. To fix: Ensure the targeted value does NOT match the regular expression `./$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers[*].url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-server-variables":{"title":"OAS3 Server Variables","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-server-variables/","source":"builtin","description":"Server variables must be defined and valid and there must be no unused variables.","message":"{{error}}","severity":"info","given":["$.servers[*]","#PathItem.servers[*]","#OperationObject.servers[*]","#LinkObject.server"],"then":{"function":"serverVariables","functionOptions":{"checkSubstitutions":true,"requireDefault":true}},"tags":["format:openapi","spec:servers","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-server-variables' (OAS3 Server Variables). Requirement: Server variables must be defined and valid and there must be no unused variables. This rule is evaluated at the JSONPath `$.servers[*] | #PathItem.servers[*] | #OperationObject.servers[*] | #LinkObject.server` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-unused-component":{"title":"OAS3 Unused Component","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-unused-component/","description":"OAS3 Unused Component.","source":"builtin","message":"Potentially unused component has been detected.","severity":"info","given":"$","then":{"function":"oasUnusedComponent"},"tags":["format:openapi","spec:document","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-unused-component' (OAS3 Unused Component). Requirement: OAS3 Unused Component. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-valid-media-example":{"title":"OAS3 Valid Media Example","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-valid-media-example/","source":"builtin","description":"Examples must be valid against their defined schema.","message":"{{error}}","severity":"info","given":["$..content..[?(@ && @.schema && (@.example !== void 0 || @.examples))]","$..headers..[?(@ && @.schema && (@.example !== void 0 || @.examples))]","$..parameters..[?(@ && @.schema && (@.example !== void 0 || @.examples))]"],"then":{"function":"oasExample","functionOptions":{"schemaField":"schema","oasVersion":3,"type":"media"}},"tags":["format:openapi","spec:parameters","spec:headers","spec:media-types","spec:schemas","spec:examples","experience:data-modeling","experience:documentation","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-valid-media-example' (OAS3 Valid Media Example). Requirement: Examples must be valid against their defined schema. This rule is evaluated at the JSONPath `$..content..[?(@ && @.schema && (@.example !== void 0 || @.examples))] | $..headers..[?(@ && @.schema && (@.example !== void 0 || @.examples))] | $..parameters..[?(@ && @.schema && (@.example !== void 0 || @.examples))]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-valid-schema-example":{"title":"OAS3 Valid Schema Example","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-valid-schema-example/","source":"builtin","description":"Examples must be valid against their defined schema.","message":"{{error}}","severity":"info","given":["$.components.schemas..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]","$..content..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]","$..headers..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]","$..parameters..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]"],"then":{"function":"oasExample","functionOptions":{"schemaField":"$","oasVersion":3,"type":"schema"}},"tags":["format:openapi","spec:parameters","spec:headers","spec:media-types","spec:schemas","spec:components","spec:examples","experience:data-modeling","experience:documentation","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-valid-schema-example' (OAS3 Valid Schema Example). Requirement: Examples must be valid against their defined schema. This rule is evaluated at the JSONPath `$.components.schemas..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))] | $..content..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))] | $..headers..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))] | $..parameters..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"openapi-tags":{"title":"Openapi Tags","reference":"https://spotlight-rules.com/spec/rules/openapi/openapi-tags/","source":"builtin","description":"OpenAPI object must have non-empty \"tags\" array.","message":"OpenAPI object must have non-empty \"tags\" array.","severity":"info","given":"$","then":{"field":"tags","function":"schema","functionOptions":{"dialect":"draft7","schema":{"type":"array","minItems":1}}},"tags":["format:openapi","spec:document","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'openapi-tags' (Openapi Tags). Requirement: OpenAPI object must have non-empty \"tags\" array. To fix: Adjust `tags` so it conforms to the schema this rule requires. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"openapi-tags-alphabetical":{"title":"Openapi Tags Alphabetical","reference":"https://spotlight-rules.com/spec/rules/openapi/openapi-tags-alphabetical/","source":"builtin","description":"OpenAPI object must have alphabetical \"tags\".","message":"OpenAPI object must have alphabetical \"tags\".","severity":"info","given":"$","then":{"field":"tags","function":"alphabetical","functionOptions":{"keyedBy":"name"}},"tags":["format:openapi","spec:document","experience:consistency","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'openapi-tags-alphabetical' (Openapi Tags Alphabetical). Requirement: OpenAPI object must have alphabetical \"tags\". To fix: Sort the entries by `name` into ascending alphabetical order. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"openapi-tags-uniqueness":{"title":"Openapi Tags Uniqueness","reference":"https://spotlight-rules.com/spec/rules/openapi/openapi-tags-uniqueness/","source":"builtin","description":"Each tag must have a unique name.","message":"{{error}}","severity":"info","given":"$.tags","then":{"function":"uniquenessTags"},"tags":["format:openapi","spec:tags","experience:consistency","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'openapi-tags-uniqueness' (Openapi Tags Uniqueness). Requirement: Each tag must have a unique name. This rule is evaluated at the JSONPath `$.tags` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-collection-support-filtering":{"title":"Operation Collection Support Filtering","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-collection-support-filtering/","source":"spotlight","description":"Collection GET operations should support filtering via a filter query parameter (e.g. filter or filter[field]).","message":"Collection should support a filter query parameter.","given":"$.paths[*].get","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"pattern":"^filter"},"in":{"const":"query"}}}}}},"tags":["format:openapi","spec:parameters","topic:pagination","experience:usability","experience:discoverability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-collection-support-filtering' (Operation Collection Support Filtering). Requirement: Collection GET operations should support filtering via a filter query parameter (e.g. filter or filter[field]). To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*].get` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-collection-support-sorting":{"title":"Operation Collection Support Sorting","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-collection-support-sorting/","source":"spotlight","description":"Collection GET operations should support sorting via a sort or order query parameter.","message":"Collection should support a sort/order query parameter.","given":"$.paths[*].get","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"pattern":"^(sort|order)"},"in":{"const":"query"}}}}}},"tags":["format:openapi","spec:parameters","topic:pagination","experience:usability","experience:discoverability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-collection-support-sorting' (Operation Collection Support Sorting). Requirement: Collection GET operations should support sorting via a sort or order query parameter. To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*].get` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-collection-support-sparse-fieldsets":{"title":"Operation Collection Support Sparse Fieldsets","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-collection-support-sparse-fieldsets/","source":"spotlight","description":"GET operations should support sparse fieldsets via a fields query parameter so clients can request only the fields they need.","message":"Operation should support a fields (sparse fieldset) query parameter.","given":"$.paths[*].get","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"pattern":"^fields"},"in":{"const":"query"}}}}}},"tags":["format:openapi","spec:parameters","topic:pagination","experience:usability","experience:reliability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-collection-support-sparse-fieldsets' (Operation Collection Support Sparse Fieldsets). Requirement: GET operations should support sparse fieldsets via a fields query parameter so clients can request only the fields they need. To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*].get` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-define-429-response":{"title":"Operation Define 429 Response","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-define-429-response/","source":"compiled","description":"APIs should define a 429 Too Many Requests response to document rate limiting behavior. Analysis shows 429 appears in 671 operations, confirming rate limiting is a common API pattern.","message":"Operations MUST Have 429 Response","severity":"info","given":"$.paths.*[get,post,put,patch,delete].responses","then":{"field":"429","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","topic:rate-limiting","experience:error-handling","experience:reliability","experience:performance","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-define-429-response' (Operation Define 429 Response). Requirement: APIs should define a 429 Too Many Requests response to document rate limiting behavior. Analysis shows 429 appears in 671 operations, confirming rate limiting is a common API pattern. To fix: Ensure `429` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,put,patch,delete].responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-define-500-response":{"title":"Operation Define 500 Response","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-define-500-response/","source":"compiled","description":"Every endpoint SHOULD have a 500 response.","message":"Every endpoint SHOULD have a 500 response.","severity":"info","given":"$.paths[*][*]","then":{"field":"responses.500","function":"truthy"},"tags":["format:openapi","spec:paths","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-define-500-response' (Operation Define 500 Response). Requirement: Every endpoint SHOULD have a 500 response. To fix: Ensure `responses.500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-deprecated-require-description":{"title":"Operation Deprecated Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-deprecated-require-description/","source":"spotlight","description":"Deprecated operations should have a description explaining the deprecation and the migration path / successor.","message":"Deprecated operation should describe the deprecation and successor.","given":"$.paths[*][?(@ && @.deprecated == true)]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:paths","topic:deprecation","experience:versioning","experience:documentation","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-deprecated-require-description' (Operation Deprecated Require Description). Requirement: Deprecated operations should have a description explaining the deprecation and the migration path / successor. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][?(@ && @.deprecated == true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-description":{"title":"Operation Description","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-description/","source":"builtin","description":"Operation \"description\" must be present and non-empty string.","message":"Operation \"description\" must be present and non-empty string.","severity":"info","given":"#OperationObject","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-description' (Operation Description). Requirement: Operation \"description\" must be present and non-empty string. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `#OperationObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-description-max-length":{"title":"Operation Description Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-description-max-length/","severity":"info","source":"compiled","description":"Having a length limitation for each description of each API operation helps apply constraints to how you describe your APIs, while helping drive consistency across APIs when it comes to search, documentation, and other ways an API is made available.","message":"Operation Description MUST Be Less Than 250 Characters","given":"$.paths.*[get,post,patch,put,delete]","then":[{"field":"description","function":"length","functionOptions":{"max":250}}],"tags":["format:openapi","spec:paths","spec:operations","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-description-max-length' (Operation Description Max Length). Requirement: Having a length limitation for each description of each API operation helps apply constraints to how you describe your APIs, while helping drive consistency across APIs when it comes to search, documentation, and other ways an API is made available. To fix: Ensure the length of `description` is at most 250. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-examples-form-complete-mocks":{"title":"Operation Examples Form Complete Mocks","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-examples-form-complete-mocks/","source":"compiled","description":"Response example must match required params examples to form full mocks.","message":"{{error}}","severity":"info","given":"$.paths.*.*","then":{"function":"microcks:oas-verify-mocks"},"formats":["oas3"],"tags":["format:openapi","spec:paths","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-examples-form-complete-mocks' (Operation Examples Form Complete Mocks). Requirement: Response example must match required params examples to form full mocks. This rule is evaluated at the JSONPath `$.paths.*.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-get-require-security":{"title":"Operation Get Require Security","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-get-require-security/","source":"compiled","description":"Your API should be protected by a `security` rule either at global or operation level. Operations should be protected specially when they are tied to non-idempotent HTTP methods like `POST`, `PUT`, `PATCH` and `DELETE`. This is done with one or more non-empty `security` rules. Security rules are defined in the `securityScheme` section. An example of a security rule applied at global level. ``` security: - BasicAuth: [] paths: /books: {} /users: {} securitySchemes: BasicAuth: scheme: http type: basic ``` An example of a security rule applied at operation level, which eventually overrides the global one ``` paths: /books: post: security: - AccessToken: [] securitySchemes: BasicAuth: scheme: http type: basic AccessToken: scheme: http type: bearer bearerFormat: JWT ```.","message":"The following operation is not protected by a `security` rule: {{path}}","severity":"info","given":["$.paths.*.get"],"then":[{"field":"security","function":"schema","functionOptions":{"schema":{"items":{"type":"object","minProperties":1},"minItems":1,"type":"array"}}}],"formats":["oas3"],"tags":["owasp:api2","format:openapi","spec:paths","spec:operations","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-get-require-security' (Operation Get Require Security). Requirement: Your API should be protected by a `security` rule either at global or operation level. Operations should be protected specially when they are tied to non-idempotent HTTP methods like `POST`, `PUT`, `PATCH` and `DELETE`. This is done with one or more non-empty `security` rules. Security rules are defined in the `securityScheme` section. An example of a security rule applied at global level. ``` security: - BasicAuth: [] paths: /books: {} /users: {} securitySchemes: BasicAuth: scheme: http type: basic ``` An example of a security rule applied at operation level, which eventually overrides the global one ``` paths: /books: post: security: - AccessToken: [] securitySchemes: BasicAuth: scheme: http type: basic AccessToken: scheme: http type: bearer bearerFormat: JWT ```. To fix: Adjust `security` so it conforms to the schema this rule requires. Guidance: The following operation is not protected by a `security` rule. This rule is evaluated at the JSONPath `$.paths.*.get` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-get-support-if-modified-since":{"title":"Operation Get Support If Modified Since","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-get-support-if-modified-since/","source":"spotlight","description":"GET operations should accept an If-Modified-Since request header to enable date-based conditional requests.","message":"Operation should accept a `If-Modified-Since` request header.","given":"$.paths[*][get]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name"],"properties":{"name":{"const":"If-Modified-Since"}}}}}},"tags":["format:openapi","spec:parameters","topic:conditional-requests","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-get-support-if-modified-since' (Operation Get Support If Modified Since). Requirement: GET operations should accept an If-Modified-Since request header to enable date-based conditional requests. To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `If-Modified-Since` request header. This rule is evaluated at the JSONPath `$.paths[*][get]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-get-support-if-none-match":{"title":"Operation Get Support If None Match","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-get-support-if-none-match/","source":"spotlight","description":"GET operations should accept an If-None-Match request header to enable ETag-based conditional requests (304 responses).","message":"Operation should accept a `If-None-Match` request header.","given":"$.paths[*][get]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name"],"properties":{"name":{"const":"If-None-Match"}}}}}},"tags":["format:openapi","spec:parameters","topic:conditional-requests","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-get-support-if-none-match' (Operation Get Support If None Match). Requirement: GET operations should accept an If-None-Match request header to enable ETag-based conditional requests (304 responses). To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `If-None-Match` request header. This rule is evaluated at the JSONPath `$.paths[*][get]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-id-camel-case":{"title":"Operation ID Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-id-camel-case/","source":"compiled","description":"Operation identifiers provide a unique way to identify each individual API, and requiring them to have consistent casing reduces friction when generating SDKs and automating around APIs.","message":"Operation Identifier MUST Be camelCase","severity":"info","given":"$.paths.*[get,post,patch,put,delete].operationId","then":[{"function":"pattern","functionOptions":{"match":"^[a-z]+(?:[A-Z][a-z]+)*$"}}],"tags":["format:openapi","spec:paths","spec:operations","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-id-camel-case' (Operation ID Camel Case). Requirement: Operation identifiers provide a unique way to identify each individual API, and requiring them to have consistent casing reduces friction when generating SDKs and automating around APIs. To fix: Ensure the targeted value matches the regular expression `^[a-z]+(?:[A-Z][a-z]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete].operationId` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-id-url-safe":{"title":"Operation ID URL Safe","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-id-url-safe/","source":"compiled","description":"OperationId must use URL friendly characters.","message":"OperationId must use URL friendly characters.","severity":"info","given":"$.paths[*][*]","then":{"field":"operationId","function":"pattern","functionOptions":{"match":"^[A-Za-z0-9-._~:/?#\\[\\]@!\\$&'()*+,;=]*$"}},"formats":["oas3","oas3_1"],"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-id-url-safe' (Operation ID URL Safe). Requirement: OperationId must use URL friendly characters. To fix: Ensure `operationId` matches the regular expression `^[A-Za-z0-9-._~:/?#\\[\\]@!\\$&'()*+,;=]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*][*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-microcks-extension-valid":{"title":"Operation Microcks Extension Valid","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-microcks-extension-valid/","source":"compiled","description":"x-microcks-operation extension must be valid.","message":"x-microcks-operation extension must be valid","severity":"info","given":["$.paths.*.*.x-microcks-operation","$.channels.*.[publish,subscribe].x-microcks-operation","$.operations.*.x-microcks-operation"],"then":{"function":"schema","functionOptions":{"schema":{"type":"object","properties":{"delay":{"type":"number","format":"int32"},"frequency":{"type":"number","format":"int32"},"dispatcher":{"type":"string"},"dispatcherRules":{"type":"string"},"parameterConstraints":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"in":{"type":"string","enum":["path","query","header"]},"required":{"type":"boolean"},"recopy":{"type":"boolean"},"mustMatchRegexp":{"type":"string"}},"required":["name","in"]}}},"additionalProperties":false}}},"formats":["oas3","aas2","aas3"],"tags":["format:openapi","spec:channels","spec:paths","experience:governance","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-microcks-extension-valid' (Operation Microcks Extension Valid). Requirement: x-microcks-operation extension must be valid. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths.*.*.x-microcks-operation | $.channels.*.[publish,subscribe].x-microcks-operation | $.operations.*.x-microcks-operation` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-mutation-support-idempotency-key":{"title":"Operation Mutation Support Idempotency Key","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-mutation-support-idempotency-key/","source":"spotlight","description":"POST and PATCH operations should accept an Idempotency-Key request header so clients can safely retry without creating duplicates.","message":"Mutation should accept an Idempotency-Key header for safe retries.","given":"$.paths[*][post,patch]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"const":"Idempotency-Key"},"in":{"const":"header"}}}}}},"tags":["format:openapi","spec:parameters","topic:idempotency","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-mutation-support-idempotency-key' (Operation Mutation Support Idempotency Key). Requirement: POST and PATCH operations should accept an Idempotency-Key request header so clients can safely retry without creating duplicates. To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][post,patch]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-operationId":{"title":"Operation OperationId","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-operationId/","source":"builtin","description":"Operation must have \"operationId\".","message":"Operation must have \"operationId\".","severity":"info","given":"#OperationObject","then":{"field":"operationId","function":"truthy"},"tags":["format:openapi","spec:document","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-operationId' (Operation OperationId). Requirement: Operation must have \"operationId\". To fix: Ensure `operationId` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `#OperationObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-operationId-unique":{"title":"Operation OperationId Unique","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-operationId-unique/","source":"builtin","description":"Every operation must have unique \"operationId\".","message":"Every operation must have unique \"operationId\".","severity":"info","given":"$.paths","then":{"function":"oasOpIdUnique"},"tags":["format:openapi","spec:paths","experience:consistency","experience:naming","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-operationId-unique' (Operation OperationId Unique). Requirement: Every operation must have unique \"operationId\". This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-operationId-valid-in-url":{"title":"Operation OperationId Valid In URL","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-operationId-valid-in-url/","description":"Operation OperationId Valid In URL.","source":"builtin","message":"operationId must not characters that are invalid when used in URL.","severity":"info","given":"#OperationObject","then":{"field":"operationId","function":"pattern","functionOptions":{"match":"^[A-Za-z0-9-._~:/?#\\[\\]@!\\$&'()*+,;=]*$"}},"tags":["format:openapi","spec:document","experience:naming","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-operationId-valid-in-url' (Operation OperationId Valid In URL). Requirement: Operation OperationId Valid In URL. To fix: Ensure `operationId` matches the regular expression `^[A-Za-z0-9-._~:/?#\\[\\]@!\\$&'()*+,;=]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `#OperationObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-parameters":{"title":"Operation Parameters","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-parameters/","source":"builtin","description":"Operation parameters are unique and non-repeating.","message":"{{error}}","severity":"info","given":"#OperationObject.parameters","then":{"function":"oasOpParams"},"tags":["format:openapi","spec:parameters","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-parameters' (Operation Parameters). Requirement: Operation parameters are unique and non-repeating. This rule is evaluated at the JSONPath `#OperationObject.parameters` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-patch-must-have-request-body":{"title":"Operation Patch Must Have Request Body","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-patch-must-have-request-body/","source":"compiled","description":"PATCH operations must have a request body.","message":"PATCH operations must have a request body.","severity":"info","given":"$.paths[*].patch","then":{"field":"requestBody","function":"schema","functionOptions":{"schema":{"type":"object"}}},"tags":["format:openapi","spec:paths","spec:operations","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-patch-must-have-request-body' (Operation Patch Must Have Request Body). Requirement: PATCH operations must have a request body. To fix: Adjust `requestBody` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*].patch` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-post-not-for-retrieval":{"title":"Operation Post Not For Retrieval","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-post-not-for-retrieval/","source":"compiled","description":"POST requests SHOULD NOT be used for retrieving information. Use GET instead.","message":"POST requests SHOULD NOT be used for retrieving information.","severity":"info","given":"$.paths[*].post","then":{"field":"summary","function":"pattern","functionOptions":{"notMatch":"(retrieve|fetch|get|read)"},"message":"{{description}}: {{error}}"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-post-not-for-retrieval' (Operation Post Not For Retrieval). Requirement: POST requests SHOULD NOT be used for retrieving information. Use GET instead. To fix: Ensure `summary` does NOT match the regular expression `(retrieve|fetch|get|read)`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].post` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-post-require-request-body":{"title":"Operation Post Require Request Body","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-post-require-request-body/","source":"compiled","description":"POST HTTP methods can have a request body, providing a structured payload for configuring each API request.","message":"POST Requests MUST Have a Body","severity":"info","given":"$.paths.*.post","then":{"field":"requestBody","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-post-require-request-body' (Operation Post Require Request Body). Requirement: POST HTTP methods can have a request body, providing a structured payload for configuring each API request. To fix: Ensure `requestBody` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.post` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-put-require-request-body":{"title":"Operation Put Require Request Body","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-put-require-request-body/","source":"compiled","description":"PUT requests MUST have a request body.","message":"PUT requests MUST have a request body.","severity":"info","given":"$.paths[*].put","then":{"field":"requestBody","function":"truthy","message":"{{description}}: {{error}}"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-put-require-request-body' (Operation Put Require Request Body). Requirement: PUT requests MUST have a request body. To fix: Ensure `requestBody` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].put` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-ref-resource-file":{"title":"Operation Ref Resource File","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-ref-resource-file/","source":"compiled","description":"Endpoint must a $ref to a file in resources/.","message":"{{description}}; {{value}} incorrect","severity":"info","given":"$.paths.*.$ref","then":{"function":"pattern","functionOptions":{"match":"^resources/.*yml$"}},"tags":["format:openapi","spec:paths","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-ref-resource-file' (Operation Ref Resource File). Requirement: Endpoint must a $ref to a file in resources/. To fix: Ensure the targeted value matches the regular expression `^resources/.*yml$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*.$ref` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-description":{"title":"Operation Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-description/","source":"compiled","description":"Having a paragraph or two description of each API operation helps API consumers understand what is possible with each API request.","message":"Operation MUST Have Description","severity":"info","given":"$.paths.*[get,post,patch,put,delete]","then":[{"field":"description","function":"truthy"}],"tags":["format:openapi","spec:paths","spec:operations","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-description' (Operation Require Description). Requirement: Having a paragraph or two description of each API operation helps API consumers understand what is possible with each API request. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-id":{"title":"Operation Require ID","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-id/","source":"compiled","description":"Every operation should have an operationId for SDK generation and documentation linking. Analysis shows operationId styles across 8878 operations with camelCase dominant at 92%.","message":"Operation MUST Have operationId","severity":"info","given":"$.paths.*[get,post,put,patch,delete]","then":{"field":"operationId","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-id' (Operation Require ID). Requirement: Every operation should have an operationId for SDK generation and documentation linking. Analysis shows operationId styles across 8878 operations with camelCase dominant at 92%. To fix: Ensure `operationId` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-identifier":{"title":"Operation Require Identifier","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-identifier/","source":"compiled","description":"Operation identifiers provide a unique way to identify each individual API, which then used for SDK generation and other automation.","message":"Operation MUST Have Identifier","severity":"info","given":"$.paths.*[get,post,patch,put,delete]","then":[{"field":"operationId","function":"truthy"}],"tags":["format:openapi","spec:paths","spec:operations","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-identifier' (Operation Require Identifier). Requirement: Operation identifiers provide a unique way to identify each individual API, which then used for SDK generation and other automation. To fix: Ensure `operationId` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-one-tag":{"title":"Operation Require One Tag","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-one-tag/","source":"compiled","description":"Having tags applied to each API operations helps organize and group APIs in portals, documentation, search, and other ways in which APIs are made available.","message":"MUST Be At Least One Operation Tag","severity":"info","given":"$.paths.*[get,post,patch,put,delete]","then":{"field":"tags","function":"length","functionOptions":{"min":1}},"tags":["format:openapi","spec:paths","spec:operations","experience:discoverability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-one-tag' (Operation Require One Tag). Requirement: Having tags applied to each API operations helps organize and group APIs in portals, documentation, search, and other ways in which APIs are made available. To fix: Ensure the length of `tags` is at least 1. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-response":{"title":"Operation Require Response","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-response/","source":"compiled","description":"Check if every request has their respective responses.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"trimble:check-for-response-in-every-request"},"tags":["format:openapi","spec:paths","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-response' (Operation Require Response). Requirement: Check if every request has their respective responses. This rule is evaluated at the JSONPath `$.paths.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-security":{"title":"Operation Require Security","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-security/","source":"compiled","description":"Check operation security is defined.","message":"Check operation security is defined.","severity":"info","given":"$.paths.*.*","then":{"field":"security","function":"truthy"},"tags":["owasp:api5","format:openapi","spec:paths","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-security' (Operation Require Security). Requirement: Check operation security is defined. To fix: Ensure `security` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-security-2":{"title":"Operation Require Security 2","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-security-2/","source":"compiled","description":"Each API operation should have a security definition referencing the central security scheme express for an OpenAPI.","message":"Operations MUST Have a Security Definition","severity":"info","given":"$.paths.*[get,post,patch,put,delete]","then":{"field":"security","function":"truthy"},"tags":["owasp:api5","format:openapi","spec:paths","spec:operations","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-security-2' (Operation Require Security 2). Requirement: Each API operation should have a security definition referencing the central security scheme express for an OpenAPI. To fix: Ensure `security` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-summary":{"title":"Operation Require Summary","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-summary/","source":"compiled","description":"Having short and intuitive summary for each API operation helps API consumers understand what is possible with each API request.","message":"Operation MUST Have a Summary","severity":"info","given":"$.paths.*[get,post,patch,put,delete]","then":[{"field":"summary","function":"truthy"}],"tags":["format:openapi","spec:paths","spec:operations","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-summary' (Operation Require Summary). Requirement: Having short and intuitive summary for each API operation helps API consumers understand what is possible with each API request. To fix: Ensure `summary` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-tag":{"title":"Operation Require Tag","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-tag/","source":"compiled","description":"Having tags applied to each API operations helps organize and group APIs in portals, documentation, search, and other ways in which APIs are made available.","message":"Operations MUST Have Tags","severity":"info","given":"$.paths.*[get,post,patch,put,delete]","then":[{"field":"tags","function":"truthy"}],"tags":["format:openapi","spec:paths","spec:operations","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-tag' (Operation Require Tag). Requirement: Having tags applied to each API operations helps organize and group APIs in portals, documentation, search, and other ways in which APIs are made available. To fix: Ensure `tags` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-security-use-defined-scheme":{"title":"Operation Security Use Defined Scheme","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-security-use-defined-scheme/","source":"compiled","description":"Check operation security uses a defined security scheme.","message":"Check operation security uses a defined security scheme.","severity":"info","given":"$.paths[*][*]..security.*","then":{"function":"schema","functionOptions":{"schema":{"anyOf":[{"required":["bearer_auth"]},{"required":["inference_bearer_auth"]}]}}},"tags":["owasp:api5","format:openapi","spec:security","spec:paths","experience:security","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-security-use-defined-scheme' (Operation Security Use Defined Scheme). Requirement: Check operation security uses a defined security scheme. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][*]..security.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-singular-tag":{"title":"Operation Singular Tag","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-singular-tag/","source":"builtin","description":"Operation must not have more than a single tag.","message":"Operation must not have more than a single tag.","severity":"info","given":"#OperationObject","then":{"field":"tags","function":"length","functionOptions":{"max":1}},"tags":["format:openapi","spec:document","experience:consistency","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-singular-tag' (Operation Singular Tag). Requirement: Operation must not have more than a single tag. To fix: Ensure the length of `tags` is at most 1. This rule is evaluated at the JSONPath `#OperationObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-success-response":{"title":"Operation Success Response","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-success-response/","source":"builtin","description":"Operation must have at least one \"2xx\" or \"3xx\" response.","message":"Operation must have at least one \"2xx\" or \"3xx\" response.","severity":"info","given":"#OperationObject","then":{"field":"responses","function":"oasOpSuccessResponse"},"tags":["format:openapi","spec:document","experience:error-handling","experience:reliability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-success-response' (Operation Success Response). Requirement: Operation must have at least one \"2xx\" or \"3xx\" response. This rule is evaluated at the JSONPath `#OperationObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-summary-description-differ":{"title":"Operation Summary Description Differ","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-summary-description-differ/","source":"compiled","description":"Operation summaries and description should not match.","message":"{{error}}","severity":"info","given":["$.paths[*].[get,post,put,patch,delete]"],"then":{"function":"trimble:operation-summary-description"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-summary-description-differ' (Operation Summary Description Differ). Requirement: Operation summaries and description should not match. This rule is evaluated at the JSONPath `$.paths[*].[get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-summary-max-length":{"title":"Operation Summary Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-summary-max-length/","severity":"info","source":"compiled","description":"Apply length constraints to the operation summary helps keep them consistent for publishing in documentation.","message":"Operation Summary MUST Be Less Than 50 Characters","given":"$.paths.*[get,post,patch,put,delete]","then":[{"field":"summary","function":"length","functionOptions":{"max":50}}],"tags":["format:openapi","spec:paths","spec:operations","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-summary-max-length' (Operation Summary Max Length). Requirement: Apply length constraints to the operation summary helps keep them consistent for publishing in documentation. To fix: Ensure the length of `summary` is at most 50. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-summary-no-period":{"title":"Operation Summary No Period","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-summary-no-period/","source":"compiled","description":"Operation summaries should not have a period, keeping the primary summary for each API as consistent as possible for publishing in documentation.","message":"Operation MUST Not Have a Period.","severity":"info","given":"$.paths[*][*].summary","then":{"function":"pattern","functionOptions":{"notMatch":"\\.$"}},"tags":["format:openapi","spec:paths","experience:consistency","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-summary-no-period' (Operation Summary No Period). Requirement: Operation summaries should not have a period, keeping the primary summary for each API as consistent as possible for publishing in documentation. To fix: Ensure the targeted value does NOT match the regular expression `\\.$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*][*].summary` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-tag-defined":{"title":"Operation Tag Defined","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-tag-defined/","source":"builtin","description":"Operation tags must be defined in global tags.","message":"Operation tags must be defined in global tags.","severity":"info","given":"$","then":{"function":"oasTagDefined"},"tags":["format:openapi","spec:document","experience:discoverability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-tag-defined' (Operation Tag Defined). Requirement: Operation tags must be defined in global tags. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-tag-title-case":{"title":"Operation Tag Title Case","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-tag-title-case/","source":"compiled","description":"Having the first letter of each word applied as a tag to API operations helps keep a consistent layout when published via search, documentation, and other ways APIs are made available.","message":"Operation Tag Names MUST Have First Letter in Each Word Capitalized","severity":"info","given":"$.paths.*[get,post,patch,put,delete].tags.*","then":{"function":"pattern","functionOptions":{"match":"[A-Z]\\w*"}},"tags":["format:openapi","spec:paths","spec:operations","spec:tags","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-tag-title-case' (Operation Tag Title Case). Requirement: Having the first letter of each word applied as a tag to API operations helps keep a consistent layout when published via search, documentation, and other ways APIs are made available. To fix: Ensure the targeted value matches the regular expression `[A-Z]\\w*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete].tags.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-tags":{"title":"Operation Tags","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-tags/","source":"builtin","description":"Operation must have non-empty \"tags\" array.","message":"Operation must have non-empty \"tags\" array.","severity":"info","given":"#OperationObject","then":{"field":"tags","function":"schema","functionOptions":{"dialect":"draft7","schema":{"type":"array","minItems":1}}},"tags":["format:openapi","spec:document","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-tags' (Operation Tags). Requirement: Operation must have non-empty \"tags\" array. To fix: Adjust `tags` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `#OperationObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-use-ref":{"title":"Operation Use Ref","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-use-ref/","source":"compiled","description":"Endpoint must be a $ref.","message":"{{description}}; {{property}} incorrect","severity":"info","given":"$.paths.*.*","then":{"field":"$ref","function":"truthy"},"tags":["format:openapi","spec:paths","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-use-ref' (Operation Use Ref). Requirement: Endpoint must be a $ref. To fix: Ensure `$ref` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-well-understood-status-codes":{"title":"Operation Well Understood Status Codes","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-well-understood-status-codes/","source":"compiled","description":"MUST use standard HTTP status codes [150].","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"baloise:assert-http-codes-for-operation","functionOptions":{"wellUnderstood":{"200":["ALL"],"201":["POST","PUT"],"202":["POST","PUT","DELETE","PATCH"],"204":["PUT","DELETE","PATCH"],"207":["POST"],"301":["ALL"],"303":["PATCH","POST","PUT","DELETE"],"304":["GET","HEAD"],"400":["ALL"],"401":["ALL"],"403":["ALL"],"404":["ALL"],"405":["ALL"],"406":["ALL"],"408":["ALL"],"409":["POST","PUT","DELETE","PATCH"],"410":["ALL"],"412":["PUT","DELETE","PATCH"],"415":["POST","PUT","DELETE","PATCH"],"422":["ALL"],"423":["PUT","DELETE","PATCH"],"428":["ALL"],"429":["ALL"],"500":["ALL"],"501":["ALL"],"503":["ALL"],"default":["ALL"]}}},"tags":["format:openapi","spec:paths","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-well-understood-status-codes' (Operation Well Understood Status Codes). Requirement: MUST use standard HTTP status codes [150]. This rule is evaluated at the JSONPath `$.paths.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-write-support-if-match":{"title":"Operation Write Support If Match","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-write-support-if-match/","source":"spotlight","description":"Write operations should accept an If-Match request header to enable optimistic concurrency / conditional writes.","message":"Operation should accept a `If-Match` request header.","given":"$.paths[*][put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name"],"properties":{"name":{"const":"If-Match"}}}}}},"tags":["format:openapi","spec:parameters","topic:conditional-requests","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-write-support-if-match' (Operation Write Support If Match). Requirement: Write operations should accept an If-Match request header to enable optimistic concurrency / conditional writes. To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `If-Match` request header. This rule is evaluated at the JSONPath `$.paths[*][put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-write-support-if-unmodified-since":{"title":"Operation Write Support If Unmodified Since","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-write-support-if-unmodified-since/","source":"spotlight","description":"Write operations should accept an If-Unmodified-Since request header to enable date-based optimistic concurrency / conditional writes.","message":"Operation should accept a `If-Unmodified-Since` request header.","given":"$.paths[*][put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name"],"properties":{"name":{"const":"If-Unmodified-Since"}}}}}},"tags":["format:openapi","spec:parameters","topic:conditional-requests","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-write-support-if-unmodified-since' (Operation Write Support If Unmodified Since). Requirement: Write operations should accept an If-Unmodified-Since request header to enable date-based optimistic concurrency / conditional writes. To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `If-Unmodified-Since` request header. This rule is evaluated at the JSONPath `$.paths[*][put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-array-require-items":{"title":"Parameter Array Require Items","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-array-require-items/","source":"compiled","description":"Parameters that are of an array type should always have the items defined, being explicit about what is continued as part of the array.","message":"Parameter Schema Array MUST Have Items","severity":"info","given":"$.components.parameters.schema[?(@.type=='array')]","then":{"field":"items","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:schemas","spec:components","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-array-require-items' (Parameter Array Require Items). Requirement: Parameters that are of an array type should always have the items defined, being explicit about what is continued as part of the array. To fix: Ensure `items` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.schema[?(@.type=='array')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-array-typed-items":{"title":"Parameter Array Typed Items","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-array-typed-items/","source":"compiled","description":"Array parameters must have an items attribute with a type.","message":"{{error}}","severity":"info","given":"$..*.parameters[*]","then":{"function":"digitalocean:ensureAllArraysHaveItemTypes"},"tags":["format:openapi","spec:parameters","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-array-typed-items' (Parameter Array Typed Items). Requirement: Array parameters must have an items attribute with a type. This rule is evaluated at the JSONPath `$..*.parameters[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-avoid-integer-id":{"title":"Parameter Avoid Integer ID","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-avoid-integer-id/","source":"compiled","description":"Avoid exposing IDs as an integer, UUIDs or other interoperable strings are preferred.","message":"Avoid exposing IDs as an integer, UUIDs or other interoperable strings are preferred.","severity":"info","given":"$.paths..parameters[*].[?(@property === \"name\" && (@ === \"id\" || @ === \"ID\" || @ === \"Id\"))]^.schema","then":{"function":"schema","functionOptions":{"schema":{"type":"object","not":{"properties":{"type":{"const":"integer"}}},"properties":{"format":{"const":"uuid"}}}}},"tags":["format:openapi","spec:paths","spec:parameters","spec:schemas","experience:security","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-avoid-integer-id' (Parameter Avoid Integer ID). Requirement: Avoid exposing IDs as an integer, UUIDs or other interoperable strings are preferred. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths..parameters[*].[?(@property === \"name\" && (@ === \"id\" || @ === \"ID\" || @ === \"Id\"))]^.schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-collection-limit-param-default":{"title":"Parameter Collection Limit Param Default","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-collection-limit-param-default/","source":"spotlight","description":"The limit / page-size query parameter should declare a default so the page size is predictable when the caller omits it.","message":"limit parameter should declare a default.","given":"$.paths[*].get.parameters[?(@ && @.in == 'query' && (@.name == 'limit' || @.name == 'per_page' || @.name == 'page_size' || @.name == 'pageSize'))].schema","severity":"info","then":{"field":"default","function":"truthy"},"tags":["format:openapi","spec:parameters","topic:pagination","experience:pagination","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-collection-limit-param-default' (Parameter Collection Limit Param Default). Requirement: The limit / page-size query parameter should declare a default so the page size is predictable when the caller omits it. To fix: Ensure `default` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.parameters[?(@ && @.in == 'query' && (@.name == 'limit' || @.name == 'per_page' || @.name == 'page_size' || @.name == 'pageSize'))].schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-collection-limit-param-maximum":{"title":"Parameter Collection Limit Param Maximum","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-collection-limit-param-maximum/","source":"spotlight","description":"The limit / page-size query parameter should declare a maximum so a caller cannot request an unbounded page (OWASP API4 — unrestricted resource consumption).","message":"limit parameter should declare a maximum.","given":"$.paths[*].get.parameters[?(@ && @.in == 'query' && (@.name == 'limit' || @.name == 'per_page' || @.name == 'page_size' || @.name == 'pageSize'))].schema","severity":"info","then":{"field":"maximum","function":"truthy"},"tags":["format:openapi","spec:parameters","topic:pagination","experience:pagination","experience:reliability","experience:performance","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-collection-limit-param-maximum' (Parameter Collection Limit Param Maximum). Requirement: The limit / page-size query parameter should declare a maximum so a caller cannot request an unbounded page (OWASP API4 — unrestricted resource consumption). To fix: Ensure `maximum` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.parameters[?(@ && @.in == 'query' && (@.name == 'limit' || @.name == 'per_page' || @.name == 'page_size' || @.name == 'pageSize'))].schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-deprecated-require-description":{"title":"Parameter Deprecated Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-deprecated-require-description/","source":"spotlight","description":"Deprecated parameters should have a description explaining the deprecation and what to use instead.","message":"Deprecated parameter should describe the deprecation.","given":"$..parameters[?(@ && @.deprecated == true)]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:parameters","topic:deprecation","experience:versioning","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-deprecated-require-description' (Parameter Deprecated Require Description). Requirement: Deprecated parameters should have a description explaining the deprecation and what to use instead. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..parameters[?(@ && @.deprecated == true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-description-max-length":{"title":"Parameter Description Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-description-max-length/","severity":"info","source":"compiled","description":"Limiting the length of parameters description forces us to be more concise in how we describe each parameter, while keeping our documentation and other ways descriptions show up in discovery and portals more consistent.","message":"Parameters Description MUST Be Less Than 500 Characters","given":"$.components.parameters.*","then":{"field":"summary","function":"length","functionOptions":{"max":500}},"tags":["format:openapi","spec:parameters","spec:components","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-description-max-length' (Parameter Description Max Length). Requirement: Limiting the length of parameters description forces us to be more concise in how we describe each parameter, while keeping our documentation and other ways descriptions show up in discovery and portals more consistent. To fix: Ensure the length of `summary` is at most 500. This rule is evaluated at the JSONPath `$.components.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-enum-upper-snake-case":{"title":"Parameter Enum Upper Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-enum-upper-snake-case/","source":"compiled","description":"Keeping parameters enumerator casing consistent across APIs helps reduce confusion by consumers, and can keep aligned with services and applications putting an API to work.","message":"Parameters Enums MUST Must Be Upper Snake Case","severity":"info","given":"$.components.parameters.*.enum.*","then":{"function":"pattern","functionOptions":{"notMatch":"^[A-Z]+(?:_[A-Z]+)*$"}},"tags":["format:openapi","spec:parameters","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-enum-upper-snake-case' (Parameter Enum Upper Snake Case). Requirement: Keeping parameters enumerator casing consistent across APIs helps reduce confusion by consumers, and can keep aligned with services and applications putting an API to work. To fix: Ensure the targeted value does NOT match the regular expression `^[A-Z]+(?:_[A-Z]+)*$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.components.parameters.*.enum.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-filter-param-only-on-get":{"title":"Parameter Filter Param Only On Get","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-filter-param-only-on-get/","source":"compiled","description":"Only GET-based endpoints SHOULD have have the query parameter 'filter'.","message":"Only GET-based endpoints SHOULD have have the query parameter 'filter'.","severity":"info","given":"$.paths.*[?(@property!='get')].parameters.[?(@.in=='query' && @.name=='filter')].name","then":{"function":"falsy"},"tags":["format:openapi","spec:paths","spec:operations","spec:parameters","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-filter-param-only-on-get' (Parameter Filter Param Only On Get). Requirement: Only GET-based endpoints SHOULD have have the query parameter 'filter'. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.*[?(@property!='get')].parameters.[?(@.in=='query' && @.name=='filter')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-integer-require-maximum":{"title":"Parameter Integer Require Maximum","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-integer-require-maximum/","source":"compiled","description":"Parameters that are of the integer schema type must have their maximum value set, defining the shape of parameter data passed in with a request.","message":"Parameter Schema Type Integer Maximum","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":{"field":"maximum","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-integer-require-maximum' (Parameter Integer Require Maximum). Requirement: Parameters that are of the integer schema type must have their maximum value set, defining the shape of parameter data passed in with a request. To fix: Ensure `maximum` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-integer-require-minimum":{"title":"Parameter Integer Require Minimum","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-integer-require-minimum/","source":"compiled","description":"Parameters that are of the integer schema type must have their minimum value set, defining the shape of parameter data passed in with a request.","message":"Parameter Schema Type Integer Minimum","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":{"field":"minimum","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-integer-require-minimum' (Parameter Integer Require Minimum). Requirement: Parameters that are of the integer schema type must have their minimum value set, defining the shape of parameter data passed in with a request. To fix: Ensure `minimum` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-keys-snake-case":{"title":"Parameter Keys Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-keys-snake-case/","source":"compiled","description":"parameter key must be snake cased (e.g. snake_case).","message":"{{error}}","severity":"info","given":"$.components['parameters'].*~","then":{"function":"digitalocean:ensureSnakeCaseWithDigits"},"tags":["format:openapi","spec:parameters","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-keys-snake-case' (Parameter Keys Snake Case). Requirement: parameter key must be snake cased (e.g. snake_case). This rule is evaluated at the JSONPath `$.components['parameters'].*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-name-max-length":{"title":"Parameter Name Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-name-max-length/","severity":"info","source":"compiled","description":"Providing short and concise names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests.","message":"Parameters Name Length MUST Be Less Than 25 Characters","given":"$.components.parameters[?(@.in=='path')].name","then":{"field":"summary","function":"length","functionOptions":{"max":25}},"tags":["format:openapi","spec:parameters","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-name-max-length' (Parameter Name Max Length). Requirement: Providing short and concise names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests. To fix: Ensure the length of `summary` is at most 25. This rule is evaluated at the JSONPath `$.components.parameters[?(@.in=='path')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-names-camel-case":{"title":"Parameter Names Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-names-camel-case/","source":"compiled","description":"Providing parameters with consistent naming helps make it easier for API consumers to understand how they are able to configure their API requests.","message":"Parameters Names MUST Be Camel Case","severity":"info","given":"$.components.parameters.*","then":[{"field":"name","function":"pattern","functionOptions":{"notMatch":"^[a-z]+(?:[A-Z][a-z]+)*$"}},{"field":"name","function":"pattern","functionOptions":{"match":"^[A-Z](([a-z0-9]+[A-Z]?)*)$"}}],"tags":["format:openapi","spec:parameters","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-names-camel-case' (Parameter Names Camel Case). Requirement: Providing parameters with consistent naming helps make it easier for API consumers to understand how they are able to configure their API requests. To fix: Ensure `name` does NOT match the regular expression `^[a-z]+(?:[A-Z][a-z]+)*$`; rename or rewrite any value that does. Also: Ensure `name` matches the regular expression `^[A-Z](([a-z0-9]+[A-Z]?)*)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-no-api-keys-in-query":{"title":"Parameter No API Keys In Query","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-no-api-keys-in-query/","source":"compiled","description":"Query parameters MUST not contain sensitive information, like API tokens or keys.","message":"Query parameters MUST not contain sensitive information, like API tokens or keys.","severity":"info","given":"$.paths.*.*.parameters[?(@.in=='query')].name","then":{"function":"pattern","functionOptions":{"notMatch":"apiKey|token"}},"tags":["format:openapi","spec:paths","spec:parameters","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-no-api-keys-in-query' (Parameter No API Keys In Query). Requirement: Query parameters MUST not contain sensitive information, like API tokens or keys. To fix: Ensure the targeted value does NOT match the regular expression `apiKey|token`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*.*.parameters[?(@.in=='query')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-no-forbidden-http-header":{"title":"Parameter No Forbidden HTTP Header","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-no-forbidden-http-header/","source":"compiled","description":"OAS do not allow using the following HTTP headers in a specification file: Authorization, Content-Type and Accept. You MUST use the associate functionalities provided by OAS, instead.","message":"{{error}} in {{path}} {{value}}","severity":"info","given":["$..parameters[?(@.in == 'header')].name","$.[responses][*].headers.*~"],"then":{"function":"pattern","functionOptions":{"notMatch":"/^(accept|content-type|authorization)$/i"}},"tags":["format:openapi","spec:parameters","spec:responses","spec:headers","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-no-forbidden-http-header' (Parameter No Forbidden HTTP Header). Requirement: OAS do not allow using the following HTTP headers in a specification file: Authorization, Content-Type and Accept. You MUST use the associate functionalities provided by OAS, instead. To fix: Ensure the targeted value does NOT match the regular expression `/^(accept|content-type|authorization)$/i`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'header')].name | $.[responses][*].headers.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-no-hybrid-and-root-filtering":{"title":"Parameter No Hybrid And Root Filtering","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-no-hybrid-and-root-filtering/","source":"compiled","description":"Hybrid filtering MAY be offered on multiple attributes, but MUST never exist if a root \"filter\" query parameter is present.","message":"Hybrid filtering MAY be offered on multiple attributes, but MUST never exist if a root \"filter\" query parameter is present.","severity":"info","given":"$.paths..get.parameters^","then":{"function":"schema","functionOptions":{"schema":{"type":"object","properties":{"parameters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"in":{"type":"string"}}}}},"allOf":[{"if":{"properties":{"parameters":{"type":"array","contains":{"type":"object","properties":{"name":{"const":"filter"}}}}}},"then":{"not":{"properties":{"parameters":{"type":"array","contains":{"type":"object","properties":{"name":{"type":"string","pattern":"\\w+Filter"}}}}}}}}]}}},"tags":["format:openapi","spec:paths","spec:operations","spec:parameters","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-no-hybrid-and-root-filtering' (Parameter No Hybrid And Root Filtering). Requirement: Hybrid filtering MAY be offered on multiple attributes, but MUST never exist if a root \"filter\" query parameter is present. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths..get.parameters^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-no-id-query":{"title":"Parameter No ID Query","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-no-id-query/","source":"compiled","description":"Resource identifier filtering is not allowed as a query parameter. Use the resource identifier in the URL path.","message":"Resource identifier filtering is not allowed as a query parameter.","severity":"info","given":"$.paths..get.parameters.[?(@.in=='query' && @.name=='id')]","then":{"field":"name","function":"pattern","functionOptions":{"notMatch":"^id$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:parameters","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-no-id-query' (Parameter No ID Query). Requirement: Resource identifier filtering is not allowed as a query parameter. Use the resource identifier in the URL path. To fix: Ensure `name` does NOT match the regular expression `^id$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths..get.parameters.[?(@.in=='query' && @.name=='id')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-no-x-prefixed-request-header":{"title":"Parameter No X Prefixed Request Header","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-no-x-prefixed-request-header/","source":"compiled","description":"Do not use headers with X-.","message":"Headers cannot start with X-. More: https://tools.ietf.org/html/rfc6648","severity":"info","given":"$..parameters.[?(@.in === 'header')].name","then":{"function":"pattern","functionOptions":{"notMatch":"^(x|X)-"}},"tags":["format:openapi","spec:parameters","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-no-x-prefixed-request-header' (Parameter No X Prefixed Request Header). Requirement: Do not use headers with X-. To fix: Ensure the targeted value does NOT match the regular expression `^(x|X)-`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..parameters.[?(@.in === 'header')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-optional-include-examples":{"title":"Parameter Optional Include Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-optional-include-examples/","source":"compiled","description":"Optional param should have examples.","message":"Optional param should have examples","severity":"info","given":"$..parameters[?(@ && @.required != true)]","then":{"field":"examples","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:parameters","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-optional-include-examples' (Parameter Optional Include Examples). Requirement: Optional param should have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..parameters[?(@ && @.required != true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-owasp-api1-no-numeric-ids":{"title":"Parameter OWASP API1 No Numeric IDs","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-owasp-api1-no-numeric-ids/","source":"spotlight","description":"Path parameters should not be sequential integers (BOLA / object enumeration, OWASP API1) — use a non-guessable identifier such as a UUID.","message":"Path parameter should not be an integer (use a non-enumerable id, e.g. UUID).","given":"$.paths[*][*].parameters[?(@ && @.in == 'path')].schema","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"object","properties":{"type":{"not":{"enum":["integer","number"]}}}}}},"tags":["format:openapi","spec:parameters","experience:security","owasp:api1"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-owasp-api1-no-numeric-ids' (Parameter OWASP API1 No Numeric IDs). Requirement: Path parameters should not be sequential integers (BOLA / object enumeration, OWASP API1) — use a non-guessable identifier such as a UUID. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][*].parameters[?(@ && @.in == 'path')].schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-pagination-params-in-query":{"title":"Parameter Pagination Params In Query","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-pagination-params-in-query/","source":"compiled","description":"Pagination parameters like page, limit, offset, and cursor should be passed as query parameters, not in headers or path segments. Analysis confirms 100% of pagination parameters observed are query parameters.","message":"Pagination Parameters MUST Be Query Parameters","severity":"info","given":"$.paths[*].get.parameters[?(@.name == 'page' || @.name == 'limit' || @.name == 'offset' || @.name == 'cursor' || @.name == 'per_page' || @.name == 'page_size')]","then":{"field":"in","function":"pattern","functionOptions":{"match":"query"}},"tags":["format:openapi","spec:paths","spec:operations","spec:parameters","topic:pagination","experience:pagination","experience:consistency","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-pagination-params-in-query' (Parameter Pagination Params In Query). Requirement: Pagination parameters like page, limit, offset, and cursor should be passed as query parameters, not in headers or path segments. Analysis confirms 100% of pagination parameters observed are query parameters. To fix: Ensure `in` matches the regular expression `query`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*].get.parameters[?(@.name == 'page' || @.name == 'limit' || @.name == 'offset' || @.name == 'cursor' || @.name == 'per_page' || @.name == 'page_size')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-query-allowed-characters":{"title":"Parameter Query Allowed Characters","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-query-allowed-characters/","source":"compiled","description":"Query parameter keys MUST include only alpha-numeric characters and periods: [Aa0-Zz9]'.","message":"Query parameter keys MUST include only alpha-numeric characters and periods: [Aa0-Zz9]'.","severity":"info","given":"$.paths.*.*.parameters[?(@.in=='query')].name","then":{"function":"pattern","functionOptions":{"match":"^[A-Za-z0-9\\.]+$"}},"tags":["format:openapi","spec:paths","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-query-allowed-characters' (Parameter Query Allowed Characters). Requirement: Query parameter keys MUST include only alpha-numeric characters and periods: [Aa0-Zz9]'. To fix: Ensure the targeted value matches the regular expression `^[A-Za-z0-9\\.]+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*.*.parameters[?(@.in=='query')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-query-camel-case":{"title":"Parameter Query Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-query-camel-case/","source":"compiled","description":"MUST query parameter names must be ASCII camelCase [130a].","message":"Query parameter name has to be ASCII camelCase","severity":"info","given":"$.paths.*.*.parameters[?(@ && @.in=='query')].name","then":{"function":"pattern","functionOptions":{"match":"^[a-z]+((\\d)|([A-Z0-9][a-z0-9]+))*([A-Z])?$"}},"tags":["format:openapi","spec:paths","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-query-camel-case' (Parameter Query Camel Case). Requirement: MUST query parameter names must be ASCII camelCase [130a]. To fix: Ensure the targeted value matches the regular expression `^[a-z]+((\\d)|([A-Z0-9][a-z0-9]+))*([A-Z])?$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*.*.parameters[?(@ && @.in=='query')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-query-must-be-optional":{"title":"Parameter Query Must Be Optional","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-query-must-be-optional/","source":"compiled","description":"Query parameters MUST be optional.","message":"Query parameters MUST be optional.","severity":"info","given":"$.paths.*.*.parameters[?(@.in=='query')].required","then":{"function":"falsy"},"tags":["format:openapi","spec:paths","spec:parameters","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-query-must-be-optional' (Parameter Query Must Be Optional). Requirement: Query parameters MUST be optional. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.*.*.parameters[?(@.in=='query')].required` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-require-description":{"title":"Parameter Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-require-description/","severity":"info","source":"compiled","description":"Having a parameters description provides more depth to what a parameter does and will be displayed via documentation, and other tooling used across the API lifecycle.","message":"Parameters MUST Have a Description","given":"$.paths.*.*.parameters.*","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:paths","spec:parameters","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-require-description' (Parameter Require Description). Requirement: Having a parameters description provides more depth to what a parameter does and will be displayed via documentation, and other tooling used across the API lifecycle. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.*.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-require-examples":{"title":"Parameter Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-require-examples/","source":"compiled","description":"Parameters must include examples.","message":"{{description}}; missing {{property}}","severity":"info","given":"$..parameters.*","then":{"function":"xor","functionOptions":{"properties":["example","examples"]}},"tags":["format:openapi","spec:parameters","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-require-examples' (Parameter Require Examples). Requirement: Parameters must include examples. To fix: Include exactly one of: example, examples. This rule is evaluated at the JSONPath `$..parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-require-in":{"title":"Parameter Require In","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-require-in/","severity":"info","source":"compiled","description":"Providing an in property for parameters gets explicit about whether a parameter is in the path, query, or a header, making it clear to consumers where they can configure their request.","message":"Parameters In Property MUST Be Set","given":"$.components.parameters.*","then":{"field":"in","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:components","experience:data-modeling","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-require-in' (Parameter Require In). Requirement: Providing an in property for parameters gets explicit about whether a parameter is in the path, query, or a header, making it clear to consumers where they can configure their request. To fix: Ensure `in` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-require-name":{"title":"Parameter Require Name","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-require-name/","source":"compiled","description":"Providing a simple, intuitive, and consistent names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests.","message":"Parameters MUST Have a Name","severity":"info","given":"$.components.parameters.*","then":{"field":"name","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:components","experience:naming","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-require-name' (Parameter Require Name). Requirement: Providing a simple, intuitive, and consistent names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-require-required-flag":{"title":"Parameter Require Required Flag","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-require-required-flag/","source":"compiled","description":"Providrequiredg an required property for parameters gets explicit about whether a parameter is required the path, query, or a header, making it clear to consumers where they can configure their request.","message":"Parameters Required Property MUST Be Set","severity":"info","given":"$.components.parameters.*","then":{"field":"required","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:components","experience:data-modeling","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-require-required-flag' (Parameter Require Required Flag). Requirement: Providrequiredg an required property for parameters gets explicit about whether a parameter is required the path, query, or a header, making it clear to consumers where they can configure their request. To fix: Ensure `required` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-require-schema":{"title":"Parameter Require Schema","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-require-schema/","severity":"info","source":"compiled","description":"Parameters must always possess a schema to help define the format and shape of the parameter, setting expections with consumers about what should be passed in.","message":"Parameters MUST Have Schema","given":"$.components.parameters.*","then":{"field":"schema","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:components","experience:data-modeling","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-require-schema' (Parameter Require Schema). Requirement: Parameters must always possess a schema to help define the format and shape of the parameter, setting expections with consumers about what should be passed in. To fix: Ensure `schema` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-required-require-examples":{"title":"Parameter Required Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-required-require-examples/","source":"compiled","description":"Required param must have examples.","message":"Required param must have examples","severity":"info","given":"$..parameters[?(@ && @.required == true)]","then":{"field":"examples","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:parameters","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-required-require-examples' (Parameter Required Require Examples). Requirement: Required param must have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..parameters[?(@ && @.required == true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-schema-require-type":{"title":"Parameter Schema Require Type","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-schema-require-type/","source":"compiled","description":"Parameters must always have their schema type defined, being precise about what type of data can be inputted and used to configure an API request.","message":"Parameter Schema Type","severity":"info","given":"$.components.parameters.*.schema","then":{"field":"type","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:schemas","spec:components","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-schema-require-type' (Parameter Schema Require Type). Requirement: Parameters must always have their schema type defined, being precise about what type of data can be inputted and used to configure an API request. To fix: Ensure `type` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.*.schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-schema-use-ref":{"title":"Parameter Schema Use Ref","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-schema-use-ref/","source":"compiled","description":"Parameters must always use a schema reference that utilizes reusable schema that are defined as part of a centralized schema components library.","message":"Parameters MUST Use Schema Reference","severity":"info","given":"$.components.parameters.*.schema","then":{"field":"$ref","function":"falsy"},"tags":["format:openapi","spec:parameters","spec:schemas","spec:components","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-schema-use-ref' (Parameter Schema Use Ref). Requirement: Parameters must always use a schema reference that utilizes reusable schema that are defined as part of a centralized schema components library. To fix: Ensure `$ref` is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.*.schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-sort-param-only-on-get":{"title":"Parameter Sort Param Only On Get","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-sort-param-only-on-get/","source":"compiled","description":"Non-GET endpoints MUST NOT have sorting query parameters. Parameter names such as sort, sorting, orderBy, etc.","message":"Non-GET endpoints MUST NOT have sorting query parameters.","severity":"info","given":"$.paths.*[?(@property!='get')].parameters.[?(@.in=='query')]","then":{"field":"name","function":"pattern","functionOptions":{"notMatch":"^sort|sorting|sortBy|order|ordering|orderBy$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:parameters","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-sort-param-only-on-get' (Parameter Sort Param Only On Get). Requirement: Non-GET endpoints MUST NOT have sorting query parameters. Parameter names such as sort, sorting, orderBy, etc. To fix: Ensure `name` does NOT match the regular expression `^sort|sorting|sortBy|order|ordering|orderBy$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*[?(@property!='get')].parameters.[?(@.in=='query')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-string-require-max-length":{"title":"Parameter String Require Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-string-require-max-length/","source":"compiled","description":"Parameters that are of the string schema type must have their maximum value set, defining the shape of parameter data passed in with a request.","message":"Parameter Schema Type String MaxLength","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":{"field":"maxLength","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-string-require-max-length' (Parameter String Require Max Length). Requirement: Parameters that are of the string schema type must have their maximum value set, defining the shape of parameter data passed in with a request. To fix: Ensure `maxLength` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-string-require-min-length":{"title":"Parameter String Require Min Length","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-string-require-min-length/","source":"compiled","description":"Parameters that are of the string schema type must have their minimum value set, defining the shape of parameter data passed in with a request.","message":"Parameter Schema Type String MinLength","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":{"field":"minLength","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-string-require-min-length' (Parameter String Require Min Length). Requirement: Parameters that are of the string schema type must have their minimum value set, defining the shape of parameter data passed in with a request. To fix: Ensure `minLength` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-string-require-pattern":{"title":"Parameter String Require Pattern","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-string-require-pattern/","source":"compiled","description":"Parameters that are of the string schema type must have a pattern set, using a regex to define the shape of parameter data passed in with a request.","message":"Parameter Schema Type String Pattern","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":{"field":"pattern","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-string-require-pattern' (Parameter String Require Pattern). Requirement: Parameters that are of the string schema type must have a pattern set, using a regex to define the shape of parameter data passed in with a request. To fix: Ensure `pattern` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-cors-support-options-preflight":{"title":"Path CORS Support Options Preflight","reference":"https://spotlight-rules.com/spec/rules/openapi/path-cors-support-options-preflight/","source":"spotlight","description":"Resources should expose an OPTIONS operation so browsers can complete a CORS preflight. (Many teams handle preflight at the gateway and treat CORS as operational — enable this only if you document CORS in the spec.).","message":"Path should expose an OPTIONS operation for CORS preflight.","given":"$.paths[*]","severity":"info","then":{"field":"options","function":"truthy"},"tags":["format:openapi","spec:paths","topic:cors","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-cors-support-options-preflight' (Path CORS Support Options Preflight). Requirement: Resources should expose an OPTIONS operation so browsers can complete a CORS preflight. (Many teams handle preflight at the gateway and treat CORS as operational — enable this only if you document CORS in the spec.). To fix: Ensure `options` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-declarations-must-exist":{"title":"Path Declarations Must Exist","reference":"https://spotlight-rules.com/spec/rules/openapi/path-declarations-must-exist/","description":"Path Declarations Must Exist.","source":"builtin","message":"Path parameter declarations must not be empty, ex.\"/given/{}\" is invalid.","severity":"info","given":"$.paths","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"{}"}},"tags":["format:openapi","spec:paths","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-declarations-must-exist' (Path Declarations Must Exist). Requirement: Path Declarations Must Exist. To fix: Ensure `@key` does NOT match the regular expression `{}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-delete-no-response-body":{"title":"Path Delete No Response Body","reference":"https://spotlight-rules.com/spec/rules/openapi/path-delete-no-response-body/","source":"compiled","description":"Check if the delete response does not have any body.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"trimble:delete-must-not-return-body"},"tags":["format:openapi","spec:paths","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-delete-no-response-body' (Path Delete No Response Body). Requirement: Check if the delete response does not have any body. This rule is evaluated at the JSONPath `$.paths.*.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-get-response-support-json":{"title":"Path Get Response Support JSON","reference":"https://spotlight-rules.com/spec/rules/openapi/path-get-response-support-json/","source":"compiled","description":"All APIs returning structured data SHOULD support JSON as the default format.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"trimble:check-if-response-body-json-in-get-response"},"tags":["format:openapi","spec:paths","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-get-response-support-json' (Path Get Response Support JSON). Requirement: All APIs returning structured data SHOULD support JSON as the default format. This rule is evaluated at the JSONPath `$.paths.*.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-include-version":{"title":"Path Include Version","reference":"https://spotlight-rules.com/spec/rules/openapi/path-include-version/","source":"compiled","description":"Path must include the version.","message":"{{description}}; {{property}} incorrect","severity":"info","given":"$.paths[?(@property!='/<upload_url>')]~","then":{"function":"pattern","functionOptions":{"match":"^(/v[12]/.*|/api/v[12]/.*)$"}},"tags":["format:openapi","spec:paths","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-include-version' (Path Include Version). Requirement: Path must include the version. To fix: Ensure the targeted value matches the regular expression `^(/v[12]/.*|/api/v[12]/.*)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[?(@property!='/<upload_url>')]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-keys-no-trailing-slash":{"title":"Path Keys No Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/openapi/path-keys-no-trailing-slash/","description":"Path Keys No Trailing Slash.","source":"builtin","message":"Path must not end with slash.","severity":"info","given":"$.paths","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":".+\\/$"}},"tags":["format:openapi","spec:paths","experience:consistency","experience:naming"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-keys-no-trailing-slash' (Path Keys No Trailing Slash). Requirement: Path Keys No Trailing Slash. To fix: Ensure `@key` does NOT match the regular expression `.+\\/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-max-nesting-depth":{"title":"Path Max Nesting Depth","reference":"https://spotlight-rules.com/spec/rules/openapi/path-max-nesting-depth/","source":"compiled","description":"API paths should not exceed 4 levels of nesting depth. Analysis of 6627 paths across 773 specs shows an average depth of 3.04 segments, with deeper paths indicating overly complex resource hierarchies.","message":"Path Nesting MUST NOT Exceed 4 Levels","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"notMatch":"^(/[^/]+){5,}"}},"tags":["format:openapi","spec:paths","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-max-nesting-depth' (Path Max Nesting Depth). Requirement: API paths should not exceed 4 levels of nesting depth. Analysis of 6627 paths across 773 specs shows an average depth of 3.04 segments, with deeper paths indicating overly complex resource hierarchies. To fix: Ensure the targeted value does NOT match the regular expression `^(/[^/]+){5,}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-api-prefix-in":{"title":"Path No API Prefix In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-api-prefix-in/","source":"compiled","description":"A resource SHOULD NOT contain 'api' as a prefix in or a part of the path.","message":"A resource SHOULD NOT contain 'api' as a prefix in or a part of the path.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"/api|/api/|-api/"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-api-prefix-in' (Path No API Prefix In). Requirement: A resource SHOULD NOT contain 'api' as a prefix in or a part of the path. To fix: Ensure the targeted value does NOT match the regular expression `/api|/api/|-api/`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-empty-segment":{"title":"Path No Empty Segment","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-empty-segment/","source":"compiled","description":"A resource MUST use normalized paths without empty path segments.","message":"A resource MUST use normalized paths without empty path segments.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"//"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-empty-segment' (Path No Empty Segment). Requirement: A resource MUST use normalized paths without empty path segments. To fix: Ensure the targeted value does NOT match the regular expression `//`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-environment-names-in":{"title":"Path No Environment Names In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-environment-names-in/","source":"compiled","description":"API paths MUST NOT indicate environment names.","message":"API paths MUST NOT indicate environment names.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"/prod/|/preprod/|/dev/|/test/|/integration/|/stage/"}},"tags":["format:openapi","spec:paths","experience:naming","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-environment-names-in' (Path No Environment Names In). Requirement: API paths MUST NOT indicate environment names. To fix: Ensure the targeted value does NOT match the regular expression `/prod/|/preprod/|/dev/|/test/|/integration/|/stage/`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-file-extension-in":{"title":"Path No File Extension In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-file-extension-in/","source":"compiled","description":"A resource SHOULD NOT make use of an extension at any point in the path.","message":"A resource SHOULD NOT make use of an extension at any point in the path.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"\\."}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-file-extension-in' (Path No File Extension In). Requirement: A resource SHOULD NOT make use of an extension at any point in the path. To fix: Ensure the targeted value does NOT match the regular expression `\\.`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-file-extensions":{"title":"Path No File Extensions","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-file-extensions/","source":"compiled","description":"API paths should not include file extensions like .json or .xml. Content negotiation should be handled through Accept headers rather than path suffixes.","message":"Paths MUST NOT Contain File Extensions","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"notMatch":"\\.(json|xml|html|yaml|yml|csv|pdf)$"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-file-extensions' (Path No File Extensions). Requirement: API paths should not include file extensions like .json or .xml. Content negotiation should be handled through Accept headers rather than path suffixes. To fix: Ensure the targeted value does NOT match the regular expression `\\.(json|xml|html|yaml|yml|csv|pdf)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-format-extensions-in":{"title":"Path No Format Extensions In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-format-extensions-in/","source":"compiled","description":"Request and Response media type formats MUST NOT be implied using extensions on resources (i.e. .json or .xml). Instead, use the standard resource path with the appropriate Content-Type header.","message":"Request and Response media type formats MUST NOT be implied using extensions on resources (i.e.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"\\.json|\\.xml|\\.yml|\\.yaml"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-format-extensions-in' (Path No Format Extensions In). Requirement: Request and Response media type formats MUST NOT be implied using extensions on resources (i.e. .json or .xml). Instead, use the standard resource path with the appropriate Content-Type header. To fix: Ensure the targeted value does NOT match the regular expression `\\.json|\\.xml|\\.yml|\\.yaml`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-http-method-names":{"title":"Path No HTTP Method Names","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-http-method-names/","source":"compiled","description":"When you design a REST API, you don't usually need to mention terms like `get`, `delete` and so on in your `paths`, because this information is conveyed by the HTTP method. Instead of using ``` POST /books/1234/delete HTTP/1.1 Host: api.example ``` You can simply call ``` DELETE /books/1234 HTTP/1.1 Host: api.example ``` Similarly you don't need verbs like `list` or `create` because the HTTP Semantics RFC7231 supports this kind of actions natively with proper methods and status code. Instead of ``` POST /create/user HTTP/1.1 Host: api.example Content-Type: application/json {\"given_name\": \"Mario\"} ``` You can use ``` POST /create/user HTTP/1.1 Host: api.example Content-Type: application/json {\"given_name\": \"Mario\"} ``` returning a proper response ``` HTTP/1.1 201 Created Location: /users/1234 ``` This simplifies securing your API as you know beforehand the kind of action which is going to be performed.","message":"API \"path\" contains a name of an http method. {{error}}","severity":"info","given":["$.paths[?(@property.match( /\\/(get|post|put|delete|patch)[\\/A-Z_\\-]?/ ))]~","$.paths[?(@property.match( /\\/(create|remove|list)[\\/A-Z_\\-]?/ ))]~"],"then":{"field":"@key","function":"undefined"},"tags":["format:openapi","spec:paths","spec:operations","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-http-method-names' (Path No HTTP Method Names). Requirement: When you design a REST API, you don't usually need to mention terms like `get`, `delete` and so on in your `paths`, because this information is conveyed by the HTTP method. Instead of using ``` POST /books/1234/delete HTTP/1.1 Host: api.example ``` You can simply call ``` DELETE /books/1234 HTTP/1.1 Host: api.example ``` Similarly you don't need verbs like `list` or `create` because the HTTP Semantics RFC7231 supports this kind of actions natively with proper methods and status code. Instead of ``` POST /create/user HTTP/1.1 Host: api.example Content-Type: application/json {\"given_name\": \"Mario\"} ``` You can use ``` POST /create/user HTTP/1.1 Host: api.example Content-Type: application/json {\"given_name\": \"Mario\"} ``` returning a proper response ``` HTTP/1.1 201 Created Location: /users/1234 ``` This simplifies securing your API as you know beforehand the kind of action which is going to be performed. To fix: Remove `@key` from each matching location. This rule is evaluated at the JSONPath `$.paths[?(@property.match( /\\/(get|post|put|delete|patch)[\\/A-Z_\\-]?/ ))]~ | $.paths[?(@property.match( /\\/(create|remove|list)[\\/A-Z_\\-]?/ ))]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-http-methods-in":{"title":"Path No HTTP Methods In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-http-methods-in/","source":"compiled","description":"A resource SHOULD NOT contain HTTP methods.","message":"A resource SHOULD NOT contain HTTP methods.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"(\\/get|\\/post|\\/put|\\/delete|\\/patch)"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-http-methods-in' (Path No HTTP Methods In). Requirement: A resource SHOULD NOT contain HTTP methods. To fix: Ensure the targeted value does NOT match the regular expression `(\\/get|\\/post|\\/put|\\/delete|\\/patch)`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-http-verbs":{"title":"Path No HTTP Verbs","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-http-verbs/","severity":"info","source":"compiled","description":"HTTP verbs should be not be in URL paths.","message":"{{property}} has HTTP verb in path: {{error}}","given":"$.paths[*]~","then":{"function":"trimble:no-http-verbs-in-path"},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-http-verbs' (Path No HTTP Verbs). Requirement: HTTP verbs should be not be in URL paths. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-invalid-symbols":{"title":"Path No Invalid Symbols","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-invalid-symbols/","source":"compiled","description":"Check if the given endpoint has queryparameter.","message":"{{error}}","severity":"info","given":"$.paths[*]~","then":{"function":"trimble:invalid-symbol-in-path"},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-invalid-symbols' (Path No Invalid Symbols). Requirement: Check if the given endpoint has queryparameter. This rule is evaluated at the JSONPath `$.paths.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-query-string":{"title":"Path No Query String","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-query-string/","source":"compiled","description":"Path must not include query string.","message":"Path must not include query string.","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"notMatch":"\\?"}},"formats":["oas3","oas3_1"],"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-query-string' (Path No Query String). Requirement: Path must not include query string. To fix: Ensure the targeted value does NOT match the regular expression `\\?`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-query-strings-in":{"title":"Path No Query Strings In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-query-strings-in/","source":"compiled","description":"Paths SHOULD NOT have query parameters in them. They should be defined separately in the OpenAPI.","message":"Paths SHOULD NOT have query parameters in them. They should be defined separately in the OpenAPI.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"\\?"}},"tags":["format:openapi","spec:paths","experience:consistency","experience:naming"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-query-strings-in' (Path No Query Strings In). Requirement: Paths SHOULD NOT have query parameters in them. They should be defined separately in the OpenAPI. To fix: Ensure the targeted value does NOT match the regular expression `\\?`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-technology-leak-in":{"title":"Path No Technology Leak In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-technology-leak-in/","source":"compiled","description":"A resource MUST NOT leak or expose format or technology-specific information at any point in the path.","message":"A resource MUST NOT leak or expose format or technology-specific information at any point in the path.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"(.php|.asp|.jsp|.cgi|.psp|.json|.xml)"}},"tags":["format:openapi","spec:paths","experience:security","experience:naming"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-technology-leak-in' (Path No Technology Leak In). Requirement: A resource MUST NOT leak or expose format or technology-specific information at any point in the path. To fix: Ensure the targeted value does NOT match the regular expression `(.php|.asp|.jsp|.cgi|.psp|.json|.xml)`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-trailing-slash":{"title":"Path No Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-trailing-slash/","source":"compiled","description":"Path must not end with a slash.","message":"Path must not end with a slash.","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"notMatch":".+\\/$"}},"formats":["oas3","oas3_1"],"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-trailing-slash' (Path No Trailing Slash). Requirement: Path must not end with a slash. To fix: Ensure the targeted value does NOT match the regular expression `.+\\/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-trailing-slash-in":{"title":"Path No Trailing Slash In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-trailing-slash-in/","source":"compiled","description":"A resource MUST be addressable without a trailing slash on the path.","message":"A resource MUST be addressable without a trailing slash on the path.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"/$"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-trailing-slash-in' (Path No Trailing Slash In). Requirement: A resource MUST be addressable without a trailing slash on the path. To fix: Ensure the targeted value does NOT match the regular expression `/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-verbs":{"title":"Path No Verbs","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-verbs/","source":"compiled","description":"API paths MUST be resource-focused and MUST NOT include verbs like 'get', 'update', 'create', or 'delete'.","message":"Path '{{path}}' includes a verb (e.g., 'get', 'update', 'create', 'delete'). API paths SHOULD be resource-focused.","severity":"info","given":"$.paths[*]~","then":{"function":"pattern","functionOptions":{"notMatch":"/\\b(get|update|create|delete|fetch|retrieve)\\b/"}},"formats":["oas3"],"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-verbs' (Path No Verbs). Requirement: API paths MUST be resource-focused and MUST NOT include verbs like 'get', 'update', 'create', or 'delete'. To fix: Ensure the targeted value does NOT match the regular expression `/\\b(get|update|create|delete|fetch|retrieve)\\b/`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-version-segment":{"title":"Path No Version Segment","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-version-segment/","source":"compiled","description":"API paths should not contain version numbers like v1 or v2. API versioning should be handled through headers, query parameters, or server URLs rather than embedded in resource paths.","message":"Paths MUST NOT Contain API Version","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"notMatch":"/v[0-9]"}},"tags":["format:openapi","spec:paths","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-version-segment' (Path No Version Segment). Requirement: API paths should not contain version numbers like v1 or v2. API versioning should be handled through headers, query parameters, or server URLs rather than embedded in resource paths. To fix: Ensure the targeted value does NOT match the regular expression `/v[0-9]`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-x-prefixed-response-header":{"title":"Path No X Prefixed Response Header","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-x-prefixed-response-header/","source":"compiled","description":"Do not use headers with X-.","message":"Headers cannot start with X-, so please find a new name for {{property}}. More: https://tools.ietf.org/html/rfc6648","severity":"info","given":"$..headers.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^(x|X)-"}},"tags":["format:openapi","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-x-prefixed-response-header' (Path No X Prefixed Response Header). Requirement: Do not use headers with X-. To fix: Ensure the targeted value does NOT match the regular expression `^(x|X)-`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..headers.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-not-include-query":{"title":"Path Not Include Query","reference":"https://spotlight-rules.com/spec/rules/openapi/path-not-include-query/","source":"builtin","description":"Path must not include query string.","message":"Path must not include query string.","severity":"info","given":"$.paths","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"\\?"}},"tags":["format:openapi","spec:paths","experience:consistency","experience:naming"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-not-include-query' (Path Not Include Query). Requirement: Path must not include query string. To fix: Ensure `@key` does NOT match the regular expression `\\?`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-parameter-camel-case":{"title":"Path Parameter Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/path-parameter-camel-case/","source":"compiled","description":"Path parameters MUST follow camelCase.","message":"{{property}} path parameter is not camelCase: {{error}}","severity":"info","given":"$..parameters[?(@.in == 'path')].name","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-zA-Z0-9]+$"}},"tags":["format:openapi","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-parameter-camel-case' (Path Parameter Camel Case). Requirement: Path parameters MUST follow camelCase. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-zA-Z0-9]+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'path')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-parameter-constant-case":{"title":"Path Parameter Constant Case","reference":"https://spotlight-rules.com/spec/rules/openapi/path-parameter-constant-case/","source":"default","description":"Path parameters MUST follow CONSTANT_CASE (screaming snake_case).","message":"{{property}} path parameter is not CONSTANT_CASE: {{error}}","severity":"info","given":"$..parameters[?(@.in == 'path')].name","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"}},"tags":["format:openapi","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-parameter-constant-case' (Path Parameter Constant Case). Requirement: Path parameters MUST follow CONSTANT_CASE (screaming snake_case). To fix: Ensure the targeted value matches the regular expression `^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'path')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-parameter-kebab-case":{"title":"Path Parameter Kebab Case","reference":"https://spotlight-rules.com/spec/rules/openapi/path-parameter-kebab-case/","source":"default","description":"Path parameters MUST follow kebab-case.","message":"{{property}} path parameter is not kebab-case: {{error}}","severity":"info","given":"$..parameters[?(@.in == 'path')].name","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(-[a-z0-9]+)*$"}},"tags":["format:openapi","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-parameter-kebab-case' (Path Parameter Kebab Case). Requirement: Path parameters MUST follow kebab-case. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(-[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'path')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-parameter-not-empty":{"title":"Path Parameter Not Empty","reference":"https://spotlight-rules.com/spec/rules/openapi/path-parameter-not-empty/","source":"compiled","description":"Path parameter declarations must not be empty ex. `/api/{}` is invalid.","message":"Path parameter declarations must not be empty ex.","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"notMatch":"{}"}},"formats":["oas3","oas3_1"],"tags":["format:openapi","spec:paths","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-parameter-not-empty' (Path Parameter Not Empty). Requirement: Path parameter declarations must not be empty ex. `/api/{}` is invalid. To fix: Ensure the targeted value does NOT match the regular expression `{}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-parameter-pascal-case":{"title":"Path Parameter Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/path-parameter-pascal-case/","source":"default","description":"Path parameters MUST follow PascalCase.","message":"{{property}} path parameter is not PascalCase: {{error}}","severity":"info","given":"$..parameters[?(@.in == 'path')].name","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][a-zA-Z0-9]+$"}},"tags":["format:openapi","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-parameter-pascal-case' (Path Parameter Pascal Case). Requirement: Path parameters MUST follow PascalCase. To fix: Ensure the targeted value matches the regular expression `^[A-Z][a-zA-Z0-9]+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'path')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-parameter-snake-case":{"title":"Path Parameter Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/path-parameter-snake-case/","source":"default","description":"Path parameters MUST follow snake_case.","message":"{{property}} path parameter is not snake_case: {{error}}","severity":"info","given":"$..parameters[?(@.in == 'path')].name","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(_[a-z0-9]+)*$"}},"tags":["format:openapi","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-parameter-snake-case' (Path Parameter Snake Case). Requirement: Path parameters MUST follow snake_case. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(_[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'path')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-params":{"title":"Path Params","reference":"https://spotlight-rules.com/spec/rules/openapi/path-params/","source":"builtin","description":"Path parameters must be defined and valid.","message":"{{error}}","severity":"info","given":"$.paths","then":{"function":"oasPathParam"},"tags":["format:openapi","spec:paths","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-params' (Path Params). Requirement: Path parameters must be defined and valid. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-params-declared-in-block":{"title":"Path Params Declared In Block","reference":"https://spotlight-rules.com/spec/rules/openapi/path-params-declared-in-block/","source":"compiled","description":"Check for the path parameter in the parameter block.","message":"{{error}}","severity":"info","given":"$.paths","then":{"function":"trimble:check-for-path-parameter"},"tags":["format:openapi","spec:paths","experience:consistency","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-params-declared-in-block' (Path Params Declared In Block). Requirement: Check for the path parameter in the parameter block. This rule is evaluated at the JSONPath `$.paths.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-require-query-parameter":{"title":"Path Require Query Parameter","reference":"https://spotlight-rules.com/spec/rules/openapi/path-require-query-parameter/","source":"compiled","description":"Check if the given resource path has queryparameter.","message":"{{error}}","severity":"info","given":"$.paths[*]~","then":{"function":"trimble:check-for-query-parameter-in-every-path"},"tags":["format:openapi","spec:paths","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-require-query-parameter' (Path Require Query Parameter). Requirement: Check if the given resource path has queryparameter. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-require-tracing-header":{"title":"Path Require Tracing Header","reference":"https://spotlight-rules.com/spec/rules/openapi/path-require-tracing-header/","source":"compiled","description":"MUST use b3 or w3c tracing [233a].","message":"Header X-B3-Traceid, X-B3-Spanid or traceparent (w3c) missing","severity":"info","given":"$.paths.*","then":{"function":"baloise:validate-tracing"},"tags":["format:openapi","spec:paths","topic:tracing","experience:reliability","experience:governance","experience:observability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-require-tracing-header' (Path Require Tracing Header). Requirement: MUST use b3 or w3c tracing [233a]. This rule is evaluated at the JSONPath `$.paths.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-require-valid-http-verb":{"title":"Path Require Valid HTTP Verb","reference":"https://spotlight-rules.com/spec/rules/openapi/path-require-valid-http-verb/","source":"compiled","description":"All APIs MUST have a valid http verb.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"field":"@key","function":"trimble:does-spec-contains-valid-http-verbs"},"tags":["format:openapi","spec:paths","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-require-valid-http-verb' (Path Require Valid HTTP Verb). Requirement: All APIs MUST have a valid http verb. This rule is evaluated at the JSONPath `$.paths.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-resources-plural":{"title":"Path Resources Plural","reference":"https://spotlight-rules.com/spec/rules/openapi/path-resources-plural/","source":"compiled","description":"Resource names in paths should use plural nouns to maintain consistency and follow REST conventions for collection-oriented resource design.","message":"Path Resources Should Be Plural","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"match":"^(/[a-z].*s(/\\{[^}]+\\})?)*$"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-resources-plural' (Path Resources Plural). Requirement: Resource names in paths should use plural nouns to maintain consistency and follow REST conventions for collection-oriented resource design. To fix: Ensure the targeted value matches the regular expression `^(/[a-z].*s(/\\{[^}]+\\})?)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-segment-kebab-case":{"title":"Path Segment Kebab Case","reference":"https://spotlight-rules.com/spec/rules/openapi/path-segment-kebab-case/","source":"compiled","description":"All YAML/JSON paths MUST follow kebab-case.","message":"{{property}} is not kebab-case: {{error}}","severity":"info","given":"$.paths[*]~","then":{"function":"pattern","functionOptions":{"match":"^/([a-z0-9]+(-[a-z0-9]+)*)?(/[a-z0-9]+(-[a-z0-9]+)*|/{.+})*$"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-segment-kebab-case' (Path Segment Kebab Case). Requirement: All YAML/JSON paths MUST follow kebab-case. To fix: Ensure the targeted value matches the regular expression `^/([a-z0-9]+(-[a-z0-9]+)*)?(/[a-z0-9]+(-[a-z0-9]+)*|/{.+})*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-success-response-require-description":{"title":"Path Success Response Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/path-success-response-require-description/","source":"compiled","description":"Check if the response description is appropriate for all requests.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"trimble:check-description-for-all-success-responses"},"tags":["format:openapi","spec:paths","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-success-response-require-description' (Path Success Response Require Description). Requirement: Check if the response description is appropriate for all requests. This rule is evaluated at the JSONPath `$.paths.*.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-uri-versioning-single-version":{"title":"Path URI Versioning Single Version","reference":"https://spotlight-rules.com/spec/rules/openapi/path-uri-versioning-single-version/","source":"compiled","description":"CAN use correct URI versioning [115a].","message":"Path can contain correct URI versioning","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"match":"^((?!.*\\/v\\d+(\\/.*)?\\/v\\d+)\\/.*)$"}},"tags":["format:openapi","spec:paths","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-uri-versioning-single-version' (Path URI Versioning Single Version). Requirement: CAN use correct URI versioning [115a]. To fix: Ensure the targeted value matches the regular expression `^((?!.*\\/v\\d+(\\/.*)?\\/v\\d+)\\/.*)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-use-standard-http-methods":{"title":"Path Use Standard HTTP Methods","reference":"https://spotlight-rules.com/spec/rules/openapi/path-use-standard-http-methods/","source":"compiled","description":"Operations MUST use only the common HTTP methods as outlined in the standards guide, and must be in lower-case.","message":"Operations MUST use only the common HTTP methods as outlined in the standards guide, and must be in lower-case.","severity":"info","given":"$.paths[*].*~","then":{"field":"method","function":"enumeration","functionOptions":{"values":["get","post","put","patch","delete","head","options"]}},"tags":["format:openapi","spec:paths","experience:consistency","experience:naming"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-use-standard-http-methods' (Path Use Standard HTTP Methods). Requirement: Operations MUST use only the common HTTP methods as outlined in the standards guide, and must be in lower-case. To fix: Set `method` to one of the allowed values: get, post, put, patch, delete, head, options. This rule is evaluated at the JSONPath `$.paths[*].*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-write-response-support-json":{"title":"Path Write Response Support JSON","reference":"https://spotlight-rules.com/spec/rules/openapi/path-write-response-support-json/","source":"compiled","description":"All APIs returning structured data SHOULD support JSON as the default format.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"trimble:check-if-application-or-json-in-put-and-post-response"},"tags":["format:openapi","spec:paths","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-write-response-support-json' (Path Write Response Support JSON). Requirement: All APIs returning structured data SHOULD support JSON as the default format. This rule is evaluated at the JSONPath `$.paths.*.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-body-must-use-json-content-type":{"title":"Request Body Must Use JSON Content Type","reference":"https://spotlight-rules.com/spec/rules/openapi/request-body-must-use-json-content-type/","source":"compiled","description":"Request bodies should use application/json as the primary content type for consistency across API operations and client implementations.","message":"Request Body MUST Use application/json Content Type","severity":"info","given":"$.paths.*[post,put,patch].requestBody.content","then":{"field":"application/json","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","spec:media-types","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-body-must-use-json-content-type' (Request Body Must Use JSON Content Type). Requirement: Request bodies should use application/json as the primary content type for consistency across API operations and client implementations. To fix: Ensure `application/json` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[post,put,patch].requestBody.content` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-content-require-examples":{"title":"Request Content Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/request-content-require-examples/","source":"compiled","description":"Request with content must have examples.","message":"Request with content must have examples","severity":"info","given":"$.paths..requestBody..content.*","then":{"field":"examples","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-content-require-examples' (Request Content Require Examples). Requirement: Request with content must have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths..requestBody..content.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-delete-must-not-have-body":{"title":"Request Delete Must Not Have Body","reference":"https://spotlight-rules.com/spec/rules/openapi/request-delete-must-not-have-body/","source":"compiled","description":"DELETE operations must not accept a request body.","message":"DELETE operations must not accept a request body.","severity":"info","given":"$.paths[*].delete.requestBody","then":{"function":"undefined"},"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-delete-must-not-have-body' (Request Delete Must Not Have Body). Requirement: DELETE operations must not accept a request body. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `$.paths[*].delete.requestBody` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-delete-no-body":{"title":"Request Delete No Body","reference":"https://spotlight-rules.com/spec/rules/openapi/request-delete-no-body/","source":"compiled","description":"DELETE requests MUST NOT have a request body.","message":"DELETE requests MUST NOT have a request body.","severity":"info","given":"$.paths[*].delete.requestBody","then":{"function":"falsy","message":"{{description}}: {{error}}"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-delete-no-body' (Request Delete No Body). Requirement: DELETE requests MUST NOT have a request body. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths[*].delete.requestBody` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-get-must-not-have-body":{"title":"Request Get Must Not Have Body","reference":"https://spotlight-rules.com/spec/rules/openapi/request-get-must-not-have-body/","source":"compiled","description":"A `GET` request MUST NOT accept a request body.","message":"A `GET` request MUST NOT accept a request body.","severity":"info","given":"$.paths[*][get].requestBody","then":{"function":"undefined"},"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-get-must-not-have-body' (Request Get Must Not Have Body). Requirement: A `GET` request MUST NOT accept a request body. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `$.paths[*][get].requestBody` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-get-no-body":{"title":"Request Get No Body","reference":"https://spotlight-rules.com/spec/rules/openapi/request-get-no-body/","source":"compiled","description":"GET requests MUST NOT have a request body.","message":"GET requests MUST NOT have a request body.","severity":"info","given":"$.paths[*].get.requestBody","then":{"function":"falsy","message":"{{description}}: {{error}}"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-get-no-body' (Request Get No Body). Requirement: GET requests MUST NOT have a request body. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.requestBody` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-head-must-not-have-body":{"title":"Request Head Must Not Have Body","reference":"https://spotlight-rules.com/spec/rules/openapi/request-head-must-not-have-body/","source":"compiled","description":"A `HEAD` request MUST NOT accept a request body.","message":"A `HEAD` request MUST NOT accept a request body.","severity":"info","given":"$.paths[*][head].requestBody","then":{"function":"undefined"},"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-head-must-not-have-body' (Request Head Must Not Have Body). Requirement: A `HEAD` request MUST NOT accept a request body. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `$.paths[*][head].requestBody` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-header-names-pascal-case":{"title":"Request Header Names Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/request-header-names-pascal-case/","source":"compiled","description":"Headers should be pascal-case. See Italian recommendation RAC_REST_NAME_003.","message":"{{value}} {{error}} in {{path}}","severity":"info","given":["$.[parameters][?(@.in==\"header\")].name"],"then":{"function":"casing","functionOptions":{"type":"pascal","separator":{"char":"-"}}},"tags":["format:openapi","spec:parameters","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-header-names-pascal-case' (Request Header Names Pascal Case). Requirement: Headers should be pascal-case. See Italian recommendation RAC_REST_NAME_003. To fix: Rename the targeted key or value to PascalCase (e.g. `UserName`) at each matching location, updating every reference to it. This rule is evaluated at the JSONPath `$.[parameters][?(@.in==\"header\")].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-options-must-not-have-body":{"title":"Request Options Must Not Have Body","reference":"https://spotlight-rules.com/spec/rules/openapi/request-options-must-not-have-body/","source":"compiled","description":"An `OPTIONS` request MUST NOT accept a request body.","message":"An `OPTIONS` request MUST NOT accept a request body.","severity":"info","given":"$.paths[*][options].requestBody","then":{"function":"undefined"},"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-options-must-not-have-body' (Request Options Must Not Have Body). Requirement: An `OPTIONS` request MUST NOT accept a request body. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `$.paths[*][options].requestBody` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-patch-media-type-not-plain-json":{"title":"Request Patch Media Type Not Plain JSON","reference":"https://spotlight-rules.com/spec/rules/openapi/request-patch-media-type-not-plain-json/","source":"compiled","description":"The PATCH specification explicits that the request body contains a \"patch document\" describing the changes to be applied to the target resource. To avoid confusion, [this errata](https://www.rfc-editor.org/errata/eid3169) explains that `application/json` is not an appropriate media-type for `PATCH`. A correct example of PATCH using eg. `application/json-patch+json` media-type defined in RFC6902. ``` paths: /books/{book_id}: patch: requestBody: content: application/json-patch+json: schema: type: object example: [{ \"op\": \"add\", \"path\": \"/baz\", \"value\": \"qux\" }] ```.","message":"application/json is not an appropriate media-type for PATCH. {{path}}","severity":"info","given":"$.[patch][requestBody][content]","then":{"field":"application/json","function":"falsy"},"formats":["oas3"],"tags":["format:openapi","spec:operations","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-patch-media-type-not-plain-json' (Request Patch Media Type Not Plain JSON). Requirement: The PATCH specification explicits that the request body contains a \"patch document\" describing the changes to be applied to the target resource. To avoid confusion, [this errata](https://www.rfc-editor.org/errata/eid3169) explains that `application/json` is not an appropriate media-type for `PATCH`. A correct example of PATCH using eg. `application/json-patch+json` media-type defined in RFC6902. ``` paths: /books/{book_id}: patch: requestBody: content: application/json-patch+json: schema: type: object example: [{ \"op\": \"add\", \"path\": \"/baz\", \"value\": \"qux\" }] ```. To fix: Ensure `application/json` is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.[patch][requestBody][content]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-post-collection-require-paging-object":{"title":"Request Post Collection Require Paging Object","reference":"https://spotlight-rules.com/spec/rules/openapi/request-post-collection-require-paging-object/","source":"compiled","description":"POST collection endpoints MUST have a request body schema that includes paging parameters.","message":"POST collection endpoints MUST have a request body schema that includes paging parameters.","severity":"info","given":"$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}$/))].post.requestBody.content.application/json.schema.properties.paging","then":{"field":"type","function":"pattern","functionOptions":{"match":"object"}},"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","spec:media-types","spec:schemas","topic:pagination","experience:pagination","experience:data-modeling","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-post-collection-require-paging-object' (Request Post Collection Require Paging Object). Requirement: POST collection endpoints MUST have a request body schema that includes paging parameters. To fix: Ensure `type` matches the regular expression `object`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}$/))].post.requestBody.content.application/json.schema.properties.paging` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-property-names-camel-case":{"title":"Request Property Names Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/request-property-names-camel-case/","source":"compiled","description":"MUST property names must be ASCII camelCase [118a].","message":"Property name has to be ASCII camelCase","severity":"info","given":"$.paths.*.*[responses,requestBody]..content..schema..properties.*~","then":{"function":"pattern","functionOptions":{"match":"^[a-z]+((\\d)|([A-Z0-9][a-z0-9]+))*([A-Z])?$"}},"tags":["format:openapi","spec:paths","spec:request-body","spec:responses","spec:media-types","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-property-names-camel-case' (Request Property Names Camel Case). Requirement: MUST property names must be ASCII camelCase [118a]. To fix: Ensure the targeted value matches the regular expression `^[a-z]+((\\d)|([A-Z0-9][a-z0-9]+))*([A-Z])?$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*.*[responses,requestBody]..content..schema..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-accept-encoding":{"title":"Request Support Accept Encoding","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-accept-encoding/","source":"spotlight","description":"Operations should accept an Accept-Encoding request header so clients can negotiate a compressed (e.g. gzip) response.","message":"Operation should accept an Accept-Encoding header.","given":"$.paths[*][get,post,put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"const":"Accept-Encoding"},"in":{"const":"header"}}}}}},"tags":["format:openapi","spec:parameters","topic:content-negotiation","experience:usability","experience:reliability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-accept-encoding' (Request Support Accept Encoding). Requirement: Operations should accept an Accept-Encoding request header so clients can negotiate a compressed (e.g. gzip) response. To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-accept-language":{"title":"Request Support Accept Language","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-accept-language/","source":"spotlight","description":"Operations should accept an Accept-Language request header so clients can negotiate a localized response (i18n).","message":"Operation should accept an Accept-Language header.","given":"$.paths[*][get,post,put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"const":"Accept-Language"},"in":{"const":"header"}}}}}},"tags":["format:openapi","spec:parameters","topic:content-negotiation","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-accept-language' (Request Support Accept Language). Requirement: Operations should accept an Accept-Language request header so clients can negotiate a localized response (i18n). To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-baggage":{"title":"Request Support Baggage","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-baggage/","source":"spotlight","description":"Operations should accept a baggage request header (W3C Baggage / OpenTelemetry) so application-defined context propagates across services.","message":"Operation should accept a `baggage` request header.","given":"$.paths[*][get,post,put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"const":"baggage"},"in":{"const":"header"}}}}}},"tags":["format:openapi","spec:parameters","topic:tracing","experience:reliability","experience:usability","experience:observability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-baggage' (Request Support Baggage). Requirement: Operations should accept a baggage request header (W3C Baggage / OpenTelemetry) so application-defined context propagates across services. To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `baggage` request header. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-correlation-id":{"title":"Request Support Correlation ID","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-correlation-id/","source":"spotlight","description":"Operations should accept a correlation / request ID request header (e.g. Correlation-Id or X-Request-Id) so a caller-supplied id can be traced end to end.","message":"Operation should accept a `Correlation-Id` request header.","given":"$.paths[*][get,post,put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"pattern":"^([Xx]-)?([Cc]orrelation|[Rr]equest)-[Ii][Dd]$"},"in":{"const":"header"}}}}}},"tags":["format:openapi","spec:parameters","topic:tracing","experience:reliability","experience:usability","experience:observability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-correlation-id' (Request Support Correlation ID). Requirement: Operations should accept a correlation / request ID request header (e.g. Correlation-Id or X-Request-Id) so a caller-supplied id can be traced end to end. To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `Correlation-Id` request header. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-form-urlencoded-media-type":{"title":"Request Support Form Urlencoded Media Type","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-form-urlencoded-media-type/","source":"default","description":"Every request MUST support `application/x-www-form-urlencoded` media type.","message":"{{description}}: {{error}}","severity":"info","given":"$.paths.[*].requestBody.content[?(@property.indexOf('urlencoded') === -1)]^","then":{"function":"falsy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-form-urlencoded-media-type' (Request Support Form Urlencoded Media Type). Requirement: Every request MUST support `application/x-www-form-urlencoded` media type. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.[*].requestBody.content[?(@property.indexOf('urlencoded') === -1)]^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-json-media-type":{"title":"Request Support JSON Media Type","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-json-media-type/","source":"compiled","description":"Every request MUST support `application/json` media type.","message":"{{description}}: {{error}}","severity":"info","given":"$.paths.[*].requestBody.content[?(@property.indexOf('json') === -1)]^","then":{"function":"falsy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-json-media-type' (Request Support JSON Media Type). Requirement: Every request MUST support `application/json` media type. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.[*].requestBody.content[?(@property.indexOf('json') === -1)]^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-json-media-type-2":{"title":"Request Support JSON Media Type 2","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-json-media-type-2/","source":"compiled","description":"Every request MUST support `application/json` media type.","message":"Every request MUST support `application/json` media type.","severity":"info","given":"$.paths[*][*].requestBody.content","then":{"function":"schema","functionOptions":{"schema":{"type":"object","properties":{"application/json":true},"required":["application/json"]}}},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-json-media-type-2' (Request Support JSON Media Type 2). Requirement: Every request MUST support `application/json` media type. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][*].requestBody.content` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-multipart-media-type":{"title":"Request Support Multipart Media Type","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-multipart-media-type/","source":"default","description":"Every request MUST support `multipart/form-data` media type.","message":"{{description}}: {{error}}","severity":"info","given":"$.paths.[*].requestBody.content[?(@property.indexOf('multipart') === -1)]^","then":{"function":"falsy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-multipart-media-type' (Request Support Multipart Media Type). Requirement: Every request MUST support `multipart/form-data` media type. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.[*].requestBody.content[?(@property.indexOf('multipart') === -1)]^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-text-plain-media-type":{"title":"Request Support Text Plain Media Type","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-text-plain-media-type/","source":"default","description":"Every request MUST support `text/plain` media type.","message":"{{description}}: {{error}}","severity":"info","given":"$.paths.[*].requestBody.content[?(@property.indexOf('plain') === -1)]^","then":{"function":"falsy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-text-plain-media-type' (Request Support Text Plain Media Type). Requirement: Every request MUST support `text/plain` media type. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.[*].requestBody.content[?(@property.indexOf('plain') === -1)]^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-tracestate":{"title":"Request Support Tracestate","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-tracestate/","source":"spotlight","description":"Operations should accept a tracestate request header (W3C Trace Context) so vendor-specific trace state propagates alongside traceparent.","message":"Operation should accept a `tracestate` request header.","given":"$.paths[*][get,post,put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"const":"tracestate"},"in":{"const":"header"}}}}}},"tags":["format:openapi","spec:parameters","topic:tracing","experience:reliability","experience:usability","experience:observability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-tracestate' (Request Support Tracestate). Requirement: Operations should accept a tracestate request header (W3C Trace Context) so vendor-specific trace state propagates alongside traceparent. To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `tracestate` request header. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-xml-media-type":{"title":"Request Support XML Media Type","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-xml-media-type/","source":"default","description":"Every request MUST support `application/xml` media type.","message":"{{description}}: {{error}}","severity":"info","given":"$.paths.[*].requestBody.content[?(@property.indexOf('xml') === -1)]^","then":{"function":"falsy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-xml-media-type' (Request Support XML Media Type). Requirement: Every request MUST support `application/xml` media type. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.[*].requestBody.content[?(@property.indexOf('xml') === -1)]^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-202-location-header":{"title":"Response 202 Location Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-202-location-header/","source":"spotlight","description":"202 Accepted responses should document a Location header pointing at the status or result resource clients can poll for the long-running operation.","message":"202 Accepted responses should document a Location header.","given":"$.paths[*][*].responses['202'].headers","severity":"info","then":{"field":"Location","function":"truthy"},"tags":["format:openapi","spec:responses","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-202-location-header' (Response 202 Location Header). Requirement: 202 Accepted responses should document a Location header pointing at the status or result resource clients can poll for the long-running operation. To fix: Ensure `Location` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][*].responses['202'].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-202-retry-after":{"title":"Response 202 Retry After","reference":"https://spotlight-rules.com/spec/rules/openapi/response-202-retry-after/","source":"spotlight","description":"202 Accepted responses should document a Retry-After header suggesting how long clients should wait before polling the status resource.","message":"202 Accepted responses should document a Retry-After header.","given":"$.paths[*][*].responses['202'].headers","severity":"info","then":{"field":"Retry-After","function":"truthy"},"tags":["format:openapi","spec:responses","topic:rate-limiting","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-202-retry-after' (Response 202 Retry After). Requirement: 202 Accepted responses should document a Retry-After header suggesting how long clients should wait before polling the status resource. To fix: Ensure `Retry-After` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][*].responses['202'].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-206-require-content-range":{"title":"Response 206 Require Content Range","reference":"https://spotlight-rules.com/spec/rules/openapi/response-206-require-content-range/","source":"compiled","description":"Check if the get response code 206 has content-type and content-range.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"trimble:check-content-type-for-206-get-response-code"},"tags":["format:openapi","spec:paths","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-206-require-content-range' (Response 206 Require Content Range). Requirement: Check if the get response code 206 has content-type and content-range. This rule is evaluated at the JSONPath `$.paths.*.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-400-require-body":{"title":"Response 400 Require Body","reference":"https://spotlight-rules.com/spec/rules/openapi/response-400-require-body/","source":"compiled","description":"All 400 responses must include a response body.","message":"All 400 responses must include a response body.","severity":"info","given":["$.paths.*.*.responses['400']"],"then":{"field":"content","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-400-require-body' (Response 400 Require Body). Requirement: All 400 responses must include a response body. To fix: Ensure `content` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.*.responses['400']` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-body-must-be-object":{"title":"Response Body Must Be Object","reference":"https://spotlight-rules.com/spec/rules/openapi/response-body-must-be-object/","source":"compiled","description":"Response bodies must be an object type.","message":"Response bodies must be an object type.","severity":"info","given":"$.paths[*][*].responses[*].content.application/json.schema.type","then":{"function":"pattern","functionOptions":{"match":"object"}},"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-body-must-be-object' (Response Body Must Be Object). Requirement: Response bodies must be an object type. To fix: Ensure the targeted value matches the regular expression `object`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*].content.application/json.schema.type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-cache-header-no-conflict":{"title":"Response Cache Header No Conflict","reference":"https://spotlight-rules.com/spec/rules/openapi/response-cache-header-no-conflict/","source":"compiled","description":"Cache usage SHOULD be extensively detailed in the `description` property to avoid data leaks or the usage of stale data. This rule should ensure in some way that the api provider documented extensively the cache usage to avoid data leaks or usage of stale data. For now this ruleset tests: * the presence of following keywords in the `description`: `max-age`, `private`, `no-store`, `no-cache`. * that one and only one between Expires and Cache-Control is used. `Cache-Control` and `Expires` should not be used in conjuction, because `Cache-Control` overrides `Expires` when `max-age` is set. Instead if neither `Cache-Control` or `Expires` are set, clients MAY use euristic cache like described in RFC7234.","message":"{{error}}","severity":"info","given":"$.[responses][?(@property[0] == \"2\" )][headers]","then":[{"function":"xor","functionOptions":{"properties":["Expires","Cache-Control"]}}],"formats":["oas3"],"tags":["format:openapi","spec:responses","spec:headers","topic:caching","experience:reliability","experience:consistency","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-cache-header-no-conflict' (Response Cache Header No Conflict). Requirement: Cache usage SHOULD be extensively detailed in the `description` property to avoid data leaks or the usage of stale data. This rule should ensure in some way that the api provider documented extensively the cache usage to avoid data leaks or usage of stale data. For now this ruleset tests: * the presence of following keywords in the `description`: `max-age`, `private`, `no-store`, `no-cache`. * that one and only one between Expires and Cache-Control is used. `Cache-Control` and `Expires` should not be used in conjuction, because `Cache-Control` overrides `Expires` when `max-age` is set. Instead if neither `Cache-Control` or `Expires` are set, clients MAY use euristic cache like described in RFC7234. To fix: Include exactly one of: Expires, Cache-Control. This rule is evaluated at the JSONPath `$.[responses][?(@property[0] == \"2\" )][headers]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-code-must-be-valid":{"title":"Response Code Must Be Valid","reference":"https://spotlight-rules.com/spec/rules/openapi/response-code-must-be-valid/","source":"compiled","description":"All APIs should return a valid http response code.","message":"{{error}}","severity":"info","given":"$..responses","then":{"field":"@key","function":"trimble:valid-http-response"},"tags":["format:openapi","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-code-must-be-valid' (Response Code Must Be Valid). Requirement: All APIs should return a valid http response code. This rule is evaluated at the JSONPath `$..responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-collection-require-results-array":{"title":"Response Collection Require Results Array","reference":"https://spotlight-rules.com/spec/rules/openapi/response-collection-require-results-array/","source":"compiled","description":"Response bodies must have a root element called results and is an array of objects.","message":"Response bodies must have a root element called results and is an array of objects.","severity":"info","given":"$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}$/))].get.responses['200'].content.application/json.schema.properties.results","then":[{"field":"type","function":"pattern","functionOptions":{"match":"array"}},{"field":"items.type","function":"pattern","functionOptions":{"match":"object"}}],"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","spec:schemas","topic:pagination","experience:pagination","experience:data-modeling","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-collection-require-results-array' (Response Collection Require Results Array). Requirement: Response bodies must have a root element called results and is an array of objects. To fix: Ensure `type` matches the regular expression `array`; rewrite any value that does not. Also: Ensure `items.type` matches the regular expression `object`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}$/))].get.responses['200'].content.application/json.schema.properties.results` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-collection-support-paging":{"title":"Response Collection Support Paging","reference":"https://spotlight-rules.com/spec/rules/openapi/response-collection-support-paging/","source":"compiled","description":"Response bodies from collection endpoints SHOULD offer paging capability.","message":"Response bodies from collection endpoints SHOULD offer paging capability.","severity":"info","given":"$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}.*$/))].get.responses['200'].content.application/json.schema.properties","then":[{"field":"paging","function":"truthy"},{"field":"paging","function":"pattern","functionOptions":{"match":"object"}},{"field":"paging.type","function":"pattern","functionOptions":{"match":"object"}}],"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","spec:schemas","topic:pagination","experience:pagination","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-collection-support-paging' (Response Collection Support Paging). Requirement: Response bodies from collection endpoints SHOULD offer paging capability. To fix: Ensure `paging` is present and non-empty at each matching location. Also: Ensure `paging` matches the regular expression `object`; rewrite any value that does not. Also: Ensure `paging.type` matches the regular expression `object`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}.*$/))].get.responses['200'].content.application/json.schema.properties` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-content-require-examples":{"title":"Response Content Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/response-content-require-examples/","source":"compiled","description":"Response with content must have examples.","message":"Response with content must have examples","severity":"info","given":"$.paths..responses..content.*","then":{"field":"examples","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-content-require-examples' (Response Content Require Examples). Requirement: Response with content must have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths..responses..content.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-cors-allow-origin-no-wildcard":{"title":"Response CORS Allow Origin No Wildcard","reference":"https://spotlight-rules.com/spec/rules/openapi/response-cors-allow-origin-no-wildcard/","source":"spotlight","description":"If an Access-Control-Allow-Origin response header is documented, it should not hard-code a wildcard (*) — reflect specific allowed origins instead, especially for authenticated APIs (OWASP API8 security misconfiguration). Note: the project treats CORS as operational (see no-operational-headers-in-spec); this is a defensive check for specs that do document it.","message":"Access-Control-Allow-Origin should not be a wildcard (*).","given":"$..responses.*.headers['Access-Control-Allow-Origin'].schema","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"not":{"anyOf":[{"required":["const"],"properties":{"const":{"const":"*"}}},{"required":["default"],"properties":{"default":{"const":"*"}}},{"required":["example"],"properties":{"example":{"const":"*"}}}]}}}},"tags":["format:openapi","spec:responses","topic:cors","experience:security","owasp:api8"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-cors-allow-origin-no-wildcard' (Response CORS Allow Origin No Wildcard). Requirement: If an Access-Control-Allow-Origin response header is documented, it should not hard-code a wildcard (*) — reflect specific allowed origins instead, especially for authenticated APIs (OWASP API8 security misconfiguration). Note: the project treats CORS as operational (see no-operational-headers-in-spec); this is a defensive check for specs that do document it. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$..responses.*.headers['Access-Control-Allow-Origin'].schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-custom-header-naming-format":{"title":"Response Custom Header Naming Format","reference":"https://spotlight-rules.com/spec/rules/openapi/response-custom-header-naming-format/","source":"compiled","description":"Custom headers MUST NOT be longer than 50 chars, and MUST only contain alphanumeric and dash chars, and MUST begin with Sps- not X-.","message":"Custom headers MUST NOT be longer than 50 chars, and MUST only contain alphanumeric and dash chars, and MUST begin with Sps- not X-.","severity":"info","given":"$.paths[*][*].responses[*].headers.*~","then":{"function":"pattern","functionOptions":{"match":"^(Sps-[a-zA-Z0-9-]{1,50}|Accept|Access-Control.*|Authorization|Cache-Control|Content-Disposition|Content-Language|Content-Length|Content-Type|Date|ETag|Host|If-Match|If-None-Match|Location|Origin|User-Agent)$"}},"tags":["format:openapi","spec:paths","spec:responses","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-custom-header-naming-format' (Response Custom Header Naming Format). Requirement: Custom headers MUST NOT be longer than 50 chars, and MUST only contain alphanumeric and dash chars, and MUST begin with Sps- not X-. To fix: Ensure the targeted value matches the regular expression `^(Sps-[a-zA-Z0-9-]{1,50}|Accept|Access-Control.*|Authorization|Cache-Control|Content-Disposition|Content-Language|Content-Length|Content-Type|Date|ETag|Host|If-Match|If-None-Match|Location|Origin|User-Agent)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*].headers.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-default-content-language-en-us":{"title":"Response Default Content Language En Us","reference":"https://spotlight-rules.com/spec/rules/openapi/response-default-content-language-en-us/","source":"compiled","description":"Content-Language is optional but MUST default locale to en-US when none provided.","message":"Content-Language is optional but MUST default locale to en-US when none provided.","severity":"info","given":"$.paths[*][*].responses[*].headers.Content-Language.schema.default","then":{"function":"pattern","functionOptions":{"match":"en-US"}},"tags":["format:openapi","spec:paths","spec:responses","spec:headers","spec:media-types","spec:schemas","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-default-content-language-en-us' (Response Default Content Language En Us). Requirement: Content-Language is optional but MUST default locale to en-US when none provided. To fix: Ensure the targeted value matches the regular expression `en-US`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*].headers.Content-Language.schema.default` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-define-401":{"title":"Response Define 401","reference":"https://spotlight-rules.com/spec/rules/openapi/response-define-401/","source":"compiled","description":"Responses should contain common response - 401 (unauthorized).","message":"{{description}}. Missing {{property}}","severity":"info","given":"$.paths..responses","then":{"field":"401","function":"truthy"},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-define-401' (Response Define 401). Requirement: Responses should contain common response - 401 (unauthorized). To fix: Ensure `401` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths..responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-define-404":{"title":"Response Define 404","reference":"https://spotlight-rules.com/spec/rules/openapi/response-define-404/","source":"compiled","description":"Responses should contain common response - 404 (not found).","message":"{{description}}. Missing {{property}}","severity":"info","given":"$.paths[?(@property.match(/.*\\/{.*}.*/))]..responses","then":{"field":"404","function":"truthy"},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-define-404' (Response Define 404). Requirement: Responses should contain common response - 404 (not found). To fix: Ensure `404` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[?(@property.match(/.*\\/{.*}.*/))]..responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-define-429":{"title":"Response Define 429","reference":"https://spotlight-rules.com/spec/rules/openapi/response-define-429/","source":"compiled","description":"Responses should contain common response - 429 (too many requests).","message":"{{description}}. Missing {{property}}","severity":"info","given":"$.paths..responses","then":{"field":"429","function":"truthy"},"tags":["format:openapi","spec:paths","spec:responses","topic:rate-limiting","experience:error-handling","experience:reliability","experience:performance","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-define-429' (Response Define 429). Requirement: Responses should contain common response - 429 (too many requests). To fix: Ensure `429` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths..responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-define-500":{"title":"Response Define 500","reference":"https://spotlight-rules.com/spec/rules/openapi/response-define-500/","source":"compiled","description":"Responses should contain common response - 500 (server error).","message":"{{description}}. Missing {{property}}","severity":"info","given":"$.paths..responses","then":{"field":"500","function":"truthy"},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-define-500' (Response Define 500). Requirement: Responses should contain common response - 500 (server error). To fix: Ensure `500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths..responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-404-use-schema-ref":{"title":"Response Delete 404 Use Schema Ref","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-404-use-schema-ref/","source":"compiled","description":"DELETE 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response.","message":"DELETE 404 Responses MUST Use Schema Reference","severity":"info","given":"$.paths.*.delete.responses.404","then":{"field":"$ref","function":"falsy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-404-use-schema-ref' (Response Delete 404 Use Schema Ref). Requirement: DELETE 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response. To fix: Ensure `$ref` is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.*.delete.responses.404` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-codes-allowed":{"title":"Response Delete Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-codes-allowed/","source":"compiled","description":"DELETE operations should not return 200 or 201 status codes.","message":"DELETE operations should not return 200 or 201 status codes.","severity":"info","given":"$.paths[*].delete.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^(200|201)$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-codes-allowed' (Response Delete Codes Allowed). Requirement: DELETE operations should not return 200 or 201 status codes. To fix: Ensure `@key` does NOT match the regular expression `^(200|201)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].delete.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-define-204":{"title":"Response Delete Define 204","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-define-204/","source":"compiled","description":"DELETE responses should have a 204 success HTTP status codes, communicating a success created response to consumers.","message":"DELETE 204 Status Code","severity":"info","given":"$.paths.*.delete.responses","then":{"field":"204","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-define-204' (Response Delete Define 204). Requirement: DELETE responses should have a 204 success HTTP status codes, communicating a success created response to consumers. To fix: Ensure `204` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.delete.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-define-401":{"title":"Response Delete Define 401","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-define-401/","source":"compiled","description":"DELETE operations should define a 401 Unauthorized response to document authentication requirements for destructive operations.","message":"DELETE MUST Have 401 Response","severity":"info","given":"$.paths[*].delete.responses","then":{"field":"401","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:security","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-define-401' (Response Delete Define 401). Requirement: DELETE operations should define a 401 Unauthorized response to document authentication requirements for destructive operations. To fix: Ensure `401` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].delete.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-define-500":{"title":"Response Delete Define 500","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-define-500/","source":"compiled","description":"DELETE responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers.","message":"DELETE Responses MUST Have 500 Status Codes","severity":"info","given":"$.paths.*.delete.responses","then":{"field":"500","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-define-500' (Response Delete Define 500). Requirement: DELETE responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers. To fix: Ensure `500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.delete.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-must-not-return-body":{"title":"Response Delete Must Not Return Body","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-must-not-return-body/","source":"compiled","description":"DELETE operations must not have a response body.","message":"DELETE operations must not have a response body.","severity":"info","given":"$.paths.*.delete.responses[202,204].content","then":{"function":"falsy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-must-not-return-body' (Response Delete Must Not Return Body). Requirement: DELETE operations must not have a response body. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.*.delete.responses[202,204].content` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-require-204":{"title":"Response Delete Require 204","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-require-204/","source":"compiled","description":"All DELETE methods MUST have a 204 response.","message":"All DELETE methods MUST have a 204 response.","severity":"info","given":["$.paths[*].delete.responses"],"then":{"field":"204","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:consistency","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-require-204' (Response Delete Require 204). Requirement: All DELETE methods MUST have a 204 response. To fix: Ensure `204` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].delete.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-deprecated-operation-deprecation-header":{"title":"Response Deprecated Operation Deprecation Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-deprecated-operation-deprecation-header/","source":"spotlight","description":"Deprecated operations should document a Deprecation response header (RFC 9745) signalling that the resource is deprecated.","message":"Deprecated operation should document a Deprecation header.","given":"$.paths[*][?(@ && @.deprecated == true)].responses[*].headers","severity":"info","then":{"field":"Deprecation","function":"truthy"},"tags":["format:openapi","spec:responses","topic:deprecation","experience:versioning","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-deprecated-operation-deprecation-header' (Response Deprecated Operation Deprecation Header). Requirement: Deprecated operations should document a Deprecation response header (RFC 9745) signalling that the resource is deprecated. To fix: Ensure `Deprecation` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][?(@ && @.deprecated == true)].responses[*].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-deprecated-operation-sunset-header":{"title":"Response Deprecated Operation Sunset Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-deprecated-operation-sunset-header/","source":"spotlight","description":"Deprecated operations should document a Sunset response header (RFC 8594) telling clients when the operation will be removed.","message":"Deprecated operation should document a Sunset header.","given":"$.paths[*][?(@ && @.deprecated == true)].responses[*].headers","severity":"info","then":{"field":"Sunset","function":"truthy"},"tags":["format:openapi","spec:responses","topic:deprecation","experience:versioning","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-deprecated-operation-sunset-header' (Response Deprecated Operation Sunset Header). Requirement: Deprecated operations should document a Sunset response header (RFC 8594) telling clients when the operation will be removed. To fix: Ensure `Sunset` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][?(@ && @.deprecated == true)].responses[*].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-match-problem-schema":{"title":"Response Error Match Problem Schema","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-match-problem-schema/","source":"compiled","description":"WARN: This rule is under implementation and just provides an hint. Error management is a key enabler of a resilient API ecosystem. Enforcing a consistent schema for errors between different APIs, enables client to properly implement an error management strategy, with positive impacts for users. This rule inspects the schema returned by an error response and verifies whether it contains the main properties defined in RFC7807: `status`, `title` and `detail`. An example of a valid payload is ``` { \"title\": \"Not Found\", \"status\": 404, \"detail\": \"Book does not exist; id: 123\" } ``` See recommendation RAC_REST_NAME_007.","message":"Your schema doesn't seem to match RFC7807. Are you sure it is ok? {{path}}","severity":"info","given":"$.paths.[*].responses[?(@property.match(/^(4|5|default)/))][[schema]]","then":{"function":"schema","functionOptions":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"title":{"type":"string"},"detail":{"type":"string"}}}}},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","spec:schemas","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-match-problem-schema' (Response Error Match Problem Schema). Requirement: WARN: This rule is under implementation and just provides an hint. Error management is a key enabler of a resilient API ecosystem. Enforcing a consistent schema for errors between different APIs, enables client to properly implement an error management strategy, with positive impacts for users. This rule inspects the schema returned by an error response and verifies whether it contains the main properties defined in RFC7807: `status`, `title` and `detail`. An example of a valid payload is ``` { \"title\": \"Not Found\", \"status\": 404, \"detail\": \"Book does not exist; id: 123\" } ``` See recommendation RAC_REST_NAME_007. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths.[*].responses[?(@property.match(/^(4|5|default)/))][[schema]]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-require-description":{"title":"Response Error Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-require-description/","source":"compiled","description":"Check if the response description is appropriate for all requests.","message":"{{error}}","severity":"info","given":"$.paths.*.*.responses","then":{"function":"trimble:check-description-for-all-error-responses"},"tags":["format:openapi","spec:paths","spec:responses","experience:documentation","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-require-description' (Response Error Require Description). Requirement: Check if the response description is appropriate for all requests. This rule is evaluated at the JSONPath `$.paths.*.*.responses.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-schema-problem-property-names":{"title":"Response Error Schema Problem Property Names","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-schema-problem-property-names/","source":"compiled","description":"WARN: This rule is under implementation and just provides an hint. Error management is a key enabler of a resilient API ecosystem. Enforcing a consistent schema for errors between different APIs, enables client to properly implement an error management strategy, with positive impacts for users. Errors should return RFC7807 objects. Instead, this schema seems to use non standard properties such as: `message`, `msg` and `code`. An error of the following form ``` { \"msg\": \"Book with id: 123 does not exist.\", \"code\": 6063 } ``` can be expressed in RFC7807 with ``` { \"detail\": \"Book with id: 123 does not exist.\", \"type\": \"https://api.example/v1/errors/6063\", \"status\": 404, \"title\": \"Not Found\" } ``` Returning an URI in `type`, instead of an opaque `code` can help the client in better identifying the error; moreover the URI though it should not be dereferenced automatically, can return an actual resource providing guidance in addressing the issue. See recommendation RAC_REST_NAME_007.","message":"Error response doesn't seem to match RFC7807. Are you sure it is ok? {{path}}","severity":"info","given":"$.[responses][?(@property.match(/^(4|5|default)/))][[schema]][properties].*~","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"message|code|msg"}},"formats":["oas3"],"tags":["format:openapi","spec:responses","spec:schemas","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-schema-problem-property-names' (Response Error Schema Problem Property Names). Requirement: WARN: This rule is under implementation and just provides an hint. Error management is a key enabler of a resilient API ecosystem. Enforcing a consistent schema for errors between different APIs, enables client to properly implement an error management strategy, with positive impacts for users. Errors should return RFC7807 objects. Instead, this schema seems to use non standard properties such as: `message`, `msg` and `code`. An error of the following form ``` { \"msg\": \"Book with id: 123 does not exist.\", \"code\": 6063 } ``` can be expressed in RFC7807 with ``` { \"detail\": \"Book with id: 123 does not exist.\", \"type\": \"https://api.example/v1/errors/6063\", \"status\": 404, \"title\": \"Not Found\" } ``` Returning an URI in `type`, instead of an opaque `code` can help the client in better identifying the error; moreover the URI though it should not be dereferenced automatically, can return an actual resource providing guidance in addressing the issue. See recommendation RAC_REST_NAME_007. To fix: Ensure `@key` does NOT match the regular expression `message|code|msg`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.[responses][?(@property.match(/^(4|5|default)/))][[schema]][properties].*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-standard-payload":{"title":"Response Error Standard Payload","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-standard-payload/","source":"compiled","description":"All 4XX and 5XX response codes must follow Trimble API Standard.","message":"{{error}}","severity":"info","given":"$.paths.*.*.responses","then":{"function":"trimble:check-standard-for-error-payload"},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-standard-payload' (Response Error Standard Payload). Requirement: All 4XX and 5XX response codes must follow Trimble API Standard. This rule is evaluated at the JSONPath `$.paths.*.*.responses.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-use-problem-json":{"title":"Response Error Use Problem JSON","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-use-problem-json/","source":"default","description":"All 4xx and 5xx error responses MUST use the `application/problem+json` media type (RFC 7807).","message":"Error response documents MUST use the application/problem+json media type: {{error}}","severity":"info","given":"$.paths..responses[?( @property >= 400 && @property < 600)].content[*]~","then":{"function":"enumeration","functionOptions":{"values":["application/problem+json"]}},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:consistency","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-use-problem-json' (Response Error Use Problem JSON). Requirement: All 4xx and 5xx error responses MUST use the `application/problem+json` media type (RFC 7807). To fix: Set the targeted value to one of the allowed values: application/problem+json. This rule is evaluated at the JSONPath `$.paths..responses[?( @property >= 400 && @property < 600)].content[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-use-problem-type":{"title":"Response Error Use Problem Type","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-use-problem-type/","source":"compiled","description":"Error management is a key enabler of a resilient API ecosystem. Enforcing a consistent schema for errors between different APIs, enables client to properly implement an error management strategy, with positive impacts for users. Error responses should return one of the media-type defined in RFC7807: - `application/problem+json` - `application/problem+xml` An example of a valid response: ``` responses: \"503\": content: application/problem+json: schema: ... ```.","message":"Error responses should support RFC7807 in {{path}}.","severity":"info","given":"$.paths.[*].responses[?(@property.match(/^(4|5|default)/))].content.*~","then":{"function":"enumeration","functionOptions":{"values":["application/problem+xml","application/problem+json"]}},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-use-problem-type' (Response Error Use Problem Type). Requirement: Error management is a key enabler of a resilient API ecosystem. Enforcing a consistent schema for errors between different APIs, enables client to properly implement an error management strategy, with positive impacts for users. Error responses should return one of the media-type defined in RFC7807: - `application/problem+json` - `application/problem+xml` An example of a valid response: ``` responses: \"503\": content: application/problem+json: schema: ... ```. To fix: Set the targeted value to one of the allowed values: application/problem+xml, application/problem+json. This rule is evaluated at the JSONPath `$.paths.[*].responses[?(@property.match(/^(4|5|default)/))].content.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-use-problem-type-2":{"title":"Response Error Use Problem Type 2","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-use-problem-type-2/","source":"compiled","description":"Every error response SHOULD support RFC 7807.","message":"Every error response SHOULD support RFC 7807.","severity":"info","given":"$.paths...responses[?(@property.match(/^(4|5)/))].content.*~","then":{"function":"enumeration","functionOptions":{"values":["application/problem+xml","application/problem+json"]}},"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-use-problem-type-2' (Response Error Use Problem Type 2). Requirement: Every error response SHOULD support RFC 7807. To fix: Set the targeted value to one of the allowed values: application/problem+xml, application/problem+json. This rule is evaluated at the JSONPath `$.paths...responses[?(@property.match(/^(4|5)/))].content.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-cache-control":{"title":"Response Get Cache Control","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-cache-control/","source":"spotlight","description":"GET success responses should define a Cache-Control header so clients and intermediaries know how to cache the representation.","message":"GET success responses should define a `Cache-Control` header.","given":"$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers","severity":"info","then":{"field":"Cache-Control","function":"truthy"},"tags":["format:openapi","spec:responses","topic:caching","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-cache-control' (Response Get Cache Control). Requirement: GET success responses should define a Cache-Control header so clients and intermediaries know how to cache the representation. To fix: Ensure `Cache-Control` is present and non-empty at each matching location. Guidance: GET success responses should define a `Cache-Control` header. This rule is evaluated at the JSONPath `$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-codes-allowed":{"title":"Response Get Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-codes-allowed/","source":"compiled","description":"GET operations should not use status codes 201, 202, 204, 409, 412.","message":"GET operations should not use status codes 201, 202, 204, 409, 412.","severity":"info","given":"$.paths[*].get.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^(201|202|204|409|412)$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-codes-allowed' (Response Get Codes Allowed). Requirement: GET operations should not use status codes 201, 202, 204, 409, 412. To fix: Ensure `@key` does NOT match the regular expression `^(201|202|204|409|412)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].get.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-define-200":{"title":"Response Get Define 200","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-define-200/","source":"compiled","description":"GET responses should have a 200 success HTTP status codes, communicating a successful response to consumers.","message":"GET Responses MUST Have 200 Status Codes","severity":"info","given":"$.paths.*.get.responses","then":{"field":"200","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-define-200' (Response Get Define 200). Requirement: GET responses should have a 200 success HTTP status codes, communicating a successful response to consumers. To fix: Ensure `200` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.get.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-define-401":{"title":"Response Get Define 401","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-define-401/","source":"compiled","description":"GET operations should define a 401 Unauthorized response. Analysis of 773 specs shows 401 is the second most common response code with 4805 occurrences, confirming authentication errors must be documented.","message":"GET MUST Have 401 Response","severity":"info","given":"$.paths[*].get.responses","then":{"field":"401","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:security","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-define-401' (Response Get Define 401). Requirement: GET operations should define a 401 Unauthorized response. Analysis of 773 specs shows 401 is the second most common response code with 4805 occurrences, confirming authentication errors must be documented. To fix: Ensure `401` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-define-500":{"title":"Response Get Define 500","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-define-500/","source":"compiled","description":"GET responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers.","message":"GET Responses MUST Have 500 Status Code","severity":"info","given":"$.paths.*.get.responses","then":{"field":"500","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-define-500' (Response Get Define 500). Requirement: GET responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers. To fix: Ensure `500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.get.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-document-304-not-modified":{"title":"Response Get Document 304 Not Modified","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-document-304-not-modified/","source":"spotlight","description":"GET operations should document a 304 Not Modified response so ETag/Last-Modified conditional requests are handled.","message":"Operation should document a `304` response.","given":"$.paths[*][get].responses","severity":"info","then":{"field":"304","function":"truthy"},"tags":["format:openapi","spec:responses","topic:conditional-requests","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-document-304-not-modified' (Response Get Document 304 Not Modified). Requirement: GET operations should document a 304 Not Modified response so ETag/Last-Modified conditional requests are handled. To fix: Ensure `304` is present and non-empty at each matching location. Guidance: Operation should document a `304` response. This rule is evaluated at the JSONPath `$.paths[*][get].responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-etag":{"title":"Response Get ETag","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-etag/","source":"spotlight","description":"GET success responses should define an ETag header to enable validation-based caching and conditional requests.","message":"GET success responses should define a `ETag` header.","given":"$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers","severity":"info","then":{"field":"ETag","function":"truthy"},"tags":["format:openapi","spec:responses","topic:caching","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-etag' (Response Get ETag). Requirement: GET success responses should define an ETag header to enable validation-based caching and conditional requests. To fix: Ensure `ETag` is present and non-empty at each matching location. Guidance: GET success responses should define a `ETag` header. This rule is evaluated at the JSONPath `$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-last-modified":{"title":"Response Get Last Modified","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-last-modified/","source":"spotlight","description":"GET success responses should define a Last-Modified header to enable date-based conditional requests.","message":"GET success responses should define a `Last-Modified` header.","given":"$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers","severity":"info","then":{"field":"Last-Modified","function":"truthy"},"tags":["format:openapi","spec:responses","topic:caching","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-last-modified' (Response Get Last Modified). Requirement: GET success responses should define a Last-Modified header to enable date-based conditional requests. To fix: Ensure `Last-Modified` is present and non-empty at each matching location. Guidance: GET success responses should define a `Last-Modified` header. This rule is evaluated at the JSONPath `$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-link-header":{"title":"Response Get Link Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-link-header/","source":"spotlight","description":"GET success responses should provide a Link header (RFC 8288) with rel next/prev/first/last for pagination and navigation — the header-based alternative to an in-body paging object.","message":"GET responses should provide a Link header (RFC 8288) for pagination/navigation.","given":"$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers","severity":"info","then":{"field":"Link","function":"truthy"},"tags":["format:openapi","spec:responses","topic:pagination","experience:pagination","experience:discoverability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-link-header' (Response Get Link Header). Requirement: GET success responses should provide a Link header (RFC 8288) with rel next/prev/first/last for pagination and navigation — the header-based alternative to an in-body paging object. To fix: Ensure `Link` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-must-return-200":{"title":"Response Get Must Return 200","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-must-return-200/","source":"compiled","description":"GET operations must always return 200 status code.","message":"GET operations must always return 200 status code.","severity":"info","given":"$.paths[*].get.responses","then":[{"field":"200","function":"truthy"}],"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-must-return-200' (Response Get Must Return 200). Requirement: GET operations must always return 200 status code. To fix: Ensure `200` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-must-return-body":{"title":"Response Get Must Return Body","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-must-return-body/","source":"compiled","description":"A `GET` operation must return a response body.","message":"A `GET` operation must return a response body.","severity":"info","given":"$.paths[*].get.responses[*]","then":{"field":"content","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-must-return-body' (Response Get Must Return Body). Requirement: A `GET` operation must return a response body. To fix: Ensure `content` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.responses[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-vary":{"title":"Response Get Vary","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-vary/","source":"spotlight","description":"GET success responses should define a Vary header so caches key correctly on the request headers that affect the representation.","message":"GET success responses should define a `Vary` header.","given":"$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers","severity":"info","then":{"field":"Vary","function":"truthy"},"tags":["format:openapi","spec:responses","topic:caching","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-vary' (Response Get Vary). Requirement: GET success responses should define a Vary header so caches key correctly on the request headers that affect the representation. To fix: Ensure `Vary` is present and non-empty at each matching location. Guidance: GET success responses should define a `Vary` header. This rule is evaluated at the JSONPath `$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-head-codes-allowed":{"title":"Response Head Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-head-codes-allowed/","source":"compiled","description":"HEAD operations should not return 201, 202, 204, 409, 412 status codes.","message":"HEAD operations should not return 201, 202, 204, 409, 412 status codes.","severity":"info","given":"$.paths[*].head.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^(201|202|204|409|412)$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-head-codes-allowed' (Response Head Codes Allowed). Requirement: HEAD operations should not return 201, 202, 204, 409, 412 status codes. To fix: Ensure `@key` does NOT match the regular expression `^(201|202|204|409|412)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].head.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-head-must-not-return-body":{"title":"Response Head Must Not Return Body","reference":"https://spotlight-rules.com/spec/rules/openapi/response-head-must-not-return-body/","source":"compiled","description":"HEAD operations should not return a response body for success.","message":"HEAD operations should not return a response body for success.","severity":"info","given":"$.paths.*.head.responses[200].content","then":{"function":"falsy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-head-must-not-return-body' (Response Head Must Not Return Body). Requirement: HEAD operations should not return a response body for success. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.*.head.responses[200].content` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-header-names-pascal-case":{"title":"Response Header Names Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/response-header-names-pascal-case/","source":"compiled","description":"Headers should be pascal-case. See Italian recommendation RAC_REST_NAME_003.","message":"Header {{error}}: {{path}}","severity":"info","given":["$.[responses][*].headers.*~"],"then":{"function":"casing","functionOptions":{"type":"pascal","separator":{"char":"-"}}},"tags":["format:openapi","spec:responses","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-header-names-pascal-case' (Response Header Names Pascal Case). Requirement: Headers should be pascal-case. See Italian recommendation RAC_REST_NAME_003. To fix: Rename the targeted key or value to PascalCase (e.g. `UserName`) at each matching location, updating every reference to it. This rule is evaluated at the JSONPath `$.[responses][*].headers.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-header-no-x-prefix":{"title":"Response Header No X Prefix","reference":"https://spotlight-rules.com/spec/rules/openapi/response-header-no-x-prefix/","source":"compiled","description":"'HTTP' headers SHOULD NOT start with 'X-' RFC6648.","message":"HTTP response header SHOULD NOT start with 'X-' in {{path}}","severity":"info","given":["$.[responses][*].headers.*~"],"then":{"function":"pattern","functionOptions":{"match":"/^([^x]|.[^-])|RateLimit-/i"}},"tags":["format:openapi","spec:responses","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-header-no-x-prefix' (Response Header No X Prefix). Requirement: 'HTTP' headers SHOULD NOT start with 'X-' RFC6648. To fix: Ensure the targeted value matches the regular expression `/^([^x]|.[^-])|RateLimit-/i`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.[responses][*].headers.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-include-hypermedia-links":{"title":"Response Include Hypermedia Links","reference":"https://spotlight-rules.com/spec/rules/openapi/response-include-hypermedia-links/","source":"compiled","description":"The API contract MAY include hypermedia links to represent the state of resources and be navigable.","message":"{{description}}: {{error}}","severity":"info","given":"$.paths[*][*].responses[*]","then":{"field":"links","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","experience:discoverability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-include-hypermedia-links' (Response Include Hypermedia Links). Requirement: The API contract MAY include hypermedia links to represent the state of resources and be navigable. To fix: Ensure `links` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-include-ratelimit-header":{"title":"Response Include Ratelimit Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-include-ratelimit-header/","source":"compiled","description":"Response must include ratelimit-x headers.","message":"{{description}}; missing {{property}}","severity":"info","given":"$..responses.*","then":[{"field":"headers.ratelimit-limit","function":"truthy"},{"field":"headers.ratelimit-remaining","function":"truthy"},{"field":"headers.ratelimit-reset","function":"truthy"}],"tags":["format:openapi","spec:responses","topic:rate-limiting","experience:reliability","experience:documentation","experience:performance","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-include-ratelimit-header' (Response Include Ratelimit Header). Requirement: Response must include ratelimit-x headers. To fix: Ensure `headers.ratelimit-limit` is present and non-empty at each matching location. Also: Ensure `headers.ratelimit-remaining` is present and non-empty at each matching location. Also: Ensure `headers.ratelimit-reset` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..responses.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-keys-snake-case":{"title":"Response Keys Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/response-keys-snake-case/","source":"compiled","description":"response key must be snake cased (e.g. snake_case).","message":"{{error}}","severity":"info","given":"$.components['responses'].*~","then":{"function":"digitalocean:ensureSnakeCaseWithDigits"},"tags":["format:openapi","spec:responses","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-keys-snake-case' (Response Keys Snake Case). Requirement: response key must be snake cased (e.g. snake_case). This rule is evaluated at the JSONPath `$.components['responses'].*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-location-header-only-on-201":{"title":"Response Location Header Only On 201","reference":"https://spotlight-rules.com/spec/rules/openapi/response-location-header-only-on-201/","source":"compiled","description":"Location header MUST NOT be present in non-201 responses.","message":"Location header MUST NOT be present in non-201 responses.","severity":"info","given":"$.paths[*][*].responses[?(@property !== '201')].headers","then":{"field":"Location","function":"falsy"},"tags":["format:openapi","spec:paths","spec:responses","spec:headers","experience:consistency","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-location-header-only-on-201' (Response Location Header Only On 201). Requirement: Location header MUST NOT be present in non-201 responses. To fix: Ensure `Location` is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths[*][*].responses[?(@property !== '201')].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-must-use-json-content-type":{"title":"Response Must Use JSON Content Type","reference":"https://spotlight-rules.com/spec/rules/openapi/response-must-use-json-content-type/","source":"compiled","description":"API responses should use application/json as the primary content type. Analysis of 773 specs shows application/json is used by 92% of APIs, making it the universal standard for modern REST APIs.","message":"Response MUST Use application/json Content Type","severity":"info","given":"$.paths.*[get,post,put,patch,delete].responses[*].content","then":{"field":"application/json","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-must-use-json-content-type' (Response Must Use JSON Content Type). Requirement: API responses should use application/json as the primary content type. Analysis of 773 specs shows application/json is used by 92% of APIs, making it the universal standard for modern REST APIs. To fix: Ensure `application/json` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,put,patch,delete].responses[*].content` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-names-pascal-case":{"title":"Response Names Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/response-names-pascal-case/","source":"compiled","description":"Response names SHOULD be written in PascalCase.","message":"{{property}} is not PascalCase: {{error}}","severity":"info","given":"$.components.responses.*~","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:responses","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-names-pascal-case' (Response Names Pascal Case). Requirement: Response names SHOULD be written in PascalCase. To fix: Ensure the targeted value matches the regular expression `^[A-Z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.responses.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-no-operational-header-in-spec":{"title":"Response No Operational Header In Spec","reference":"https://spotlight-rules.com/spec/rules/openapi/response-no-operational-header-in-spec/","source":"compiled","description":"Access-Control-*, Content-Type, and Accept Headers SHOULD NOT be specified explicitly in a spec as it an operational concern.","message":"Access-Control-*, Content-Type, and Accept Headers SHOULD NOT be specified explicitly in a spec as it an operational concern.","severity":"info","given":"$.paths[*][*].responses[*].headers","then":{"function":"pattern","functionOptions":{"notMatch":"^(Access-Control-.*|Content-Type|Accept)$"}},"tags":["format:openapi","spec:paths","spec:responses","spec:headers","topic:cors","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-no-operational-header-in-spec' (Response No Operational Header In Spec). Requirement: Access-Control-*, Content-Type, and Accept Headers SHOULD NOT be specified explicitly in a spec as it an operational concern. To fix: Ensure the targeted value does NOT match the regular expression `^(Access-Control-.*|Content-Type|Accept)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-no-sensitive-data-in-header":{"title":"Response No Sensitive Data In Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-no-sensitive-data-in-header/","source":"compiled","description":"Headers MUST NOT contain sensitive data.","message":"Headers MUST NOT contain sensitive data.","severity":"info","given":"$.paths[*][*].responses[*].headers.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^(SPS-Token|SPS-Password|SPS-Identity|Password)$"}},"tags":["format:openapi","spec:paths","spec:responses","spec:headers","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-no-sensitive-data-in-header' (Response No Sensitive Data In Header). Requirement: Headers MUST NOT contain sensitive data. To fix: Ensure the targeted value does NOT match the regular expression `^(SPS-Token|SPS-Password|SPS-Identity|Password)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*].headers.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-options-codes-allowed":{"title":"Response Options Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-options-codes-allowed/","source":"compiled","description":"OPTIONS operations should not return 201, 202, 409, 412 status codes.","message":"OPTIONS operations should not return 201, 202, 409, 412 status codes.","severity":"info","given":"$.paths[*].options.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^(201|202|409|412)$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-options-codes-allowed' (Response Options Codes Allowed). Requirement: OPTIONS operations should not return 201, 202, 409, 412 status codes. To fix: Ensure `@key` does NOT match the regular expression `^(201|202|409|412)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].options.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-options-must-not-return-body":{"title":"Response Options Must Not Return Body","reference":"https://spotlight-rules.com/spec/rules/openapi/response-options-must-not-return-body/","source":"compiled","description":"OPTIONS operations should not return a response body for success.","message":"OPTIONS operations should not return a response body for success.","severity":"info","given":"$.paths.*.options.responses[200, 204].content","then":{"function":"falsy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-options-must-not-return-body' (Response Options Must Not Return Body). Requirement: OPTIONS operations should not return a response body for success. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.*.options.responses[200, 204].content` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-owasp-api3-define-error-validation":{"title":"Response OWASP API3 Define Error Validation","reference":"https://spotlight-rules.com/spec/rules/openapi/response-owasp-api3-define-error-validation/","source":"spotlight","description":"Write operations (POST/PUT/PATCH) should define a 400 or 422 validation error response (OWASP API3 — reject malformed or unexpected properties).","message":"Write operations should define a 400 or 422 validation error response.","given":"$.paths[*][post,put,patch].responses","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"object","anyOf":[{"required":["400"]},{"required":["422"]}]}}},"tags":["format:openapi","spec:responses","experience:security","owasp:api3"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-owasp-api3-define-error-validation' (Response OWASP API3 Define Error Validation). Requirement: Write operations (POST/PUT/PATCH) should define a 400 or 422 validation error response (OWASP API3 — reject malformed or unexpected properties). To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][post,put,patch].responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-owasp-api8-define-error-401":{"title":"Response OWASP API8 Define Error 401","reference":"https://spotlight-rules.com/spec/rules/openapi/response-owasp-api8-define-error-401/","source":"spotlight","description":"Operations should define a 401 Unauthorized response (OWASP API8 — security misconfiguration; document auth failures).","message":"Operation should define a 401 Unauthorized response.","given":"$.paths[*][get,post,put,patch,delete].responses","severity":"info","then":{"field":"401","function":"truthy"},"tags":["format:openapi","spec:responses","experience:security","owasp:api8"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-owasp-api8-define-error-401' (Response OWASP API8 Define Error 401). Requirement: Operations should define a 401 Unauthorized response (OWASP API8 — security misconfiguration; document auth failures). To fix: Ensure `401` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete].responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-owasp-api8-define-error-500":{"title":"Response OWASP API8 Define Error 500","reference":"https://spotlight-rules.com/spec/rules/openapi/response-owasp-api8-define-error-500/","source":"spotlight","description":"Operations should define a 500 Internal Server Error response (OWASP API8 — document server-error behavior).","message":"Operation should define a 500 Internal Server Error response.","given":"$.paths[*][get,post,put,patch,delete].responses","severity":"info","then":{"field":"500","function":"truthy"},"tags":["format:openapi","spec:responses","experience:security","owasp:api8"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-owasp-api8-define-error-500' (Response OWASP API8 Define Error 500). Requirement: Operations should define a 500 Internal Server Error response (OWASP API8 — document server-error behavior). To fix: Ensure `500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete].responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-patch-codes-allowed":{"title":"Response Patch Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-patch-codes-allowed/","source":"compiled","description":"PATCH operations should not return 201 status code.","message":"PATCH operations should not return 201 status code.","severity":"info","given":"$.paths[*].patch.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^201$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-patch-codes-allowed' (Response Patch Codes Allowed). Requirement: PATCH operations should not return 201 status code. To fix: Ensure `@key` does NOT match the regular expression `^201$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].patch.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-patch-define-200":{"title":"Response Patch Define 200","reference":"https://spotlight-rules.com/spec/rules/openapi/response-patch-define-200/","source":"compiled","description":"PATCH operations should define a 200 OK response for successful partial updates. Analysis shows PATCH is used in 17.7% of APIs.","message":"PATCH MUST Have 200 Response","severity":"info","given":"$.paths[*].patch.responses","then":{"field":"200","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-patch-define-200' (Response Patch Define 200). Requirement: PATCH operations should define a 200 OK response for successful partial updates. Analysis shows PATCH is used in 17.7% of APIs. To fix: Ensure `200` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].patch.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-patch-define-400":{"title":"Response Patch Define 400","reference":"https://spotlight-rules.com/spec/rules/openapi/response-patch-define-400/","source":"compiled","description":"PATCH operations should define a 400 Bad Request response for validation errors on partial update payloads.","message":"PATCH MUST Have 400 Response","severity":"info","given":"$.paths[*].patch.responses","then":{"field":"400","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-patch-define-400' (Response Patch Define 400). Requirement: PATCH operations should define a 400 Bad Request response for validation errors on partial update payloads. To fix: Ensure `400` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].patch.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-patch-define-404":{"title":"Response Patch Define 404","reference":"https://spotlight-rules.com/spec/rules/openapi/response-patch-define-404/","source":"compiled","description":"PATCH operations should define a 404 Not Found response for cases where the resource to be updated does not exist.","message":"PATCH MUST Have 404 Response","severity":"info","given":"$.paths[*].patch.responses","then":{"field":"404","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-patch-define-404' (Response Patch Define 404). Requirement: PATCH operations should define a 404 Not Found response for cases where the resource to be updated does not exist. To fix: Ensure `404` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].patch.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-post-codes-allowed":{"title":"Response Post Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-post-codes-allowed/","source":"compiled","description":"POST operations should not return 412 status codes.","message":"POST operations should not return 412 status codes.","severity":"info","given":"$.paths[*].post.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"412"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-post-codes-allowed' (Response Post Codes Allowed). Requirement: POST operations should not return 412 status codes. To fix: Ensure `@key` does NOT match the regular expression `412`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].post.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-post-define-201":{"title":"Response Post Define 201","reference":"https://spotlight-rules.com/spec/rules/openapi/response-post-define-201/","source":"compiled","description":"POST responses should have a 201 success HTTP status codes, communicating a success created response to consumers.","message":"POST Responses MUST Have 201 Status Codes","severity":"info","given":"$.paths[*].post.responses","then":{"field":"201","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-post-define-201' (Response Post Define 201). Requirement: POST responses should have a 201 success HTTP status codes, communicating a success created response to consumers. To fix: Ensure `201` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].post.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-post-define-400":{"title":"Response Post Define 400","reference":"https://spotlight-rules.com/spec/rules/openapi/response-post-define-400/","source":"compiled","description":"POST operations should define a 400 Bad Request response for input validation errors. Analysis shows 400 is the 4th most common response code across 2516 operations.","message":"POST MUST Have 400 Response","severity":"info","given":"$.paths[*].post.responses","then":{"field":"400","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-post-define-400' (Response Post Define 400). Requirement: POST operations should define a 400 Bad Request response for input validation errors. Analysis shows 400 is the 4th most common response code across 2516 operations. To fix: Ensure `400` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].post.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-post-define-401":{"title":"Response Post Define 401","reference":"https://spotlight-rules.com/spec/rules/openapi/response-post-define-401/","source":"compiled","description":"POST operations should define a 401 Unauthorized response to document authentication requirements for write operations.","message":"POST MUST Have 401 Response","severity":"info","given":"$.paths[*].post.responses","then":{"field":"401","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:security","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-post-define-401' (Response Post Define 401). Requirement: POST operations should define a 401 Unauthorized response to document authentication requirements for write operations. To fix: Ensure `401` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].post.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-post-define-500":{"title":"Response Post Define 500","reference":"https://spotlight-rules.com/spec/rules/openapi/response-post-define-500/","source":"compiled","description":"POST responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers.","message":"POST Responses MUST Have 500 Status Codes","severity":"info","given":"$.paths.*.post.responses","then":{"field":"500","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-post-define-500' (Response Post Define 500). Requirement: POST responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers. To fix: Ensure `500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.post.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-post-require-201-or-202":{"title":"Response Post Require 201 Or 202","reference":"https://spotlight-rules.com/spec/rules/openapi/response-post-require-201-or-202/","source":"compiled","description":"All POST methods MUST have a 201 or 202 response.","message":"All POST methods MUST have a 201 or 202 response.","severity":"info","given":["$.paths[*].post.responses"],"then":{"function":"trimble:operation-post-201-202-status-code"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:consistency","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-post-require-201-or-202' (Response Post Require 201 Or 202). Requirement: All POST methods MUST have a 201 or 202 response. This rule is evaluated at the JSONPath `$.paths[*].post.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-prefer-400-over-422":{"title":"Response Prefer 400 Over 422","reference":"https://spotlight-rules.com/spec/rules/openapi/response-prefer-400-over-422/","source":"compiled","description":"MUST use standard HTTP status codes [150a].","message":"Prefer 400 over 422 as response code","severity":"info","given":"$.paths.*.*.responses.422","then":{"field":"422","function":"defined"},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-prefer-400-over-422' (Response Prefer 400 Over 422). Requirement: MUST use standard HTTP status codes [150a]. To fix: Ensure `422` is defined at each matching location. This rule is evaluated at the JSONPath `$.paths.*.*.responses.422` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-put-codes-allowed":{"title":"Response Put Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-put-codes-allowed/","source":"compiled","description":"PUT operations should not return 200 or 201 status codes.","message":"PUT operations should not return 200 or 201 status codes.","severity":"info","given":"$.paths[*].put.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^(200|201)$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-put-codes-allowed' (Response Put Codes Allowed). Requirement: PUT operations should not return 200 or 201 status codes. To fix: Ensure `@key` does NOT match the regular expression `^(200|201)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].put.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-put-define-400":{"title":"Response Put Define 400","reference":"https://spotlight-rules.com/spec/rules/openapi/response-put-define-400/","source":"compiled","description":"PUT responses should have a 400 not found HTTP status code, communicating nothing was found to consumers.","message":"PUT Responses MUST Have 400 Status Codes","severity":"info","given":"$.paths.*.put.responses","then":{"field":"400","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-put-define-400' (Response Put Define 400). Requirement: PUT responses should have a 400 not found HTTP status code, communicating nothing was found to consumers. To fix: Ensure `400` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.put.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-put-define-401":{"title":"Response Put Define 401","reference":"https://spotlight-rules.com/spec/rules/openapi/response-put-define-401/","source":"compiled","description":"PUT operations should define a 401 Unauthorized response to document authentication requirements for update operations.","message":"PUT MUST Have 401 Response","severity":"info","given":"$.paths[*].put.responses","then":{"field":"401","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:security","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-put-define-401' (Response Put Define 401). Requirement: PUT operations should define a 401 Unauthorized response to document authentication requirements for update operations. To fix: Ensure `401` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].put.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-put-define-500":{"title":"Response Put Define 500","reference":"https://spotlight-rules.com/spec/rules/openapi/response-put-define-500/","source":"compiled","description":"PUT responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers.","message":"PUT Responses MUST Have 500 Status Codes","severity":"info","given":"$.paths.*.put.responses","then":{"field":"500","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-put-define-500' (Response Put Define 500). Requirement: PUT responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers. To fix: Ensure `500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.put.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-ratelimit-header":{"title":"Response Ratelimit Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-ratelimit-header/","source":"spotlight","description":"Responses should define the structured RateLimit header (current IETF draft) conveying quota, remaining, and reset in one field — the modern successor to the RateLimit-Limit/Remaining/Reset triplet.","message":"Responses should define a `RateLimit` header.","given":"$..responses.*","severity":"info","then":{"field":"headers.RateLimit","function":"truthy"},"tags":["format:openapi","spec:responses","topic:rate-limiting","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-ratelimit-header' (Response Ratelimit Header). Requirement: Responses should define the structured RateLimit header (current IETF draft) conveying quota, remaining, and reset in one field — the modern successor to the RateLimit-Limit/Remaining/Reset triplet. To fix: Ensure `headers.RateLimit` is present and non-empty at each matching location. Guidance: Responses should define a `RateLimit` header. This rule is evaluated at the JSONPath `$..responses.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-ratelimit-policy":{"title":"Response Ratelimit Policy","reference":"https://spotlight-rules.com/spec/rules/openapi/response-ratelimit-policy/","source":"spotlight","description":"Responses should define a RateLimit-Policy header documenting the quota policy and window (e.g. 100;w=60), so clients understand the limits in effect.","message":"Responses should define a `RateLimit-Policy` header.","given":"$..responses.*","severity":"info","then":{"field":"headers.RateLimit-Policy","function":"truthy"},"tags":["format:openapi","spec:responses","topic:rate-limiting","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-ratelimit-policy' (Response Ratelimit Policy). Requirement: Responses should define a RateLimit-Policy header documenting the quota policy and window (e.g. 100;w=60), so clients understand the limits in effect. To fix: Ensure `headers.RateLimit-Policy` is present and non-empty at each matching location. Guidance: Responses should define a `RateLimit-Policy` header. This rule is evaluated at the JSONPath `$..responses.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-require-status-health-check-path":{"title":"Response Require Status Health Check Path","reference":"https://spotlight-rules.com/spec/rules/openapi/response-require-status-health-check-path/","source":"compiled","description":"You must define a `/status` path that can be used to health-check the API. Using this path avoids the arbitrary usage of a server URL for health-check scope. The `/status` endpoint should return a `application/problem+json` response containing a successful status code if the service is working correctly. The service provider is free to define the implementation logic for this path.","message":"The \"/status\" path used to health-check the API must be defined. {{error}}","severity":"info","given":"$","then":{"field":"paths./status.get.responses.200","function":"truthy"},"tags":["format:openapi","spec:document","experience:reliability","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-require-status-health-check-path' (Response Require Status Health Check Path). Requirement: You must define a `/status` path that can be used to health-check the API. Using this path avoids the arbitrary usage of a server URL for health-check scope. The `/status` endpoint should return a `application/problem+json` response containing a successful status code if the service is working correctly. The service provider is free to define the implementation logic for this path. To fix: Ensure `paths./status.get.responses.200` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-return-correlation-id":{"title":"Response Return Correlation ID","reference":"https://spotlight-rules.com/spec/rules/openapi/response-return-correlation-id/","source":"spotlight","description":"Responses should return a correlation / request ID header (e.g. Request-Id or X-Correlation-Id) so callers can correlate a response with their request and with server-side logs.","message":"Responses should return a correlation / request ID header.","given":"$..responses.*","severity":"info","then":{"field":"headers","function":"schema","functionOptions":{"schema":{"type":"object","anyOf":[{"required":["Request-Id"]},{"required":["X-Request-Id"]},{"required":["X-Request-ID"]},{"required":["Correlation-Id"]},{"required":["X-Correlation-Id"]},{"required":["X-Correlation-ID"]}]}}},"tags":["format:openapi","spec:responses","topic:tracing","experience:reliability","experience:usability","experience:observability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-return-correlation-id' (Response Return Correlation ID). Requirement: Responses should return a correlation / request ID header (e.g. Request-Id or X-Correlation-Id) so callers can correlate a response with their request and with server-side logs. To fix: Adjust `headers` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$..responses.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-status-path-problem-schema-fields":{"title":"Response Status Path Problem Schema Fields","reference":"https://spotlight-rules.com/spec/rules/openapi/response-status-path-problem-schema-fields/","source":"compiled","description":"\"/status\" schema is not a Problem object.","message":"{{error}} {{path}}","severity":"info","given":"$.paths.'/status'.get.responses.200.content.[[schema]]","then":[{"function":"truthy","field":"properties.status"},{"function":"truthy","field":"properties.title"},{"function":"truthy","field":"properties.detail"}],"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","spec:schemas","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-status-path-problem-schema-fields' (Response Status Path Problem Schema Fields). Requirement: \"/status\" schema is not a Problem object. To fix: Ensure `properties.status` is present and non-empty at each matching location. Also: Ensure `properties.title` is present and non-empty at each matching location. Also: Ensure `properties.detail` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.'/status'.get.responses.200.content.[[schema]]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-status-path-return-problem-type":{"title":"Response Status Path Return Problem Type","reference":"https://spotlight-rules.com/spec/rules/openapi/response-status-path-return-problem-type/","source":"compiled","description":"\"/status\" must return a Problem object.","message":"{{error}}","severity":"info","given":"$.paths.'/status'.get.responses.200.content.*~","then":{"function":"enumeration","functionOptions":{"values":["application/problem+xml","application/problem+json"]}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-status-path-return-problem-type' (Response Status Path Return Problem Type). Requirement: \"/status\" must return a Problem object. To fix: Set the targeted value to one of the allowed values: application/problem+xml, application/problem+json. This rule is evaluated at the JSONPath `$.paths.'/status'.get.responses.200.content.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-success-require-ratelimit-header":{"title":"Response Success Require Ratelimit Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-success-require-ratelimit-header/","source":"compiled","description":"Ratelimiting API preserves a service and limits attack scenario [see API4:2019 Lack of Resources & Rate Limiting](https://owasp.org/www-project-api-security). APIs should use the following headers at least on successful responses: - `X-RateLimit-Limit`: number of total requests in a give time window - `X-RateLimit-Remaining`: remaining requests in the current window - `X-RateLimit-Reset`: number of seconds before the window resets An example set of headers is the following ``` X-Ratelimit-Limit: 100 X-Ratelimit-Remaining: 40 X-Ratelimit-Reset: 12 ``` A standardization proposal for ratelimit headers is ongoning inside the IETF HTTPAPI Workgroup. See [the draft](https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/).","message":"Missing ratelimit headers. {{property}} {{error}} {{path}}","severity":"info","given":"$.[responses][?(@property[0] == \"2\" )][headers]","then":[{"functionOptions":{"properties":["X-RateLimit-Limit","RateLimit-Limit"]},"function":"xor"},{"functionOptions":{"properties":["X-RateLimit-Remaining","RateLimit-Remaining"]},"function":"xor"},{"functionOptions":{"properties":["X-RateLimit-Reset","RateLimit-Reset"]},"function":"xor"}],"formats":["oas3"],"tags":["format:openapi","spec:responses","spec:headers","topic:rate-limiting","experience:reliability","experience:security","experience:performance","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-success-require-ratelimit-header' (Response Success Require Ratelimit Header). Requirement: Ratelimiting API preserves a service and limits attack scenario [see API4:2019 Lack of Resources & Rate Limiting](https://owasp.org/www-project-api-security). APIs should use the following headers at least on successful responses: - `X-RateLimit-Limit`: number of total requests in a give time window - `X-RateLimit-Remaining`: remaining requests in the current window - `X-RateLimit-Reset`: number of seconds before the window resets An example set of headers is the following ``` X-Ratelimit-Limit: 100 X-Ratelimit-Remaining: 40 X-Ratelimit-Reset: 12 ``` A standardization proposal for ratelimit headers is ongoning inside the IETF HTTPAPI Workgroup. See [the draft](https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/). To fix: Include exactly one of: X-RateLimit-Limit, RateLimit-Limit. Also: Include exactly one of: X-RateLimit-Remaining, RateLimit-Remaining. Also: Include exactly one of: X-RateLimit-Reset, RateLimit-Reset. This rule is evaluated at the JSONPath `$.[responses][?(@property[0] == \"2\" )][headers]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-success-use-hal-json":{"title":"Response Success Use HAL JSON","reference":"https://spotlight-rules.com/spec/rules/openapi/response-success-use-hal-json/","source":"default","description":"All 2xx success responses MUST use the `application/hal+json` media type.","message":"Success response documents MUST use the application/hal+json media type: {{error}}","severity":"info","given":"$.paths..responses[?( @property >= 200 && @property < 300 && @property != 204)].content[*]~","then":{"function":"enumeration","functionOptions":{"values":["application/hal+json"]}},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-success-use-hal-json' (Response Success Use HAL JSON). Requirement: All 2xx success responses MUST use the `application/hal+json` media type. To fix: Set the targeted value to one of the allowed values: application/hal+json. This rule is evaluated at the JSONPath `$.paths..responses[?( @property >= 200 && @property < 300 && @property != 204)].content[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-throttled-require-retry-after":{"title":"Response Throttled Require Retry After","reference":"https://spotlight-rules.com/spec/rules/openapi/response-throttled-require-retry-after/","source":"compiled","description":"When a client is either: * throttled out with a 429 status code; * warned about a temporary server issue with a 503 status code; the server should explicitly communicate how long to wait before issuing further requests using the Retry-After header. Retry-After is defined in RFC7231.","message":"Missing ratelimit header: {{property}} in {{path}}","severity":"info","given":"$.[responses][?(@property == \"429\" || @property == \"503\"  )][headers]","then":{"field":"Retry-After","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:responses","spec:headers","topic:rate-limiting","experience:reliability","experience:error-handling","experience:performance","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-throttled-require-retry-after' (Response Throttled Require Retry After). Requirement: When a client is either: * throttled out with a 429 status code; * warned about a temporary server issue with a 503 status code; the server should explicitly communicate how long to wait before issuing further requests using the Retry-After header. Retry-After is defined in RFC7231. To fix: Ensure `Retry-After` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.[responses][?(@property == \"429\" || @property == \"503\" )][headers]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-use-json-api":{"title":"Response Use JSON API","reference":"https://spotlight-rules.com/spec/rules/openapi/response-use-json-api/","source":"default","description":"All responses MUST use the JSON:API `application/vnd.api+json` media type.","message":"Response documents MUST use the application/vnd.api+json (JSON:API) media type: {{error}}","severity":"info","given":"$.paths..responses[?( @property >= 200 && @property < 600 && @property != 204)].content[*]~","then":{"function":"enumeration","functionOptions":{"values":["application/vnd.api+json"]}},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-use-json-api' (Response Use JSON API). Requirement: All responses MUST use the JSON:API `application/vnd.api+json` media type. To fix: Set the targeted value to one of the allowed values: application/vnd.api+json. This rule is evaluated at the JSONPath `$.paths..responses[?( @property >= 200 && @property < 600 && @property != 204)].content[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-use-standard-mime-types":{"title":"Response Use Standard Mime Types","reference":"https://spotlight-rules.com/spec/rules/openapi/response-use-standard-mime-types/","source":"compiled","description":"MIME types MUST be standard (application/json, application/problem+json, application/problem+xml) or use custom format application/vnd.*.","message":"MIME types MUST be standard (application/json, application/problem+json, application/problem+xml) or use custom format application/vnd.*.","severity":"info","given":"$.paths[*][*].responses[*].content.*~","then":{"function":"pattern","functionOptions":{"match":"^application/(json|problem\\+json|problem\\+xml|vnd\\..*)$"}},"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-use-standard-mime-types' (Response Use Standard Mime Types). Requirement: MIME types MUST be standard (application/json, application/problem+json, application/problem+xml) or use custom format application/vnd.*. To fix: Ensure the targeted value matches the regular expression `^application/(json|problem\\+json|problem\\+xml|vnd\\..*)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*].content.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-use-standard-status-codes":{"title":"Response Use Standard Status Codes","reference":"https://spotlight-rules.com/spec/rules/openapi/response-use-standard-status-codes/","source":"compiled","description":"MUST use standard HTTP status codes [150a].","message":"{{property}} is not a standardized response code","severity":"info","given":"$.paths.*.*.responses.*~","then":{"function":"enumeration","functionOptions":{"values":["100","101","200","201","202","203","204","205","206","207","300","301","302","303","304","305","307","400","401","402","403","404","405","406","407","408","409","410","411","412","413","414","415","416","417","422","423","426","428","429","431","500","501","502","503","504","505","511","default"]}},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-use-standard-status-codes' (Response Use Standard Status Codes). Requirement: MUST use standard HTTP status codes [150a]. To fix: Set the targeted value to one of the allowed values: 100, 101, 200, 201, 202, 203, 204, 205, 206, 207, 300, 301, 302, 303, 304, 305, 307, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 422, 423, 426, 428, 429, 431, 500, 501, 502, 503, 504, 505, 511, default. This rule is evaluated at the JSONPath `$.paths.*.*.responses.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-use-standard-status-codes-2":{"title":"Response Use Standard Status Codes 2","reference":"https://spotlight-rules.com/spec/rules/openapi/response-use-standard-status-codes-2/","source":"compiled","description":"An API MUST return HTTP response codes in conformance with RFC-2616 and common usage.","message":"An API MUST return HTTP response codes in conformance with RFC-2616 and common usage.","severity":"info","given":"$.paths...responses.*~","then":{"function":"enumeration","functionOptions":{"values":["200","201","202","204","400","401","403","404","405","406","409","412","415","428","429","500"]}},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-use-standard-status-codes-2' (Response Use Standard Status Codes 2). Requirement: An API MUST return HTTP response codes in conformance with RFC-2616 and common usage. To fix: Set the targeted value to one of the allowed values: 200, 201, 202, 204, 400, 401, 403, 404, 405, 406, 409, 412, 415, 428, 429, 500. This rule is evaluated at the JSONPath `$.paths...responses.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-write-document-412-precondition-failed":{"title":"Response Write Document 412 Precondition Failed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-write-document-412-precondition-failed/","source":"spotlight","description":"Write operations should document a 412 Precondition Failed response for failed conditional (If-Match) writes.","message":"Operation should document a `412` response.","given":"$.paths[*][put,patch,delete].responses","severity":"info","then":{"field":"412","function":"truthy"},"tags":["format:openapi","spec:responses","topic:conditional-requests","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-write-document-412-precondition-failed' (Response Write Document 412 Precondition Failed). Requirement: Write operations should document a 412 Precondition Failed response for failed conditional (If-Match) writes. To fix: Ensure `412` is present and non-empty at each matching location. Guidance: Operation should document a `412` response. This rule is evaluated at the JSONPath `$.paths[*][put,patch,delete].responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-write-etag":{"title":"Response Write ETag","reference":"https://spotlight-rules.com/spec/rules/openapi/response-write-etag/","source":"spotlight","description":"Write success responses (POST/PUT/PATCH) should define an ETag header so clients receive the new entity tag after a write and can make subsequent conditional requests.","message":"Write success responses should define a `ETag` header.","given":"$.paths[*][post,put,patch].responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers","severity":"info","then":{"field":"ETag","function":"truthy"},"tags":["format:openapi","spec:responses","topic:caching","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-write-etag' (Response Write ETag). Requirement: Write success responses (POST/PUT/PATCH) should define an ETag header so clients receive the new entity tag after a write and can make subsequent conditional requests. To fix: Ensure `ETag` is present and non-empty at each matching location. Guidance: Write success responses should define a `ETag` header. This rule is evaluated at the JSONPath `$.paths[*][post,put,patch].responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-write-require-content-type":{"title":"Response Write Require Content Type","reference":"https://spotlight-rules.com/spec/rules/openapi/response-write-require-content-type/","source":"compiled","description":"All API responses MUST include the Content-Type header in all responses.","message":"{{error}}","severity":"info","given":["$.paths[*].post.responses","$.paths[*].put.responses"],"then":{"function":"trimble:check-for-content-type-in-put-and-post-responses"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-write-require-content-type' (Response Write Require Content Type). Requirement: All API responses MUST include the Content-Type header in all responses. This rule is evaluated at the JSONPath `$.paths[*].post.responses | $.paths[*].put.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-array-property-require-items":{"title":"Schema Array Property Require Items","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-array-property-require-items/","source":"compiled","description":"Schema properties that are of the type array must have an items property defined.","message":"Schema Array Properties MUST Have Items","severity":"info","given":"$.components.schemas.*.properties[?(@.type==\"array\")]","then":{"field":"items","function":"truthy"},"tags":["format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-array-property-require-items' (Schema Array Property Require Items). Requirement: Schema properties that are of the type array must have an items property defined. To fix: Ensure `items` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type==\"array\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-array-property-require-max-items":{"title":"Schema Array Property Require Max Items","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-array-property-require-max-items/","source":"compiled","description":"Schema properties that are of the type array should have a max items property defined.","message":"Schema Array Properties MUST Have Max Items","severity":"info","given":"$.components.schemas.*.properties[?(@.type==\"array\")]","then":[{"field":"maxItems","function":"truthy"}],"tags":["owasp:api4","format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-array-property-require-max-items' (Schema Array Property Require Max Items). Requirement: Schema properties that are of the type array should have a max items property defined. To fix: Ensure `maxItems` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type==\"array\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-array-property-require-min-items":{"title":"Schema Array Property Require Min Items","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-array-property-require-min-items/","source":"compiled","description":"Schema properties that are of the type array should have a min items property defined.","message":"Schema Array Properties MUST Have Min Items","severity":"info","given":"$.components.schemas.*.properties[?(@.type==\"array\")]","then":[{"field":"minItems","function":"truthy"}],"tags":["format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-array-property-require-min-items' (Schema Array Property Require Min Items). Requirement: Schema properties that are of the type array should have a min items property defined. To fix: Ensure `minItems` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type==\"array\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-array-property-typed-items":{"title":"Schema Array Property Typed Items","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-array-property-typed-items/","source":"compiled","description":"Array properties must have an items attribute with a type.","message":"{{error}}","severity":"info","given":"$..*.properties[*]","then":{"function":"digitalocean:ensureAllArraysHaveItemTypes"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-array-property-typed-items' (Schema Array Property Typed Items). Requirement: Array properties must have an items attribute with a type. This rule is evaluated at the JSONPath `$..*.properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-array-require-min-max-items":{"title":"Schema Array Require Min Max Items","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-array-require-min-max-items/","source":"compiled","description":"Array size should be limited to mitigate resource exhaustion attacks. This can be done using `maxItems` and `minItems`, like in the example below. ``` Limited: type: array maxItems: 10 items: type: string format: date ``` You should ensure that the schema referenced in `items` is constrained too. If you delegate input validation to a library or framework, be sure to test it thoroughly and ensure that it verifies `maxItems`.","message":"Schema of type array must specify maxItems and minItems. {{path}} {{error}}","severity":"info","given":["$.[?(@.type==\"array\")]"],"then":[{"field":"maxItems","function":"defined"},{"field":"minItems","function":"defined"}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-array-require-min-max-items' (Schema Array Require Min Max Items). Requirement: Array size should be limited to mitigate resource exhaustion attacks. This can be done using `maxItems` and `minItems`, like in the example below. ``` Limited: type: array maxItems: 10 items: type: string format: date ``` You should ensure that the schema referenced in `items` is constrained too. If you delegate input validation to a library or framework, be sure to test it thoroughly and ensure that it verifies `maxItems`. To fix: Ensure `maxItems` is defined at each matching location. Also: Ensure `minItems` is defined at each matching location. This rule is evaluated at the JSONPath `$.[?(@.type==\"array\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-boolean-no-prefix":{"title":"Schema Boolean No Prefix","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-boolean-no-prefix/","source":"compiled","description":"Boolean properties SHOULD NOT use is, has, or another prefix.","message":"Boolean properties SHOULD NOT use is, has, or another prefix.","severity":"info","given":"$..properties[?(@ && @.type == 'boolean')]~","then":{"function":"pattern","functionOptions":{"notMatch":"^(is|has|was|will|needs|uses|should|can)([A-Z]|$).*"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-boolean-no-prefix' (Schema Boolean No Prefix). Requirement: Boolean properties SHOULD NOT use is, has, or another prefix. To fix: Ensure the targeted value does NOT match the regular expression `^(is|has|was|will|needs|uses|should|can)([A-Z]|$).*`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..properties[?(@ && @.type == 'boolean')]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-collection-require-pagination-params":{"title":"Schema Collection Require Pagination Params","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-collection-require-pagination-params/","source":"compiled","description":"Collection GET endpoints SHOULD support pagination using query parameters. Offset or cursor based pagination is required.","message":"Collection GET endpoints SHOULD support pagination using query parameters.","severity":"info","given":"$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}\\/*.*/))].get","then":[{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","items":{"type":"object"},"contains":{"type":"object","properties":{"name":{"const":"limit"},"in":{"const":"query"}}},"allOf":[{"anyOf":[{"contains":{"type":"object","properties":{"name":{"const":"offset"},"in":{"const":"query"}}}},{"contains":{"type":"object","properties":{"name":{"const":"cursor"},"in":{"const":"query"}}}},{"contains":{"type":"object","properties":{"name":{"const":"page"},"in":{"const":"query"}}}}]}]}}}],"tags":["format:openapi","spec:paths","spec:operations","topic:pagination","experience:pagination","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-collection-require-pagination-params' (Schema Collection Require Pagination Params). Requirement: Collection GET endpoints SHOULD support pagination using query parameters. Offset or cursor based pagination is required. To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}\\/*.*/))].get` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-created-datetime-must-be-date-time":{"title":"Schema Created Datetime Must Be Date Time","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-created-datetime-must-be-date-time/","source":"compiled","description":"createdDateTime MUST use a data type of 'string' with the format 'date-time'.","message":"createdDateTime MUST use a data type of 'string' with the format 'date-time'.","severity":"info","given":"$..properties.createdDateTime","then":[{"field":"type","function":"pattern","functionOptions":{"match":"^string$"}},{"field":"format","function":"truthy"},{"field":"format","function":"pattern","functionOptions":{"match":"^date-time$"}}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-created-datetime-must-be-date-time' (Schema Created Datetime Must Be Date Time). Requirement: createdDateTime MUST use a data type of 'string' with the format 'date-time'. To fix: Ensure `type` matches the regular expression `^string$`; rewrite any value that does not. Also: Ensure `format` is present and non-empty at each matching location. Also: Ensure `format` matches the regular expression `^date-time$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..properties.createdDateTime` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-createdby-property-must-be-string":{"title":"Schema Createdby Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-createdby-property-must-be-string/","source":"compiled","description":"createdBy MUST use a data type of 'string'.","message":"createdBy MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"createdBy\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-createdby-property-must-be-string' (Schema Createdby Property Must Be String). Requirement: createdBy MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"createdBy\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-date-time-property-require-format":{"title":"Schema Date Time Property Require Format","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-date-time-property-require-format/","source":"spotlight","description":"Date/time string properties (createdAt, updated_at, *_date, timestamp, …) should declare a format such as date-time (RFC 3339) so the value is unambiguous and machine-validatable.","message":"Date/time string property should declare a format (e.g. date-time).","given":"$..properties[?( @property.match(/(_at$|_date$|_time$|At$|Date$|Time$|timestamp)/i) && @.type == 'string' )]","severity":"info","then":{"field":"format","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-date-time-property-require-format' (Schema Date Time Property Require Format). Requirement: Date/time string properties (createdAt, updated_at, *_date, timestamp, …) should declare a format such as date-time (RFC 3339) so the value is unambiguous and machine-validatable. To fix: Ensure `format` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..properties[?( @property.match(/(_at$|_date$|_time$|At$|Date$|Time$|timestamp)/i) && @.type == 'string' )]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-definition-camel-case":{"title":"Schema Definition Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-definition-camel-case/","source":"default","description":"Schema definitions MUST follow camelCase.","message":"{{property}} schema definition is not camelCase: {{error}}","severity":"info","given":"$.definitions[*]~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-definition-camel-case' (Schema Definition Camel Case). Requirement: Schema definitions MUST follow camelCase. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-definition-constant-case":{"title":"Schema Definition Constant Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-definition-constant-case/","source":"default","description":"Schema definitions MUST follow CONSTANT_CASE (screaming snake_case).","message":"{{property}} schema definition is not CONSTANT_CASE: {{error}}","severity":"info","given":"$.definitions[*]~","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-definition-constant-case' (Schema Definition Constant Case). Requirement: Schema definitions MUST follow CONSTANT_CASE (screaming snake_case). To fix: Ensure the targeted value matches the regular expression `^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-definition-kebab-case":{"title":"Schema Definition Kebab Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-definition-kebab-case/","source":"default","description":"Schema definitions MUST follow kebab-case.","message":"{{property}} schema definition is not kebab-case: {{error}}","severity":"info","given":"$.definitions[*]~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(-[a-z0-9]+)*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-definition-kebab-case' (Schema Definition Kebab Case). Requirement: Schema definitions MUST follow kebab-case. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(-[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-definition-pascal-case":{"title":"Schema Definition Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-definition-pascal-case/","source":"default","description":"Schema definitions MUST follow PascalCase.","message":"{{property}} schema definition is not PascalCase: {{error}}","severity":"info","given":"$.definitions[*]~","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-definition-pascal-case' (Schema Definition Pascal Case). Requirement: Schema definitions MUST follow PascalCase. To fix: Ensure the targeted value matches the regular expression `^[A-Z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-definition-snake-case":{"title":"Schema Definition Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-definition-snake-case/","source":"default","description":"Schema definitions MUST follow snake_case.","message":"{{property}} schema definition is not snake_case: {{error}}","severity":"info","given":"$.definitions[*]~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(_[a-z0-9]+)*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-definition-snake-case' (Schema Definition Snake Case). Requirement: Schema definitions MUST follow snake_case. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(_[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-deletedby-property-must-be-string":{"title":"Schema Deletedby Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-deletedby-property-must-be-string/","source":"compiled","description":"deletedBy MUST use a data type of 'string'.","message":"deletedBy MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"deletedBy\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-deletedby-property-must-be-string' (Schema Deletedby Property Must Be String). Requirement: deletedBy MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"deletedBy\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-deprecated-property-require-description":{"title":"Schema Deprecated Property Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-deprecated-property-require-description/","source":"spotlight","description":"Deprecated schema properties should have a description explaining the deprecation and the replacement field.","message":"Deprecated property should describe the deprecation.","given":"$..properties[?(@ && @.deprecated == true)]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:schemas","topic:deprecation","experience:versioning","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-deprecated-property-require-description' (Schema Deprecated Property Require Description). Requirement: Deprecated schema properties should have a description explaining the deprecation and the replacement field. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..properties[?(@ && @.deprecated == true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-description-max-length":{"title":"Schema Description Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-description-max-length/","source":"compiled","description":"Schema should have a length limit applied, restricting how long schema descriptions can be, helping keep them concise and consistent.","message":"Schema Description MUST be Less Than 250 Characters","severity":"info","given":"$.components.schemas.*","then":{"field":"description","function":"length","functionOptions":{"max":250}},"tags":["format:openapi","spec:schemas","spec:components","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-description-max-length' (Schema Description Max Length). Requirement: Schema should have a length limit applied, restricting how long schema descriptions can be, helping keep them concise and consistent. To fix: Ensure the length of `description` is at most 250. This rule is evaluated at the JSONPath `$.components.schemas.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-description-property-must-be-string":{"title":"Schema Description Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-description-property-must-be-string/","source":"compiled","description":"description MUST use a data type of 'string'.","message":"description MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"description\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-description-property-must-be-string' (Schema Description Property Must Be String). Requirement: description MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"description\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-enum-not-empty":{"title":"Schema Enum Not Empty","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-enum-not-empty/","source":"spotlight","description":"An enum should declare at least one value — an empty enum permits nothing and is almost always a mistake.","message":"enum should not be empty.","given":"$..enum","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"array","minItems":1}}},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-enum-not-empty' (Schema Enum Not Empty). Requirement: An enum should declare at least one value — an empty enum permits nothing and is almost always a mistake. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$..enum` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-fingerprint-property-must-be-string":{"title":"Schema Fingerprint Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-fingerprint-property-must-be-string/","source":"compiled","description":"Fingerprint values MUST use a data type of `string`.","message":"Fingerprint values MUST use a data type of `string`.","severity":"info","given":"$..[?(@property === \"fingerprint\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-fingerprint-property-must-be-string' (Schema Fingerprint Property Must Be String). Requirement: Fingerprint values MUST use a data type of `string`. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"fingerprint\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-get-define-404-response":{"title":"Schema Get Define 404 Response","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-get-define-404-response/","source":"compiled","description":"GET responses should have a 404 not found HTTP status code, communicating that nothing was found to consumers.","message":"GET Responses MUST Have 404 Status Code","severity":"info","given":"$.paths.*.get[?(@.properties)]","then":{"field":"404","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:schemas","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-get-define-404-response' (Schema Get Define 404 Response). Requirement: GET responses should have a 404 not found HTTP status code, communicating that nothing was found to consumers. To fix: Ensure `404` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.get[?(@.properties)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-id-property-must-be-string":{"title":"Schema ID Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-id-property-must-be-string/","source":"compiled","description":"id SHOULD use a data type of 'string'.","message":"id SHOULD use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"id\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-id-property-must-be-string' (Schema ID Property Must Be String). Requirement: id SHOULD use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"id\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-integer-format-allowed-values":{"title":"Schema Integer Format Allowed Values","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-integer-format-allowed-values/","source":"compiled","description":"To improve interoperability, integer and number formats are constrained to a shared subset. See recommendation RAC_REST_FORMAT_004.","message":"Type format is \"{{value}}\", expected one of [int32, int64]. {{path}}","severity":"info","given":"$.[?(@.type==\"integer\")]\n","then":{"field":"format","function":"enumeration","functionOptions":{"values":["int32","int64"]}},"formats":["oas3"],"tags":["format:openapi","spec:document","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-integer-format-allowed-values' (Schema Integer Format Allowed Values). Requirement: To improve interoperability, integer and number formats are constrained to a shared subset. See recommendation RAC_REST_FORMAT_004. To fix: Set `format` to one of the allowed values: int32, int64. This rule is evaluated at the JSONPath `$.[?(@.type==\"integer\")] ` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-integer-require-format":{"title":"Schema Integer Require Format","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-integer-require-format/","source":"compiled","description":"Schema of type number or integer must specify a format to express the associated datatype, eg. `int32`, `int64`, ... You can express similar requirements using the `minimum` and `maximum` properties. See recommendation RAC_REST_FORMAT_004.","message":"Schema of type number or integer must specify a format. {{path}}","severity":"info","given":"$.[?(@.type==\"integer\")]\n","then":{"field":"format","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:document","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-integer-require-format' (Schema Integer Require Format). Requirement: Schema of type number or integer must specify a format to express the associated datatype, eg. `int32`, `int64`, ... You can express similar requirements using the `minimum` and `maximum` properties. See recommendation RAC_REST_FORMAT_004. To fix: Ensure `format` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.[?(@.type==\"integer\")] ` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-keys-snake-case":{"title":"Schema Keys Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-keys-snake-case/","source":"compiled","description":"schema key must be snake cased (e.g. snake_case).","message":"{{error}}","severity":"info","given":"$.components['schemas'].*~","then":{"function":"digitalocean:ensureSnakeCaseWithDigits"},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-keys-snake-case' (Schema Keys Snake Case). Requirement: schema key must be snake cased (e.g. snake_case). This rule is evaluated at the JSONPath `$.components['schemas'].*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-modified-datetime-must-be-date-time":{"title":"Schema Modified Datetime Must Be Date Time","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-modified-datetime-must-be-date-time/","source":"compiled","description":"modifiedDateTime MUST use a data type of 'string' with the format 'date-time'.","message":"modifiedDateTime MUST use a data type of 'string' with the format 'date-time'.","severity":"info","given":"$..properties.modifiedDateTime","then":[{"field":"type","function":"pattern","functionOptions":{"match":"^string$"}},{"field":"format","function":"truthy"},{"field":"format","function":"pattern","functionOptions":{"match":"^date-time$"}}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-modified-datetime-must-be-date-time' (Schema Modified Datetime Must Be Date Time). Requirement: modifiedDateTime MUST use a data type of 'string' with the format 'date-time'. To fix: Ensure `type` matches the regular expression `^string$`; rewrite any value that does not. Also: Ensure `format` is present and non-empty at each matching location. Also: Ensure `format` matches the regular expression `^date-time$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..properties.modifiedDateTime` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-modifiedby-property-must-be-string":{"title":"Schema Modifiedby Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-modifiedby-property-must-be-string/","source":"compiled","description":"modifiedBy MUST use a data type of 'string'.","message":"modifiedBy MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"modifiedBy\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-modifiedby-property-must-be-string' (Schema Modifiedby Property Must Be String). Requirement: modifiedBy MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"modifiedBy\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-monetary-property-avoid-float":{"title":"Schema Monetary Property Avoid Float","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-monetary-property-avoid-float/","source":"spotlight","description":"Monetary properties (amount, price, cost, fee, balance, …) should avoid floating-point numbers, which lose precision — use an integer of minor units or a decimal string instead.","message":"Monetary property should not be a floating-point number.","given":"$..properties[?( @property.match(/(amount|price|cost|total|fee|balance|subtotal)/i) )]","severity":"info","then":{"field":"type","function":"pattern","functionOptions":{"notMatch":"^number$"}},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-monetary-property-avoid-float' (Schema Monetary Property Avoid Float). Requirement: Monetary properties (amount, price, cost, fee, balance, …) should avoid floating-point numbers, which lose precision — use an integer of minor units or a decimal string instead. To fix: Ensure `type` does NOT match the regular expression `^number$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..properties[?( @property.match(/(amount|price|cost|total|fee|balance|subtotal)/i) )]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-name-max-length":{"title":"Schema Name Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-name-max-length/","source":"compiled","description":"Schema should have a length limit applied keeping the names of schema consistent across APIs.","message":"Schema Names MUST Be Less Than 25 Characters","severity":"info","given":"$.components.schemas","then":{"field":"@key","function":"length","functionOptions":{"max":25}},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-name-max-length' (Schema Name Max Length). Requirement: Schema should have a length limit applied keeping the names of schema consistent across APIs. To fix: Ensure the length of `@key` is at most 25. This rule is evaluated at the JSONPath `$.components.schemas` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-name-property-must-be-string":{"title":"Schema Name Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-name-property-must-be-string/","source":"compiled","description":"name MUST use a data type of 'string'.","message":"name MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"name\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-name-property-must-be-string' (Schema Name Property Must Be String). Requirement: name MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"name\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-names-pascal-case":{"title":"Schema Names Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-names-pascal-case/","source":"compiled","description":"Schema names SHOULD be written in PascalCase.","message":"{{property}} is not PascalCase: {{error}}","severity":"info","given":"$.components.schemas.*~","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-names-pascal-case' (Schema Names Pascal Case). Requirement: Schema names SHOULD be written in PascalCase. To fix: Ensure the targeted value matches the regular expression `^[A-Z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.schemas.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-number-format-allowed-values":{"title":"Schema Number Format Allowed Values","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-number-format-allowed-values/","source":"compiled","description":"To improve interoperability, integer and number formats are constrained to a shared subset. See recommendation RAC_REST_FORMAT_004.","message":"Type format is \"{{value}}\", expected one of [decimal32, decimal64, decimal128, float, double]. {{path}}","severity":"info","given":"$.[?(@.type==\"number\")]\n","then":{"field":"format","function":"enumeration","functionOptions":{"values":["decimal32","decimal64","float","double","decimal128"]}},"formats":["oas3"],"tags":["format:openapi","spec:document","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-number-format-allowed-values' (Schema Number Format Allowed Values). Requirement: To improve interoperability, integer and number formats are constrained to a shared subset. See recommendation RAC_REST_FORMAT_004. To fix: Set `format` to one of the allowed values: decimal32, decimal64, float, double, decimal128. This rule is evaluated at the JSONPath `$.[?(@.type==\"number\")] ` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-number-property-require-maximum":{"title":"Schema Number Property Require Maximum","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-number-property-require-maximum/","source":"compiled","description":"Schema properties that are of the type number should have a maximum property defined.","message":"Schema Number Properties MUST Have Maximum","severity":"info","given":"$.components.schemas.*.properties[?(@.type==\"number\")]","then":[{"field":"maximum","function":"defined"}],"tags":["owasp:api4","format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-number-property-require-maximum' (Schema Number Property Require Maximum). Requirement: Schema properties that are of the type number should have a maximum property defined. To fix: Ensure `maximum` is defined at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type==\"number\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-number-property-require-minimum":{"title":"Schema Number Property Require Minimum","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-number-property-require-minimum/","source":"compiled","description":"Schema properties that are of the type number should have a minimum property defined.","message":"Schema Number Properties MUST Have Minimum","severity":"info","given":"$.components.schemas.*.properties[?(@.type==\"number\")]","then":[{"field":"minimum","function":"defined"}],"tags":["owasp:api4","format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-number-property-require-minimum' (Schema Number Property Require Minimum). Requirement: Schema properties that are of the type number should have a minimum property defined. To fix: Ensure `minimum` is defined at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type==\"number\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-number-require-format":{"title":"Schema Number Require Format","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-number-require-format/","source":"compiled","description":"Schema of type number or integer must specify a format to express the associated datatype, eg. `int32`, `int64`, ... You can express similar requirements using the `minimum` and `maximum` properties. See recommendation RAC_REST_FORMAT_004.","message":"Schema of type number or integer must specify a format. {{path}}","severity":"info","given":"$.[?(@.type==\"number\")]","then":{"field":"format","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-number-require-format' (Schema Number Require Format). Requirement: Schema of type number or integer must specify a format to express the associated datatype, eg. `int32`, `int64`, ... You can express similar requirements using the `minimum` and `maximum` properties. See recommendation RAC_REST_FORMAT_004. To fix: Ensure `format` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.[?(@.type==\"number\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-number-require-min-max":{"title":"Schema Number Require Min Max","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-number-require-min-max/","source":"compiled","description":"Numeric values should be limited in size to mitigate resource exhaustion using `maximum` and `minimum`. If you delegate input validation to a library or framework, be sure to test it thoroughly.","message":"Schema of type number or integer must specify a maximum and a minimum. {{path}} {{error}}","severity":"info","given":["$.[?(@.type==\"number\")]","$.[?(@.type==\"integer\")]"],"then":[{"field":"maximum","function":"defined"},{"field":"minimum","function":"defined"}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-number-require-min-max' (Schema Number Require Min Max). Requirement: Numeric values should be limited in size to mitigate resource exhaustion using `maximum` and `minimum`. If you delegate input validation to a library or framework, be sure to test it thoroughly. To fix: Ensure `maximum` is defined at each matching location. Also: Ensure `minimum` is defined at each matching location. This rule is evaluated at the JSONPath `$.[?(@.type==\"number\")] | $.[?(@.type==\"integer\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-object-constrain-additional-property":{"title":"Schema Object Constrain Additional Property","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-object-constrain-additional-property/","source":"compiled","description":"By default, jsonschema allows additionalProperties. This means that schema validators can be bypassed using further, unspecified fields. While forbidding additionalProperties can create rigidity and hinder the evolution of an API - eg making it hard to accept new parameters or fields - it is possible that this flexibility can be used to bypass the schema validator and force the application to process unwanted information. Disable `additionalProperties` with `false` ``` Person: type: object additionalProperties: false properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` Or constraint them using `maxProperties` ``` Person: type: object additionalProperties: type: string pattern: /+39[0-9]{,14}/ maxProperties: 3 properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` - no additionalProperties - constrained additionalProperties.","message":"Objects should not allow additionalProperties. Disable them with `additionalProperties: false` or constraint them.","severity":"info","given":["$.[?(@.type==\"object\" && @.additionalProperties &&  @.additionalProperties!=true &&  @.additionalProperties!=false )]"],"then":[{"field":"maxProperties","function":"defined"}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling","owasp:api3"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-object-constrain-additional-property' (Schema Object Constrain Additional Property). Requirement: By default, jsonschema allows additionalProperties. This means that schema validators can be bypassed using further, unspecified fields. While forbidding additionalProperties can create rigidity and hinder the evolution of an API - eg making it hard to accept new parameters or fields - it is possible that this flexibility can be used to bypass the schema validator and force the application to process unwanted information. Disable `additionalProperties` with `false` ``` Person: type: object additionalProperties: false properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` Or constraint them using `maxProperties` ``` Person: type: object additionalProperties: type: string pattern: /+39[0-9]{,14}/ maxProperties: 3 properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` - no additionalProperties - constrained additionalProperties. To fix: Ensure `maxProperties` is defined at each matching location. Guidance: Objects should not allow additionalProperties. Disable them with `additionalProperties: false` or constraint them. This rule is evaluated at the JSONPath `$.[?(@.type==\"object\" && @.additionalProperties && @.additionalProperties!=true && @.additionalProperties!=false )]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-object-disallow-additional-property":{"title":"Schema Object Disallow Additional Property","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-object-disallow-additional-property/","source":"compiled","description":"By default, jsonschema allows additionalProperties. This means that schema validators can be bypassed using further, unspecified fields. While forbidding additionalProperties can create rigidity and hinder the evolution of an API - eg making it hard to accept new parameters or fields - it is possible that this flexibility can be used to bypass the schema validator and force the application to process unwanted information. Disable `additionalProperties` with `false` ``` Person: type: object additionalProperties: false properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` Or constraint them using `maxProperties` ``` Person: type: object additionalProperties: type: string pattern: /+39[0-9]{,14}/ maxProperties: 3 properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` - no additionalProperties - constrained additionalProperties.","message":"Objects should not allow additionalProperties. Disable them with `additionalProperties: false` or constraint them.","severity":"info","given":["$.[?(@.type==\"object\" && @.additionalProperties==true)]"],"then":[{"field":"additionalProperties","function":"falsy"}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling","owasp:api3"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-object-disallow-additional-property' (Schema Object Disallow Additional Property). Requirement: By default, jsonschema allows additionalProperties. This means that schema validators can be bypassed using further, unspecified fields. While forbidding additionalProperties can create rigidity and hinder the evolution of an API - eg making it hard to accept new parameters or fields - it is possible that this flexibility can be used to bypass the schema validator and force the application to process unwanted information. Disable `additionalProperties` with `false` ``` Person: type: object additionalProperties: false properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` Or constraint them using `maxProperties` ``` Person: type: object additionalProperties: type: string pattern: /+39[0-9]{,14}/ maxProperties: 3 properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` - no additionalProperties - constrained additionalProperties. To fix: Ensure `additionalProperties` is absent or empty (falsy) at each matching location. Guidance: Objects should not allow additionalProperties. Disable them with `additionalProperties: false` or constraint them. This rule is evaluated at the JSONPath `$.[?(@.type==\"object\" && @.additionalProperties==true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-object-set-additional-property":{"title":"Schema Object Set Additional Property","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-object-set-additional-property/","source":"compiled","description":"By default, jsonschema allows additionalProperties. This means that schema validators can be bypassed using further, unspecified fields. While forbidding additionalProperties can create rigidity and hinder the evolution of an API - eg making it hard to accept new parameters or fields - it is possible that this flexibility can be used to bypass the schema validator and force the application to process unwanted information. Disable `additionalProperties` with `false` ``` Person: type: object additionalProperties: false properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` Or constraint them using `maxProperties` ``` Person: type: object additionalProperties: type: string pattern: /+39[0-9]{,14}/ maxProperties: 3 properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` - no additionalProperties - constrained additionalProperties. @.additionalProperties)]`).","message":"Objects should not allow additionalProperties. Disable them with `additionalProperties: false` or constraint them.","severity":"info","given":["$.[?(@.type==\"object\" && ! @.additionalProperties)]"],"then":[{"field":"additionalProperties","function":"defined"}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling","owasp:api3"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-object-set-additional-property' (Schema Object Set Additional Property). Requirement: By default, jsonschema allows additionalProperties. This means that schema validators can be bypassed using further, unspecified fields. While forbidding additionalProperties can create rigidity and hinder the evolution of an API - eg making it hard to accept new parameters or fields - it is possible that this flexibility can be used to bypass the schema validator and force the application to process unwanted information. Disable `additionalProperties` with `false` ``` Person: type: object additionalProperties: false properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` Or constraint them using `maxProperties` ``` Person: type: object additionalProperties: type: string pattern: /+39[0-9]{,14}/ maxProperties: 3 properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` - no additionalProperties - constrained additionalProperties. @.additionalProperties)]`). To fix: Ensure `additionalProperties` is defined at each matching location. Guidance: Objects should not allow additionalProperties. Disable them with `additionalProperties: false` or constraint them. This rule is evaluated at the JSONPath `$.[?(@.type==\"object\" && ! @.additionalProperties)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-orgid-property-must-be-string":{"title":"Schema Orgid Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-orgid-property-must-be-string/","source":"compiled","description":"orgId MUST use a data type of 'string'.","message":"orgId MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"orgId\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-orgid-property-must-be-string' (Schema Orgid Property Must Be String). Requirement: orgId MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"orgId\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-owasp-api4-integer-format":{"title":"Schema OWASP API4 Integer Format","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-owasp-api4-integer-format/","source":"spotlight","description":"Integer properties should declare a format (int32 / int64) so their range is bounded (OWASP API4 — unrestricted resource consumption).","message":"Integer property should declare a format (int32 or int64).","given":"$..properties[?(@ && @.type == 'integer')]","severity":"info","then":{"field":"format","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:security","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-owasp-api4-integer-format' (Schema OWASP API4 Integer Format). Requirement: Integer properties should declare a format (int32 / int64) so their range is bounded (OWASP API4 — unrestricted resource consumption). To fix: Ensure `format` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..properties[?(@ && @.type == 'integer')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-camel-case":{"title":"Schema Property Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-camel-case/","source":"default","description":"Schema properties MUST follow camelCase.","message":"{{property}} schema property is not camelCase: {{error}}","severity":"info","given":"$.definitions..properties[*]~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-camel-case' (Schema Property Camel Case). Requirement: Schema properties MUST follow camelCase. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions..properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-camel-case-3":{"title":"Schema Property Camel Case 3","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-camel-case-3/","source":"compiled","description":"Schema property names should use camelCase. Analysis of 773 specs shows camelCase is the dominant convention at 65% (12958 properties), followed by snake_case at 33% (6661 properties).","message":"Schema Properties MUST Use camelCase","severity":"info","given":"$.components.schemas[*].properties","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-camel-case-3' (Schema Property Camel Case 3). Requirement: Schema property names should use camelCase. Analysis of 773 specs shows camelCase is the dominant convention at 65% (12958 properties), followed by snake_case at 33% (6661 properties). To fix: Ensure the targeted value matches the regular expression `^[a-z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.schemas[*].properties` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-constant-case":{"title":"Schema Property Constant Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-constant-case/","source":"default","description":"Schema properties MUST follow CONSTANT_CASE (screaming snake_case).","message":"{{property}} schema property is not CONSTANT_CASE: {{error}}","severity":"info","given":"$.definitions..properties[*]~","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-constant-case' (Schema Property Constant Case). Requirement: Schema properties MUST follow CONSTANT_CASE (screaming snake_case). To fix: Ensure the targeted value matches the regular expression `^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions..properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-description-max-length":{"title":"Schema Property Description Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-description-max-length/","source":"compiled","description":"Schema property descriptions should have a length limit applied, applying constraints to writing descriptions, and keeping consistent across APIs.","message":"Schema Properties Description MUST Have 250 Characters","severity":"info","given":"$.components.schemas.*.properties[?(@.type == 'string')]","then":{"field":"description","function":"length","functionOptions":{"max":250}},"tags":["format:openapi","spec:schemas","spec:components","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-description-max-length' (Schema Property Description Max Length). Requirement: Schema property descriptions should have a length limit applied, applying constraints to writing descriptions, and keeping consistent across APIs. To fix: Ensure the length of `description` is at most 250. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type == 'string')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-enum-upper-snake-case":{"title":"Schema Property Enum Upper Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-enum-upper-snake-case/","source":"compiled","description":"Schema property enumerators are consistent casing, keeping all entries upper snake case, and consistent across all APIs.","message":"Schema Property Enum MUST Be Upper Snake Case","severity":"info","given":"$.components.schemas.*.properties.*.enum.*","then":{"function":"pattern","functionOptions":{"match":"^[A-Z]+(?:_[A-Z]+)*$"}},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-enum-upper-snake-case' (Schema Property Enum Upper Snake Case). Requirement: Schema property enumerators are consistent casing, keeping all entries upper snake case, and consistent across all APIs. To fix: Ensure the targeted value matches the regular expression `^[A-Z]+(?:_[A-Z]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.schemas.*.properties.*.enum.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-kebab-case":{"title":"Schema Property Kebab Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-kebab-case/","source":"default","description":"Schema properties MUST follow kebab-case.","message":"{{property}} schema property is not kebab-case: {{error}}","severity":"info","given":"$.definitions..properties[*]~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(-[a-z0-9]+)*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-kebab-case' (Schema Property Kebab Case). Requirement: Schema properties MUST follow kebab-case. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(-[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions..properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-names-camel-case":{"title":"Schema Property Names Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-names-camel-case/","source":"compiled","description":"Schema property names are camel case, providing consistent casing across all the schema properties used by APIs.","message":"Schema Property Names MUST Be camelCase.","severity":"info","given":"$.components.schemas.*.properties","then":[{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^[A-Z][a-z0-9]*[A-Z0-9][a-z0-9]+[A-Za-z0-9]*$"}}],"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-names-camel-case' (Schema Property Names Camel Case). Requirement: Schema property names are camel case, providing consistent casing across all the schema properties used by APIs. To fix: Ensure `@key` does NOT match the regular expression `^[A-Z][a-z0-9]*[A-Z0-9][a-z0-9]+[A-Za-z0-9]*$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.components.schemas.*.properties` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-names-camel-case-2":{"title":"Schema Property Names Camel Case 2","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-names-camel-case-2/","source":"compiled","description":"Property names and acronyms MUST be in camelCase.","message":"Property names and acronyms MUST be in camelCase.","severity":"info","given":"$..properties.*~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(([A-Z]{2}|[A-Z])[a-z0-9]+)*$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-names-camel-case-2' (Schema Property Names Camel Case 2). Requirement: Property names and acronyms MUST be in camelCase. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(([A-Z]{2}|[A-Z])[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-names-length-limit":{"title":"Schema Property Names Length Limit","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-names-length-limit/","source":"compiled","description":"Schema property names have a length restriction applied, keeping names consistent, and avoiding being too long.","message":"Schema Properties Name Length","severity":"info","given":"$.components.schemas.*.properties","then":{"field":"@key","function":"length","functionOptions":{"max":25}},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-names-length-limit' (Schema Property Names Length Limit). Requirement: Schema property names have a length restriction applied, keeping names consistent, and avoiding being too long. To fix: Ensure the length of `@key` is at most 25. This rule is evaluated at the JSONPath `$.components.schemas.*.properties` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-no-language-keywords":{"title":"Schema Property No Language Keywords","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-no-language-keywords/","source":"compiled","description":"Names that may conflict with keywords in common programming languages SHOULD NOT be used.","message":"Names that may conflict with keywords in common programming languages SHOULD NOT be used.","severity":"info","given":"$..properties.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^(abstract|for|new|switch|assert|default|goto|package|synchronized|boolean|do|if|private|this|break|double|implements|throw|byte|else|import|public|throws|case|enum|instanceof|return|transient|catch|extends|int|short|try|char|final|interface|static|void|class|finally|long|volatile|const|float|native|super|while)$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-no-language-keywords' (Schema Property No Language Keywords). Requirement: Names that may conflict with keywords in common programming languages SHOULD NOT be used. To fix: Ensure the targeted value does NOT match the regular expression `^(abstract|for|new|switch|assert|default|goto|package|synchronized|boolean|do|if|private|this|break|double|implements|throw|byte|else|import|public|throws|case|enum|instanceof|return|transient|catch|extends|int|short|try|char|final|interface|static|void|class|finally|long|volatile|const|float|native|super|while)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-no-prepositions":{"title":"Schema Property No Prepositions","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-no-prepositions/","source":"compiled","description":"Property names SHOULD NOT include prepositions (e.g. \"for\", \"during\", \"at\", etc.).","message":"Property names SHOULD NOT include prepositions (e.g.","severity":"info","given":"$..properties.*~","then":{"function":"pattern","functionOptions":{"notMatch":"(^(about|above|across|after|against|among|around|at|before|behind|below|beside|between|down|during|for|from|in|inside|into|near|of|off|on|out|over|through|to|toward|under|up|with|as|but|like|since|than|till|unlike|until|upon|within|without)([A-Z]|$)|.*(About|Above|Across|After|Against|Among|Around|At|Before|Behind|Below|Beside|Between|Down|During|For|From|In|Inside|Into|Near|Of|Off|On|Out|Over|Through|To|Toward|Under|Up|With|As|But|Like|Since|Than|Till|Unlike|Until|Upon|Within|Without)([A-Z]|$)).*"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-no-prepositions' (Schema Property No Prepositions). Requirement: Property names SHOULD NOT include prepositions (e.g. \"for\", \"during\", \"at\", etc.). To fix: Ensure the targeted value does NOT match the regular expression `(^(about|above|across|after|against|among|around|at|before|behind|below|beside|between|down|during|for|from|in|inside|into|near|of|off|on|out|over|through|to|toward|under|up|with|as|but|like|since|than|till|unlike|until|upon|within|without)([A-Z]|$)|.*(About|Above|Across|After|Against|Among|Around|At|Before|Behind|Below|Beside|Between|Down|During|For|From|In|Inside|Into|Near|Of|Off|On|Out|Over|Through|To|Toward|Under|Up|With|As|But|Like|Since|Than|Till|Unlike|Until|Upon|Within|Without)([A-Z]|$)).*`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-pascal-case":{"title":"Schema Property Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-pascal-case/","source":"default","description":"Schema properties MUST follow PascalCase.","message":"{{property}} schema property is not PascalCase: {{error}}","severity":"info","given":"$.definitions..properties[*]~","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-pascal-case' (Schema Property Pascal Case). Requirement: Schema properties MUST follow PascalCase. To fix: Ensure the targeted value matches the regular expression `^[A-Z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions..properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-require-description":{"title":"Schema Property Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-require-description/","source":"compiled","description":"Schema properties should have descriptions that provide a narrative of the property contains, and how it can be used.","message":"Schema Properties MUST Have Description","severity":"info","given":"$.components.schemas.*.properties[?(@.type == 'string')]","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:schemas","spec:components","experience:documentation","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-require-description' (Schema Property Require Description). Requirement: Schema properties should have descriptions that provide a narrative of the property contains, and how it can be used. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type == 'string')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-require-examples":{"title":"Schema Property Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-require-examples/","source":"compiled","description":"Object properties must include examples.","message":"{{description}}; {{property}}","severity":"info","given":"$..properties..properties.*","then":{"function":"digitalocean:ensurePropertiesExample"},"tags":["format:openapi","spec:schemas","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-require-examples' (Schema Property Require Examples). Requirement: Object properties must include examples. This rule is evaluated at the JSONPath `$..properties..properties.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-require-type":{"title":"Schema Property Require Type","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-require-type/","source":"compiled","description":"Schema properties must have a type defined.","message":"{{error}}","severity":"info","given":"$..properties.*","then":{"function":"digitalocean:ensureSchemaHasType"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-require-type' (Schema Property Require Type). Requirement: Schema properties must have a type defined. This rule is evaluated at the JSONPath `$..properties.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-snake-case":{"title":"Schema Property Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-snake-case/","source":"default","description":"Schema properties MUST follow snake_case.","message":"{{property}} schema property is not snake_case: {{error}}","severity":"info","given":"$.definitions..properties[*]~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(_[a-z0-9]+)*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-snake-case' (Schema Property Snake Case). Requirement: Schema properties MUST follow snake_case. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(_[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions..properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-ref-property-must-be-string":{"title":"Schema Ref Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-ref-property-must-be-string/","source":"compiled","description":"ref MUST use a data type of 'string'.","message":"ref MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"ref\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-ref-property-must-be-string' (Schema Ref Property Must Be String). Requirement: ref MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"ref\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-ref-property-require-format":{"title":"Schema Ref Property Require Format","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-ref-property-require-format/","source":"compiled","description":"Property with the name 'ref' MUST use a format 'sps-ref'.","message":"Property with the name 'ref' MUST use a format 'sps-ref'.","severity":"info","given":"$..properties..[?((@property=== \"ref\" || @property === \"Ref\") && @.$ref == null && @.allOf == null && @.oneOf == null && @.type != null)]","then":[{"field":"format","function":"truthy"},{"field":"format","function":"pattern","functionOptions":{"match":"^sps-ref$"}}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-ref-property-require-format' (Schema Ref Property Require Format). Requirement: Property with the name 'ref' MUST use a format 'sps-ref'. To fix: Ensure `format` is present and non-empty at each matching location. Also: Ensure `format` matches the regular expression `^sps-ref$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..properties..[?((@property=== \"ref\" || @property === \"Ref\") && @.$ref == null && @.allOf == null && @.oneOf == null && @.type != null)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-ref-property-standard":{"title":"Schema Ref Property Standard","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-ref-property-standard/","source":"compiled","description":"Properties following 'sps-ref' format MUST use the standardized schema - maxLength (255), minLength(7), pattern (includes 'sps'), type (string).","message":"{{property}} is not provided or not following required schema values.","severity":"info","given":"$..[?(@property=== \"format\" && @ == \"sps-ref\")]^","then":[{"function":"schema","functionOptions":{"schema":{"type":"object","required":["maxLength","minLength","type","pattern"],"properties":{"maxLength":{"type":"integer","minimum":255,"maximum":255},"minLength":{"type":"integer","minimum":7,"maximum":7},"type":{"type":"string"},"pattern":{"type":"string"}}}}},{"field":"pattern","function":"pattern","functionOptions":{"match":"sps"}},{"field":"type","function":"pattern","functionOptions":{"match":"^string$"}}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-ref-property-standard' (Schema Ref Property Standard). Requirement: Properties following 'sps-ref' format MUST use the standardized schema - maxLength (255), minLength(7), pattern (includes 'sps'), type (string). To fix: Adjust the targeted value so it conforms to the schema this rule requires. Also: Ensure `pattern` matches the regular expression `sps`; rewrite any value that does not. Also: Ensure `type` matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property=== \"format\" && @ == \"sps-ref\")]^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-requestid-property-must-be-string":{"title":"Schema Requestid Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-requestid-property-must-be-string/","source":"compiled","description":"requestId MUST use a data type of 'string'.","message":"requestId MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"requestId\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","topic:tracing","experience:data-modeling","experience:consistency","experience:observability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-requestid-property-must-be-string' (Schema Requestid Property Must Be String). Requirement: requestId MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"requestId\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-require-description":{"title":"Schema Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-require-description/","source":"compiled","description":"Schema should have descriptions that provide a narrative of what a schema object is for, and how it can be used, leaving examples to demonstrate what can actually be expected.","message":"Schema MUST Have a Description.","severity":"info","given":"$.components.schemas.*","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:schemas","spec:components","experience:documentation","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-require-description' (Schema Require Description). Requirement: Schema should have descriptions that provide a narrative of what a schema object is for, and how it can be used, leaving examples to demonstrate what can actually be expected. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-require-info-object":{"title":"Schema Require Info Object","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-require-info-object/","source":"compiled","description":"Having an info object provides much of the metadata needed for the collection of APIs described in an OpenAPI.","message":"Info Object MUST Exist","severity":"info","given":"$","then":{"field":"info","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-require-info-object' (Schema Require Info Object). Requirement: Having an info object provides much of the metadata needed for the collection of APIs described in an OpenAPI. To fix: Ensure `info` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-require-name":{"title":"Schema Require Name","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-require-name/","source":"compiled","description":"Schema names, keeping the naming of them consistent across APIs, standardizing how consumers can use in their applications.","message":"Schema Names MUST Exist","severity":"info","given":"$.components.schemas","then":{"field":"@key","function":"truthy"},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-require-name' (Schema Require Name). Requirement: Schema names, keeping the naming of them consistent across APIs, standardizing how consumers can use in their applications. To fix: Ensure `@key` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-require-tag-object":{"title":"Schema Require Tag Object","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-require-tag-object/","source":"compiled","description":"There needs to be a central tags object applied to the OpenAPI, providing central tags that can be applied across all operations within an OpenAPI.","message":"OpenAPIs MUST Have a Tag Object","severity":"info","given":"$","then":{"field":"tags","function":"truthy"},"tags":["format:openapi","spec:document","experience:discoverability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-require-tag-object' (Schema Require Tag Object). Requirement: There needs to be a central tags object applied to the OpenAPI, providing central tags that can be applied across all operations within an OpenAPI. To fix: Ensure `tags` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-require-type":{"title":"Schema Require Type","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-require-type/","source":"compiled","description":"Schema should have a type defined, being explicit about type of data a schema describes and can be used to validate, helping standardize the type of data being made available.","message":"Schema MUST Have Type Property","severity":"info","given":"$.components.schemas.*","then":{"field":"type","function":"truthy"},"tags":["format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-require-type' (Schema Require Type). Requirement: Schema should have a type defined, being explicit about type of data a schema describes and can be used to validate, helping standardize the type of data being made available. To fix: Ensure `type` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-string-property-require-max-length":{"title":"Schema String Property Require Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-string-property-require-max-length/","source":"compiled","description":"Schema properties that are of the string type have the max length applied defining the shape of the property.","message":"Schema String Properties MUST Have Maximum Length","severity":"info","given":"$.components.schemas.*.properties[?(@.type == 'string')]","then":{"field":"maxLength","function":"truthy"},"tags":["owasp:api4","format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-string-property-require-max-length' (Schema String Property Require Max Length). Requirement: Schema properties that are of the string type have the max length applied defining the shape of the property. To fix: Ensure `maxLength` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type == 'string')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-string-property-require-min-length":{"title":"Schema String Property Require Min Length","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-string-property-require-min-length/","source":"compiled","description":"Schema properties that are of the string type have the min length applied defining the shape of the property.","message":"Schema String Properties MUST Have Minimum Length","severity":"info","given":"$.components.schemas.*.properties[?(@.type == 'string')]","then":{"field":"minLength","function":"truthy"},"tags":["format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-string-property-require-min-length' (Schema String Property Require Min Length). Requirement: Schema properties that are of the string type have the min length applied defining the shape of the property. To fix: Ensure `minLength` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type == 'string')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-string-require-max-length":{"title":"Schema String Require Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-string-require-max-length/","source":"compiled","description":"String length should be limited to avoid an attacker to send very long strings to your service. You can do this in different ways: - specify a `maxLength` - constraint the possible values with an `enum` - use a constrained `format` like `date` or `date-time`. A constrained string using the `date` format. ``` ConstrainedString: type: string format: date ``` Another constrained string using `maxLength`. You can always add further constraints using a `pattern` or a `format`. ``` ZipCode: type: string maxLength: 5 pattern: '[0-9]{5}' ``` For further security, you can always limit string length even in conjunction with `format` and `pattern`.","message":"Strings (non enum) must specify a maximum length. {{path}} {{error}}","severity":"info","given":["$.[?(@.type==\"string\" && !@.enum && @.format!=\"date\" && @.format !=\"date-time\" )]"],"then":[{"field":"maxLength","function":"defined"}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-string-require-max-length' (Schema String Require Max Length). Requirement: String length should be limited to avoid an attacker to send very long strings to your service. You can do this in different ways: - specify a `maxLength` - constraint the possible values with an `enum` - use a constrained `format` like `date` or `date-time`. A constrained string using the `date` format. ``` ConstrainedString: type: string format: date ``` Another constrained string using `maxLength`. You can always add further constraints using a `pattern` or a `format`. ``` ZipCode: type: string maxLength: 5 pattern: '[0-9]{5}' ``` For further security, you can always limit string length even in conjunction with `format` and `pattern`. To fix: Ensure `maxLength` is defined at each matching location. This rule is evaluated at the JSONPath `$.[?(@.type==\"string\" && !@.enum && @.format!=\"date\" && @.format !=\"date-time\" )]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-string-require-pattern-or-format":{"title":"Schema String Require Pattern Or Format","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-string-require-pattern-or-format/","source":"compiled","description":"String length should be limited to avoid an attacker to send very long strings to your service. You can do this in different ways: - specify a `maxLength` - constraint the possible values with an `enum` - use a constrained `format` like `date` or `date-time`. A constrained string using the `date` format. ``` ConstrainedString: type: string format: date ``` Another constrained string using `maxLength`. You can always add further constraints using a `pattern` or a `format`. ``` ZipCode: type: string maxLength: 5 pattern: '[0-9]{5}' ``` For further security, you can always limit string length even in conjunction with `format` and `pattern`.","message":"Strings (non enum) must specify a pattern or a format. {{path}}","severity":"info","given":["$.[?(@.type==\"string\" && !@.enum && @.format!=\"date\" && @.format !=\"date-time\" )]"],"then":{"function":"schema","functionOptions":{"schema":{"type":"object","anyOf":[{"required":["pattern"]},{"required":["format"]}],"additionalProperties":true}}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-string-require-pattern-or-format' (Schema String Require Pattern Or Format). Requirement: String length should be limited to avoid an attacker to send very long strings to your service. You can do this in different ways: - specify a `maxLength` - constraint the possible values with an `enum` - use a constrained `format` like `date` or `date-time`. A constrained string using the `date` format. ``` ConstrainedString: type: string format: date ``` Another constrained string using `maxLength`. You can always add further constraints using a `pattern` or a `format`. ``` ZipCode: type: string maxLength: 5 pattern: '[0-9]{5}' ``` For further security, you can always limit string length even in conjunction with `format` and `pattern`. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.[?(@.type==\"string\" && !@.enum && @.format!=\"date\" && @.format !=\"date-time\" )]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-use-fingerprint-not-hash":{"title":"Schema Use Fingerprint Not Hash","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-use-fingerprint-not-hash/","source":"compiled","description":"Rather than property names refering to the implementation for 'hash' or 'hashkey', you MUST use the property name 'fingerprint'.","message":"{{property}} is not using property name fingerprint.","severity":"info","given":"$.components.schemas..properties.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^hashkey|hashKey|hash$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-use-fingerprint-not-hash' (Schema Use Fingerprint Not Hash). Requirement: Rather than property names refering to the implementation for 'hash' or 'hashkey', you MUST use the property name 'fingerprint'. To fix: Ensure the targeted value does NOT match the regular expression `^hashkey|hashKey|hash$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.components.schemas..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-use-id-not-identifier":{"title":"Schema Use ID Not Identifier","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-use-id-not-identifier/","source":"compiled","description":"Use abbreviations instead of long form names, i.e. identifier SHOULD BE id.","message":"Use abbreviations instead of long form names, i.e.","severity":"info","given":"$..properties.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^identifier$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-use-id-not-identifier' (Schema Use ID Not Identifier). Requirement: Use abbreviations instead of long form names, i.e. identifier SHOULD BE id. To fix: Ensure the targeted value does NOT match the regular expression `^identifier$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-use-org-not-organization":{"title":"Schema Use Org Not Organization","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-use-org-not-organization/","source":"compiled","description":"Use abbreviations instead of long form names, i.e. organization SHOULD BE org.","message":"Use abbreviations instead of long form names, i.e.","severity":"info","given":"$..properties.*~","then":{"function":"pattern","functionOptions":{"notMatch":"(^organization([A-Z]|$)|Organization([A-Z]|$))"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-use-org-not-organization' (Schema Use Org Not Organization). Requirement: Use abbreviations instead of long form names, i.e. organization SHOULD BE org. To fix: Ensure the targeted value does NOT match the regular expression `(^organization([A-Z]|$)|Organization([A-Z]|$))`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-write-operation-require-security":{"title":"Schema Write Operation Require Security","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-write-operation-require-security/","source":"compiled","description":"Your API should be protected by a `security` rule either at global or operation level. Operations should be protected specially when they are tied to non-idempotent HTTP methods like `POST`, `PUT`, `PATCH` and `DELETE`. This is done with one or more non-empty `security` rules. Security rules are defined in the `securityScheme` section. An example of a security rule applied at global level. ``` security: - BasicAuth: [] paths: /books: {} /users: {} securitySchemes: BasicAuth: scheme: http type: basic ``` An example of a security rule applied at operation level, which eventually overrides the global one ``` paths: /books: post: security: - AccessToken: [] securitySchemes: BasicAuth: scheme: http type: basic AccessToken: scheme: http type: bearer bearerFormat: JWT ```.","message":"The following non-idempotent operation is not protected by a `security` rule: {{path}}","severity":"info","given":["$.paths.*[?(@property.match(/^(post|put|patch|delete)/))]"],"then":[{"field":"security","function":"schema","functionOptions":{"schema":{"items":{"type":"object","minProperties":1},"minItems":1,"type":"array"}}}],"formats":["oas3"],"tags":["owasp:api2","format:openapi","spec:paths","spec:operations","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-write-operation-require-security' (Schema Write Operation Require Security). Requirement: Your API should be protected by a `security` rule either at global or operation level. Operations should be protected specially when they are tied to non-idempotent HTTP methods like `POST`, `PUT`, `PATCH` and `DELETE`. This is done with one or more non-empty `security` rules. Security rules are defined in the `securityScheme` section. An example of a security rule applied at global level. ``` security: - BasicAuth: [] paths: /books: {} /users: {} securitySchemes: BasicAuth: scheme: http type: basic ``` An example of a security rule applied at operation level, which eventually overrides the global one ``` paths: /books: post: security: - AccessToken: [] securitySchemes: BasicAuth: scheme: http type: basic AccessToken: scheme: http type: bearer bearerFormat: JWT ```. To fix: Adjust `security` so it conforms to the schema this rule requires. Guidance: The following non-idempotent operation is not protected by a `security` rule. This rule is evaluated at the JSONPath `$.paths.*[?(@property.match(/^(post|put|patch|delete)/))]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-bearer-scheme-require-bearer-format":{"title":"Security Bearer Scheme Require Bearer Format","reference":"https://spotlight-rules.com/spec/rules/openapi/security-bearer-scheme-require-bearer-format/","source":"spotlight","description":"HTTP bearer security schemes should declare a bearerFormat (e.g. JWT) so consumers know the token type and tooling can validate it.","message":"HTTP bearer scheme should declare a bearerFormat (e.g. JWT).","given":"$.components.securitySchemes[?(@ && @.type == 'http' && @.scheme == 'bearer')]","severity":"info","then":{"field":"bearerFormat","function":"truthy"},"tags":["format:openapi","spec:components","experience:security","owasp:api2"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-bearer-scheme-require-bearer-format' (Security Bearer Scheme Require Bearer Format). Requirement: HTTP bearer security schemes should declare a bearerFormat (e.g. JWT) so consumers know the token type and tooling can validate it. To fix: Ensure `bearerFormat` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.securitySchemes[?(@ && @.type == 'http' && @.scheme == 'bearer')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-jwt-scheme-require-description":{"title":"Security JWT Scheme Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/security-jwt-scheme-require-description/","severity":"info","source":"compiled","description":"Json Web Tokens RFC7519 is a compact, URL-safe means of representing claims to be transferred between two parties. JWT can be enclosed in encrypted or signed tokens like JWS and JWE. The [JOSE IANA registry](https://www.iana.org/assignments/jose/jose.xhtml) provides algorithms information. RFC8725 describes common pitfalls in the JWx specifications and in their implementations, such as: - the ability to ignore algorithms, eg. `{\"alg\": \"none\"}`; - using insecure algorithms like `RSASSA-PKCS1-v1_5` eg. `{\"alg\": \"RS256\"}`. An API using JWT should explicit in the `description` that the implementation conforms to RFC8725. ``` components: securitySchemes: JWTBearer: type: http scheme: bearer bearerFormat: JWT description: |- A bearer token in the format of a JWS and conformato to the specifications included in RFC8725. ```.","message":"JWT usage should be detailed in `description` {{error}}.","given":["$.[securitySchemes][?(@.bearerFormat==\"jwt\" || @.bearerFormat==\"JWT\")]"],"then":[{"field":"description","function":"truthy"},{"field":"description","function":"pattern","functionOptions":{"match":".*RFC8725.*"}}],"tags":["owasp:api2","format:openapi","spec:security","experience:security","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-jwt-scheme-require-description' (Security JWT Scheme Require Description). Requirement: Json Web Tokens RFC7519 is a compact, URL-safe means of representing claims to be transferred between two parties. JWT can be enclosed in encrypted or signed tokens like JWS and JWE. The [JOSE IANA registry](https://www.iana.org/assignments/jose/jose.xhtml) provides algorithms information. RFC8725 describes common pitfalls in the JWx specifications and in their implementations, such as: - the ability to ignore algorithms, eg. `{\"alg\": \"none\"}`; - using insecure algorithms like `RSASSA-PKCS1-v1_5` eg. `{\"alg\": \"RS256\"}`. An API using JWT should explicit in the `description` that the implementation conforms to RFC8725. ``` components: securitySchemes: JWTBearer: type: http scheme: bearer bearerFormat: JWT description: |- A bearer token in the format of a JWS and conformato to the specifications included in RFC8725. ```. To fix: Ensure `description` is present and non-empty at each matching location. Also: Ensure `description` matches the regular expression `.*RFC8725.*`; rewrite any value that does not. Guidance: JWT usage should be detailed in `description`. This rule is evaluated at the JSONPath `$.[securitySchemes][?(@.bearerFormat==\"jwt\" || @.bearerFormat==\"JWT\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-no-http-basic-auth":{"title":"Security No HTTP Basic Auth","reference":"https://spotlight-rules.com/spec/rules/openapi/security-no-http-basic-auth/","source":"compiled","description":"Consider a more secure alternative to HTTP Basic.","message":"HTTP Basic is an insecure way to pass credentials around, use an alternative.","severity":"info","given":"$.components.securitySchemes[*]","then":{"field":"scheme","function":"pattern","functionOptions":{"notMatch":"basic"}},"tags":["owasp:api2","format:openapi","spec:security","spec:components","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-no-http-basic-auth' (Security No HTTP Basic Auth). Requirement: Consider a more secure alternative to HTTP Basic. To fix: Ensure `scheme` does NOT match the regular expression `basic`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.components.securitySchemes[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-oauth-disallow-insecure-flows":{"title":"Security OAuth Disallow Insecure Flows","reference":"https://spotlight-rules.com/spec/rules/openapi/security-oauth-disallow-insecure-flows/","source":"compiled","description":"The OAuth2 authorization framework defines various [grant types](https://tools.ietf.org/html/rfc6749#section-1.3), most notably the [AuthorizationCode](https://tools.ietf.org/html/rfc6749#section-1.3.1) and the [Client Credentials](https://tools.ietf.org/html/rfc6749#section-1.3.4). Some grant types are now considered insecure and MUST not be used, including `implicit` and `password`. The new [OAuth2.1](https://tools.ietf.org/html/draft-ietf-oauth-v2-1-01) still in draft, removes them and suggests to replace the `implicit` with `authorizationCode` + PKCE defined in RFC7636.","message":"Do not use oauth2 insecure flow: \"{{property}}\".","severity":"info","given":["$.[?(@.type==\"oauth2\")].flows"],"then":[{"field":"implicit","function":"falsy"},{"field":"password","function":"falsy"}],"formats":["oas3"],"tags":["format:openapi","spec:security","experience:security","owasp:api2"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-oauth-disallow-insecure-flows' (Security OAuth Disallow Insecure Flows). Requirement: The OAuth2 authorization framework defines various [grant types](https://tools.ietf.org/html/rfc6749#section-1.3), most notably the [AuthorizationCode](https://tools.ietf.org/html/rfc6749#section-1.3.1) and the [Client Credentials](https://tools.ietf.org/html/rfc6749#section-1.3.4). Some grant types are now considered insecure and MUST not be used, including `implicit` and `password`. The new [OAuth2.1](https://tools.ietf.org/html/draft-ietf-oauth-v2-1-01) still in draft, removes them and suggests to replace the `implicit` with `authorizationCode` + PKCE defined in RFC7636. To fix: Ensure `implicit` is absent or empty (falsy) at each matching location. Also: Ensure `password` is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.[?(@.type==\"oauth2\")].flows` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-oauth-endpoints-require-https":{"title":"Security OAuth Endpoints Require HTTPS","reference":"https://spotlight-rules.com/spec/rules/openapi/security-oauth-endpoints-require-https/","source":"compiled","description":"OAuth2 endpoints must use `https://`.","message":"OAuth endpoints must use https://","severity":"info","given":["$.[securitySchemes][?(@.type==\"oauth2\")][*].[?(@property.match(/url$/i))]"],"then":[{"field":"value","function":"pattern","functionOptions":{"match":"^https://"}}],"formats":["oas3"],"tags":["owasp:api8","format:openapi","spec:security","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-oauth-endpoints-require-https' (Security OAuth Endpoints Require HTTPS). Requirement: OAuth2 endpoints must use `https://`. To fix: Ensure `value` matches the regular expression `^https://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.[securitySchemes][?(@.type==\"oauth2\")][*].[?(@property.match(/url$/i))]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-oauth-flow-require-scopes":{"title":"Security OAuth Flow Require Scopes","reference":"https://spotlight-rules.com/spec/rules/openapi/security-oauth-flow-require-scopes/","source":"spotlight","description":"OAuth2 flows should define scopes so authorization is granular and least-privilege rather than all-or-nothing.","message":"OAuth2 flow should define at least one scope.","given":"$.components.securitySchemes[?(@ && @.type == 'oauth2')].flows[*]","severity":"info","then":{"field":"scopes","function":"schema","functionOptions":{"schema":{"type":"object","minProperties":1}}},"tags":["format:openapi","spec:components","experience:security","experience:governance","owasp:api5"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-oauth-flow-require-scopes' (Security OAuth Flow Require Scopes). Requirement: OAuth2 flows should define scopes so authorization is granular and least-privilege rather than all-or-nothing. To fix: Adjust `scopes` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.components.securitySchemes[?(@ && @.type == 'oauth2')].flows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-oauth-scheme-require-description":{"title":"Security OAuth Scheme Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/security-oauth-scheme-require-description/","severity":"info","source":"compiled","description":"Json Web Tokens RFC7519 is a compact, URL-safe means of representing claims to be transferred between two parties. JWT can be enclosed in encrypted or signed tokens like JWS and JWE. The [JOSE IANA registry](https://www.iana.org/assignments/jose/jose.xhtml) provides algorithms information. RFC8725 describes common pitfalls in the JWx specifications and in their implementations, such as: - the ability to ignore algorithms, eg. `{\"alg\": \"none\"}`; - using insecure algorithms like `RSASSA-PKCS1-v1_5` eg. `{\"alg\": \"RS256\"}`. An API using JWT should explicit in the `description` that the implementation conforms to RFC8725. ``` components: securitySchemes: JWTBearer: type: http scheme: bearer bearerFormat: JWT description: |- A bearer token in the format of a JWS and conformato to the specifications included in RFC8725. ```.","message":"JWT usage should be detailed in `description` {{error}}.","given":["$.[securitySchemes][?(@.type==\"oauth2\")]"],"then":[{"field":"description","function":"truthy"},{"field":"description","function":"pattern","functionOptions":{"match":".*RFC8725.*"}}],"tags":["owasp:api2","format:openapi","spec:security","experience:security","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-oauth-scheme-require-description' (Security OAuth Scheme Require Description). Requirement: Json Web Tokens RFC7519 is a compact, URL-safe means of representing claims to be transferred between two parties. JWT can be enclosed in encrypted or signed tokens like JWS and JWE. The [JOSE IANA registry](https://www.iana.org/assignments/jose/jose.xhtml) provides algorithms information. RFC8725 describes common pitfalls in the JWx specifications and in their implementations, such as: - the ability to ignore algorithms, eg. `{\"alg\": \"none\"}`; - using insecure algorithms like `RSASSA-PKCS1-v1_5` eg. `{\"alg\": \"RS256\"}`. An API using JWT should explicit in the `description` that the implementation conforms to RFC8725. ``` components: securitySchemes: JWTBearer: type: http scheme: bearer bearerFormat: JWT description: |- A bearer token in the format of a JWS and conformato to the specifications included in RFC8725. ```. To fix: Ensure `description` is present and non-empty at each matching location. Also: Ensure `description` matches the regular expression `.*RFC8725.*`; rewrite any value that does not. Guidance: JWT usage should be detailed in `description`. This rule is evaluated at the JSONPath `$.[securitySchemes][?(@.type==\"oauth2\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-openidconnect-require-url":{"title":"Security OpenID-Connect Require URL","reference":"https://spotlight-rules.com/spec/rules/openapi/security-openidconnect-require-url/","source":"spotlight","description":"OpenID Connect security schemes should declare an openIdConnectUrl pointing at the discovery document so clients can configure themselves.","message":"openIdConnect scheme should declare an openIdConnectUrl.","given":"$.components.securitySchemes[?(@ && @.type == 'openIdConnect')]","severity":"info","then":{"field":"openIdConnectUrl","function":"truthy"},"tags":["format:openapi","spec:components","experience:security","owasp:api2"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-openidconnect-require-url' (Security OpenID-Connect Require URL). Requirement: OpenID Connect security schemes should declare an openIdConnectUrl pointing at the discovery document so clients can configure themselves. To fix: Ensure `openIdConnectUrl` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.securitySchemes[?(@ && @.type == 'openIdConnect')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-openidconnect-url-https":{"title":"Security OpenID-Connect URL HTTPS","reference":"https://spotlight-rules.com/spec/rules/openapi/security-openidconnect-url-https/","source":"spotlight","description":"The OpenID Connect discovery URL (openIdConnectUrl) should use https so token/identity configuration is not retrieved over an insecure channel.","message":"openIdConnectUrl should use https.","given":"$.components.securitySchemes[?(@ && @.type == 'openIdConnect')].openIdConnectUrl","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https://"}},"tags":["format:openapi","spec:components","experience:security","owasp:api8"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-openidconnect-url-https' (Security OpenID-Connect URL HTTPS). Requirement: The OpenID Connect discovery URL (openIdConnectUrl) should use https so token/identity configuration is not retrieved over an insecure channel. To fix: Ensure the targeted value matches the regular expression `^https://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.securitySchemes[?(@ && @.type == 'openIdConnect')].openIdConnectUrl` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-owasp-api2-auth-insecure-schemes":{"title":"Security OWASP API2 Auth Insecure Schemes","reference":"https://spotlight-rules.com/spec/rules/openapi/security-owasp-api2-auth-insecure-schemes/","source":"spotlight","description":"HTTP auth schemes should not use insecure mechanisms such as negotiate or oauth1 (OWASP API2). Prefer bearer with a vetted token.","message":"HTTP auth scheme is insecure (avoid negotiate / oauth1).","given":"$.components.securitySchemes[?(@ && @.type == 'http')].scheme","severity":"info","then":{"function":"pattern","functionOptions":{"notMatch":"^(negotiate|oauth)$"}},"tags":["format:openapi","spec:components","experience:security","owasp:api2"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-owasp-api2-auth-insecure-schemes' (Security OWASP API2 Auth Insecure Schemes). Requirement: HTTP auth schemes should not use insecure mechanisms such as negotiate or oauth1 (OWASP API2). Prefer bearer with a vetted token. To fix: Ensure the targeted value does NOT match the regular expression `^(negotiate|oauth)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.components.securitySchemes[?(@ && @.type == 'http')].scheme` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-owasp-api2-no-api-keys-in-url":{"title":"Security OWASP API2 No API Keys In URL","reference":"https://spotlight-rules.com/spec/rules/openapi/security-owasp-api2-no-api-keys-in-url/","source":"spotlight","description":"API key security schemes should be sent in a header or cookie, never in the query string or path (OWASP API2 — credentials leak into logs and history).","message":"apiKey scheme should be in a header or cookie, not the URL.","given":"$.components.securitySchemes[?(@ && @.type == 'apiKey')]","severity":"info","then":{"field":"in","function":"enumeration","functionOptions":{"values":["header","cookie"]}},"tags":["format:openapi","spec:components","experience:security","owasp:api2"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-owasp-api2-no-api-keys-in-url' (Security OWASP API2 No API Keys In URL). Requirement: API key security schemes should be sent in a header or cookie, never in the query string or path (OWASP API2 — credentials leak into logs and history). To fix: Set `in` to one of the allowed values: header, cookie. This rule is evaluated at the JSONPath `$.components.securitySchemes[?(@ && @.type == 'apiKey')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-require-root":{"title":"Security Require Root","reference":"https://spotlight-rules.com/spec/rules/openapi/security-require-root/","source":"compiled","description":"The API contract MUST include a 'security' section at the root level.","message":"{{description}}: {{error}}","severity":"info","given":"$","then":{"field":"security","function":"truthy"},"formats":["oas3"],"tags":["owasp:api2","format:openapi","spec:document","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-require-root' (Security Require Root). Requirement: The API contract MUST include a 'security' section at the root level. To fix: Ensure `security` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-require-root-scheme":{"title":"Security Require Root Scheme","reference":"https://spotlight-rules.com/spec/rules/openapi/security-require-root-scheme/","source":"compiled","description":"Security field MUST be present at the root of the spec with at least one item (ie. HTTPBearer, Token, APIKey, etc.).","message":"Security field MUST be present at the root of the spec with at least one item (ie.","severity":"info","given":"$","then":{"field":"security","function":"schema","functionOptions":{"schema":{"type":"array","minItems":1}}},"tags":["owasp:api2","format:openapi","spec:document","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-require-root-scheme' (Security Require Root Scheme). Requirement: Security field MUST be present at the root of the spec with at least one item (ie. HTTPBearer, Token, APIKey, etc.). To fix: Adjust `security` so it conforms to the schema this rule requires. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-scheme-require-description":{"title":"Security Scheme Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/security-scheme-require-description/","source":"spotlight","description":"Every security scheme should declare a description so consumers know how to authenticate (which token, where to get it, what scopes).","message":"Security scheme should have a description.","given":"$.components.securitySchemes[*]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:components","experience:security","owasp:api2"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-scheme-require-description' (Security Scheme Require Description). Requirement: Every security scheme should declare a description so consumers know how to authenticate (which token, where to get it, what scopes). To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.securitySchemes[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-must-not-specify-port":{"title":"Server Must Not Specify Port","reference":"https://spotlight-rules.com/spec/rules/openapi/server-must-not-specify-port/","source":"compiled","description":"Port MUST NOT be specified or required to use the API, except for 'localhost' testing in a spec.","message":"Port MUST NOT be specified or required to use the API, except for 'localhost' testing in a spec.","severity":"info","given":"$.servers..url","then":{"function":"pattern","functionOptions":{"notMatch":"(?!https?://localhost)(https?://.*):(\\d*)\\/?(.*)"}},"formats":["oas3"],"tags":["format:openapi","spec:servers","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-must-not-specify-port' (Server Must Not Specify Port). Requirement: Port MUST NOT be specified or required to use the API, except for 'localhost' testing in a spec. To fix: Ensure the targeted value does NOT match the regular expression `(?!https?://localhost)(https?://.*):(\\d*)\\/?(.*)`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers..url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-must-use-https":{"title":"Server Must Use HTTPS","reference":"https://spotlight-rules.com/spec/rules/openapi/server-must-use-https/","source":"compiled","description":"Servers MUST be https and no other protocol is allowed unless using localhost.","message":"Servers MUST be https and no other protocol is allowed unless using localhost.","severity":"info","given":"$.servers..url","then":{"function":"pattern","functionOptions":{"match":"^(https:|http://localhost)"}},"formats":["oas3"],"tags":["owasp:api8","format:openapi","spec:servers","experience:security","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-must-use-https' (Server Must Use HTTPS). Requirement: Servers MUST be https and no other protocol is allowed unless using localhost. To fix: Ensure the targeted value matches the regular expression `^(https:|http://localhost)`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.servers..url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-on-approved-domain":{"title":"Server On Approved Domain","reference":"https://spotlight-rules.com/spec/rules/openapi/server-on-approved-domain/","source":"compiled","description":"APIs SHOULD be accessible under api.spscommerce.com.","message":"APIs SHOULD be accessible under api.spscommerce.com.","severity":"info","given":"$.servers..url","then":{"function":"pattern","functionOptions":{"match":"api.spscommerce.com|api.sps-internal.com|localhost"}},"formats":["oas3"],"tags":["format:openapi","spec:servers","experience:governance","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-on-approved-domain' (Server On Approved Domain). Requirement: APIs SHOULD be accessible under api.spscommerce.com. To fix: Ensure the targeted value matches the regular expression `api.spscommerce.com|api.sps-internal.com|localhost`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.servers..url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-require-description":{"title":"Server Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/server-require-description/","source":"compiled","description":"Servers must have a description.","message":"Server {{path}} must have a description.","severity":"info","given":["$.servers[*]","$.paths..servers"],"then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:servers","spec:paths","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-require-description' (Server Require Description). Requirement: Servers must have a description. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.servers[*] | $.paths..servers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-require-https":{"title":"Server Require HTTPS","reference":"https://spotlight-rules.com/spec/rules/openapi/server-require-https/","source":"compiled","description":"ALL requests MUST go through `https` protocol only.","message":"Servers MUST be https and no other protocol is allowed.","severity":"info","given":"$.servers..url","then":{"function":"pattern","functionOptions":{"match":"/^https:/"}},"formats":["oas3"],"tags":["owasp:api8","format:openapi","spec:servers","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-require-https' (Server Require HTTPS). Requirement: ALL requests MUST go through `https` protocol only. To fix: Ensure the targeted value matches the regular expression `/^https:/`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.servers..url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-require-https-2":{"title":"Server Require HTTPS 2","reference":"https://spotlight-rules.com/spec/rules/openapi/server-require-https-2/","source":"compiled","description":"Servers must use https to ensure the origin of the responses and protect the integrity and the confidentiality of the communication. You can use `http://` only on sandboxes environment. Use `x-sandbox: true` to skip this kind of check.","message":"Non-sandbox url  {{value}} {{error}}. Add `x-sandbox: true` to skip this check on a specific server.","severity":"info","given":["$.servers[?(@[\"x-sandbox\"] != true)]","$.paths..servers[?(@[\"x-sandbox\"] != true)]"],"then":{"field":"url","function":"pattern","functionOptions":{"match":"^https://.*"}},"tags":["owasp:api8","format:openapi","spec:servers","spec:paths","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-require-https-2' (Server Require HTTPS 2). Requirement: Servers must use https to ensure the origin of the responses and protect the integrity and the confidentiality of the communication. You can use `http://` only on sandboxes environment. Use `x-sandbox: true` to skip this kind of check. To fix: Ensure `url` matches the regular expression `^https://.*`; rewrite any value that does not. Guidance: Non-sandbox url . Add `x-sandbox: true` to skip this check on a specific server. This rule is evaluated at the JSONPath `$.servers[?(@[\"x-sandbox\"] != true)] | $.paths..servers[?(@[\"x-sandbox\"] != true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-url-include-version":{"title":"Server URL Include Version","reference":"https://spotlight-rules.com/spec/rules/openapi/server-url-include-version/","source":"compiled","description":"API URLs versions should meet the Trimble API Standards.","message":"{{error}}","severity":"info","given":"$.servers","then":{"function":"trimble:valid-version-checker"},"tags":["format:openapi","spec:servers","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-url-include-version' (Server URL Include Version). Requirement: API URLs versions should meet the Trimble API Standards. This rule is evaluated at the JSONPath `$.servers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-url-meet-standards":{"title":"Server URL Meet Standards","reference":"https://spotlight-rules.com/spec/rules/openapi/server-url-meet-standards/","source":"compiled","description":"API URLs should meet the Trimble API Standards.","message":"{{error}}","severity":"info","given":"$.servers","then":{"function":"trimble:valid-url-checker"},"tags":["format:openapi","spec:servers","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-url-meet-standards' (Server URL Meet Standards). Requirement: API URLs should meet the Trimble API Standards. This rule is evaluated at the JSONPath `$.servers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-url-must-be-lowercase":{"title":"Server URL Must Be Lowercase","reference":"https://spotlight-rules.com/spec/rules/openapi/server-url-must-be-lowercase/","source":"compiled","description":"Server URL SHOULD BE lowercase.","message":"Server URL SHOULD BE lowercase.","severity":"info","given":"$.servers..url","then":{"function":"pattern","functionOptions":{"match":"^[^A-Z]*$"}},"formats":["oas3"],"tags":["format:openapi","spec:servers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-url-must-be-lowercase' (Server URL Must Be Lowercase). Requirement: Server URL SHOULD BE lowercase. To fix: Ensure the targeted value matches the regular expression `^[^A-Z]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.servers..url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-url-require-https":{"title":"Server URL Require HTTPS","reference":"https://spotlight-rules.com/spec/rules/openapi/server-url-require-https/","source":"compiled","description":"API server URLs should use HTTPS to ensure encrypted communication between clients and servers, protecting sensitive data in transit.","message":"Server URL MUST Use HTTPS","severity":"info","given":"$.servers[*]","then":{"field":"url","function":"pattern","functionOptions":{"match":"^https://"}},"tags":["owasp:api8","format:openapi","spec:servers","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-url-require-https' (Server URL Require HTTPS). Requirement: API server URLs should use HTTPS to ensure encrypted communication between clients and servers, protecting sensitive data in transit. To fix: Ensure `url` matches the regular expression `^https://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.servers[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-description":{"title":"Tag Description","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-description/","source":"builtin","description":"Tag object must have \"description\".","message":"Tag object must have \"description\".","severity":"info","given":"$.tags[*]","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:tags","experience:documentation","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-description' (Tag Description). Requirement: Tag object must have \"description\". To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-names-title-case":{"title":"Tag Names Title Case","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-names-title-case/","source":"compiled","description":"The first letter of each word in a tag being applied to APIs needs to be capitalized, keeping the tags being applied across APIs the same look and feel for organizing and publishing to documentation.","message":"Tag Names MUST Have First Letter in Each Word Capitalized","severity":"info","given":"$.tags.*.name","then":{"function":"pattern","functionOptions":{"match":"[A-Z]\\w*"}},"tags":["format:openapi","spec:tags","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-names-title-case' (Tag Names Title Case). Requirement: The first letter of each word in a tag being applied to APIs needs to be capitalized, keeping the tags being applied across APIs the same look and feel for organizing and publishing to documentation. To fix: Ensure the targeted value matches the regular expression `[A-Z]\\w*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.tags.*.name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-no-camel-case":{"title":"Tag No Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-no-camel-case/","source":"compiled","description":"Detects a tag with camelCase (personalItem) text within it.","message":"Tag names cannot use Camel Case. Please rename {{value}}.","severity":"info","given":["$.tags[*].name","$.paths[*][*].tags[*]"],"then":{"function":"pattern","functionOptions":{"notMatch":"/^[a-z]+[A-Z][a-z]+$/g"}},"tags":["format:openapi","spec:paths","spec:tags","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-no-camel-case' (Tag No Camel Case). Requirement: Detects a tag with camelCase (personalItem) text within it. To fix: Ensure the targeted value does NOT match the regular expression `/^[a-z]+[A-Z][a-z]+$/g`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.tags[*].name | $.paths[*][*].tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-no-pascal-case":{"title":"Tag No Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-no-pascal-case/","source":"compiled","description":"Tag names cannot use Pascal Case. Please rename {{value}}.","message":"Tag names cannot use Pascal Case. Please rename {{value}}.","severity":"info","given":["$.tags[*].name","$.paths[*][*].tags[*]"],"then":{"function":"pattern","functionOptions":{"notMatch":"/[A-Z][a-z]+[A-Z][a-z]+$/g"}},"tags":["format:openapi","spec:paths","spec:tags","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-no-pascal-case' (Tag No Pascal Case). Requirement: Tag names cannot use Pascal Case. Please rename {{value}}. To fix: Ensure the targeted value does NOT match the regular expression `/[A-Z][a-z]+[A-Z][a-z]+$/g`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.tags[*].name | $.paths[*][*].tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-no-version-info":{"title":"Tag No Version Info","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-no-version-info/","source":"compiled","description":"Tag names cannot have version information {{value}}. Consider versioning your API.","message":"Tag names cannot have version information {{value}}. Consider versioning your API.","severity":"info","given":["$.tags[*].name","$.paths[*][*].tags[*]"],"then":{"function":"pattern","functionOptions":{"notMatch":"/(V|v)\\s?[0-9]+/g"}},"tags":["format:openapi","spec:paths","spec:tags","experience:naming","experience:versioning"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-no-version-info' (Tag No Version Info). Requirement: Tag names cannot have version information {{value}}. Consider versioning your API. To fix: Ensure the targeted value does NOT match the regular expression `/(V|v)\\s?[0-9]+/g`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.tags[*].name | $.paths[*][*].tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-require-at-least-one":{"title":"Tag Require At Least One","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-require-at-least-one/","source":"compiled","description":"There needs to be at least one tag applied to an OpenAPI, providing a key word or phrase that can be applied to API operations.","message":"MUST Be At Least One Tag","severity":"info","given":"$","then":{"field":"tags","function":"length","functionOptions":{"min":1}},"tags":["format:openapi","spec:document","experience:discoverability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-require-at-least-one' (Tag Require At Least One). Requirement: There needs to be at least one tag applied to an OpenAPI, providing a key word or phrase that can be applied to API operations. To fix: Ensure the length of `tags` is at least 1. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-require-name":{"title":"Tag Require Name","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-require-name/","source":"compiled","description":"Tags used as part of an OpenAPI should have names, providing a simple key word or phrase that represents the tag being applied to APIs.","message":"Tags MUST Have a Name","severity":"info","given":"$.tags[*]","then":{"field":"name","function":"truthy"},"tags":["format:openapi","spec:tags","experience:discoverability","experience:naming"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-require-name' (Tag Require Name). Requirement: Tags used as part of an OpenAPI should have names, providing a simple key word or phrase that represents the tag being applied to APIs. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"typed-enum":{"title":"Typed Enum","reference":"https://spotlight-rules.com/spec/rules/openapi/typed-enum/","source":"builtin","description":"Enum values must respect the specified type.","message":"{{error}}","severity":"info","given":"$..[?(@ && @.enum && @.type)]","then":{"function":"typedEnum"},"tags":["format:openapi","spec:document","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'typed-enum' (Typed Enum). Requirement: Enum values must respect the specified type. To fix: Make every enum value match the declared type. This rule is evaluated at the JSONPath `$..[?(@ && @.enum && @.type)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."}},"apis-json":{"api-baseurl-https":{"title":"API Baseurl HTTPS","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-baseurl-https/","source":"spotlight","description":"Each API baseURL should be an https URL.","message":"API baseURL should use https.","given":"$.apis[*].baseURL","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https://"}},"tags":["format:apis-json","spec:apis","experience:security"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-baseurl-https' (API Baseurl HTTPS). Requirement: Each API baseURL should be an https URL. To fix: Ensure the targeted value matches the regular expression `^https://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.apis[*].baseURL` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-contact-include-email":{"title":"API Contact Include Email","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-contact-include-email/","source":"default","description":"The contact object in an APIs.json file allows for referencing the email address of a person or group. This property provides a convenient way for users to seek support for an API, using email as the default method to reach the team managing the API in production.","message":"API contact COULD have email.","severity":"info","given":"$.apis.*.contact.*","then":{"field":"email","function":"truthy"},"tags":["format:apis-json","spec:apis","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-contact-include-email' (API Contact Include Email). Requirement: The contact object in an APIs.json file allows for referencing the email address of a person or group. This property provides a convenient way for users to seek support for an API, using email as the default method to reach the team managing the API in production. To fix: Ensure `email` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.contact.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-contact-include-full-name":{"title":"API Contact Include Full Name","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-contact-include-full-name/","source":"default","description":"The contact object in an APIs.json file includes a full name (FN) property, which specifies the formatted text corresponding to the contact name in the vCard for an API. This provides a quick and clear way to assign a person, group, or other point of contact to an API for addressing questions and providing support.","message":"Contact Could Have FN","severity":"info","given":"$.apis.*.contact.*","then":{"field":"FN","function":"truthy"},"tags":["format:apis-json","spec:apis","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-contact-include-full-name' (API Contact Include Full Name). Requirement: The contact object in an APIs.json file includes a full name (FN) property, which specifies the formatted text corresponding to the contact name in the vCard for an API. This provides a quick and clear way to assign a person, group, or other point of contact to an API for addressing questions and providing support. To fix: Ensure `FN` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.contact.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-entry-require-tag":{"title":"API Entry Require Tag","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-entry-require-tag/","source":"default","description":"Each API defined in an APIs.json artifact includes a property for adding one or more tags. These tags provide additional context about the resources or capabilities offered by the API, highlighting its business value and the domain in which it is applied.","message":"API MUST Have a Tags Object","severity":"info","given":"$.apis.*","then":{"field":"tags","function":"truthy"},"tags":["format:apis-json","spec:apis","experience:discoverability","experience:data-modeling"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-entry-require-tag' (API Entry Require Tag). Requirement: Each API defined in an APIs.json artifact includes a property for adding one or more tags. These tags provide additional context about the resources or capabilities offered by the API, highlighting its business value and the domain in which it is applied. To fix: Ensure `tags` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-include-about-page":{"title":"API Include About Page","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-include-about-page/","source":"default","description":"This property ensures provides a reference to an about page, either for the company, organization, or government agency behind an API, or specifically about the domain, team, and the APIs they produce.","message":"Has About","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(about|About)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-include-about-page' (API Include About Page). Requirement: This property ensures provides a reference to an about page, either for the company, organization, or government agency behind an API, or specifically about the domain, team, and the APIs they produce. To fix: Ensure `type` does NOT match the regular expression `\\b(about|About)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-include-contact":{"title":"API Include Contact","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-include-contact/","source":"default","description":"The contact object in an APIs.json file allows for associating a vCard that represents an individual or organizational entity. It includes common contact information such as a name, email, or other references, offering a standardized method for providing support for an API.","message":"API COULD have a contact.","severity":"info","given":"$.apis.*","then":{"field":"contact","function":"truthy"},"tags":["format:apis-json","spec:apis","experience:discoverability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-include-contact' (API Include Contact). Requirement: The contact object in an APIs.json file allows for associating a vCard that represents an individual or organizational entity. It includes common contact information such as a name, email, or other references, offering a standardized method for providing support for an API. To fix: Ensure `contact` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-go-sdk":{"title":"API Property Require Go SDK","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-go-sdk/","source":"default","description":"This property ensures that there is a Go SDK available for an API, making it easier for Go developers to integrate an API into their applications.","message":"Has Go SDK","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-sdk-go)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-go-sdk' (API Property Require Go SDK). Requirement: This property ensures that there is a Go SDK available for an API, making it easier for Go developers to integrate an API into their applications. To fix: Ensure `type` does NOT match the regular expression `\\b(api-sdk-go)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-java-sdk":{"title":"API Property Require Java SDK","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-java-sdk/","source":"default","description":"This property ensures that there is a Java SDK available for an API, making it easier for Java developers to integrate an API into their applications.","message":"Has Java SDK","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-sdk-java)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-java-sdk' (API Property Require Java SDK). Requirement: This property ensures that there is a Java SDK available for an API, making it easier for Java developers to integrate an API into their applications. To fix: Ensure `type` does NOT match the regular expression `\\b(api-sdk-java)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-linting-rules":{"title":"API Property Require Linting Rules","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-linting-rules/","source":"default","description":"This property ensures that an API has governance rules applied, usually as part of a central set of governance rules, defined by policy, or stages of the API lifecycle.","message":"Has Linting Rules","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-rules|OpenApiRules)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:consistency"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-linting-rules' (API Property Require Linting Rules). Requirement: This property ensures that an API has governance rules applied, usually as part of a central set of governance rules, defined by policy, or stages of the API lifecycle. To fix: Ensure `type` does NOT match the regular expression `\\b(api-rules|OpenApiRules)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-node-sdk":{"title":"API Property Require Node SDK","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-node-sdk/","source":"default","description":"This property ensures that there is a Node SDK available for an API, making it easier for Node developers to integrate an API into their applications.","message":"Has Node SDK","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-sdk-node)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-node-sdk' (API Property Require Node SDK). Requirement: This property ensures that there is a Node SDK available for an API, making it easier for Node developers to integrate an API into their applications. To fix: Ensure `type` does NOT match the regular expression `\\b(api-sdk-node)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-python-sdk":{"title":"API Property Require Python SDK","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-python-sdk/","source":"default","description":"This property ensures that there is a Python SDK available for an API, making it easier for Python developers to integrate an API into their applications.","message":"Has Python SDK","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-sdk-python)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-python-sdk' (API Property Require Python SDK). Requirement: This property ensures that there is a Python SDK available for an API, making it easier for Python developers to integrate an API into their applications. To fix: Ensure `type` does NOT match the regular expression `\\b(api-sdk-python)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-road-map":{"title":"API Property Require Road Map","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-road-map/","source":"default","description":"This property ensures there is a reference to the road map for an API or for the entire API operations within domain, line of business, or teams.","message":"Has a Road Map","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-road-map|road-map|Roadmap|Road Map|RoadMap)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:discoverability","experience:documentation","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-road-map' (API Property Require Road Map). Requirement: This property ensures there is a reference to the road map for an API or for the entire API operations within domain, line of business, or teams. To fix: Ensure `type` does NOT match the regular expression `\\b(api-road-map|road-map|Roadmap|Road Map|RoadMap)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-sandbox":{"title":"API Property Require Sandbox","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-sandbox/","source":"default","description":"This property ensures that an API has a reference to a sandbox for individual APIs or as part of common properties, providing sandbox, synthetic data, and mock servers for use in making test requests.","message":"Has a Blog","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(sandbox|Sandbox)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-sandbox' (API Property Require Sandbox). Requirement: This property ensures that an API has a reference to a sandbox for individual APIs or as part of common properties, providing sandbox, synthetic data, and mock servers for use in making test requests. To fix: Ensure `type` does NOT match the regular expression `\\b(sandbox|Sandbox)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-sdk":{"title":"API Property Require SDK","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-sdk/","source":"default","description":"This property ensures that there is an SDK available for an API, making it easier for developers to integrate an API into their applications.","message":"Has SDK","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(sdk|sdks|SDKs)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-sdk' (API Property Require SDK). Requirement: This property ensures that there is an SDK available for an API, making it easier for developers to integrate an API into their applications. To fix: Ensure `type` does NOT match the regular expression `\\b(sdk|sdks|SDKs)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-security-page":{"title":"API Property Require Security Page","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-security-page/","source":"default","description":"This property ensures there is a URL to the security page, providing details about how security is handled for an API.","message":"Has Security Path","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(Security|SecurityTesting)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:security","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-security-page' (API Property Require Security Page). Requirement: This property ensures there is a URL to the security page, providing details about how security is handled for an API. To fix: Ensure `type` does NOT match the regular expression `\\b(Security|SecurityTesting)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-signup":{"title":"API Property Require Signup","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-signup/","source":"default","description":"This property ensures there is a link to where you sign up for an API, making sure API consumers can access in a single click.","message":"Has a Sign Up","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(X-signup|signup|Sign Up|SignUp)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-signup' (API Property Require Signup). Requirement: This property ensures there is a link to where you sign up for an API, making sure API consumers can access in a single click. To fix: Ensure `type` does NOT match the regular expression `\\b(X-signup|signup|Sign Up|SignUp)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-status-page":{"title":"API Property Require Status Page","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-status-page/","source":"default","description":"This property ensures that there is a status page available for each API, providing the uptime status for any given moment, as well as historical data.","message":"Has a Status Page","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(x-status|status|Status|StatusPage)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:reliability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-status-page' (API Property Require Status Page). Requirement: This property ensures that there is a status page available for each API, providing the uptime status for any given moment, as well as historical data. To fix: Ensure `type` does NOT match the regular expression `\\b(x-status|status|Status|StatusPage)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-support-email":{"title":"API Property Require Support Email","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-support-email/","source":"default","description":"This property ensures that an API has email support, providing a valid email address that can be used to get API support.","message":"Has Support Email","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(support-email|SupportEmail)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-support-email' (API Property Require Support Email). Requirement: This property ensures that an API has email support, providing a valid email address that can be used to get API support. To fix: Ensure `type` does NOT match the regular expression `\\b(support-email|SupportEmail)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-support-issues-url":{"title":"API Property Require Support Issues URL","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-support-issues-url/","source":"default","description":"This property ensures that there are Git issues available to support an API, using the issues capability of GitHub, GitLab, or Bitbucket to support API consumers.","message":"Has Support Issues URL","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(SupportIssues|SupportGitHubIssues)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-support-issues-url' (API Property Require Support Issues URL). Requirement: This property ensures that there are Git issues available to support an API, using the issues capability of GitHub, GitLab, or Bitbucket to support API consumers. To fix: Ensure `type` does NOT match the regular expression `\\b(SupportIssues|SupportGitHubIssues)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-support-page":{"title":"API Property Require Support Page","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-support-page/","source":"default","description":"This property ensures that there is a support page available for an API, providing direct and in-direct support opportunities for each API or for entire API platform.","message":"Has Support Page","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(support|Support)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-support-page' (API Property Require Support Page). Requirement: This property ensures that there is a support page available for an API, providing direct and in-direct support opportunities for each API or for entire API platform. To fix: Ensure `type` does NOT match the regular expression `\\b(support|Support)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-team":{"title":"API Property Require Team","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-team/","source":"default","description":"This property ensures that there is a reference to the team behind an API, providing a reference to business and engineering stakeholders.","message":"Has a Team Defined","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(team|teams|Team|Teams)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-team' (API Property Require Team). Requirement: This property ensures that there is a reference to the team behind an API, providing a reference to business and engineering stakeholders. To fix: Ensure `type` does NOT match the regular expression `\\b(team|teams|Team|Teams)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-terms-of-service":{"title":"API Property Require Terms Of Service","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-terms-of-service/","source":"default","description":"This property ensures that an API has a reference to a terms of service, covering the legal side of using an API.","message":"Has an API Terms of Service","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-terms-of-service|terms-of-service|Terms of Service|TOS|TermsOfService)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-terms-of-service' (API Property Require Terms Of Service). Requirement: This property ensures that an API has a reference to a terms of service, covering the legal side of using an API. To fix: Ensure `type` does NOT match the regular expression `\\b(api-terms-of-service|terms-of-service|Terms of Service|TOS|TermsOfService)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-use-cases":{"title":"API Property Require Use Cases","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-use-cases/","source":"default","description":"This property ensures there is a reference to the use cases for an API, helping align an API with the who, what, how, and why of putting an API to work.","message":"Has Use Cases","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(UseCases)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-use-cases' (API Property Require Use Cases). Requirement: This property ensures there is a reference to the use cases for an API, helping align an API with the who, what, how, and why of putting an API to work. To fix: Ensure `type` does NOT match the regular expression `\\b(UseCases)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-valid-url":{"title":"API Property Require Valid URL","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-valid-url/","source":"default","description":"This property ensures that properties of an API or API contract all have valid URLs, checking if any of the URLs are not properly formed, or could be other formats.","message":"Property URLs Are Valid","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"url","function":"pattern","functionOptions":{"notMatch":"^((http|https)://)[-a-zA-Z0-9@:%._\\+~#?&//=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%._\\+~#?&//=]*)$"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:consistency","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-valid-url' (API Property Require Valid URL). Requirement: This property ensures that properties of an API or API contract all have valid URLs, checking if any of the URLs are not properly formed, or could be other formats. To fix: Ensure `url` does NOT match the regular expression `^((http|https)://)[-a-zA-Z0-9@:%._\\+~#?&//=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%._\\+~#?&//=]*)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-skill-require-versioning":{"title":"API Property Require Versioning","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-skill-require-versioning/","source":"default","description":"This property ensures there is a reference to how APIs are versioned, providing a single place where teams can learn about how change is communicated.","message":"Has Versioning for API","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(versions|Versions|Versioning|versioning)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:versioning","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-skill-require-versioning' (API Property Require Versioning). Requirement: This property ensures there is a reference to how APIs are versioned, providing a single place where teams can learn about how change is communicated. To fix: Ensure `type` does NOT match the regular expression `\\b(versions|Versions|Versioning|versioning)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-video":{"title":"API Property Require Video","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-video/","source":"default","description":"This property ensures there is a reference to a video page or channel for an API.","message":"Has Videos for API","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(videos|Videos)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-video' (API Property Require Video). Requirement: This property ensures there is a reference to a video page or channel for an API. To fix: Ensure `type` does NOT match the regular expression `\\b(videos|Videos)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-vocabulary":{"title":"API Property Require Vocabulary","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-vocabulary/","source":"default","description":"This property ensures that there is a centralized vocabulary in use for guiding the creation and usage of tags, path segments, and other metadata associated with an APIs.","message":"Has Vocabulary","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(vocabulary|vocabularies|Vocabulary|Vocabularies)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:consistency","experience:naming","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-vocabulary' (API Property Require Vocabulary). Requirement: This property ensures that there is a centralized vocabulary in use for guiding the creation and usage of tags, path segments, and other metadata associated with an APIs. To fix: Ensure `type` does NOT match the regular expression `\\b(vocabulary|vocabularies|Vocabulary|Vocabularies)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-url-https":{"title":"API Property URL HTTPS","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-url-https/","source":"spotlight","description":"API property URLs (documentation, OpenAPI, etc.) should be https.","message":"API property url should use https.","given":"$.apis[*].properties[*].url","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https://"}},"tags":["format:apis-json","spec:schemas","experience:security"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-url-https' (API Property URL HTTPS). Requirement: API property URLs (documentation, OpenAPI, etc.) should be https. To fix: Ensure the targeted value matches the regular expression `^https://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.apis[*].properties[*].url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-require-aid":{"title":"API Require Aid","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-require-aid/","source":"default","description":"Every API should have a unique identifier, known as an AID (API Identifier). The APIs.json file, contract, or collection contains its own AID, which the API uses as part of its reference. Additionally, the API applies a slugified version of its name, resulting in a unique, human-readable identifier for the API.","message":"APIs MUST have an aid property.","severity":"info","given":"$.apis.*","then":{"field":"aid","function":"truthy"},"tags":["format:apis-json","spec:apis","experience:discoverability","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-require-aid' (API Require Aid). Requirement: Every API should have a unique identifier, known as an AID (API Identifier). The APIs.json file, contract, or collection contains its own AID, which the API uses as part of its reference. Additionally, the API applies a slugified version of its name, resulting in a unique, human-readable identifier for the API. To fix: Ensure `aid` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-require-base-url":{"title":"API Require Base URL","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-require-base-url/","source":"default","description":"Each API defined within an APIs.json artifact can specify the base URL for the API. This URL serves as a reference point for developers during onboarding and when making API calls. Additionally, it helps identify the API and validate the domain it is associated with.","message":"APIs MUST Have a Base URL","severity":"info","given":"$.apis.*","then":{"field":"baseURL","function":"truthy"},"tags":["format:apis-json","spec:apis","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-require-base-url' (API Require Base URL). Requirement: Each API defined within an APIs.json artifact can specify the base URL for the API. This URL serves as a reference point for developers during onboarding and when making API calls. Additionally, it helps identify the API and validate the domain it is associated with. To fix: Ensure `baseURL` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-tag-require-upper-case":{"title":"API Tag Require Upper Case","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-tag-require-upper-case/","source":"default","description":"Maintaining consistent casing for tags applied to individual APIs ensures a uniform appearance and enhances search and discovery. Each word in a tag should be capitalized, with the first letter of every word in a phrase treated the same way.","message":"API Tags MUST Be Upper Case","severity":"info","given":"$.apis.*.tags.*","then":{"function":"pattern","functionOptions":{"match":"[A-Z]\\w*"}},"tags":["format:apis-json","spec:apis","spec:tags","experience:naming","experience:consistency","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-tag-require-upper-case' (API Tag Require Upper Case). Requirement: Maintaining consistent casing for tags applied to individual APIs ensures a uniform appearance and enhances search and discovery. Each word in a tag should be capitalized, with the first letter of every word in a phrase treated the same way. To fix: Ensure the targeted value matches the regular expression `[A-Z]\\w*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.apis.*.tags.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-apis-json-url-https":{"title":"Document APIs JSON URL HTTPS","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-apis-json-url-https/","source":"spotlight","description":"The APIs.json url should be an https URL.","message":"APIs.json url should use https.","given":"$.url","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https://"}},"tags":["format:apis-json","spec:document","experience:security","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-apis-json-url-https' (Document APIs JSON URL HTTPS). Requirement: The APIs.json url should be an https URL. To fix: Ensure the targeted value matches the regular expression `^https://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-business-impact-canvas":{"title":"Document Include Business Impact Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-business-impact-canvas/","source":"default","description":"This ensures that an API has had the APIOps Business Impact Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Business Impact Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsBusinessImpactCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-business-impact-canvas' (Document Include Business Impact Canvas). Requirement: This ensures that an API has had the APIOps Business Impact Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsBusinessImpactCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-business-model-canvas":{"title":"Document Include Business Model Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-business-model-canvas/","source":"default","description":"This ensures that an API has had the APIOps Business Model Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Business Model Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsBusinessModelCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-business-model-canvas' (Document Include Business Model Canvas). Requirement: This ensures that an API has had the APIOps Business Model Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsBusinessModelCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-capacity-canvas":{"title":"Document Include Capacity Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-capacity-canvas/","source":"default","description":"This ensures that an API has had the APIOps Capacity Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Capacity Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsCapacityCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-capacity-canvas' (Document Include Capacity Canvas). Requirement: This ensures that an API has had the APIOps Capacity Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsCapacityCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-customer-journey-canvas":{"title":"Document Include Customer Journey Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-customer-journey-canvas/","source":"default","description":"This ensures that an API has had the APIOps Customer Journey Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Customer Journey Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsCustomerJourneyCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-customer-journey-canvas' (Document Include Customer Journey Canvas). Requirement: This ensures that an API has had the APIOps Customer Journey Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsCustomerJourneyCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-domain-canvas":{"title":"Document Include Domain Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-domain-canvas/","source":"default","description":"This ensures that an API has had the APIOps Domain Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Domain Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsDomainCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-domain-canvas' (Document Include Domain Canvas). Requirement: This ensures that an API has had the APIOps Domain Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsDomainCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-event-canvas":{"title":"Document Include Event Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-event-canvas/","source":"default","description":"This ensures that an API has had the APIOps Event Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Event Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsEventCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-event-canvas' (Document Include Event Canvas). Requirement: This ensures that an API has had the APIOps Event Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsEventCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-locations-canvas":{"title":"Document Include Locations Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-locations-canvas/","source":"default","description":"This ensures that an API has had the APIOps Locations Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Locations Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsLocationsCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-locations-canvas' (Document Include Locations Canvas). Requirement: This ensures that an API has had the APIOps Locations Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsLocationsCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-rest-canvas":{"title":"Document Include Rest Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-rest-canvas/","source":"default","description":"This ensures that an API has had the APIOps Locations Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Locations Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsRestCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-rest-canvas' (Document Include Rest Canvas). Requirement: This ensures that an API has had the APIOps Locations Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsRestCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-value-proposition-canvas":{"title":"Document Include Value Proposition Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-value-proposition-canvas/","source":"default","description":"This ensures that an API has had the APIOps Value Proposition Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Value Proposition Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsValuePropositionCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-value-proposition-canvas' (Document Include Value Proposition Canvas). Requirement: This ensures that an API has had the APIOps Value Proposition Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsValuePropositionCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-access":{"title":"Document Require Access","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-access/","source":"spotlight","description":"apis-json document should declare a `access` property.","message":"Missing `access`.","given":"$","severity":"info","then":{"field":"access","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-access' (Document Require Access). Requirement: apis-json document should declare a `access` property. To fix: Ensure `access` is present and non-empty at each matching location. Guidance: Missing `access`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-aid":{"title":"Document Require Aid","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-aid/","source":"spotlight","description":"apis-json document should declare a `aid` property.","message":"Missing `aid`.","given":"$","severity":"info","then":{"field":"aid","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-aid' (Document Require Aid). Requirement: apis-json document should declare a `aid` property. To fix: Ensure `aid` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-apis":{"title":"Document Require APIs","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-apis/","source":"spotlight","description":"apis-json document should declare a `apis` property.","message":"Missing `apis`.","given":"$","severity":"info","then":{"field":"apis","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-apis' (Document Require APIs). Requirement: apis-json document should declare a `apis` property. To fix: Ensure `apis` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-common":{"title":"Document Require Common","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-common/","source":"spotlight","description":"apis-json document should declare a `common` property.","message":"Missing `common`.","given":"$","severity":"info","then":{"field":"common","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-common' (Document Require Common). Requirement: apis-json document should declare a `common` property. To fix: Ensure `common` is present and non-empty at each matching location. Guidance: Missing `common`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-created":{"title":"Document Require Created","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-created/","source":"spotlight","description":"apis-json document should declare a `created` property.","message":"Missing `created`.","given":"$","severity":"info","then":{"field":"created","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-created' (Document Require Created). Requirement: apis-json document should declare a `created` property. To fix: Ensure `created` is present and non-empty at each matching location. Guidance: Missing `created`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-description":{"title":"Document Require Description","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-description/","source":"spotlight","description":"apis-json document should declare a `description` property.","message":"Missing `description`.","given":"$","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-description' (Document Require Description). Requirement: apis-json document should declare a `description` property. To fix: Ensure `description` is present and non-empty at each matching location. Guidance: Missing `description`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-image":{"title":"Document Require Image","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-image/","source":"spotlight","description":"apis-json document should declare a `image` property.","message":"Missing `image`.","given":"$","severity":"info","then":{"field":"image","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-image' (Document Require Image). Requirement: apis-json document should declare a `image` property. To fix: Ensure `image` is present and non-empty at each matching location. Guidance: Missing `image`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-include":{"title":"Document Require Include","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-include/","source":"spotlight","description":"apis-json document should declare a `include` property.","message":"Missing `include`.","given":"$","severity":"info","then":{"field":"include","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-include' (Document Require Include). Requirement: apis-json document should declare a `include` property. To fix: Ensure `include` is present and non-empty at each matching location. Guidance: Missing `include`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-kind":{"title":"Document Require Kind","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-kind/","source":"spotlight","description":"apis-json document should declare a `kind` property.","message":"Missing `kind`.","given":"$","severity":"info","then":{"field":"kind","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-kind' (Document Require Kind). Requirement: apis-json document should declare a `kind` property. To fix: Ensure `kind` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-maintainer":{"title":"Document Require Maintainer","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-maintainer/","source":"spotlight","description":"apis-json document should declare a `maintainers` property.","message":"Missing `maintainers`.","given":"$","severity":"info","then":{"field":"maintainers","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-maintainer' (Document Require Maintainer). Requirement: apis-json document should declare a `maintainers` property. To fix: Ensure `maintainers` is present and non-empty at each matching location. Guidance: Missing `maintainers`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-modified":{"title":"Document Require Modified","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-modified/","source":"spotlight","description":"apis-json document should declare a `modified` property.","message":"Missing `modified`.","given":"$","severity":"info","then":{"field":"modified","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-modified' (Document Require Modified). Requirement: apis-json document should declare a `modified` property. To fix: Ensure `modified` is present and non-empty at each matching location. Guidance: Missing `modified`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-name":{"title":"Document Require Name","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-name/","source":"spotlight","description":"apis-json document should declare a `name` property.","message":"Missing `name`.","given":"$","severity":"info","then":{"field":"name","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-name' (Document Require Name). Requirement: apis-json document should declare a `name` property. To fix: Ensure `name` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-network":{"title":"Document Require Network","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-network/","source":"spotlight","description":"apis-json document should declare a `network` property.","message":"Missing `network`.","given":"$","severity":"info","then":{"field":"network","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-network' (Document Require Network). Requirement: apis-json document should declare a `network` property. To fix: Ensure `network` is present and non-empty at each matching location. Guidance: Missing `network`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-overlays":{"title":"Document Require Overlays","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-overlays/","source":"spotlight","description":"apis-json document should declare a `overlays` property.","message":"Missing `overlays`.","given":"$","severity":"info","then":{"field":"overlays","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-overlays' (Document Require Overlays). Requirement: apis-json document should declare a `overlays` property. To fix: Ensure `overlays` is present and non-empty at each matching location. Guidance: Missing `overlays`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-position":{"title":"Document Require Position","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-position/","source":"spotlight","description":"apis-json document should declare a `position` property.","message":"Missing `position`.","given":"$","severity":"info","then":{"field":"position","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-position' (Document Require Position). Requirement: apis-json document should declare a `position` property. To fix: Ensure `position` is present and non-empty at each matching location. Guidance: Missing `position`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-prompts":{"title":"Document Require Prompts","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-prompts/","source":"spotlight","description":"apis-json document should declare a `prompts` property.","message":"Missing `prompts`.","given":"$","severity":"info","then":{"field":"prompts","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-prompts' (Document Require Prompts). Requirement: apis-json document should declare a `prompts` property. To fix: Ensure `prompts` is present and non-empty at each matching location. Guidance: Missing `prompts`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-rating":{"title":"Document Require Rating","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-rating/","source":"spotlight","description":"apis-json document should declare a `rating` property.","message":"Missing `rating`.","given":"$","severity":"info","then":{"field":"rating","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-rating' (Document Require Rating). Requirement: apis-json document should declare a `rating` property. To fix: Ensure `rating` is present and non-empty at each matching location. Guidance: Missing `rating`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-rules":{"title":"Document Require Rules","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-rules/","source":"spotlight","description":"apis-json document should declare a `rules` property.","message":"Missing `rules`.","given":"$","severity":"info","then":{"field":"rules","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-rules' (Document Require Rules). Requirement: apis-json document should declare a `rules` property. To fix: Ensure `rules` is present and non-empty at each matching location. Guidance: Missing `rules`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-specificationversion":{"title":"Document Require Specificationversion","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-specificationversion/","source":"spotlight","description":"apis-json document should declare a `specificationVersion` property.","message":"Missing `specificationVersion`.","given":"$","severity":"info","then":{"field":"specificationVersion","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-specificationversion' (Document Require Specificationversion). Requirement: apis-json document should declare a `specificationVersion` property. To fix: Ensure `specificationVersion` is present and non-empty at each matching location. Guidance: Missing `specificationVersion`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-tag":{"title":"Document Require Tag","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-tag/","source":"spotlight","description":"apis-json document should declare a `tags` property.","message":"Missing `tags`.","given":"$","severity":"info","then":{"field":"tags","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-tag' (Document Require Tag). Requirement: apis-json document should declare a `tags` property. To fix: Ensure `tags` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-type":{"title":"Document Require Type","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-type/","source":"spotlight","description":"apis-json document should declare a `type` property.","message":"Missing `type`.","given":"$","severity":"info","then":{"field":"type","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-type' (Document Require Type). Requirement: apis-json document should declare a `type` property. To fix: Ensure `type` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-url":{"title":"Document Require URL","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-url/","source":"spotlight","description":"apis-json document should declare a `url` property.","message":"Missing `url`.","given":"$","severity":"info","then":{"field":"url","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-url' (Document Require URL). Requirement: apis-json document should declare a `url` property. To fix: Ensure `url` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-visibility":{"title":"Document Require Visibility","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-visibility/","source":"spotlight","description":"apis-json document should declare a `visibility` property.","message":"Missing `visibility`.","given":"$","severity":"info","then":{"field":"visibility","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-visibility' (Document Require Visibility). Requirement: apis-json document should declare a `visibility` property. To fix: Ensure `visibility` is present and non-empty at each matching location. Guidance: Missing `visibility`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-workflow":{"title":"Document Require Workflow","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-workflow/","source":"spotlight","description":"apis-json document should declare a `workflows` property.","message":"Missing `workflows`.","given":"$","severity":"info","then":{"field":"workflows","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-workflow' (Document Require Workflow). Requirement: apis-json document should declare a `workflows` property. To fix: Ensure `workflows` is present and non-empty at each matching location. Guidance: Missing `workflows`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"info-apis-json-specification-version-format":{"title":"Info APIs JSON Specification Version Format","reference":"https://spotlight-rules.com/spec/rules/apis-json/info-apis-json-specification-version-format/","source":"spotlight","description":"specificationVersion should be a major.minor version (e.g. 0.21).","message":"specificationVersion should be major.minor.","given":"$.specificationVersion","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^\\d+\\.\\d+$"}},"tags":["format:apis-json","spec:document","experience:versioning","experience:consistency"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'info-apis-json-specification-version-format' (Info APIs JSON Specification Version Format). Requirement: specificationVersion should be a major.minor version (e.g. 0.21). To fix: Ensure the targeted value matches the regular expression `^\\d+\\.\\d+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.specificationVersion` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"maintainer-email-format":{"title":"Maintainer Email Format","reference":"https://spotlight-rules.com/spec/rules/apis-json/maintainer-email-format/","source":"spotlight","description":"A maintainer email should be a valid email address.","message":"Maintainer email should be a valid email.","given":"$.maintainers[*].email","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$"}},"tags":["format:apis-json","spec:maintainers","experience:consistency"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'maintainer-email-format' (Maintainer Email Format). Requirement: A maintainer email should be a valid email address. To fix: Ensure the targeted value matches the regular expression `^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.maintainers[*].email` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-api-lifecycle":{"title":"Schema Include API Lifecycle","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-api-lifecycle/","source":"default","description":"This property makes sure there is an API lifecycle schema defining all of the stages of a lifecycle and which policies get applied at each stage of the API lifecycle.","message":"Has an API Lifecycle","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(lifecycle|Lifecycle)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:versioning"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-api-lifecycle' (Schema Include API Lifecycle). Requirement: This property makes sure there is an API lifecycle schema defining all of the stages of a lifecycle and which policies get applied at each stage of the API lifecycle. To fix: Ensure `type` does NOT match the regular expression `\\b(lifecycle|Lifecycle)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-api-plan":{"title":"Schema Include API Plan","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-api-plan/","source":"default","description":"This property provides a link to the dedicated plans page that applies to an API, providing information about access tiers, rate limits, and features available for an API as part of a wider API business plan.","message":"Has API Plans","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-plans|Plans)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-api-plan' (Schema Include API Plan). Requirement: This property provides a link to the dedicated plans page that applies to an API, providing information about access tiers, rate limits, and features available for an API as part of a wider API business plan. To fix: Ensure `type` does NOT match the regular expression `\\b(api-plans|Plans)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-authentication-page":{"title":"Schema Include Authentication Page","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-authentication-page/","source":"default","description":"This property ensures that there is a human readable authentication page available that will provide what type of authentication is used and how it can be applied, as well as any services or tooling that API consumers can use to troubleshoot authentication with APIs.","message":"Has Authentication","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(Authentication)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:security","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-authentication-page' (Schema Include Authentication Page). Requirement: This property ensures that there is a human readable authentication page available that will provide what type of authentication is used and how it can be applied, as well as any services or tooling that API consumers can use to troubleshoot authentication with APIs. To fix: Ensure `type` does NOT match the regular expression `\\b(Authentication)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-blog":{"title":"Schema Include Blog","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-blog/","source":"default","description":"This property ensures that an API has a reference to a blog where anyone can find updates and other stories that will help keep API consumers and other stakeholders up to speed on what is happening with an API, and the larger operations.","message":"Has a Blog","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(blog|Blogs)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-blog' (Schema Include Blog). Requirement: This property ensures that an API has a reference to a blog where anyone can find updates and other stories that will help keep API consumers and other stakeholders up to speed on what is happening with an API, and the larger operations. To fix: Ensure `type` does NOT match the regular expression `\\b(blog|Blogs)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-blog-feed":{"title":"Schema Include Blog Feed","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-blog-feed/","source":"default","description":"This property ensures that blogs in support of APIs have an Atom or RSS feed of posts, allowing for the syndication of updates and information around individual APIs and the operations around them.","message":"Has a Blog Feed","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(blog-feed|BlogFeeds)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-blog-feed' (Schema Include Blog Feed). Requirement: This property ensures that blogs in support of APIs have an Atom or RSS feed of posts, allowing for the syndication of updates and information around individual APIs and the operations around them. To fix: Ensure `type` does NOT match the regular expression `\\b(blog-feed|BlogFeeds)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-business-validator":{"title":"Schema Include Business Validator","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-business-validator/","source":"default","description":"This property ensures that there is a link to the validator for the APIs.","message":"Has APIs.json (Business) Validator","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(OperationalValidation)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-business-validator' (Schema Include Business Validator). Requirement: This property ensures that there is a link to the validator for the APIs. To fix: Ensure `type` does NOT match the regular expression `\\b(OperationalValidation)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-change-log":{"title":"Schema Include Change Log","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-change-log/","source":"default","description":"This property ensures that than an individual API or API operations possesses a change log that catalogs all the changes that have occurred in a recent time frame, with historical and version information available if possible.","message":"Has Change Log","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-change-log|change-log|Change Log|Changelog|ChangeLog)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:versioning","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-change-log' (Schema Include Change Log). Requirement: This property ensures that than an individual API or API operations possesses a change log that catalogs all the changes that have occurred in a recent time frame, with historical and version information available if possible. To fix: Ensure `type` does NOT match the regular expression `\\b(api-change-log|change-log|Change Log|Changelog|ChangeLog)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-deprecation-policy":{"title":"Schema Include Deprecation Policy","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-deprecation-policy/","source":"default","description":"This property ensures that an API has a deprecation policy shared as part of the contract, communicating what the lifespan of APIs are, each individual version, as well as communication around the deprecation of APIs.","message":"Has Deprecation Policy","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-deprecation-policy|deprecation-policy|Deprecation|Deprecation Policy|DeprecationPolicy)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","topic:deprecation","experience:versioning","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-deprecation-policy' (Schema Include Deprecation Policy). Requirement: This property ensures that an API has a deprecation policy shared as part of the contract, communicating what the lifespan of APIs are, each individual version, as well as communication around the deprecation of APIs. To fix: Ensure `type` does NOT match the regular expression `\\b(api-deprecation-policy|deprecation-policy|Deprecation|Deprecation Policy|DeprecationPolicy)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-developer-portal":{"title":"Schema Include Developer Portal","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-developer-portal/","source":"default","description":"This property ensures there a developer portal associated with an API and that you can find a landing page for the API, documentation, SDKs, and other resources.","message":"Has Developer Portal","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-developer-portal|developer-portal|portal|Portal|Portals|DeveloperPortal)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:discoverability","experience:usability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-developer-portal' (Schema Include Developer Portal). Requirement: This property ensures there a developer portal associated with an API and that you can find a landing page for the API, documentation, SDKs, and other resources. To fix: Ensure `type` does NOT match the regular expression `\\b(api-developer-portal|developer-portal|portal|Portal|Portals|DeveloperPortal)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-discussion-forum":{"title":"Schema Include Discussion Forum","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-discussion-forum/","source":"default","description":"This property ensures that there is a link to a discussion forum, providing a way for consumers and producers to engage and support either other throughout the lifecycle.","message":"Has Discussion Forum","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(Forums|Forums|Discussions)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-discussion-forum' (Schema Include Discussion Forum). Requirement: This property ensures that there is a link to a discussion forum, providing a way for consumers and producers to engage and support either other throughout the lifecycle. To fix: Ensure `type` does NOT match the regular expression `\\b(Forums|Forums|Discussions)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-documentation":{"title":"Schema Include Documentation","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-documentation/","source":"default","description":"This property ensures that there is documentation published for an API, and API consumers will have a set of human-readable instructions for onboarding and integrating with HTTP APIs in their applications.","message":"Has Documentation","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(documentation|Documentation)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:usability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-documentation' (Schema Include Documentation). Requirement: This property ensures that there is documentation published for an API, and API consumers will have a set of human-readable instructions for onboarding and integrating with HTTP APIs in their applications. To fix: Ensure `type` does NOT match the regular expression `\\b(documentation|Documentation)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-examples":{"title":"Schema Include Examples","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-examples/","source":"default","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"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:usability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-examples' (Schema Include Examples). Requirement: 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. To fix: Ensure `type` does NOT match the regular expression `\\b(examples|Examples)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-feedback-email":{"title":"Schema Include Feedback Email","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-feedback-email/","source":"default","description":"This property ensures that there is an email available for API consumers to provide feedback.","message":"Has Feedback Email","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(feedback-email|FeedbackEmail)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-feedback-email' (Schema Include Feedback Email). Requirement: This property ensures that there is an email available for API consumers to provide feedback. To fix: Ensure `type` does NOT match the regular expression `\\b(feedback-email|FeedbackEmail)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-feedback-issues-url":{"title":"Schema Include Feedback Issues URL","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-feedback-issues-url/","source":"default","description":"This property ensures there is a URL to Git issues specifically for providing feedback.","message":"Has Feedback Issues URL","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(FeedbackIssues|FeedbackGitHubIssues)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-feedback-issues-url' (Schema Include Feedback Issues URL). Requirement: This property ensures there is a URL to Git issues specifically for providing feedback. To fix: Ensure `type` does NOT match the regular expression `\\b(FeedbackIssues|FeedbackGitHubIssues)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-gateway-reference":{"title":"Schema Include Gateway Reference","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-gateway-reference/","source":"default","description":"This property ensures that there is a reference to the gateway for an API, referencing where you can manage the configuration for each API.","message":"Has Staging Gateway for API","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(gateway|Gateway)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-gateway-reference' (Schema Include Gateway Reference). Requirement: This property ensures that there is a reference to the gateway for an API, referencing where you can manage the configuration for each API. To fix: Ensure `type` does NOT match the regular expression `\\b(gateway|Gateway)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-getting-started":{"title":"Schema Include Getting Started","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-getting-started/","source":"default","description":"This property ensures that there is a getting started link available, providing a reference for API consumers to get started with an API is as few steps as possible.","message":"Has Getting Started","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(GettingStarted)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:usability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-getting-started' (Schema Include Getting Started). Requirement: This property ensures that there is a getting started link available, providing a reference for API consumers to get started with an API is as few steps as possible. To fix: Ensure `type` does NOT match the regular expression `\\b(GettingStarted)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-github-action":{"title":"Schema Include Github Action","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-github-action/","source":"default","description":"This property ensures that a GitHub Actions CI/CD pipeline is available for an API, providing a link to the pipeline YAML artifact, which can be used to automate and govern the API as part of the build process.","message":"Has a GitHub Action","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(github-actions|GitHubActions)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:reliability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-github-action' (Schema Include Github Action). Requirement: This property ensures that a GitHub Actions CI/CD pipeline is available for an API, providing a link to the pipeline YAML artifact, which can be used to automate and govern the API as part of the build process. To fix: Ensure `type` does NOT match the regular expression `\\b(github-actions|GitHubActions)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-github-organization":{"title":"Schema Include Github Organization","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-github-organization/","source":"default","description":"This property ensures that an API is associated with GitHub organization, providing the URL to where you can engage with the operations surrounding an API.","message":"Has a GitHub Organization","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(github-organization|GitHubOrganization)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:discoverability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-github-organization' (Schema Include Github Organization). Requirement: This property ensures that an API is associated with GitHub organization, providing the URL to where you can engage with the operations surrounding an API. To fix: Ensure `type` does NOT match the regular expression `\\b(github-organization|GitHubOrganization)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-github-repository":{"title":"Schema Include Github Repository","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-github-repository/","source":"default","description":"This property ensures that an API possess a reference to a dedicated GitHub repository that is used to manage the Open, but also possible server and client code.","message":"Has a GitHub Repository","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(github-repository|GitHubRepository)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:discoverability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-github-repository' (Schema Include Github Repository). Requirement: This property ensures that an API possess a reference to a dedicated GitHub repository that is used to manage the Open, but also possible server and client code. To fix: Ensure `type` does NOT match the regular expression `\\b(github-repository|GitHubRepository)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-governance-policies":{"title":"Schema Include Governance Policies","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-governance-policies/","source":"default","description":"This property ensures there is a governance policies reference as part of an API contract, usually a common property pointing to a centralized set of policies that get applied.","message":"Has API Governance Policies","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-policies|Policies)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-governance-policies' (Schema Include Governance Policies). Requirement: This property ensures there is a governance policies reference as part of an API contract, usually a common property pointing to a centralized set of policies that get applied. To fix: Ensure `type` does NOT match the regular expression `\\b(api-policies|Policies)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-insomnia-collection":{"title":"Schema Include Insomnia Collection","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-insomnia-collection/","source":"default","description":"This property defines an Insomnia collection available for each API, providing executable artifacts that can be used in the Insomnia client for making calls, and executing automation workflows.","message":"Has Insomnia Collection","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(RunInInsomnia)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-insomnia-collection' (Schema Include Insomnia Collection). Requirement: This property defines an Insomnia collection available for each API, providing executable artifacts that can be used in the Insomnia client for making calls, and executing automation workflows. To fix: Ensure `type` does NOT match the regular expression `\\b(RunInInsomnia)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-interface-license":{"title":"Schema Include Interface License","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-interface-license/","source":"default","description":"This property ensures that an API Commons interface license exists for an API, providing a machine-readable reference for an API, as well as data, backend, and front-end code.","message":"Has Interface License","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-license|License|license|InterfaceLicense)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-interface-license' (Schema Include Interface License). Requirement: This property ensures that an API Commons interface license exists for an API, providing a machine-readable reference for an API, as well as data, backend, and front-end code. To fix: Ensure `type` does NOT match the regular expression `\\b(api-license|License|license|InterfaceLicense)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-mock-server":{"title":"Schema Include Mock Server","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-mock-server/","source":"default","description":"This property ensures that an API has a reference to a mock servers for individual APIs or as part of common properties, providing mocked deployments of an API that can be used for making test API calls.","message":"Has a Mock Server","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(mocks|Mocks|MockServers)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-mock-server' (Schema Include Mock Server). Requirement: This property ensures that an API has a reference to a mock servers for individual APIs or as part of common properties, providing mocked deployments of an API that can be used for making test API calls. To fix: Ensure `type` does NOT match the regular expression `\\b(mocks|Mocks|MockServers)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-openapi-definition":{"title":"Schema Include Openapi Definition","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-openapi-definition/","source":"default","description":"This property ensures that there is an OpenAPI present for an API, providing the technical contract that describes the surface area of an API.","message":"Has An OpenAPI","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(openapi|OpenAPI)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-openapi-definition' (Schema Include Openapi Definition). Requirement: This property ensures that there is an OpenAPI present for an API, providing the technical contract that describes the surface area of an API. To fix: Ensure `type` does NOT match the regular expression `\\b(openapi|OpenAPI)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-openapi-governance-rules":{"title":"Schema Include Openapi Governance Rules","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-openapi-governance-rules/","source":"default","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"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-openapi-governance-rules' (Schema Include Openapi Governance Rules). Requirement: 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. To fix: Ensure `type` does NOT match the regular expression `\\b(api-rules|ApiRules)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-openapi-validator":{"title":"Schema Include Openapi Validator","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-openapi-validator/","source":"default","description":"This property ensures that there is a link to the validator for the OpenAPI technical contract, allowing anyone to see the details of governance being applied.","message":"Has OpenAPI (Technical) Validator","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIValidation)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-openapi-validator' (Schema Include Openapi Validator). Requirement: This property ensures that there is a link to the validator for the OpenAPI technical contract, allowing anyone to see the details of governance being applied. To fix: Ensure `type` does NOT match the regular expression `\\b(APIValidation)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-operational-rules":{"title":"Schema Include Operational Rules","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-operational-rules/","source":"default","description":"This property ensures that an API has operational level rules for APIs.","message":"Has Operational Rules","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(operational-rules|OperationalRules)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-operational-rules' (Schema Include Operational Rules). Requirement: This property ensures that an API has operational level rules for APIs. To fix: Ensure `type` does NOT match the regular expression `\\b(operational-rules|OperationalRules)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-performance-testing":{"title":"Schema Include Performance Testing","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-performance-testing/","source":"default","description":"This property ensures that an API has performance testing in place, providing a URL to the performance testing, dashboard, or other resource.","message":"Has API Performance","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(Performance|PerformanceTesting)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:reliability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-performance-testing' (Schema Include Performance Testing). Requirement: This property ensures that an API has performance testing in place, providing a URL to the performance testing, dashboard, or other resource. To fix: Ensure `type` does NOT match the regular expression `\\b(Performance|PerformanceTesting)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-postman-collection":{"title":"Schema Include Postman Collection","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-postman-collection/","source":"default","description":"This property ensures that an API has at least one Postman Collection associated with it, providing automation, tests, and other executable derivatives of an APIs OpenAPI.","message":"Has a Postman Collection","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(PostmanCollection)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-postman-collection' (Schema Include Postman Collection). Requirement: This property ensures that an API has at least one Postman Collection associated with it, providing automation, tests, and other executable derivatives of an APIs OpenAPI. To fix: Ensure `type` does NOT match the regular expression `\\b(PostmanCollection)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-postman-public-workspace":{"title":"Schema Include Postman Public Workspace","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-postman-public-workspace/","source":"default","description":"This property ensures that an API is associated with a Postman Workspace, providing a single location that API producers and/or API consumers can engage around an API.","message":"Has Public Postman Workspace","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(postman-public-workspace|PostmanPublicWorkspace|PostmanWorkspace)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-postman-public-workspace' (Schema Include Postman Public Workspace). Requirement: This property ensures that an API is associated with a Postman Workspace, providing a single location that API producers and/or API consumers can engage around an API. To fix: Ensure `type` does NOT match the regular expression `\\b(postman-public-workspace|PostmanPublicWorkspace|PostmanWorkspace)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-pricing":{"title":"Schema Include Pricing","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-pricing/","source":"default","description":"This property provides a link to a pricing page that applies to an API, providing a breakdown of the costs associated with using an API.","message":"Has Pricing","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(Pricing)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-pricing' (Schema Include Pricing). Requirement: This property provides a link to a pricing page that applies to an API, providing a breakdown of the costs associated with using an API. To fix: Ensure `type` does NOT match the regular expression `\\b(Pricing)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-privacy-policy":{"title":"Schema Include Privacy Policy","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-privacy-policy/","source":"default","description":"This property provides a link to the privacy policy for an API, providing the legal details of how privacy is approached for each API.","message":"Has an API Privacy Policy","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-privacy-policy|privacy-policy|Privacy|Privacy Policy|PrivacyPolicy)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-privacy-policy' (Schema Include Privacy Policy). Requirement: This property provides a link to the privacy policy for an API, providing the legal details of how privacy is approached for each API. To fix: Ensure `type` does NOT match the regular expression `\\b(api-privacy-policy|privacy-policy|Privacy|Privacy Policy|PrivacyPolicy)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-production-environment":{"title":"Schema Include Production Environment","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-production-environment/","source":"default","description":"This property ensures that there is a production environment available for an API, providing base URL, tokens, keys, and other key / value pairs that are needed to integrate with an API.","message":"Has a Production Environment","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(ProductionEnvironment)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:reliability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-production-environment' (Schema Include Production Environment). Requirement: This property ensures that there is a production environment available for an API, providing base URL, tokens, keys, and other key / value pairs that are needed to integrate with an API. To fix: Ensure `type` does NOT match the regular expression `\\b(ProductionEnvironment)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-questions-issues-url":{"title":"Schema Include Questions Issues URL","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-questions-issues-url/","source":"default","description":"This property ensures that an API has a dedicated link to Git issues for asking questions.","message":"Has Questions Issues URL","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(QuestionsIssues|QuestionsGitHubIssues)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-questions-issues-url' (Schema Include Questions Issues URL). Requirement: This property ensures that an API has a dedicated link to Git issues for asking questions. To fix: Ensure `type` does NOT match the regular expression `\\b(QuestionsIssues|QuestionsGitHubIssues)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-rate-limit-reference":{"title":"Schema Include Rate Limit Reference","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-rate-limit-reference/","source":"default","description":"This property ensures there is an API rate limits reference associated with API, ensuring the rate limits applied to an API are clearly communicated.","message":"Has an API Terms of Services","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(rate-limits|RateLimits|Rate Limits)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","topic:rate-limiting","experience:reliability","experience:documentation","experience:performance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-rate-limit-reference' (Schema Include Rate Limit Reference). Requirement: This property ensures there is an API rate limits reference associated with API, ensuring the rate limits applied to an API are clearly communicated. To fix: Ensure `type` does NOT match the regular expression `\\b(rate-limits|RateLimits|Rate Limits)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-staging-environment":{"title":"Schema Include Staging Environment","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-staging-environment/","source":"default","description":"This property ensures that there is a staging environment available for an API, providing base URL, tokens, keys, and other key / value pairs that are needed to integrate with an API.","message":"Has a Stage Environment","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(StagingEnvironment)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:reliability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-staging-environment' (Schema Include Staging Environment). Requirement: This property ensures that there is a staging environment available for an API, providing base URL, tokens, keys, and other key / value pairs that are needed to integrate with an API. To fix: Ensure `type` does NOT match the regular expression `\\b(StagingEnvironment)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-version-comparison":{"title":"Schema Include Version Comparison","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-version-comparison/","source":"default","description":"This property ensures that an API has the ability to compare two different versions of an API and see what the difference are between them.","message":"Has an API Comparison","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(compare|Compare)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:versioning","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-version-comparison' (Schema Include Version Comparison). Requirement: This property ensures that an API has the ability to compare two different versions of an API and see what the difference are between them. To fix: Ensure `type` does NOT match the regular expression `\\b(compare|Compare)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"tag-apis-json-not-empty":{"title":"Tag APIs JSON Not Empty","reference":"https://spotlight-rules.com/spec/rules/apis-json/tag-apis-json-not-empty/","source":"spotlight","description":"If tags are declared they should not be empty — tags drive discovery in the catalog.","message":"tags should not be empty.","given":"$.tags","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"array","minItems":1}}},"tags":["format:apis-json","spec:tags","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'tag-apis-json-not-empty' (Tag APIs JSON Not Empty). Requirement: If tags are declared they should not be empty — tags drive discovery in the catalog. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.tags` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"tag-require-upper-case":{"title":"Tag Require Upper Case","reference":"https://spotlight-rules.com/spec/rules/apis-json/tag-require-upper-case/","source":"default","description":"Maintaining consistent casing for tags applied to APIs.json contracts ensures a uniform appearance and enhances search and discovery. Each word in a tag should be capitalized, with the first letter of every word in a phrase treated the same way.","message":"Tags Upper Case","severity":"info","given":"$.tags.*","then":{"function":"pattern","functionOptions":{"match":"[A-Z]\\w*"}},"tags":["format:apis-json","spec:tags","experience:naming","experience:consistency","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'tag-require-upper-case' (Tag Require Upper Case). Requirement: Maintaining consistent casing for tags applied to APIs.json contracts ensures a uniform appearance and enhances search and discovery. Each word in a tag should be capitalized, with the first letter of every word in a phrase treated the same way. To fix: Ensure the targeted value matches the regular expression `[A-Z]\\w*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.tags.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."}},"asyncapi":{"asyncapi-3-channel-no-empty-parameter":{"title":"Asyncapi 3 Channel No Empty Parameter","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-channel-no-empty-parameter/","source":"builtin","description":"Channel address must not have empty parameter substitution pattern.","message":"Channel address must not have empty parameter substitution pattern.","severity":"info","given":"$.channels.*","then":{"field":"address","function":"pattern","functionOptions":{"notMatch":"{}"}},"tags":["format:asyncapi","spec:channels","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-channel-no-empty-parameter' (Asyncapi 3 Channel No Empty Parameter). Requirement: Channel address must not have empty parameter substitution pattern. To fix: Ensure `address` does NOT match the regular expression `{}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.channels.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-channel-no-query-nor-fragment":{"title":"Asyncapi 3 Channel No Query Nor Fragment","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-channel-no-query-nor-fragment/","source":"builtin","description":"Channel address must not include query (\"?\") or fragment (\"#\") delimiter.","message":"Channel address must not include query (\"?\") or fragment (\"#\") delimiter.","severity":"info","given":"$.channels.*","then":{"field":"address","function":"pattern","functionOptions":{"notMatch":"[\\?#]"}},"tags":["format:asyncapi","spec:channels","experience:consistency","experience:naming"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-channel-no-query-nor-fragment' (Asyncapi 3 Channel No Query Nor Fragment). Requirement: Channel address must not include query (\"?\") or fragment (\"#\") delimiter. To fix: Ensure `address` does NOT match the regular expression `[\\?#]`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.channels.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-channel-no-trailing-slash":{"title":"Asyncapi 3 Channel No Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-channel-no-trailing-slash/","source":"builtin","description":"Channel address must not end with slash.","message":"Channel address must not end with slash.","severity":"info","given":"$.channels.*","then":{"field":"address","function":"pattern","functionOptions":{"notMatch":".+\\/$"}},"tags":["format:asyncapi","spec:channels","experience:consistency","experience:naming"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-channel-no-trailing-slash' (Asyncapi 3 Channel No Trailing Slash). Requirement: Channel address must not end with slash. To fix: Ensure `address` does NOT match the regular expression `.+\\/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.channels.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-channel-servers":{"title":"Asyncapi 3 Channel Servers","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-channel-servers/","source":"builtin","description":"Channel servers must be defined in the \"servers\" object.","message":"Channel servers must be defined in the \"servers\" object.","severity":"info","given":"$.channels.*","then":{"field":"$.servers.*.$ref","function":"pattern","functionOptions":{"match":"#\\/servers\\/"}},"tags":["format:asyncapi","spec:channels","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-channel-servers' (Asyncapi 3 Channel Servers). Requirement: Channel servers must be defined in the \"servers\" object. To fix: Ensure `$.servers.*.$ref` matches the regular expression `#\\/servers\\/`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.channels.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-document-unresolved":{"title":"Asyncapi 3 Document Unresolved","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-document-unresolved/","source":"builtin","description":"Checking if the AsyncAPI v3 document has valid structure before resolving references.","message":"{{error}}","severity":"info","given":"$","then":{"function":"","functionOptions":{"resolved":false}},"tags":["format:asyncapi","spec:document","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-document-unresolved' (Asyncapi 3 Document Unresolved). Requirement: Checking if the AsyncAPI v3 document has valid structure before resolving references. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-headers-schema-type-object":{"title":"Asyncapi 3 Headers Schema Type Object","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-headers-schema-type-object/","source":"builtin","description":"Headers schema type must be \"object\".","message":"Headers schema type must be \"object\" ({{error}}).","severity":"info","given":["$.components.messageTraits.*.headers","$.components.messages.*.headers","$.channels.*.messages.*.headers","$.channels.*.messages.*.traits[*].headers"],"then":{"function":"schema","functionOptions":{"allErrors":true,"schema":{"type":"object","properties":{"type":{"enum":["object"]}},"required":["type"]}}},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-headers-schema-type-object' (Asyncapi 3 Headers Schema Type Object). Requirement: Headers schema type must be \"object\". To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.components.messageTraits.*.headers | $.components.messages.*.headers | $.channels.*.messages.*.headers | $.channels.*.messages.*.traits[*].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-operation-description":{"title":"Asyncapi 3 Operation Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-operation-description/","source":"builtin","description":"Operation \"description\" must be present and non-empty string.","message":"Operation \"description\" must be present and non-empty string.","severity":"info","given":"$.operations.*","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:operations","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-operation-description' (Asyncapi 3 Operation Description). Requirement: Operation \"description\" must be present and non-empty string. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.operations.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-operation-security":{"title":"Asyncapi 3 Operation Security","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-operation-security/","source":"builtin","description":"Operation have to reference a defined security schemes.","message":"{{error}}","severity":"info","given":"$.operations.*.security.*","then":{"function":"asyncApiSecurity","functionOptions":{"objectType":"Operation"}},"tags":["format:asyncapi","spec:security","experience:security","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-operation-security' (Asyncapi 3 Operation Security). Requirement: Operation have to reference a defined security schemes. This rule is evaluated at the JSONPath `$.operations.*.security.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-payload-unsupported-schemaFormat":{"title":"Asyncapi 3 Payload Unsupported SchemaFormat","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-payload-unsupported-schemaFormat/","source":"builtin","description":"Message schema validation is only supported with default unspecified \"schemaFormat\".","message":"Message schema validation is only supported with default unspecified \"schemaFormat\".","severity":"info","given":["$.components.messages.*.payload","$.channels.*.messages.*.payload"],"then":{"field":"schemaFormat","function":"undefined"},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-payload-unsupported-schemaFormat' (Asyncapi 3 Payload Unsupported SchemaFormat). Requirement: Message schema validation is only supported with default unspecified \"schemaFormat\". To fix: Remove `schemaFormat` from each matching location. This rule is evaluated at the JSONPath `$.components.messages.*.payload | $.channels.*.messages.*.payload` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-server-no-empty-variable":{"title":"Asyncapi 3 Server No Empty Variable","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-server-no-empty-variable/","source":"builtin","description":"Server host and pathname must not have empty variable substitution pattern.","message":"Server host and pathname must not have empty variable substitution pattern.","severity":"info","given":["$.servers[*].host","$.servers[*].pathname"],"then":{"function":"pattern","functionOptions":{"notMatch":"{}"}},"tags":["format:asyncapi","spec:servers","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-server-no-empty-variable' (Asyncapi 3 Server No Empty Variable). Requirement: Server host and pathname must not have empty variable substitution pattern. To fix: Ensure the targeted value does NOT match the regular expression `{}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers[*].host | $.servers[*].pathname` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-server-no-trailing-slash":{"title":"Asyncapi 3 Server No Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-server-no-trailing-slash/","source":"builtin","description":"Server host must not end with slash.","message":"Server host must not end with slash.","severity":"info","given":"$.servers.*.host","then":{"function":"pattern","functionOptions":{"notMatch":"/$"}},"tags":["format:asyncapi","spec:servers","experience:consistency","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-server-no-trailing-slash' (Asyncapi 3 Server No Trailing Slash). Requirement: Server host must not end with slash. To fix: Ensure the targeted value does NOT match the regular expression `/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers.*.host` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-server-not-example-com":{"title":"Asyncapi 3 Server Not Example Com","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-server-not-example-com/","source":"builtin","description":"Server host must not point at example.com.","message":"Server host must not point at example.com.","severity":"info","given":"$.servers.*.host","then":{"function":"pattern","functionOptions":{"notMatch":"example\\.com"}},"tags":["format:asyncapi","spec:servers","experience:reliability","experience:usability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-server-not-example-com' (Asyncapi 3 Server Not Example Com). Requirement: Server host must not point at example.com. To fix: Ensure the targeted value does NOT match the regular expression `example\\.com`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers.*.host` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-tag-description":{"title":"Asyncapi 3 Tag Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-tag-description/","source":"builtin","description":"Tag object must have \"description\".","message":"Tag object must have \"description\".","severity":"info","given":"$.info.tags[*]","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:info","experience:documentation","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-tag-description' (Asyncapi 3 Tag Description). Requirement: Tag object must have \"description\". To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-tags":{"title":"Asyncapi 3 Tags","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-tags/","source":"builtin","description":"AsyncAPI document must have non-empty \"tags\" array.","message":"AsyncAPI document must have non-empty \"tags\" array.","severity":"info","given":["$.info"],"then":{"field":"tags","function":"truthy"},"tags":["format:asyncapi","spec:info","experience:discoverability","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-tags' (Asyncapi 3 Tags). Requirement: AsyncAPI document must have non-empty \"tags\" array. To fix: Ensure `tags` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-tags-alphabetical":{"title":"Asyncapi 3 Tags Alphabetical","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-tags-alphabetical/","source":"builtin","description":"AsyncAPI object must have alphabetical \"tags\".","message":"AsyncAPI object must have alphabetical \"tags\".","severity":"info","given":"$.info","then":{"field":"tags","function":"alphabetical","functionOptions":{"keyedBy":"name"}},"tags":["format:asyncapi","spec:info","experience:consistency","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-tags-alphabetical' (Asyncapi 3 Tags Alphabetical). Requirement: AsyncAPI object must have alphabetical \"tags\". To fix: Sort the entries by `name` into ascending alphabetical order. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-tags-uniqueness":{"title":"Asyncapi 3 Tags Uniqueness","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-tags-uniqueness/","source":"builtin","description":"Each tag must have a unique name.","message":"{{error}}","severity":"info","given":["$.info.tags","$.servers.*.tags","$.components.servers.*.tags","$.operations.*.tags","$.components.operations.*.tags","$.operations.*.traits.*.tags","$.components.operations.traits.*.tags","$.components.operationTraits.*.tags","$.channels.*.messages.*.tags","$.components.channels.*.messages.tags","$.components.messages.*.tags","$.channels.*..messages.*.traits.*.tags","$.components.channels.*.messages.*.traits.*.tags","$.components.messages.*.traits.*.tags","$.components.messageTraits.*.tags"],"then":{"function":"uniquenessTags"},"tags":["format:asyncapi","spec:info","spec:servers","spec:channels","spec:messages","spec:components","experience:consistency","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-tags-uniqueness' (Asyncapi 3 Tags Uniqueness). Requirement: Each tag must have a unique name. This rule is evaluated at the JSONPath `$.info.tags | $.servers.*.tags | $.components.servers.*.tags | $.operations.*.tags | $.components.operations.*.tags | $.operations.*.traits.*.tags | $.components.operations.traits.*.tags | $.components.operationTraits.*.tags | $.channels.*.messages.*.tags | $.components.channels.*.messages.tags | $.components.messages.*.tags | $.channels.*..messages.*.traits.*.tags | $.components.channels.*.messages.*.traits.*.tags | $.components.messages.*.traits.*.tags | $.components.messageTraits.*.tags` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-channel-no-empty-parameter":{"title":"Asyncapi Channel No Empty Parameter","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-channel-no-empty-parameter/","source":"builtin","description":"Channel path must not have empty parameter substitution pattern.","message":"Channel path must not have empty parameter substitution pattern.","severity":"info","given":"$.channels","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"{}"}},"tags":["format:asyncapi","spec:channels","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-channel-no-empty-parameter' (Asyncapi Channel No Empty Parameter). Requirement: Channel path must not have empty parameter substitution pattern. To fix: Ensure `@key` does NOT match the regular expression `{}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.channels` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-channel-no-query-nor-fragment":{"title":"Asyncapi Channel No Query Nor Fragment","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-channel-no-query-nor-fragment/","source":"builtin","description":"Channel path must not include query (\"?\") or fragment (\"#\") delimiter.","message":"Channel path must not include query (\"?\") or fragment (\"#\") delimiter.","severity":"info","given":"$.channels","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"[\\?#]"}},"tags":["format:asyncapi","spec:channels","experience:consistency","experience:naming"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-channel-no-query-nor-fragment' (Asyncapi Channel No Query Nor Fragment). Requirement: Channel path must not include query (\"?\") or fragment (\"#\") delimiter. To fix: Ensure `@key` does NOT match the regular expression `[\\?#]`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.channels` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-channel-no-trailing-slash":{"title":"Asyncapi Channel No Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-channel-no-trailing-slash/","source":"builtin","description":"Channel path must not end with slash.","message":"Channel path must not end with slash.","severity":"info","given":"$.channels","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":".+\\/$"}},"tags":["format:asyncapi","spec:channels","experience:consistency","experience:naming"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-channel-no-trailing-slash' (Asyncapi Channel No Trailing Slash). Requirement: Channel path must not end with slash. To fix: Ensure `@key` does NOT match the regular expression `.+\\/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.channels` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-channel-parameters":{"title":"Asyncapi Channel Parameters","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-channel-parameters/","source":"builtin","description":"Channel parameters must be defined and there must be no redundant parameters.","message":"{{error}}","severity":"info","given":["$.channels.*","$.components.channels.*"],"then":{"function":"asyncApiChannelParameters"},"tags":["format:asyncapi","spec:channels","spec:components","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-channel-parameters' (Asyncapi Channel Parameters). Requirement: Channel parameters must be defined and there must be no redundant parameters. This rule is evaluated at the JSONPath `$.channels.* | $.components.channels.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-channel-servers":{"title":"Asyncapi Channel Servers","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-channel-servers/","source":"builtin","description":"Channel servers must be defined in the \"servers\" object.","message":"{{error}}","severity":"info","given":"$","then":{"function":"asyncApi2ChannelServers"},"tags":["format:asyncapi","spec:document","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-channel-servers' (Asyncapi Channel Servers). Requirement: Channel servers must be defined in the \"servers\" object. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-headers-schema-type-object":{"title":"Asyncapi Headers Schema Type Object","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-headers-schema-type-object/","source":"builtin","description":"Headers schema type must be \"object\".","message":"Headers schema type must be \"object\" ({{error}}).","severity":"info","given":["$.components.messageTraits.*.headers","$.components.messages.*.headers","$.channels.*.[publish,subscribe].message.headers","$.channels.*.[publish,subscribe].message.traits[*].headers"],"then":{"function":"schema","functionOptions":{"allErrors":true,"schema":{"type":"object","properties":{"type":{"enum":["object"]}},"required":["type"]}}},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-headers-schema-type-object' (Asyncapi Headers Schema Type Object). Requirement: Headers schema type must be \"object\". To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.components.messageTraits.*.headers | $.components.messages.*.headers | $.channels.*.[publish,subscribe].message.headers | $.channels.*.[publish,subscribe].message.traits[*].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-info-contact":{"title":"Asyncapi Info Contact","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-info-contact/","source":"builtin","description":"Info object must have \"contact\" object.","message":"Info object must have \"contact\" object.","severity":"info","given":"$","then":{"field":"info.contact","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:documentation","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-info-contact' (Asyncapi Info Contact). Requirement: Info object must have \"contact\" object. To fix: Ensure `info.contact` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-info-contact-properties":{"title":"Asyncapi Info Contact Properties","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-info-contact-properties/","source":"builtin","description":"Contact object must have \"name\", \"url\" and \"email\".","message":"Contact object must have \"name\", \"url\" and \"email\".","severity":"info","given":"$.info.contact","then":[{"field":"name","function":"truthy"},{"field":"url","function":"truthy"},{"field":"email","function":"truthy"}],"tags":["format:asyncapi","spec:info","experience:documentation","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-info-contact-properties' (Asyncapi Info Contact Properties). Requirement: Contact object must have \"name\", \"url\" and \"email\". To fix: Ensure `name` is present and non-empty at each matching location. Also: Ensure `url` is present and non-empty at each matching location. Also: Ensure `email` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.contact` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-info-description":{"title":"Asyncapi Info Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-info-description/","source":"builtin","description":"Info \"description\" must be present and non-empty string.","message":"Info \"description\" must be present and non-empty string.","severity":"info","given":"$","then":{"field":"info.description","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-info-description' (Asyncapi Info Description). Requirement: Info \"description\" must be present and non-empty string. To fix: Ensure `info.description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-info-license":{"title":"Asyncapi Info License","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-info-license/","source":"builtin","description":"Info object must have \"license\" object.","message":"Info object must have \"license\" object.","severity":"info","given":"$","then":{"field":"info.license","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-info-license' (Asyncapi Info License). Requirement: Info object must have \"license\" object. To fix: Ensure `info.license` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-info-license-url":{"title":"Asyncapi Info License URL","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-info-license-url/","source":"builtin","description":"License object must include \"url\".","message":"License object must include \"url\".","severity":"info","given":"$","then":{"field":"info.license.url","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-info-license-url' (Asyncapi Info License URL). Requirement: License object must include \"url\". To fix: Ensure `info.license.url` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-latest-version":{"title":"Asyncapi Latest Version","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-latest-version/","source":"builtin","description":"Checking if the AsyncAPI document is using the latest version.","message":"The latest version is not used. You should update to the \"3.1.0\" version.","severity":"info","given":"$.asyncapi","then":{"function":"schema","functionOptions":{"schema":{"const":"3.1.0"}}},"tags":["format:asyncapi","spec:document","experience:versioning","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-latest-version' (Asyncapi Latest Version). Requirement: Checking if the AsyncAPI document is using the latest version. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.asyncapi` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-message-examples":{"title":"Asyncapi Message Examples","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-message-examples/","source":"builtin","description":"Examples of message object should follow by \"payload\" and \"headers\" schemas.","message":"{{error}}","severity":"info","given":["$.channels.*.[publish,subscribe].message","$.channels.*.[publish,subscribe].message.oneOf.*","$.components.channels.*.[publish,subscribe].message","$.components.channels.*.[publish,subscribe].message.oneOf.*","$.components.messages.*","$.channels.*.[publish,subscribe].message.traits.*","$.channels.*.[publish,subscribe].message.oneOf.*.traits.*","$.components.channels.*.[publish,subscribe].message.traits.*","$.components.channels.*.[publish,subscribe].message.oneOf.*.traits.*","$.components.messages.*.traits.*","$.components.messageTraits.*"],"then":{"function":"asyncApi2MessageExamplesValidation"},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","experience:data-modeling","experience:documentation","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-message-examples' (Asyncapi Message Examples). Requirement: Examples of message object should follow by \"payload\" and \"headers\" schemas. This rule is evaluated at the JSONPath `$.channels.*.[publish,subscribe].message | $.channels.*.[publish,subscribe].message.oneOf.* | $.components.channels.*.[publish,subscribe].message | $.components.channels.*.[publish,subscribe].message.oneOf.* | $.components.messages.* | $.channels.*.[publish,subscribe].message.traits.* | $.channels.*.[publish,subscribe].message.oneOf.*.traits.* | $.components.channels.*.[publish,subscribe].message.traits.* | $.components.channels.*.[publish,subscribe].message.oneOf.*.traits.* | $.components.messages.*.traits.* | $.components.messageTraits.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-message-messageId-uniqueness":{"title":"Asyncapi Message MessageId Uniqueness","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-message-messageId-uniqueness/","source":"builtin","description":"\"messageId\" must be unique across all the messages.","message":"\"messageId\" must be unique across all the messages.","severity":"info","given":"$","then":{"function":"asyncApi2MessageIdUniqueness"},"tags":["format:asyncapi","spec:document","experience:consistency","experience:naming","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-message-messageId-uniqueness' (Asyncapi Message MessageId Uniqueness). Requirement: \"messageId\" must be unique across all the messages. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-operation-description":{"title":"Asyncapi Operation Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-operation-description/","source":"builtin","description":"Operation \"description\" must be present and non-empty string.","message":"Operation \"description\" must be present and non-empty string.","severity":"info","given":"$.channels[*][publish,subscribe]","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:channels","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-operation-description' (Asyncapi Operation Description). Requirement: Operation \"description\" must be present and non-empty string. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.channels[*][publish,subscribe]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-operation-operationId":{"title":"Asyncapi Operation OperationId","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-operation-operationId/","source":"builtin","description":"Operation must have \"operationId\".","message":"Operation must have \"operationId\".","severity":"info","given":"$.channels[*][publish,subscribe]","then":{"field":"operationId","function":"truthy"},"tags":["format:asyncapi","spec:channels","experience:consistency","experience:usability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-operation-operationId' (Asyncapi Operation OperationId). Requirement: Operation must have \"operationId\". To fix: Ensure `operationId` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.channels[*][publish,subscribe]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-operation-operationId-uniqueness":{"title":"Asyncapi Operation OperationId Uniqueness","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-operation-operationId-uniqueness/","source":"builtin","description":"\"operationId\" must be unique across all the operations.","message":"\"operationId\" must be unique across all the operations.","severity":"info","given":"$","then":{"function":"asyncApi2OperationIdUniqueness"},"tags":["format:asyncapi","spec:document","experience:consistency","experience:naming","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-operation-operationId-uniqueness' (Asyncapi Operation OperationId Uniqueness). Requirement: \"operationId\" must be unique across all the operations. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-operation-security":{"title":"Asyncapi Operation Security","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-operation-security/","source":"builtin","description":"Operation have to reference a defined security schemes.","message":"{{error}}","severity":"info","given":"$.channels[*][publish,subscribe].security.*","then":{"function":"asyncApiSecurity","functionOptions":{"objectType":"Operation"}},"tags":["format:asyncapi","spec:channels","experience:security","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-operation-security' (Asyncapi Operation Security). Requirement: Operation have to reference a defined security schemes. This rule is evaluated at the JSONPath `$.channels[*][publish,subscribe].security.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-parameter-description":{"title":"Asyncapi Parameter Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-parameter-description/","source":"builtin","description":"Parameter objects must have \"description\".","message":"Parameter objects must have \"description\".","severity":"info","given":["$.components.parameters.*","$.channels.*.parameters.*"],"then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:channels","spec:components","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-parameter-description' (Asyncapi Parameter Description). Requirement: Parameter objects must have \"description\". To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.* | $.channels.*.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-payload":{"title":"Asyncapi Payload","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-payload/","source":"builtin","description":"Payloads must be valid against AsyncAPI Schema object.","message":"{{error}}","severity":"info","given":["$.components.messageTraits[?(@.schemaFormat === void 0)].payload","$.components.messages[?(@.schemaFormat === void 0)].payload","$.channels[*][publish,subscribe][?(@property === 'message' && @.schemaFormat === void 0)].payload"],"then":{"function":"asyncApiPayloadValidation"},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-payload' (Asyncapi Payload). Requirement: Payloads must be valid against AsyncAPI Schema object. This rule is evaluated at the JSONPath `$.components.messageTraits[?(@.schemaFormat === void 0)].payload | $.components.messages[?(@.schemaFormat === void 0)].payload | $.channels[*][publish,subscribe][?(@property === 'message' && @.schemaFormat === void 0)].payload` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-payload-default":{"title":"Asyncapi Payload Default","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-payload-default/","source":"builtin","description":"Default must be valid against its defined schema.","message":"{{error}}","severity":"info","given":["$.components.messageTraits[?(@.schemaFormat === void 0)].payload.default^","$.components.messages[?(@.schemaFormat === void 0)].payload.default^","$.channels[*][publish,subscribe][?(@property === 'message' && @.schemaFormat === void 0)].payload.default^"],"then":{"function":"asyncApiSchemaValidation","functionOptions":{"type":"default"}},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-payload-default' (Asyncapi Payload Default). Requirement: Default must be valid against its defined schema. This rule is evaluated at the JSONPath `$.components.messageTraits[?(@.schemaFormat === void 0)].payload.default^ | $.components.messages[?(@.schemaFormat === void 0)].payload.default^ | $.channels[*][publish,subscribe][?(@property === 'message' && @.schemaFormat === void 0)].payload.default^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-payload-examples":{"title":"Asyncapi Payload Examples","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-payload-examples/","source":"builtin","description":"Examples must be valid against their defined schema.","message":"{{error}}","severity":"info","given":["$.components.messageTraits[?(@.schemaFormat === void 0)].payload.examples^","$.components.messages[?(@.schemaFormat === void 0)].payload.examples^","$.channels[*][publish,subscribe][?(@property === 'message' && @.schemaFormat === void 0)].payload.examples^"],"then":{"function":"asyncApiSchemaValidation","functionOptions":{"type":"examples"}},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","spec:schemas","experience:data-modeling","experience:documentation","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-payload-examples' (Asyncapi Payload Examples). Requirement: Examples must be valid against their defined schema. This rule is evaluated at the JSONPath `$.components.messageTraits[?(@.schemaFormat === void 0)].payload.examples^ | $.components.messages[?(@.schemaFormat === void 0)].payload.examples^ | $.channels[*][publish,subscribe][?(@property === 'message' && @.schemaFormat === void 0)].payload.examples^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-payload-unsupported-schemaFormat":{"title":"Asyncapi Payload Unsupported SchemaFormat","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-payload-unsupported-schemaFormat/","source":"builtin","description":"Message schema validation is only supported with default unspecified \"schemaFormat\".","message":"Message schema validation is only supported with default unspecified \"schemaFormat\".","severity":"info","given":["$.components.messageTraits.*","$.components.messages.*","$.channels[*][publish,subscribe].message"],"then":{"field":"schemaFormat","function":"undefined"},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-payload-unsupported-schemaFormat' (Asyncapi Payload Unsupported SchemaFormat). Requirement: Message schema validation is only supported with default unspecified \"schemaFormat\". To fix: Remove `schemaFormat` from each matching location. This rule is evaluated at the JSONPath `$.components.messageTraits.* | $.components.messages.* | $.channels[*][publish,subscribe].message` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-schema":{"title":"Asyncapi Schema","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-schema/","source":"builtin","description":"Validate structure of AsyncAPI specification.","message":"{{error}}","severity":"info","given":"$","then":{"function":"","functionOptions":{"resolved":true}},"tags":["format:asyncapi","spec:document","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-schema' (Asyncapi Schema). Requirement: Validate structure of AsyncAPI specification. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-schema-default":{"title":"Asyncapi Schema Default","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-schema-default/","source":"builtin","description":"Default must be valid against its defined schema.","message":"{{error}}","severity":"info","given":["$.components.schemas.*.default^","$.components.parameters.*.schema.default^","$.channels.*.parameters.*.schema.default^"],"then":{"function":"asyncApiSchemaValidation","functionOptions":{"type":"default"}},"tags":["format:asyncapi","spec:channels","spec:components","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-schema-default' (Asyncapi Schema Default). Requirement: Default must be valid against its defined schema. This rule is evaluated at the JSONPath `$.components.schemas.*.default^ | $.components.parameters.*.schema.default^ | $.channels.*.parameters.*.schema.default^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-schema-examples":{"title":"Asyncapi Schema Examples","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-schema-examples/","source":"builtin","description":"Examples must be valid against their defined schema.","message":"{{error}}","severity":"info","given":["$.components.schemas.*.examples^","$.components.parameters.*.schema.examples^","$.channels.*.parameters.*.schema.examples^"],"then":{"function":"asyncApiSchemaValidation","functionOptions":{"type":"examples"}},"tags":["format:asyncapi","spec:channels","spec:components","spec:schemas","experience:data-modeling","experience:documentation","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-schema-examples' (Asyncapi Schema Examples). Requirement: Examples must be valid against their defined schema. This rule is evaluated at the JSONPath `$.components.schemas.*.examples^ | $.components.parameters.*.schema.examples^ | $.channels.*.parameters.*.schema.examples^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-server-no-empty-variable":{"title":"Asyncapi Server No Empty Variable","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-server-no-empty-variable/","source":"builtin","description":"Server URL must not have empty variable substitution pattern.","message":"Server URL must not have empty variable substitution pattern.","severity":"info","given":"$.servers[*].url","then":{"function":"pattern","functionOptions":{"notMatch":"{}"}},"tags":["format:asyncapi","spec:servers","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-server-no-empty-variable' (Asyncapi Server No Empty Variable). Requirement: Server URL must not have empty variable substitution pattern. To fix: Ensure the targeted value does NOT match the regular expression `{}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers[*].url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-server-no-trailing-slash":{"title":"Asyncapi Server No Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-server-no-trailing-slash/","source":"builtin","description":"Server URL must not end with slash.","message":"Server URL must not end with slash.","severity":"info","given":"$.servers[*].url","then":{"function":"pattern","functionOptions":{"notMatch":"/$"}},"tags":["format:asyncapi","spec:servers","experience:consistency","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-server-no-trailing-slash' (Asyncapi Server No Trailing Slash). Requirement: Server URL must not end with slash. To fix: Ensure the targeted value does NOT match the regular expression `/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers[*].url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-server-not-example-com":{"title":"Asyncapi Server Not Example Com","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-server-not-example-com/","source":"builtin","description":"Server URL must not point at example.com.","message":"Server URL must not point at example.com.","severity":"info","given":"$.servers[*].url","then":{"function":"pattern","functionOptions":{"notMatch":"example\\.com"}},"tags":["format:asyncapi","spec:servers","experience:reliability","experience:usability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-server-not-example-com' (Asyncapi Server Not Example Com). Requirement: Server URL must not point at example.com. To fix: Ensure the targeted value does NOT match the regular expression `example\\.com`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers[*].url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-server-security":{"title":"Asyncapi Server Security","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-server-security/","source":"builtin","description":"Server have to reference a defined security schemes.","message":"{{error}}","severity":"info","given":"$.servers.*.security.*","then":{"function":"asyncApiSecurity","functionOptions":{"objectType":"Server"}},"tags":["format:asyncapi","spec:servers","experience:security","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-server-security' (Asyncapi Server Security). Requirement: Server have to reference a defined security schemes. This rule is evaluated at the JSONPath `$.servers.*.security.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-server-variables":{"title":"Asyncapi Server Variables","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-server-variables/","source":"builtin","description":"Server variables must be defined and there must be no redundant variables.","message":"{{error}}","severity":"info","given":["$.servers.*","$.components.servers.*"],"then":{"function":"serverVariables"},"tags":["format:asyncapi","spec:servers","spec:components","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-server-variables' (Asyncapi Server Variables). Requirement: Server variables must be defined and there must be no redundant variables. This rule is evaluated at the JSONPath `$.servers.* | $.components.servers.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-servers":{"title":"Asyncapi Servers","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-servers/","source":"builtin","description":"AsyncAPI object must have non-empty \"servers\" object.","message":"AsyncAPI object must have non-empty \"servers\" object.","severity":"info","given":"$","then":{"field":"servers","function":"schema","functionOptions":{"schema":{"type":"object","minProperties":1},"allErrors":true}},"tags":["format:asyncapi","spec:document","experience:usability","experience:reliability","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-servers' (Asyncapi Servers). Requirement: AsyncAPI object must have non-empty \"servers\" object. To fix: Adjust `servers` so it conforms to the schema this rule requires. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-tag-description":{"title":"Asyncapi Tag Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-tag-description/","source":"builtin","description":"Tag object must have \"description\".","message":"Tag object must have \"description\".","severity":"info","given":"$.tags[*]","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:tags","experience:documentation","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-tag-description' (Asyncapi Tag Description). Requirement: Tag object must have \"description\". To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-tags":{"title":"Asyncapi Tags","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-tags/","source":"builtin","description":"AsyncAPI object must have non-empty \"tags\" array.","message":"AsyncAPI object must have non-empty \"tags\" array.","severity":"info","given":"$","then":{"field":"tags","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:discoverability","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-tags' (Asyncapi Tags). Requirement: AsyncAPI object must have non-empty \"tags\" array. To fix: Ensure `tags` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-tags-alphabetical":{"title":"Asyncapi Tags Alphabetical","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-tags-alphabetical/","source":"builtin","description":"AsyncAPI object must have alphabetical \"tags\".","message":"AsyncAPI object must have alphabetical \"tags\".","severity":"info","given":"$","then":{"field":"tags","function":"alphabetical","functionOptions":{"keyedBy":"name"}},"tags":["format:asyncapi","spec:document","experience:consistency","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-tags-alphabetical' (Asyncapi Tags Alphabetical). Requirement: AsyncAPI object must have alphabetical \"tags\". To fix: Sort the entries by `name` into ascending alphabetical order. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-tags-uniqueness":{"title":"Asyncapi Tags Uniqueness","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-tags-uniqueness/","source":"builtin","description":"Each tag must have a unique name.","message":"{{error}}","severity":"info","given":["$.tags","$.servers.*.tags","$.components.servers.*.tags","$.channels.*.[publish,subscribe].tags","$.components.channels.*.[publish,subscribe].tags","$.channels.*.[publish,subscribe].traits.*.tags","$.components.channels.*.[publish,subscribe].traits.*.tags","$.components.operationTraits.*.tags","$.channels.*.[publish,subscribe].message.tags","$.channels.*.[publish,subscribe].message.oneOf.*.tags","$.components.channels.*.[publish,subscribe].message.tags","$.components.channels.*.[publish,subscribe].message.oneOf.*.tags","$.components.messages.*.tags","$.channels.*.[publish,subscribe].message.traits.*.tags","$.channels.*.[publish,subscribe].message.oneOf.*.traits.*.tags","$.components.channels.*.[publish,subscribe].message.traits.*.tags","$.components.channels.*.[publish,subscribe].message.oneOf.*.traits.*.tags","$.components.messages.*.traits.*.tags","$.components.messageTraits.*.tags"],"then":{"function":"uniquenessTags"},"tags":["format:asyncapi","spec:servers","spec:channels","spec:messages","spec:components","experience:consistency","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-tags-uniqueness' (Asyncapi Tags Uniqueness). Requirement: Each tag must have a unique name. This rule is evaluated at the JSONPath `$.tags | $.servers.*.tags | $.components.servers.*.tags | $.channels.*.[publish,subscribe].tags | $.components.channels.*.[publish,subscribe].tags | $.channels.*.[publish,subscribe].traits.*.tags | $.components.channels.*.[publish,subscribe].traits.*.tags | $.components.operationTraits.*.tags | $.channels.*.[publish,subscribe].message.tags | $.channels.*.[publish,subscribe].message.oneOf.*.tags | $.components.channels.*.[publish,subscribe].message.tags | $.components.channels.*.[publish,subscribe].message.oneOf.*.tags | $.components.messages.*.tags | $.channels.*.[publish,subscribe].message.traits.*.tags | $.channels.*.[publish,subscribe].message.oneOf.*.traits.*.tags | $.components.channels.*.[publish,subscribe].message.traits.*.tags | $.components.channels.*.[publish,subscribe].message.oneOf.*.traits.*.tags | $.components.messages.*.traits.*.tags | $.components.messageTraits.*.tags` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-unused-components-schema":{"title":"Asyncapi Unused Components Schema","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-unused-components-schema/","source":"builtin","description":"Potentially unused components schema has been detected.","message":"Potentially unused components schema has been detected.","severity":"info","given":"$.components.schemas","then":{"function":"unreferencedReusableObject","functionOptions":{"reusableObjectsLocation":"#/components/schemas"}},"tags":["format:asyncapi","spec:components","spec:schemas","experience:consistency","experience:data-modeling"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-unused-components-schema' (Asyncapi Unused Components Schema). Requirement: Potentially unused components schema has been detected. To fix: Remove the unreferenced reusable object, or reference it where it is needed. This rule is evaluated at the JSONPath `$.components.schemas` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-unused-components-server":{"title":"Asyncapi Unused Components Server","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-unused-components-server/","source":"builtin","description":"Potentially unused components server has been detected.","message":"Potentially unused components server has been detected.","severity":"info","given":"$.components.servers","then":{"function":"unreferencedReusableObject","functionOptions":{"reusableObjectsLocation":"#/components/servers"}},"tags":["format:asyncapi","spec:servers","spec:components","experience:consistency","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-unused-components-server' (Asyncapi Unused Components Server). Requirement: Potentially unused components server has been detected. To fix: Remove the unreferenced reusable object, or reference it where it is needed. This rule is evaluated at the JSONPath `$.components.servers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"channel-asyncapi-require-description":{"title":"Channel Asyncapi Require Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/channel-asyncapi-require-description/","source":"spotlight","description":"Channels should have a description of the messages they carry.","message":"Channel should have a description.","given":"$.channels[*]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:channels","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'channel-asyncapi-require-description' (Channel Asyncapi Require Description). Requirement: Channels should have a description of the messages they carry. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.channels[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"component-asyncapi-message-require-contenttype":{"title":"Component Asyncapi Message Require Contenttype","reference":"https://spotlight-rules.com/spec/rules/asyncapi/component-asyncapi-message-require-contenttype/","source":"spotlight","description":"Messages should declare a contentType (e.g. application/json).","message":"Message should declare a contentType.","given":"$.components.messages[*]","severity":"info","then":{"field":"contentType","function":"truthy"},"tags":["format:asyncapi","spec:components","experience:consistency","experience:data-modeling"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'component-asyncapi-message-require-contenttype' (Component Asyncapi Message Require Contenttype). Requirement: Messages should declare a contentType (e.g. application/json). To fix: Ensure `contentType` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"component-asyncapi-message-require-correlation-id":{"title":"Component Asyncapi Message Require Correlation ID","reference":"https://spotlight-rules.com/spec/rules/asyncapi/component-asyncapi-message-require-correlation-id/","source":"spotlight","description":"Messages should define a correlationId so events can be traced across services.","message":"Message should define a correlationId.","given":"$.components.messages[*]","severity":"info","then":{"field":"correlationId","function":"truthy"},"tags":["format:asyncapi","spec:components","topic:tracing","experience:reliability","experience:observability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'component-asyncapi-message-require-correlation-id' (Component Asyncapi Message Require Correlation ID). Requirement: Messages should define a correlationId so events can be traced across services. To fix: Ensure `correlationId` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"component-asyncapi-message-require-name":{"title":"Component Asyncapi Message Require Name","reference":"https://spotlight-rules.com/spec/rules/asyncapi/component-asyncapi-message-require-name/","source":"spotlight","description":"Messages should declare a name.","message":"Message should declare a name.","given":"$.components.messages[*]","severity":"info","then":{"field":"name","function":"truthy"},"tags":["format:asyncapi","spec:components","experience:documentation","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'component-asyncapi-message-require-name' (Component Asyncapi Message Require Name). Requirement: Messages should declare a name. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"component-asyncapi-message-require-payload":{"title":"Component Asyncapi Message Require Payload","reference":"https://spotlight-rules.com/spec/rules/asyncapi/component-asyncapi-message-require-payload/","source":"spotlight","description":"Messages should define a payload schema.","message":"Message should define a payload.","given":"$.components.messages[*]","severity":"info","then":{"field":"payload","function":"truthy"},"tags":["format:asyncapi","spec:components","experience:data-modeling"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'component-asyncapi-message-require-payload' (Component Asyncapi Message Require Payload). Requirement: Messages should define a payload schema. To fix: Ensure `payload` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"component-asyncapi-message-require-title":{"title":"Component Asyncapi Message Require Title","reference":"https://spotlight-rules.com/spec/rules/asyncapi/component-asyncapi-message-require-title/","source":"spotlight","description":"Messages should declare a human-readable title.","message":"Message should declare a title.","given":"$.components.messages[*]","severity":"info","then":{"field":"title","function":"truthy"},"tags":["format:asyncapi","spec:components","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'component-asyncapi-message-require-title' (Component Asyncapi Message Require Title). Requirement: Messages should declare a human-readable title. To fix: Ensure `title` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-asyncapi":{"title":"Document Require Asyncapi","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-asyncapi/","source":"spotlight","description":"asyncapi document should declare a `asyncapi` property.","message":"Missing `asyncapi`.","given":"$","severity":"info","then":{"field":"asyncapi","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-asyncapi' (Document Require Asyncapi). Requirement: asyncapi document should declare a `asyncapi` property. To fix: Ensure `asyncapi` is present and non-empty at each matching location. Guidance: Missing `asyncapi`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-channel":{"title":"Document Require Channel","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-channel/","source":"spotlight","description":"asyncapi document should declare a `channels` property.","message":"Missing `channels`.","given":"$","severity":"info","then":{"field":"channels","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-channel' (Document Require Channel). Requirement: asyncapi document should declare a `channels` property. To fix: Ensure `channels` is present and non-empty at each matching location. Guidance: Missing `channels`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-component":{"title":"Document Require Component","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-component/","source":"spotlight","description":"asyncapi document should declare a `components` property.","message":"Missing `components`.","given":"$","severity":"info","then":{"field":"components","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-component' (Document Require Component). Requirement: asyncapi document should declare a `components` property. To fix: Ensure `components` is present and non-empty at each matching location. Guidance: Missing `components`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-defaultcontenttype":{"title":"Document Require Defaultcontenttype","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-defaultcontenttype/","source":"spotlight","description":"asyncapi document should declare a `defaultContentType` property.","message":"Missing `defaultContentType`.","given":"$","severity":"info","then":{"field":"defaultContentType","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-defaultcontenttype' (Document Require Defaultcontenttype). Requirement: asyncapi document should declare a `defaultContentType` property. To fix: Ensure `defaultContentType` is present and non-empty at each matching location. Guidance: Missing `defaultContentType`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-id":{"title":"Document Require ID","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-id/","source":"spotlight","description":"asyncapi document should declare a `id` property.","message":"Missing `id`.","given":"$","severity":"info","then":{"field":"id","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-id' (Document Require ID). Requirement: asyncapi document should declare a `id` property. To fix: Ensure `id` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-info":{"title":"Document Require Info","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-info/","source":"spotlight","description":"asyncapi document should declare a `info` property.","message":"Missing `info`.","given":"$","severity":"info","then":{"field":"info","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-info' (Document Require Info). Requirement: asyncapi document should declare a `info` property. To fix: Ensure `info` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-operation":{"title":"Document Require Operation","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-operation/","source":"spotlight","description":"asyncapi document should declare a `operations` property.","message":"Missing `operations`.","given":"$","severity":"info","then":{"field":"operations","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-operation' (Document Require Operation). Requirement: asyncapi document should declare a `operations` property. To fix: Ensure `operations` is present and non-empty at each matching location. Guidance: Missing `operations`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-server":{"title":"Document Require Server","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-server/","source":"spotlight","description":"asyncapi document should declare a `servers` property.","message":"Missing `servers`.","given":"$","severity":"info","then":{"field":"servers","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-server' (Document Require Server). Requirement: asyncapi document should declare a `servers` property. To fix: Ensure `servers` is present and non-empty at each matching location. Guidance: Missing `servers`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"info-asyncapi-require-title":{"title":"Info Asyncapi Require Title","reference":"https://spotlight-rules.com/spec/rules/asyncapi/info-asyncapi-require-title/","source":"spotlight","description":"The API should declare an info.title.","message":"AsyncAPI info should have a title.","given":"$.info","severity":"info","then":{"field":"title","function":"truthy"},"tags":["format:asyncapi","spec:info","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'info-asyncapi-require-title' (Info Asyncapi Require Title). Requirement: The API should declare an info.title. To fix: Ensure `title` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"info-asyncapi-version-semver":{"title":"Info Asyncapi Version Semver","reference":"https://spotlight-rules.com/spec/rules/asyncapi/info-asyncapi-version-semver/","source":"spotlight","description":"info.version should be semantic (e.g. 1.0.0).","message":"AsyncAPI version should be semantic.","given":"$.info.version","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^\\d+\\.\\d+\\.\\d+"}},"tags":["format:asyncapi","spec:info","experience:versioning"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'info-asyncapi-version-semver' (Info Asyncapi Version Semver). Requirement: info.version should be semantic (e.g. 1.0.0). To fix: Ensure the targeted value matches the regular expression `^\\d+\\.\\d+\\.\\d+`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.info.version` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"operation-asyncapi-require-summary":{"title":"Operation Asyncapi Require Summary","reference":"https://spotlight-rules.com/spec/rules/asyncapi/operation-asyncapi-require-summary/","source":"spotlight","description":"Operations should have a short summary.","message":"Operation should have a summary.","given":"$.operations[*]","severity":"info","then":{"field":"summary","function":"truthy"},"tags":["format:asyncapi","spec:operations","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'operation-asyncapi-require-summary' (Operation Asyncapi Require Summary). Requirement: Operations should have a short summary. To fix: Ensure `summary` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.operations[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"operation-asyncapi-require-tag":{"title":"Operation Asyncapi Require Tag","reference":"https://spotlight-rules.com/spec/rules/asyncapi/operation-asyncapi-require-tag/","source":"spotlight","description":"Operations should declare tags for grouping.","message":"Operation should declare tags.","given":"$.operations[*]","severity":"info","then":{"field":"tags","function":"truthy"},"tags":["format:asyncapi","spec:operations","experience:documentation","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'operation-asyncapi-require-tag' (Operation Asyncapi Require Tag). Requirement: Operations should declare tags for grouping. To fix: Ensure `tags` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.operations[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"schema-asyncapi-property-camel-case":{"title":"Schema Asyncapi Property Camel Case","reference":"https://spotlight-rules.com/spec/rules/asyncapi/schema-asyncapi-property-camel-case/","source":"spotlight","description":"Schema property names should be camelCase.","message":"Schema property is not camelCase.","given":"$.components.schemas[*].properties[*]~","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-zA-Z0-9]*$"}},"tags":["format:asyncapi","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'schema-asyncapi-property-camel-case' (Schema Asyncapi Property Camel Case). Requirement: Schema property names should be camelCase. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.schemas[*].properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"schema-asyncapi-property-require-description":{"title":"Schema Asyncapi Property Require Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/schema-asyncapi-property-require-description/","source":"spotlight","description":"Schema properties should be documented with a description.","message":"Schema property should have a description.","given":"$.components.schemas[*].properties[*]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:components","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'schema-asyncapi-property-require-description' (Schema Asyncapi Property Require Description). Requirement: Schema properties should be documented with a description. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas[*].properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"server-asyncapi-require-description":{"title":"Server Asyncapi Require Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/server-asyncapi-require-description/","source":"spotlight","description":"Servers should have a description identifying the environment/broker.","message":"Server should have a description.","given":"$.servers[*]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:servers","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'server-asyncapi-require-description' (Server Asyncapi Require Description). Requirement: Servers should have a description identifying the environment/broker. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.servers[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."}},"arazzo":{"arazzo-document-schema":{"title":"Arazzo Document Schema","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-document-schema/","source":"builtin","description":"Arazzo Document must be valid against the Arazzo schema.","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoDocumentSchema"},"tags":["format:arazzo","spec:document","experience:data-modeling","experience:reliability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-document-schema' (Arazzo Document Schema). Requirement: Arazzo Document must be valid against the Arazzo schema. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-info-description":{"title":"Arazzo Info Description","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-info-description/","source":"builtin","description":"Info \"description\" should be present and non-empty string.","message":"Info \"description\" should be present and non-empty string.","severity":"info","given":"$","then":{"field":"info.description","function":"truthy"},"tags":["format:arazzo","spec:document","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-info-description' (Arazzo Info Description). Requirement: Info \"description\" should be present and non-empty string. To fix: Ensure `info.description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-info-summary":{"title":"Arazzo Info Summary","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-info-summary/","source":"builtin","description":"Info \"summary\" is recommended be present and be a non-empty string.","message":"Info \"summary\" is recommended be present and be a non-empty string.","severity":"info","given":"$","then":{"field":"info.summary","function":"truthy"},"tags":["format:arazzo","spec:document","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-info-summary' (Arazzo Info Summary). Requirement: Info \"summary\" is recommended be present and be a non-empty string. To fix: Ensure `info.summary` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-no-script-tags-in-markdown":{"title":"Arazzo No Script Tags In Markdown","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-no-script-tags-in-markdown/","source":"builtin","description":"Markdown descriptions must not have \"<script>\" tags.","message":"Markdown descriptions must not have \"<script>\" tags.","severity":"info","given":"$..[description,title]","then":{"function":"pattern","functionOptions":{"notMatch":"<script"}},"tags":["format:arazzo","spec:document","experience:security"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-no-script-tags-in-markdown' (Arazzo No Script Tags In Markdown). Requirement: Markdown descriptions must not have \"<script>\" tags. To fix: Ensure the targeted value does NOT match the regular expression `<script`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..[description,title]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-source-descriptions-type":{"title":"Arazzo Source Descriptions Type","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-source-descriptions-type/","source":"builtin","description":"Source Description \"type\" should be present.","message":"Source Description \"type\" should be present.","severity":"info","given":"$.sourceDescriptions[*]","then":{"field":"type","function":"truthy"},"tags":["format:arazzo","spec:source-descriptions","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-source-descriptions-type' (Arazzo Source Descriptions Type). Requirement: Source Description \"type\" should be present. To fix: Ensure `type` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.sourceDescriptions[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-description":{"title":"Arazzo Step Description","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-description/","source":"builtin","description":"Step \"description\" should be present and non-empty string.","message":"Step \"description\" should be present and non-empty string.","severity":"info","given":"$.workflows[*].steps[*]","then":{"field":"description","function":"truthy"},"tags":["format:arazzo","spec:workflows","spec:steps","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-description' (Arazzo Step Description). Requirement: Step \"description\" should be present and non-empty string. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.workflows[*].steps[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-failure-actions-validation":{"title":"Arazzo Step Failure Actions Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-failure-actions-validation/","source":"builtin","description":"Every failure action must have a unique \"name\", and the fields \"workflowId\" and \"stepId\" are mutually exclusive.","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoStepFailureActionsValidation"},"tags":["format:arazzo","spec:document","experience:error-handling","experience:reliability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-failure-actions-validation' (Arazzo Step Failure Actions Validation). Requirement: Every failure action must have a unique \"name\", and the fields \"workflowId\" and \"stepId\" are mutually exclusive. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-operationPath":{"title":"Arazzo Step OperationPath","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-operationPath/","source":"builtin","description":"It is recommended to use \"operationId\" rather than \"operationPath\".","message":"It is recommended to use \"operationId\" rather than \"operationPath\".","severity":"info","given":"$.workflows[*].steps[*]","then":{"field":"operationPath","function":"falsy"},"tags":["format:arazzo","spec:workflows","spec:steps","experience:consistency","experience:usability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-operationPath' (Arazzo Step OperationPath). Requirement: It is recommended to use \"operationId\" rather than \"operationPath\". To fix: Ensure `operationPath` is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.workflows[*].steps[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-output-validation":{"title":"Arazzo Step Output Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-output-validation/","source":"builtin","description":"Every step output must have unique name and its value must be a valid runtime expression.","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoStepOutputNamesValidation"},"tags":["format:arazzo","spec:document","experience:data-modeling","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-output-validation' (Arazzo Step Output Validation). Requirement: Every step output must have unique name and its value must be a valid runtime expression. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-parameters-validation":{"title":"Arazzo Step Parameters Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-parameters-validation/","source":"builtin","description":"Step parameters and workflow parameters must valid.","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoStepParametersValidation"},"tags":["format:arazzo","spec:document","experience:reliability","experience:data-modeling"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-parameters-validation' (Arazzo Step Parameters Validation). Requirement: Step parameters and workflow parameters must valid. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-request-body-validation":{"title":"Arazzo Step Request Body Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-request-body-validation/","source":"builtin","description":"Every step request body must have a valid `contentType` and use of runtime expressions.","message":"Every step request body must have a valid `contentType` and use of runtime expressions.","severity":"info","given":"$","then":{"function":"arazzoStepRequestBodyValidation"},"tags":["format:arazzo","spec:document","experience:reliability","experience:data-modeling"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-request-body-validation' (Arazzo Step Request Body Validation). Requirement: Every step request body must have a valid `contentType` and use of runtime expressions. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-stepId":{"title":"Arazzo Step StepId","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-stepId/","source":"builtin","description":"Step \"stepId\" should follow the pattern \"^[A-Za-z0-9_\\-]+$\".","message":"Step \"stepId\" should follow the pattern \"^[A-Za-z0-9_\\-]+$\".","severity":"info","given":"$.workflows[*].steps[*]","then":{"field":"stepId","function":"pattern","functionOptions":{"match":"^[A-Za-z0-9_\\-]+$"}},"tags":["format:arazzo","spec:workflows","spec:steps","experience:naming","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-stepId' (Arazzo Step StepId). Requirement: Step \"stepId\" should follow the pattern \"^[A-Za-z0-9_\\-]+$\". To fix: Ensure `stepId` matches the regular expression `^[A-Za-z0-9_\\-]+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.workflows[*].steps[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-success-actions-validation":{"title":"Arazzo Step Success Actions Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-success-actions-validation/","source":"builtin","description":"Every success action must have a unique \"name\", and the fields \"workflowId\" and \"stepId\" are mutually exclusive.","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoStepSuccessActionsValidation"},"tags":["format:arazzo","spec:document","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-success-actions-validation' (Arazzo Step Success Actions Validation). Requirement: Every success action must have a unique \"name\", and the fields \"workflowId\" and \"stepId\" are mutually exclusive. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-success-criteria-validation":{"title":"Arazzo Step Success Criteria Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-success-criteria-validation/","source":"builtin","description":"Every success criteria must have a valid context, conditions, and types.","message":"{{error}}","severity":"info","given":"$.workflows[*]","then":{"function":"arazzoStepSuccessCriteriaValidation"},"tags":["format:arazzo","spec:workflows","experience:reliability","experience:error-handling"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-success-criteria-validation' (Arazzo Step Success Criteria Validation). Requirement: Every success criteria must have a valid context, conditions, and types. This rule is evaluated at the JSONPath `$.workflows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-validation":{"title":"Arazzo Step Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-validation/","source":"builtin","description":"Every step must have a valid \"stepId\" and an valid \"operationId\" or \"operationPath\" or \"workflowId\".","message":"Every step must have a valid \"stepId\" and an valid \"operationId\" or \"operationPath\" or \"workflowId\".","severity":"info","given":"$","then":{"function":"arazzoStepValidation"},"tags":["format:arazzo","spec:document","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-validation' (Arazzo Step Validation). Requirement: Every step must have a valid \"stepId\" and an valid \"operationId\" or \"operationPath\" or \"workflowId\". Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflow-depends-on-validation":{"title":"Arazzo Workflow Depends On Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflow-depends-on-validation/","source":"builtin","description":"Every workflow dependency must be valid.","message":"Every workflow dependency must be valid.","severity":"info","given":"$","then":{"function":"arazzoWorkflowDependsOnValidation"},"tags":["format:arazzo","spec:document","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflow-depends-on-validation' (Arazzo Workflow Depends On Validation). Requirement: Every workflow dependency must be valid. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflow-description":{"title":"Arazzo Workflow Description","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflow-description/","source":"builtin","description":"Workflow \"description\" should be present and non-empty string.","message":"Workflow \"description\" should be present and non-empty string.","severity":"info","given":"$.workflows[*]","then":{"field":"description","function":"truthy"},"tags":["format:arazzo","spec:workflows","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflow-description' (Arazzo Workflow Description). Requirement: Workflow \"description\" should be present and non-empty string. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.workflows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflow-output-validation":{"title":"Arazzo Workflow Output Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflow-output-validation/","source":"builtin","description":"Every workflow output must have unique name and its value must be a valid runtime expression.","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoWorkflowOutputNamesValidation"},"tags":["format:arazzo","spec:document","experience:data-modeling","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflow-output-validation' (Arazzo Workflow Output Validation). Requirement: Every workflow output must have unique name and its value must be a valid runtime expression. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflow-stepId-unique":{"title":"Arazzo Workflow StepId Unique","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflow-stepId-unique/","source":"builtin","description":"Every step must have unique \"stepId\".","message":"{{error}}","severity":"info","given":"$.workflows[*]","then":{"function":"arazzoStepIdUniqueness"},"tags":["format:arazzo","spec:workflows","experience:consistency","experience:naming","experience:reliability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflow-stepId-unique' (Arazzo Workflow StepId Unique). Requirement: Every step must have unique \"stepId\". This rule is evaluated at the JSONPath `$.workflows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflow-summary":{"title":"Arazzo Workflow Summary","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflow-summary/","source":"builtin","description":"Workflow \"summary\" should be present and non-empty string.","message":"Workflow \"summary\" should be present and non-empty string.","severity":"info","given":"$.workflows[*]","then":{"field":"summary","function":"truthy"},"tags":["format:arazzo","spec:workflows","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflow-summary' (Arazzo Workflow Summary). Requirement: Workflow \"summary\" should be present and non-empty string. To fix: Ensure `summary` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.workflows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflow-workflowId":{"title":"Arazzo Workflow WorkflowId","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflow-workflowId/","source":"builtin","description":"Workflow \"workflowId\" should follow the pattern \"^[A-Za-z0-9_\\-]+$\".","message":"Workflow \"workflowId\" should follow the pattern \"^[A-Za-z0-9_\\-]+$\".","severity":"info","given":"$.workflows[*]","then":{"field":"workflowId","function":"pattern","functionOptions":{"match":"^[A-Za-z0-9_\\-]+$"}},"tags":["format:arazzo","spec:workflows","experience:naming","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflow-workflowId' (Arazzo Workflow WorkflowId). Requirement: Workflow \"workflowId\" should follow the pattern \"^[A-Za-z0-9_\\-]+$\". To fix: Ensure `workflowId` matches the regular expression `^[A-Za-z0-9_\\-]+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.workflows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflowId-unique":{"title":"Arazzo WorkflowId Unique","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflowId-unique/","source":"builtin","description":"Every workflow must have unique \"workflowId\".","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoWorkflowIdUniqueness"},"tags":["format:arazzo","spec:document","experience:consistency","experience:naming","experience:reliability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflowId-unique' (Arazzo WorkflowId Unique). Requirement: Every workflow must have unique \"workflowId\". Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"document-require-arazzo":{"title":"Document Require Arazzo","reference":"https://spotlight-rules.com/spec/rules/arazzo/document-require-arazzo/","source":"spotlight","description":"arazzo document should declare a `arazzo` property.","message":"Missing `arazzo`.","given":"$","severity":"info","then":{"field":"arazzo","function":"truthy"},"tags":["format:arazzo","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'document-require-arazzo' (Document Require Arazzo). Requirement: arazzo document should declare a `arazzo` property. To fix: Ensure `arazzo` is present and non-empty at each matching location. Guidance: Missing `arazzo`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"document-require-component":{"title":"Document Require Component","reference":"https://spotlight-rules.com/spec/rules/arazzo/document-require-component/","source":"spotlight","description":"arazzo document should declare a `components` property.","message":"Missing `components`.","given":"$","severity":"info","then":{"field":"components","function":"truthy"},"tags":["format:arazzo","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'document-require-component' (Document Require Component). Requirement: arazzo document should declare a `components` property. To fix: Ensure `components` is present and non-empty at each matching location. Guidance: Missing `components`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"document-require-info":{"title":"Document Require Info","reference":"https://spotlight-rules.com/spec/rules/arazzo/document-require-info/","source":"spotlight","description":"arazzo document should declare a `info` property.","message":"Missing `info`.","given":"$","severity":"info","then":{"field":"info","function":"truthy"},"tags":["format:arazzo","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'document-require-info' (Document Require Info). Requirement: arazzo document should declare a `info` property. To fix: Ensure `info` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"document-require-sourcedescriptions":{"title":"Document Require Sourcedescriptions","reference":"https://spotlight-rules.com/spec/rules/arazzo/document-require-sourcedescriptions/","source":"spotlight","description":"arazzo document should declare a `sourceDescriptions` property.","message":"Missing `sourceDescriptions`.","given":"$","severity":"info","then":{"field":"sourceDescriptions","function":"truthy"},"tags":["format:arazzo","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'document-require-sourcedescriptions' (Document Require Sourcedescriptions). Requirement: arazzo document should declare a `sourceDescriptions` property. To fix: Ensure `sourceDescriptions` is present and non-empty at each matching location. Guidance: Missing `sourceDescriptions`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"document-require-workflow":{"title":"Document Require Workflow","reference":"https://spotlight-rules.com/spec/rules/arazzo/document-require-workflow/","source":"spotlight","description":"arazzo document should declare a `workflows` property.","message":"Missing `workflows`.","given":"$","severity":"info","then":{"field":"workflows","function":"truthy"},"tags":["format:arazzo","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'document-require-workflow' (Document Require Workflow). Requirement: arazzo document should declare a `workflows` property. To fix: Ensure `workflows` is present and non-empty at each matching location. Guidance: Missing `workflows`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"info-arazzo-require-title":{"title":"Info Arazzo Require Title","reference":"https://spotlight-rules.com/spec/rules/arazzo/info-arazzo-require-title/","source":"spotlight","description":"The Arazzo description should declare an info.title.","message":"Arazzo info should have a title.","given":"$.info","severity":"info","then":{"field":"title","function":"truthy"},"tags":["format:arazzo","spec:info","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'info-arazzo-require-title' (Info Arazzo Require Title). Requirement: The Arazzo description should declare an info.title. To fix: Ensure `title` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"source-arazzo-description-require-name":{"title":"Source Arazzo Description Require Name","reference":"https://spotlight-rules.com/spec/rules/arazzo/source-arazzo-description-require-name/","source":"spotlight","description":"Each source description should declare a name used to reference it from steps.","message":"Source description should have a name.","given":"$.sourceDescriptions[*]","severity":"info","then":{"field":"name","function":"truthy"},"tags":["format:arazzo","spec:source-descriptions","experience:consistency","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'source-arazzo-description-require-name' (Source Arazzo Description Require Name). Requirement: Each source description should declare a name used to reference it from steps. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.sourceDescriptions[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"source-arazzo-description-require-url":{"title":"Source Arazzo Description Require URL","reference":"https://spotlight-rules.com/spec/rules/arazzo/source-arazzo-description-require-url/","source":"spotlight","description":"Each source description should declare a url to the referenced OpenAPI/Arazzo document.","message":"Source description should have a url.","given":"$.sourceDescriptions[*]","severity":"info","then":{"field":"url","function":"truthy"},"tags":["format:arazzo","spec:source-descriptions","experience:discoverability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'source-arazzo-description-require-url' (Source Arazzo Description Require URL). Requirement: Each source description should declare a url to the referenced OpenAPI/Arazzo document. To fix: Ensure `url` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.sourceDescriptions[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"workflow-arazzo-require-step":{"title":"Workflow Arazzo Require Step","reference":"https://spotlight-rules.com/spec/rules/arazzo/workflow-arazzo-require-step/","source":"spotlight","description":"A workflow should define at least one step.","message":"Workflow should define at least one step.","given":"$.workflows[*]","severity":"info","then":{"field":"steps","function":"schema","functionOptions":{"schema":{"type":"array","minItems":1}}},"tags":["format:arazzo","spec:workflows","experience:reliability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'workflow-arazzo-require-step' (Workflow Arazzo Require Step). Requirement: A workflow should define at least one step. To fix: Adjust `steps` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.workflows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"workflow-arazzo-step-require-operation":{"title":"Workflow Arazzo Step Require Operation","reference":"https://spotlight-rules.com/spec/rules/arazzo/workflow-arazzo-step-require-operation/","source":"spotlight","description":"Each step should reference an operation via operationId, operationPath, or a nested workflowId.","message":"Step should reference an operationId, operationPath, or workflowId.","given":"$.workflows[*].steps[*]","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"object","anyOf":[{"required":["operationId"]},{"required":["operationPath"]},{"required":["workflowId"]}]}}},"tags":["format:arazzo","spec:workflows","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'workflow-arazzo-step-require-operation' (Workflow Arazzo Step Require Operation). Requirement: Each step should reference an operation via operationId, operationPath, or a nested workflowId. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.workflows[*].steps[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"workflow-arazzo-step-require-success-criteria":{"title":"Workflow Arazzo Step Require Success Criteria","reference":"https://spotlight-rules.com/spec/rules/arazzo/workflow-arazzo-step-require-success-criteria/","source":"spotlight","description":"Steps should declare successCriteria so the workflow can assert each step succeeded.","message":"Step should declare successCriteria.","given":"$.workflows[*].steps[*]","severity":"info","then":{"field":"successCriteria","function":"truthy"},"tags":["format:arazzo","spec:workflows","experience:reliability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'workflow-arazzo-step-require-success-criteria' (Workflow Arazzo Step Require Success Criteria). Requirement: Steps should declare successCriteria so the workflow can assert each step succeeded. To fix: Ensure `successCriteria` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.workflows[*].steps[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."}},"jsonschema":{"document-require-description":{"title":"Document Require Description","reference":"https://spotlight-rules.com/spec/rules/json-schema/document-require-description/","source":"default","description":"The `description` property should be present.","message":"description should be present","severity":"info","given":"$","then":{"field":"description","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:documentation","experience:data-modeling"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'document-require-description' (Document Require Description). Requirement: The `description` property should be present. To fix: Ensure `description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"document-require-id":{"title":"Document Require ID","reference":"https://spotlight-rules.com/spec/rules/json-schema/document-require-id/","source":"default","description":"The `$id` property should be present.","message":"$id should be present","severity":"info","given":"$","then":{"field":"$id","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'document-require-id' (Document Require ID). Requirement: The `$id` property should be present. To fix: Ensure `$id` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"document-require-property":{"title":"Document Require Property","reference":"https://spotlight-rules.com/spec/rules/json-schema/document-require-property/","source":"default","description":"The `properties` property should be present.","message":"properties should be present","severity":"info","given":"$","then":{"field":"properties","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'document-require-property' (Document Require Property). Requirement: The `properties` property should be present. To fix: Ensure `properties` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"document-require-required-list":{"title":"Document Require Required List","reference":"https://spotlight-rules.com/spec/rules/json-schema/document-require-required-list/","source":"default","description":"The `required` property should be present.","message":"required should be present","severity":"info","given":"$","then":{"field":"required","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'document-require-required-list' (Document Require Required List). Requirement: The `required` property should be present. To fix: Ensure `required` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"document-require-title":{"title":"Document Require Title","reference":"https://spotlight-rules.com/spec/rules/json-schema/document-require-title/","source":"default","description":"The `title` property should be present.","message":"title should be present","severity":"info","given":"$","then":{"field":"title","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:documentation","experience:data-modeling"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'document-require-title' (Document Require Title). Requirement: The `title` property should be present. To fix: Ensure `title` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"document-require-type":{"title":"Document Require Type","reference":"https://spotlight-rules.com/spec/rules/json-schema/document-require-type/","source":"default","description":"The `type` property should be present.","message":"type should be present","severity":"info","given":"$","then":{"field":"type","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'document-require-type' (Document Require Type). Requirement: The `type` property should be present. To fix: Ensure `type` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"schema-property-require-description":{"title":"Schema Property Require Description","reference":"https://spotlight-rules.com/spec/rules/json-schema/schema-property-require-description/","source":"default","description":"The `description` property of each property should be present.","message":"description should be present","severity":"info","given":"$.properties[*]","then":{"field":"description","function":"truthy"},"tags":["format:jsonschema","spec:properties","experience:documentation","experience:data-modeling"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'schema-property-require-description' (Schema Property Require Description). Requirement: The `description` property of each property should be present. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"schema-property-require-type":{"title":"Schema Property Require Type","reference":"https://spotlight-rules.com/spec/rules/json-schema/schema-property-require-type/","source":"default","description":"The `type` property of each property should be present.","message":"type should be present","severity":"info","given":"$.properties[*]","then":{"field":"type","function":"truthy"},"tags":["format:jsonschema","spec:properties","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'schema-property-require-type' (Schema Property Require Type). Requirement: The `type` property of each property should be present. To fix: Ensure `type` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"schema-require":{"title":"Schema Require","reference":"https://spotlight-rules.com/spec/rules/json-schema/schema-require/","source":"default","description":"The `$schema` property should be present.","message":"$schema should be present","severity":"info","given":"$","then":{"field":"$schema","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'schema-require' (Schema Require). Requirement: The `$schema` property should be present. To fix: Ensure `$schema` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."}},"json-structure":{"document-json-structure-id-uri":{"title":"Document JSON Structure ID URI","reference":"https://spotlight-rules.com/spec/rules/json-structure/document-json-structure-id-uri/","source":"spotlight","description":"$id should be a stable absolute URI (https:// or urn:) identifying the schema.","message":"$id should be an absolute URI.","given":"$.$id","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https?://|^urn:"}},"tags":["format:json-structure","spec:document","experience:consistency","experience:discoverability"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'document-json-structure-id-uri' (Document JSON Structure ID URI). Requirement: $id should be a stable absolute URI (https:// or urn:) identifying the schema. To fix: Ensure the targeted value matches the regular expression `^https?://|^urn:`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.$id` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"document-require-id":{"title":"Document Require ID","reference":"https://spotlight-rules.com/spec/rules/json-structure/document-require-id/","source":"default","description":"The `$id` property should be present.","message":"$id should be present","severity":"info","given":"$","then":{"field":"$id","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'document-require-id' (Document Require ID). Requirement: The `$id` property should be present. To fix: Ensure `$id` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"document-require-name":{"title":"Document Require Name","reference":"https://spotlight-rules.com/spec/rules/json-structure/document-require-name/","source":"default","description":"The `name` property should be present.","message":"name should be present","severity":"info","given":"$","then":{"field":"name","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'document-require-name' (Document Require Name). Requirement: The `name` property should be present. To fix: Ensure `name` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"document-require-property":{"title":"Document Require Property","reference":"https://spotlight-rules.com/spec/rules/json-structure/document-require-property/","source":"default","description":"The `properties` property should be present.","message":"properties should be present","severity":"info","given":"$","then":{"field":"properties","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'document-require-property' (Document Require Property). Requirement: The `properties` property should be present. To fix: Ensure `properties` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"document-require-type":{"title":"Document Require Type","reference":"https://spotlight-rules.com/spec/rules/json-structure/document-require-type/","source":"default","description":"The `type` property should be present.","message":"type should be present","severity":"info","given":"$","then":{"field":"type","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'document-require-type' (Document Require Type). Requirement: The `type` property should be present. To fix: Ensure `type` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-json-structure-property-camel-case":{"title":"Schema JSON Structure Property Camel Case","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-json-structure-property-camel-case/","source":"spotlight","description":"Property names should be camelCase.","message":"Property is not camelCase.","given":"$.properties[*]~","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-zA-Z0-9]*$"}},"tags":["format:json-structure","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-json-structure-property-camel-case' (Schema JSON Structure Property Camel Case). Requirement: Property names should be camelCase. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-json-structure-property-require-description":{"title":"Schema JSON Structure Property Require Description","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-json-structure-property-require-description/","source":"spotlight","description":"Properties should be documented with a description.","message":"Property should have a description.","given":"$.properties[*]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:documentation"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-json-structure-property-require-description' (Schema JSON Structure Property Require Description). Requirement: Properties should be documented with a description. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-json-structure-property-require-type":{"title":"Schema JSON Structure Property Require Type","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-json-structure-property-require-type/","source":"spotlight","description":"Properties should declare a type.","message":"Property should declare a type.","given":"$.properties[*]","severity":"info","then":{"field":"type","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:data-modeling"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-json-structure-property-require-type' (Schema JSON Structure Property Require Type). Requirement: Properties should declare a type. To fix: Ensure `type` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-json-structure-root-type-object":{"title":"Schema JSON Structure Root Type Object","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-json-structure-root-type-object/","source":"spotlight","description":"The root type of a JSON Structure document is typically object.","message":"Root type should usually be object.","given":"$.type","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^object$"}},"tags":["format:json-structure","spec:document","experience:data-modeling"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-json-structure-root-type-object' (Schema JSON Structure Root Type Object). Requirement: The root type of a JSON Structure document is typically object. To fix: Ensure the targeted value matches the regular expression `^object$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-json-structure-uri":{"title":"Schema JSON Structure URI","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-json-structure-uri/","source":"spotlight","description":"$schema should be the URI of the JSON Structure meta-schema.","message":"$schema should be a URI.","given":"$.$schema","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https?://"}},"tags":["format:json-structure","spec:schemas","experience:consistency","experience:discoverability"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-json-structure-uri' (Schema JSON Structure URI). Requirement: $schema should be the URI of the JSON Structure meta-schema. To fix: Ensure the targeted value matches the regular expression `^https?://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.$schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-property-require-type":{"title":"Schema Property Require Type","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-property-require-type/","source":"default","description":"The `type` property of each property should be present.","message":"type should be present","severity":"info","given":"$.properties[*]","then":{"field":"type","function":"truthy"},"tags":["format:json-structure","spec:properties","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-property-require-type' (Schema Property Require Type). Requirement: The `type` property of each property should be present. To fix: Ensure `type` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-require":{"title":"Schema Require","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-require/","source":"default","description":"The `$schema` property should be present.","message":"$schema should be present","severity":"info","given":"$","then":{"field":"$schema","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-require' (Schema Require). Requirement: The `$schema` property should be present. To fix: Ensure `$schema` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."}},"json-ld":{"document-json-ld-id-iri":{"title":"Document JSON LD ID IRI","reference":"https://spotlight-rules.com/spec/rules/json-ld/document-json-ld-id-iri/","source":"spotlight","description":"@id should be an IRI (https://, urn:, did:) or a blank-node identifier.","message":"@id should be an IRI.","given":"$['@id']","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https?://|^urn:|^did:|^_:"}},"tags":["format:json-ld","spec:document","experience:consistency","experience:discoverability"],"prompt":"You are editing a JSON-LD document to satisfy the Spotlight API governance rule 'document-json-ld-id-iri' (Document JSON LD ID IRI). Requirement: @id should be an IRI (https://, urn:, did:) or a blank-node identifier. To fix: Ensure the targeted value matches the regular expression `^https?://|^urn:|^did:|^_:`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.@id` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON-LD. Return only the complete corrected document, with no commentary."},"document-require-context":{"title":"Document Require Context","reference":"https://spotlight-rules.com/spec/rules/json-ld/document-require-context/","source":"default","description":"The `@context` property should be present.","message":"@context should be present","severity":"info","given":"$","then":{"field":"@context","function":"truthy"},"tags":["format:json-ld","spec:document","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a JSON-LD document to satisfy the Spotlight API governance rule 'document-require-context' (Document Require Context). Requirement: The `@context` property should be present. To fix: Ensure `@context` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON-LD. Return only the complete corrected document, with no commentary."},"document-require-id":{"title":"Document Require ID","reference":"https://spotlight-rules.com/spec/rules/json-ld/document-require-id/","source":"default","description":"The `@id` property should be present.","message":"@id should be present","severity":"info","given":"$","then":{"field":"@id","function":"truthy"},"tags":["format:json-ld","spec:document","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a JSON-LD document to satisfy the Spotlight API governance rule 'document-require-id' (Document Require ID). Requirement: The `@id` property should be present. To fix: Ensure `@id` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON-LD. Return only the complete corrected document, with no commentary."},"document-require-type":{"title":"Document Require Type","reference":"https://spotlight-rules.com/spec/rules/json-ld/document-require-type/","source":"default","description":"The `@type` property should be present.","message":"@type should be present","severity":"info","given":"$","then":{"field":"@type","function":"truthy"},"tags":["format:json-ld","spec:document","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a JSON-LD document to satisfy the Spotlight API governance rule 'document-require-type' (Document Require Type). Requirement: The `@type` property should be present. To fix: Ensure `@type` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON-LD. Return only the complete corrected document, with no commentary."},"schema-json-ld-context-uri-or-object":{"title":"Schema JSON LD Context URI Or Object","reference":"https://spotlight-rules.com/spec/rules/json-ld/schema-json-ld-context-uri-or-object/","source":"spotlight","description":"@context should be a URI string, an inline object, or an array of those.","message":"@context should be a URI, object, or array.","given":"$['@context']","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":["string","object","array"]}}},"tags":["format:json-ld","spec:document","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON-LD document to satisfy the Spotlight API governance rule 'schema-json-ld-context-uri-or-object' (Schema JSON LD Context URI Or Object). Requirement: @context should be a URI string, an inline object, or an array of those. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.@context` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON-LD. Return only the complete corrected document, with no commentary."},"schema-json-ld-type-string-or-array":{"title":"Schema JSON LD Type String Or Array","reference":"https://spotlight-rules.com/spec/rules/json-ld/schema-json-ld-type-string-or-array/","source":"spotlight","description":"@type should be a string or an array of type strings.","message":"@type should be a string or array.","given":"$['@type']","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":["string","array"]}}},"tags":["format:json-ld","spec:document","experience:data-modeling"],"prompt":"You are editing a JSON-LD document to satisfy the Spotlight API governance rule 'schema-json-ld-type-string-or-array' (Schema JSON LD Type String Or Array). Requirement: @type should be a string or an array of type strings. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.@type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON-LD. Return only the complete corrected document, with no commentary."}},"mcp":{"capability-mcp-capabilities-not-empty":{"title":"Capability MCP Capabilities Not Empty","reference":"https://spotlight-rules.com/spec/rules/mcp/capability-mcp-capabilities-not-empty/","source":"spotlight","description":"capabilities should declare at least one of tools, resources, or prompts.","message":"capabilities should not be empty.","given":"$.capabilities","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"object","minProperties":1}}},"tags":["format:mcp","spec:capabilities","experience:discoverability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'capability-mcp-capabilities-not-empty' (Capability MCP Capabilities Not Empty). Requirement: capabilities should declare at least one of tools, resources, or prompts. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.capabilities` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"capability-require-prompts":{"title":"Capability Require Prompts","reference":"https://spotlight-rules.com/spec/rules/mcp/capability-require-prompts/","source":"default","description":"The `prompts` property of each capability should be present.","message":"prompts should be present","severity":"info","given":"$.capabilities","then":{"field":"prompts","function":"truthy"},"tags":["format:mcp","spec:capabilities","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'capability-require-prompts' (Capability Require Prompts). Requirement: The `prompts` property of each capability should be present. To fix: Ensure `prompts` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.capabilities` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"capability-require-resources":{"title":"Capability Require Resources","reference":"https://spotlight-rules.com/spec/rules/mcp/capability-require-resources/","source":"default","description":"The `resources` property of each capability should be present.","message":"resources should be present","severity":"info","given":"$.capabilities","then":{"field":"resources","function":"truthy"},"tags":["format:mcp","spec:capabilities","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'capability-require-resources' (Capability Require Resources). Requirement: The `resources` property of each capability should be present. To fix: Ensure `resources` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.capabilities` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"capability-require-tools":{"title":"Capability Require Tools","reference":"https://spotlight-rules.com/spec/rules/mcp/capability-require-tools/","source":"default","description":"The `tools` property of each capability should be present.","message":"tools should be present","severity":"info","given":"$.capabilities","then":{"field":"tools","function":"truthy"},"tags":["format:mcp","spec:capabilities","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'capability-require-tools' (Capability Require Tools). Requirement: The `tools` property of each capability should be present. To fix: Ensure `tools` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.capabilities` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"document-mcp-description-meaningful":{"title":"Document MCP Description Meaningful","reference":"https://spotlight-rules.com/spec/rules/mcp/document-mcp-description-meaningful/","source":"spotlight","description":"The server description should be specific (at least 40 characters) so agents can decide when to use it.","message":"MCP description should be at least 40 characters.","given":"$.description","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"string","minLength":40}}},"tags":["format:mcp","spec:document","experience:discoverability","experience:documentation"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'document-mcp-description-meaningful' (Document MCP Description Meaningful). Requirement: The server description should be specific (at least 40 characters) so agents can decide when to use it. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.description` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"document-mcp-name-kebab-case":{"title":"Document MCP Name Kebab Case","reference":"https://spotlight-rules.com/spec/rules/mcp/document-mcp-name-kebab-case/","source":"spotlight","description":"MCP server name should be lower kebab-case.","message":"MCP server name should be kebab-case.","given":"$.name","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^[a-z0-9]+(?:-[a-z0-9]+)*$"}},"tags":["format:mcp","spec:document","experience:naming","experience:consistency"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'document-mcp-name-kebab-case' (Document MCP Name Kebab Case). Requirement: MCP server name should be lower kebab-case. To fix: Ensure the targeted value matches the regular expression `^[a-z0-9]+(?:-[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"document-require-capabilities":{"title":"Document Require Capabilities","reference":"https://spotlight-rules.com/spec/rules/mcp/document-require-capabilities/","source":"default","description":"The `capabilities` property should be present.","message":"capabilities should be present","severity":"info","given":"$","then":{"field":"capabilities","function":"truthy"},"tags":["format:mcp","spec:servers","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'document-require-capabilities' (Document Require Capabilities). Requirement: The `capabilities` property should be present. To fix: Ensure `capabilities` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"document-require-description":{"title":"Document Require Description","reference":"https://spotlight-rules.com/spec/rules/mcp/document-require-description/","source":"default","description":"The `description` property should be present.","message":"description should be present","severity":"info","given":"$","then":{"field":"description","function":"truthy"},"tags":["format:mcp","spec:servers","experience:documentation","experience:data-modeling"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'document-require-description' (Document Require Description). Requirement: The `description` property should be present. To fix: Ensure `description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"document-require-instructions":{"title":"Document Require Instructions","reference":"https://spotlight-rules.com/spec/rules/mcp/document-require-instructions/","source":"default","description":"The `instructions` property should be present.","message":"instructions should be present","severity":"info","given":"$","then":{"field":"instructions","function":"truthy"},"tags":["format:mcp","spec:servers","experience:documentation","experience:usability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'document-require-instructions' (Document Require Instructions). Requirement: The `instructions` property should be present. To fix: Ensure `instructions` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"document-require-name":{"title":"Document Require Name","reference":"https://spotlight-rules.com/spec/rules/mcp/document-require-name/","source":"default","description":"The `name` property should be present.","message":"name should be present","severity":"info","given":"$","then":{"field":"name","function":"truthy"},"tags":["format:mcp","spec:servers","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'document-require-name' (Document Require Name). Requirement: The `name` property should be present. To fix: Ensure `name` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"info-mcp-protocol-version-dated":{"title":"Info MCP Protocol Version Dated","reference":"https://spotlight-rules.com/spec/rules/mcp/info-mcp-protocol-version-dated/","source":"spotlight","description":"protocolVersion should be a dated MCP revision (YYYY-MM-DD).","message":"protocolVersion should be a dated revision (YYYY-MM-DD).","given":"$.protocolVersion","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^\\d{4}-\\d{2}-\\d{2}$"}},"tags":["format:mcp","spec:document","experience:versioning","experience:consistency"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'info-mcp-protocol-version-dated' (Info MCP Protocol Version Dated). Requirement: protocolVersion should be a dated MCP revision (YYYY-MM-DD). To fix: Ensure the targeted value matches the regular expression `^\\d{4}-\\d{2}-\\d{2}$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.protocolVersion` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"info-mcp-version-semver":{"title":"Info MCP Version Semver","reference":"https://spotlight-rules.com/spec/rules/mcp/info-mcp-version-semver/","source":"spotlight","description":"The server version should be semantic (e.g. 1.0.0).","message":"MCP version should be semantic.","given":"$.version","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^\\d+\\.\\d+\\.\\d+"}},"tags":["format:mcp","spec:document","experience:versioning"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'info-mcp-version-semver' (Info MCP Version Semver). Requirement: The server version should be semantic (e.g. 1.0.0). To fix: Ensure the targeted value matches the regular expression `^\\d+\\.\\d+\\.\\d+`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.version` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"info-require-protocol-version":{"title":"Info Require Protocol Version","reference":"https://spotlight-rules.com/spec/rules/mcp/info-require-protocol-version/","source":"default","description":"The `protocolVersion` property should be present.","message":"protocolVersion should be present","severity":"info","given":"$","then":{"field":"protocolVersion","function":"truthy"},"tags":["format:mcp","spec:servers","experience:versioning","experience:consistency"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'info-require-protocol-version' (Info Require Protocol Version). Requirement: The `protocolVersion` property should be present. To fix: Ensure `protocolVersion` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"info-skill-require-version":{"title":"Info Require Version","reference":"https://spotlight-rules.com/spec/rules/mcp/info-skill-require-version/","source":"default","description":"The `version` property should be present.","message":"version should be present","severity":"info","given":"$","then":{"field":"version","function":"truthy"},"tags":["format:mcp","spec:servers","experience:versioning","experience:data-modeling"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'info-skill-require-version' (Info Require Version). Requirement: The `version` property should be present. To fix: Ensure `version` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."}},"plans":{"document-require-currency":{"title":"Document Require Currency","reference":"https://spotlight-rules.com/spec/rules/plans/document-require-currency/","source":"default","description":"The `currency` property should be present.","message":"currency should be present","severity":"info","given":"$","then":{"field":"currency","function":"truthy"},"tags":["format:plans","spec:document","experience:governance","experience:usability"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'document-require-currency' (Document Require Currency). Requirement: The `currency` property should be present. To fix: Ensure `currency` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"document-require-description":{"title":"Document Require Description","reference":"https://spotlight-rules.com/spec/rules/plans/document-require-description/","source":"default","description":"The `description` property should be present.","message":"description should be present","severity":"info","given":"$","then":{"field":"description","function":"truthy"},"tags":["format:plans","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'document-require-description' (Document Require Description). Requirement: The `description` property should be present. To fix: Ensure `description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"document-require-name":{"title":"Document Require Name","reference":"https://spotlight-rules.com/spec/rules/plans/document-require-name/","source":"default","description":"The `name` property should be present.","message":"name should be present","severity":"info","given":"$","then":{"field":"name","function":"truthy"},"tags":["format:plans","spec:document","experience:data-modeling","experience:governance"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'document-require-name' (Document Require Name). Requirement: The `name` property should be present. To fix: Ensure `name` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"document-require-plan":{"title":"Document Require Plan","reference":"https://spotlight-rules.com/spec/rules/plans/document-require-plan/","source":"default","description":"The `plans` property should be present.","message":"plans should be present","severity":"info","given":"$","then":{"field":"plans","function":"truthy"},"tags":["format:plans","spec:document","experience:data-modeling","experience:governance"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'document-require-plan' (Document Require Plan). Requirement: The `plans` property should be present. To fix: Ensure `plans` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-currency-iso4217":{"title":"Plan Currency Iso4217","reference":"https://spotlight-rules.com/spec/rules/plans/plan-currency-iso4217/","source":"spotlight","description":"currency should be a 3-letter ISO 4217 code (e.g. USD).","message":"currency should be an ISO 4217 code.","given":"$.currency","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^[A-Z]{3}$"}},"tags":["format:plans","spec:document","experience:consistency","experience:data-modeling"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-currency-iso4217' (Plan Currency Iso4217). Requirement: currency should be a 3-letter ISO 4217 code (e.g. USD). To fix: Ensure the targeted value matches the regular expression `^[A-Z]{3}$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.currency` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-features-non-empty":{"title":"Plan Features Non Empty","reference":"https://spotlight-rules.com/spec/rules/plans/plan-features-non-empty/","source":"spotlight","description":"If a plan lists features, the list should not be empty.","message":"Plan features should not be empty.","given":"$.plans[*].features","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"array","minItems":1}}},"tags":["format:plans","spec:plans","experience:documentation"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-features-non-empty' (Plan Features Non Empty). Requirement: If a plan lists features, the list should not be empty. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.plans[*].features` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-price-non-negative":{"title":"Plan Price Non Negative","reference":"https://spotlight-rules.com/spec/rules/plans/plan-price-non-negative/","source":"spotlight","description":"A plan price should be a non-negative number.","message":"Plan price should be a non-negative number.","given":"$.plans[*].price","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":["number","integer"],"minimum":0}}},"tags":["format:plans","spec:plans","experience:data-modeling"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-price-non-negative' (Plan Price Non Negative). Requirement: A plan price should be a non-negative number. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.plans[*].price` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-require-description":{"title":"Plan Require Description","reference":"https://spotlight-rules.com/spec/rules/plans/plan-require-description/","source":"default","description":"The `description` property of each plan should be present.","message":"description should be present","severity":"info","given":"$.plans[*]","then":{"field":"description","function":"truthy"},"tags":["format:plans","spec:plans","experience:documentation","experience:usability"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-require-description' (Plan Require Description). Requirement: The `description` property of each plan should be present. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.plans[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-require-features":{"title":"Plan Require Features","reference":"https://spotlight-rules.com/spec/rules/plans/plan-require-features/","source":"default","description":"The `features` property of each plan should be present.","message":"features should be present","severity":"info","given":"$.plans[*]","then":{"field":"features","function":"truthy"},"tags":["format:plans","spec:plans","experience:usability","experience:documentation"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-require-features' (Plan Require Features). Requirement: The `features` property of each plan should be present. To fix: Ensure `features` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.plans[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-require-interval":{"title":"Plan Require Interval","reference":"https://spotlight-rules.com/spec/rules/plans/plan-require-interval/","source":"spotlight","description":"Each plan should declare a billing interval (e.g. month, year).","message":"Plan should declare a billing interval.","given":"$.plans[*]","severity":"info","then":{"field":"interval","function":"truthy"},"tags":["format:plans","spec:plans","experience:consistency","experience:usability"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-require-interval' (Plan Require Interval). Requirement: Each plan should declare a billing interval (e.g. month, year). To fix: Ensure `interval` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.plans[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-require-limit":{"title":"Plan Require Limit","reference":"https://spotlight-rules.com/spec/rules/plans/plan-require-limit/","source":"default","description":"The `limits` property of each plan should be present.","message":"limits should be present","severity":"info","given":"$.plans[*]","then":{"field":"limits","function":"truthy"},"tags":["format:plans","spec:plans","experience:governance","experience:reliability"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-require-limit' (Plan Require Limit). Requirement: The `limits` property of each plan should be present. To fix: Ensure `limits` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.plans[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-require-name":{"title":"Plan Require Name","reference":"https://spotlight-rules.com/spec/rules/plans/plan-require-name/","source":"default","description":"The `name` property of each plan should be present.","message":"name should be present","severity":"info","given":"$.plans[*]","then":{"field":"name","function":"truthy"},"tags":["format:plans","spec:plans","experience:data-modeling","experience:governance"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-require-name' (Plan Require Name). Requirement: The `name` property of each plan should be present. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.plans[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-require-price":{"title":"Plan Require Price","reference":"https://spotlight-rules.com/spec/rules/plans/plan-require-price/","source":"default","description":"The `price` property of each plan should be present.","message":"price should be present","severity":"info","given":"$.plans[*]","then":{"field":"price","function":"truthy"},"tags":["format:plans","spec:plans","experience:governance","experience:usability"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-require-price' (Plan Require Price). Requirement: The `price` property of each plan should be present. To fix: Ensure `price` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.plans[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."}},"rate-limits":{"document-require-description":{"title":"Document Require Description","reference":"https://spotlight-rules.com/spec/rules/rate-limits/document-require-description/","source":"default","description":"The `description` property should be present.","message":"description should be present","severity":"info","given":"$","then":{"field":"description","function":"truthy"},"tags":["format:rate-limits","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'document-require-description' (Document Require Description). Requirement: The `description` property should be present. To fix: Ensure `description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"document-require-limit":{"title":"Document Require Limit","reference":"https://spotlight-rules.com/spec/rules/rate-limits/document-require-limit/","source":"default","description":"The `limits` property should be present.","message":"limits should be present","severity":"info","given":"$","then":{"field":"limits","function":"truthy"},"tags":["format:rate-limits","spec:document","experience:reliability","experience:data-modeling"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'document-require-limit' (Document Require Limit). Requirement: The `limits` property should be present. To fix: Ensure `limits` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"document-require-name":{"title":"Document Require Name","reference":"https://spotlight-rules.com/spec/rules/rate-limits/document-require-name/","source":"default","description":"The `name` property should be present.","message":"name should be present","severity":"info","given":"$","then":{"field":"name","function":"truthy"},"tags":["format:rate-limits","spec:document","experience:data-modeling","experience:governance"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'document-require-name' (Document Require Name). Requirement: The `name` property should be present. To fix: Ensure `name` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-max-positive":{"title":"Limit Max Positive","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-max-positive/","source":"spotlight","description":"A limit max should be a positive integer.","message":"Limit max should be a positive integer.","given":"$.limits[*].max","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"integer","minimum":1}}},"tags":["format:rate-limits","spec:limits","experience:data-modeling","experience:reliability"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-max-positive' (Limit Max Positive). Requirement: A limit max should be a positive integer. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.limits[*].max` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-require-max":{"title":"Limit Require Max","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-require-max/","source":"default","description":"The `max` property of each limit should be present.","message":"max should be present","severity":"info","given":"$.limits[*]","then":{"field":"max","function":"truthy"},"tags":["format:rate-limits","spec:limits","experience:reliability","experience:governance"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-require-max' (Limit Require Max). Requirement: The `max` property of each limit should be present. To fix: Ensure `max` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.limits[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-require-name":{"title":"Limit Require Name","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-require-name/","source":"default","description":"The `name` property of each limit should be present.","message":"name should be present","severity":"info","given":"$.limits[*]","then":{"field":"name","function":"truthy"},"tags":["format:rate-limits","spec:limits","experience:data-modeling","experience:reliability"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-require-name' (Limit Require Name). Requirement: The `name` property of each limit should be present. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.limits[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-require-scope":{"title":"Limit Require Scope","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-require-scope/","source":"default","description":"The `scope` property of each limit should be present.","message":"scope should be present","severity":"info","given":"$.limits[*]","then":{"field":"scope","function":"truthy"},"tags":["format:rate-limits","spec:limits","experience:reliability","experience:governance"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-require-scope' (Limit Require Scope). Requirement: The `scope` property of each limit should be present. To fix: Ensure `scope` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.limits[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-require-window":{"title":"Limit Require Window","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-require-window/","source":"default","description":"The `window` property of each limit should be present.","message":"window should be present","severity":"info","given":"$.limits[*]","then":{"field":"window","function":"truthy"},"tags":["format:rate-limits","spec:limits","experience:reliability","experience:governance"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-require-window' (Limit Require Window). Requirement: The `window` property of each limit should be present. To fix: Ensure `window` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.limits[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-scope-known":{"title":"Limit Scope Known","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-scope-known/","source":"spotlight","description":"A limit scope should be one of ip, user, api-key, client, or global.","message":"Limit scope should be a known value.","given":"$.limits[*].scope","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"string","enum":["ip","user","api-key","client","global"]}}},"tags":["format:rate-limits","spec:limits","experience:consistency"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-scope-known' (Limit Scope Known). Requirement: A limit scope should be one of ip, user, api-key, client, or global. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.limits[*].scope` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-window-format":{"title":"Limit Window Format","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-window-format/","source":"spotlight","description":"A limit window should be a duration like 60s, 1m, 1h, or 1d.","message":"Limit window should be a duration (e.g. 60s, 1h).","given":"$.limits[*].window","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^\\d+(ms|s|m|h|d)$"}},"tags":["format:rate-limits","spec:limits","experience:consistency","experience:reliability"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-window-format' (Limit Window Format). Requirement: A limit window should be a duration like 60s, 1m, 1h, or 1d. To fix: Ensure the targeted value matches the regular expression `^\\d+(ms|s|m|h|d)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.limits[*].window` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."}},"finops":{"cost-finops-monthly-non-negative":{"title":"Cost FinOps Monthly Non Negative","reference":"https://spotlight-rules.com/spec/rules/finops/cost-finops-monthly-non-negative/","source":"spotlight","description":"A cost monthly amount should be a non-negative number.","message":"Cost monthly should be a non-negative number.","given":"$.costs[*].monthly","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":["number","integer"],"minimum":0}}},"tags":["format:finops","spec:costs","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'cost-finops-monthly-non-negative' (Cost FinOps Monthly Non Negative). Requirement: A cost monthly amount should be a non-negative number. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.costs[*].monthly` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"cost-finops-require-monthly":{"title":"Cost FinOps Require Monthly","reference":"https://spotlight-rules.com/spec/rules/finops/cost-finops-require-monthly/","source":"default","description":"The `monthly` property of each cost should be present.","message":"monthly should be present","severity":"info","given":"$.costs[*]","then":{"field":"monthly","function":"truthy"},"tags":["format:finops","spec:costs","experience:governance","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'cost-finops-require-monthly' (Cost FinOps Require Monthly). Requirement: The `monthly` property of each cost should be present. To fix: Ensure `monthly` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.costs[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"cost-finops-require-service":{"title":"Cost FinOps Require Service","reference":"https://spotlight-rules.com/spec/rules/finops/cost-finops-require-service/","source":"default","description":"The `service` property of each cost should be present.","message":"service should be present","severity":"info","given":"$.costs[*]","then":{"field":"service","function":"truthy"},"tags":["format:finops","spec:costs","experience:governance","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'cost-finops-require-service' (Cost FinOps Require Service). Requirement: The `service` property of each cost should be present. To fix: Ensure `service` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.costs[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-budget-non-negative":{"title":"Document FinOps Budget Non Negative","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-budget-non-negative/","source":"spotlight","description":"budget should be a non-negative number.","message":"budget should be a non-negative number.","given":"$.budget","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":["number","integer"],"minimum":0}}},"tags":["format:finops","spec:document","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-budget-non-negative' (Document FinOps Budget Non Negative). Requirement: budget should be a non-negative number. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.budget` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-currency-iso4217":{"title":"Document FinOps Currency Iso4217","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-currency-iso4217/","source":"spotlight","description":"currency should be a 3-letter ISO 4217 code (e.g. USD).","message":"currency should be an ISO 4217 code.","given":"$.currency","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^[A-Z]{3}$"}},"tags":["format:finops","spec:document","experience:consistency","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-currency-iso4217' (Document FinOps Currency Iso4217). Requirement: currency should be a 3-letter ISO 4217 code (e.g. USD). To fix: Ensure the targeted value matches the regular expression `^[A-Z]{3}$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.currency` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-require-budget":{"title":"Document FinOps Require Budget","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-require-budget/","source":"default","description":"The `budget` property should be present.","message":"budget should be present","severity":"info","given":"$","then":{"field":"budget","function":"truthy"},"tags":["format:finops","spec:document","experience:governance","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-require-budget' (Document FinOps Require Budget). Requirement: The `budget` property should be present. To fix: Ensure `budget` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-require-cost":{"title":"Document FinOps Require Cost","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-require-cost/","source":"default","description":"The `costs` property should be present.","message":"costs should be present","severity":"info","given":"$","then":{"field":"costs","function":"truthy"},"tags":["format:finops","spec:document","experience:governance","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-require-cost' (Document FinOps Require Cost). Requirement: The `costs` property should be present. To fix: Ensure `costs` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-require-currency":{"title":"Document FinOps Require Currency","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-require-currency/","source":"default","description":"The `currency` property should be present.","message":"currency should be present","severity":"info","given":"$","then":{"field":"currency","function":"truthy"},"tags":["format:finops","spec:document","experience:governance","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-require-currency' (Document FinOps Require Currency). Requirement: The `currency` property should be present. To fix: Ensure `currency` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-require-description":{"title":"Document FinOps Require Description","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-require-description/","source":"default","description":"The `description` property should be present.","message":"description should be present","severity":"info","given":"$","then":{"field":"description","function":"truthy"},"tags":["format:finops","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-require-description' (Document FinOps Require Description). Requirement: The `description` property should be present. To fix: Ensure `description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-require-name":{"title":"Document FinOps Require Name","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-require-name/","source":"default","description":"The `name` property should be present.","message":"name should be present","severity":"info","given":"$","then":{"field":"name","function":"truthy"},"tags":["format:finops","spec:document","experience:data-modeling","experience:governance"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-require-name' (Document FinOps Require Name). Requirement: The `name` property should be present. To fix: Ensure `name` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-require-period":{"title":"Document FinOps Require Period","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-require-period/","source":"spotlight","description":"A FinOps artifact should declare a period (e.g. monthly, annual) for the budget and costs.","message":"FinOps should declare a period.","given":"$","severity":"info","then":{"field":"period","function":"truthy"},"tags":["format:finops","spec:document","experience:consistency","experience:governance"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-require-period' (Document FinOps Require Period). Requirement: A FinOps artifact should declare a period (e.g. monthly, annual) for the budget and costs. To fix: Ensure `period` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."}},"agent-skill":{"skill-require-allowed-tools":{"title":"Skill Require Allowed Tools","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-require-allowed-tools/","source":"spotlight","description":"agent-skill document should declare a `allowed-tools` property.","message":"Missing `allowed-tools`.","given":"$.frontmatter","severity":"info","then":{"field":"allowed-tools","function":"truthy"},"tags":["format:agent-skill","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-require-allowed-tools' (Require Allowed Tools). Requirement: agent-skill document should declare a `allowed-tools` property. To fix: Ensure `allowed-tools` is present and non-empty at each matching location. Guidance: Missing `allowed-tools`. This rule is evaluated at the JSONPath `$.frontmatter` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-require-metadata":{"title":"Skill Require Metadata","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-require-metadata/","source":"spotlight","description":"agent-skill document should declare a `metadata` property.","message":"Missing `metadata`.","given":"$.frontmatter","severity":"info","then":{"field":"metadata","function":"truthy"},"tags":["format:agent-skill","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-require-metadata' (Require Metadata). Requirement: agent-skill document should declare a `metadata` property. To fix: Ensure `metadata` is present and non-empty at each matching location. Guidance: Missing `metadata`. This rule is evaluated at the JSONPath `$.frontmatter` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-require-version":{"title":"Skill Require Version","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-require-version/","source":"spotlight","description":"agent-skill document should declare a `version` property.","message":"Missing `version`.","given":"$.frontmatter","severity":"info","then":{"field":"version","function":"truthy"},"tags":["format:agent-skill","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-require-version' (Require Version). Requirement: agent-skill document should declare a `version` property. To fix: Ensure `version` is present and non-empty at each matching location. Guidance: Missing `version`. This rule is evaluated at the JSONPath `$.frontmatter` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-allowed-tools-array":{"title":"Skill Allowed Tools Array","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-allowed-tools-array/","source":"default","description":"If a skill declares allowed-tools, it must be an array of tool names so its capability surface is explicit and auditable.","message":"allowed-tools must be an array of tool names.","severity":"info","given":"$.frontmatter['allowed-tools']","then":{"function":"schema","functionOptions":{"schema":{"type":"array","items":{"type":"string"}}}},"tags":["format:agent-skill","spec:frontmatter","experience:security","experience:governance"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-allowed-tools-array' (Skill Allowed Tools Array). Requirement: If a skill declares allowed-tools, it must be an array of tool names so its capability surface is explicit and auditable. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.frontmatter['allowed-tools']` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-body-length":{"title":"Skill Body Length","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-body-length/","source":"default","description":"Skill bodies should stay focused — very long instructions degrade agent performance. Keep the body under ~5000 words.","message":"Skill body is very long (over ~5000 words).","severity":"info","given":"$.words","then":{"function":"schema","functionOptions":{"schema":{"type":"integer","maximum":5000}}},"tags":["format:agent-skill","spec:body","experience:usability","experience:reliability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-body-length' (Skill Body Length). Requirement: Skill bodies should stay focused — very long instructions degrade agent performance. Keep the body under ~5000 words. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.words` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-body-present":{"title":"Skill Body Present","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-body-present/","source":"default","description":"A skill must have body content, not just frontmatter — the body is the instruction set the agent actually follows.","message":"A skill must have body content.","severity":"info","given":"$.words","then":{"function":"schema","functionOptions":{"schema":{"type":"integer","minimum":1}}},"tags":["format:agent-skill","spec:body","experience:documentation","experience:reliability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-body-present' (Skill Body Present). Requirement: A skill must have body content, not just frontmatter — the body is the instruction set the agent actually follows. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.words` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-description":{"title":"Skill Description","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-description/","source":"default","description":"A skill must declare a description — it is the primary signal an agent uses to decide when to invoke the skill.","message":"A skill must declare a description.","severity":"info","given":"$.frontmatter","then":{"field":"description","function":"truthy"},"tags":["format:agent-skill","spec:frontmatter","experience:discoverability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-description' (Skill Description). Requirement: A skill must declare a description — it is the primary signal an agent uses to decide when to invoke the skill. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.frontmatter` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-description-length":{"title":"Skill Description Length","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-description-length/","source":"default","description":"Skill descriptions should be specific enough to drive good selection — at least 40 characters of meaningful intent.","message":"Skill description should be at least 40 characters.","severity":"info","given":"$.frontmatter.description","then":{"function":"length","functionOptions":{"min":40,"max":1024}},"tags":["format:agent-skill","spec:frontmatter","experience:discoverability","experience:usability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-description-length' (Skill Description Length). Requirement: Skill descriptions should be specific enough to drive good selection — at least 40 characters of meaningful intent. To fix: Ensure the length of the targeted value is at least 40 and at most 1024. This rule is evaluated at the JSONPath `$.frontmatter.description` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-description-single-line":{"title":"Skill Description Single Line","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-description-single-line/","source":"spotlight","description":"A skill description should be a single line (no embedded line breaks) so it renders cleanly in pickers.","message":"Skill description should be a single line.","given":"$.frontmatter.description","severity":"info","then":{"function":"pattern","functionOptions":{"notMatch":"\\n"}},"tags":["format:agent-skill","spec:frontmatter","experience:consistency","experience:usability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-description-single-line' (Skill Description Single Line). Requirement: A skill description should be a single line (no embedded line breaks) so it renders cleanly in pickers. To fix: Ensure the targeted value does NOT match the regular expression `\\n`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.frontmatter.description` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-has-examples-section":{"title":"Skill Has Examples Section","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-has-examples-section/","source":"default","description":"A skill body should show concrete examples under an Examples section so agents and humans can see how it is meant to be invoked.","message":"Skill body should have an \"Examples\" section.","severity":"info","given":"$","then":{"function":"headingPresent","functionOptions":{"name":"Examples"}},"tags":["format:agent-skill","spec:body","experience:documentation"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-has-examples-section' (Skill Has Examples Section). Requirement: A skill body should show concrete examples under an Examples section so agents and humans can see how it is meant to be invoked. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-has-usage-section":{"title":"Skill Has Usage Section","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-has-usage-section/","source":"default","description":"A skill body should document how to use it under a Usage section, so both humans and agents can see how it is meant to be invoked.","message":"Skill body should have a \"Usage\" section.","severity":"info","given":"$","then":{"function":"headingPresent","functionOptions":{"name":"Usage"}},"tags":["format:agent-skill","spec:body","experience:documentation"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-has-usage-section' (Skill Has Usage Section). Requirement: A skill body should document how to use it under a Usage section, so both humans and agents can see how it is meant to be invoked. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-license":{"title":"Skill License","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-license/","source":"default","description":"A skill should declare a license so consumers know the terms under which they can reuse and redistribute it.","message":"A skill should declare a license.","severity":"info","given":"$.frontmatter","then":{"field":"license","function":"truthy"},"tags":["format:agent-skill","spec:frontmatter","experience:governance"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-license' (Skill License). Requirement: A skill should declare a license so consumers know the terms under which they can reuse and redistribute it. To fix: Ensure `license` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.frontmatter` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-metadata-object":{"title":"Skill Metadata Object","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-metadata-object/","source":"spotlight","description":"If a skill declares metadata, it should be an object of key/value pairs.","message":"Skill metadata should be an object.","given":"$.frontmatter.metadata","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"object"}}},"tags":["format:agent-skill","spec:frontmatter","experience:data-modeling"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-metadata-object' (Skill Metadata Object). Requirement: If a skill declares metadata, it should be an object of key/value pairs. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.frontmatter.metadata` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-name":{"title":"Skill Name","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-name/","source":"default","description":"A skill must declare a name in its frontmatter — it identifies the skill to agents and tooling.","message":"A skill must declare a name.","severity":"info","given":"$.frontmatter","then":{"field":"name","function":"truthy"},"tags":["format:agent-skill","spec:frontmatter","experience:governance","experience:discoverability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-name' (Skill Name). Requirement: A skill must declare a name in its frontmatter — it identifies the skill to agents and tooling. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.frontmatter` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-name-kebab-case":{"title":"Skill Name Kebab Case","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-name-kebab-case/","source":"default","description":"Skill name should be lower kebab-case so it matches the skill directory name and stays portable.","message":"Skill name should be lower kebab-case.","severity":"info","given":"$.frontmatter.name","then":{"function":"pattern","functionOptions":{"match":"^[a-z0-9]+(?:-[a-z0-9]+)*$"}},"tags":["format:agent-skill","spec:frontmatter","experience:naming"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-name-kebab-case' (Skill Name Kebab Case). Requirement: Skill name should be lower kebab-case so it matches the skill directory name and stays portable. To fix: Ensure the targeted value matches the regular expression `^[a-z0-9]+(?:-[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.frontmatter.name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-name-max-length":{"title":"Skill Name Max Length","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-name-max-length/","source":"spotlight","description":"A skill name should be concise (64 characters or fewer).","message":"Skill name should be 64 characters or fewer.","given":"$.frontmatter.name","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"string","maxLength":64}}},"tags":["format:agent-skill","spec:frontmatter","experience:naming","experience:usability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-name-max-length' (Skill Name Max Length). Requirement: A skill name should be concise (64 characters or fewer). To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.frontmatter.name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-single-title":{"title":"Skill Single Title","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-single-title/","source":"default","description":"A skill body should have at most one level-1 heading — the frontmatter name is the title, and sections should use level-2 headings.","message":"Skill body should have at most one level-1 heading.","severity":"info","given":"$","then":{"function":"headingCount","functionOptions":{"depth":1,"max":1}},"tags":["format:agent-skill","spec:body","experience:consistency"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-single-title' (Skill Single Title). Requirement: A skill body should have at most one level-1 heading — the frontmatter name is the title, and sections should use level-2 headings. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-version-semver":{"title":"Skill Version Semver","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-version-semver/","source":"default","description":"If a skill declares a version, it should be semantic (e.g. 1.0.0) so consumers can reason about changes between releases.","message":"Skill version should be semantic (e.g. 1.0.0).","severity":"info","given":"$.frontmatter.version","then":{"function":"pattern","functionOptions":{"match":"^\\d+\\.\\d+\\.\\d+(?:[-+][0-9A-Za-z.-]+)?$"}},"tags":["format:agent-skill","spec:frontmatter","experience:versioning"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-version-semver' (Skill Version Semver). Requirement: If a skill declares a version, it should be semantic (e.g. 1.0.0) so consumers can reason about changes between releases. To fix: Ensure the targeted value matches the regular expression `^\\d+\\.\\d+\\.\\d+(?:[-+][0-9A-Za-z.-]+)?$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.frontmatter.version` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."}}}
\ No newline at end of file
+{"openapi":{"array-items":{"title":"Array Items","reference":"https://spotlight-rules.com/spec/rules/openapi/array-items/","description":"Array Items.","source":"builtin","message":"Schemas with \"type: array\", require a sibling \"items\" field","severity":"info","given":"#ArrayProperties","then":{"function":"truthy","field":"items"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'array-items' (Array Items). Requirement: Array Items. To fix: Ensure `items` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `#ArrayProperties` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"channel-parameter-require-examples":{"title":"Channel Parameter Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/channel-parameter-require-examples/","source":"compiled","description":"Parameter must have examples.","message":"Parameter must have examples","severity":"info","given":"$.channels.*.parameters.*.schema","then":{"field":"examples","function":"truthy"},"formats":["aas2"],"tags":["format:openapi","spec:channels","spec:parameters","spec:schemas","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'channel-parameter-require-examples' (Channel Parameter Require Examples). Requirement: Parameter must have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.channels.*.parameters.*.schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"component-example-keys-snake-case":{"title":"Component Example Keys Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/component-example-keys-snake-case/","source":"compiled","description":"example key must be snake cased (e.g. snake_case).","message":"{{error}}","severity":"info","given":"$.components['examples'].*~","then":{"function":"digitalocean:ensureSnakeCaseWithDigits"},"tags":["format:openapi","spec:components","spec:examples","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'component-example-keys-snake-case' (Component Example Keys Snake Case). Requirement: example key must be snake cased (e.g. snake_case). This rule is evaluated at the JSONPath `$.components['examples'].*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"component-message-require-examples":{"title":"Component Message Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/component-message-require-examples/","source":"compiled","description":"Message must have examples.","message":"Message must have examples","severity":"info","given":"$.components.messages.*","then":{"field":"examples","function":"truthy"},"formats":["aas3"],"tags":["format:openapi","spec:messages","spec:components","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'component-message-require-examples' (Component Message Require Examples). Requirement: Message must have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"component-require-security-schemes":{"title":"Component Require Security Schemes","reference":"https://spotlight-rules.com/spec/rules/openapi/component-require-security-schemes/","source":"compiled","description":"The API contract MUST include a 'securitySchemes' subsection under the 'components' section.","message":"{{description}}: {{error}}","severity":"info","given":"$.components","then":{"field":"securitySchemes","function":"truthy"},"formats":["oas3"],"tags":["owasp:api2","format:openapi","spec:components","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'component-require-security-schemes' (Component Require Security Schemes). Requirement: The API contract MUST include a 'securitySchemes' subsection under the 'components' section. To fix: Ensure `securitySchemes` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"contact-properties":{"title":"Contact Properties","reference":"https://spotlight-rules.com/spec/rules/openapi/contact-properties/","source":"builtin","description":"Contact object must have \"name\", \"url\" and \"email\".","message":"Contact object must have \"name\", \"url\" and \"email\".","severity":"info","given":"$.info.contact","then":[{"field":"name","function":"truthy"},{"field":"url","function":"truthy"},{"field":"email","function":"truthy"}],"tags":["format:openapi","spec:info","experience:documentation","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'contact-properties' (Contact Properties). Requirement: Contact object must have \"name\", \"url\" and \"email\". To fix: Ensure `name` is present and non-empty at each matching location. Also: Ensure `url` is present and non-empty at each matching location. Also: Ensure `email` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.contact` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-cache-control-parameter":{"title":"Document Cache Control Parameter","reference":"https://spotlight-rules.com/spec/rules/openapi/document-cache-control-parameter/","source":"compiled","description":"Cache usage SHOULD be extensively detailed in the `description` property to avoid data leaks or the usage of stale data. This rule should ensure in some way that the api provider documented extensively the cache usage to avoid data leaks or usage of stale data. For now this ruleset tests: * the presence of following keywords in the `description`: `max-age`, `private`, `no-store`, `no-cache`. * that one and only one between Expires and Cache-Control is used. `Cache-Control` and `Expires` should not be used in conjuction, because `Cache-Control` overrides `Expires` when `max-age` is set. Instead if neither `Cache-Control` or `Expires` are set, clients MAY use euristic cache like described in RFC7234.","message":"Cache usage SHOULD be documented when used.","severity":"info","given":"$..[parameters][?(@.in == \"header\" && @.name.match(/Cache-Control/i))]","then":[{"field":"description","function":"truthy"},{"field":"description","function":"pattern","functionOptions":{"match":".*(max-age|private|no-store|no-cache).*"}}],"formats":["oas3"],"tags":["format:openapi","spec:parameters","spec:headers","topic:caching","experience:documentation","experience:reliability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-cache-control-parameter' (Document Cache Control Parameter). Requirement: Cache usage SHOULD be extensively detailed in the `description` property to avoid data leaks or the usage of stale data. This rule should ensure in some way that the api provider documented extensively the cache usage to avoid data leaks or usage of stale data. For now this ruleset tests: * the presence of following keywords in the `description`: `max-age`, `private`, `no-store`, `no-cache`. * that one and only one between Expires and Cache-Control is used. `Cache-Control` and `Expires` should not be used in conjuction, because `Cache-Control` overrides `Expires` when `max-age` is set. Instead if neither `Cache-Control` or `Expires` are set, clients MAY use euristic cache like described in RFC7234. To fix: Ensure `description` is present and non-empty at each matching location. Also: Ensure `description` matches the regular expression `.*(max-age|private|no-store|no-cache).*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[parameters][?(@.in == \"header\" && @.name.match(/Cache-Control/i))]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-cache-response-header":{"title":"Document Cache Response Header","reference":"https://spotlight-rules.com/spec/rules/openapi/document-cache-response-header/","source":"compiled","description":"Cache usage SHOULD be extensively detailed in the `description` property to avoid data leaks or the usage of stale data. This rule should ensure in some way that the api provider documented extensively the cache usage to avoid data leaks or usage of stale data. For now this ruleset tests: * the presence of following keywords in the `description`: `max-age`, `private`, `no-store`, `no-cache`. * that one and only one between Expires and Cache-Control is used. `Cache-Control` and `Expires` should not be used in conjuction, because `Cache-Control` overrides `Expires` when `max-age` is set. Instead if neither `Cache-Control` or `Expires` are set, clients MAY use euristic cache like described in RFC7234.","message":"Cache usage in responses SHOULD be documented in Cache-Control and/or Expires. {{error}}","severity":"info","given":"$.[responses][?(@property[0] == \"2\" )][headers].[?(@property.match(/Cache-Control|Expires/i))]]","then":[{"field":"description","function":"truthy"},{"field":"description","function":"pattern","functionOptions":{"match":".*(max-age|private|no-store|no-cache).*"}}],"formats":["oas3"],"tags":["format:openapi","spec:responses","spec:headers","topic:caching","experience:documentation","experience:reliability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-cache-response-header' (Document Cache Response Header). Requirement: Cache usage SHOULD be extensively detailed in the `description` property to avoid data leaks or the usage of stale data. This rule should ensure in some way that the api provider documented extensively the cache usage to avoid data leaks or usage of stale data. For now this ruleset tests: * the presence of following keywords in the `description`: `max-age`, `private`, `no-store`, `no-cache`. * that one and only one between Expires and Cache-Control is used. `Cache-Control` and `Expires` should not be used in conjuction, because `Cache-Control` overrides `Expires` when `max-age` is set. Instead if neither `Cache-Control` or `Expires` are set, clients MAY use euristic cache like described in RFC7234. To fix: Ensure `description` is present and non-empty at each matching location. Also: Ensure `description` matches the regular expression `.*(max-age|private|no-store|no-cache).*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.[responses][?(@property[0] == \"2\" )][headers].[?(@property.match(/Cache-Control|Expires/i))]]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-owasp-api9-server":{"title":"Document OWASP API9 Server","reference":"https://spotlight-rules.com/spec/rules/openapi/document-owasp-api9-server/","source":"spotlight","description":"The API should declare its servers so all hosts and environments are inventoried — undocumented or stray non-production hosts are a common inventory-management risk (OWASP API9).","message":"API should declare its servers (host/environment inventory).","given":"$","severity":"info","then":{"field":"servers","function":"truthy"},"tags":["format:openapi","spec:servers","experience:security","experience:governance","owasp:api9"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-owasp-api9-server' (Document OWASP API9 Server). Requirement: The API should declare its servers so all hosts and environments are inventoried — undocumented or stray non-production hosts are a common inventory-management risk (OWASP API9). To fix: Ensure `servers` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-component-section":{"title":"Document Require Component Section","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-component-section/","source":"compiled","description":"The API contract MUST include a 'components' section.","message":"{{description}}: {{error}}","severity":"info","given":"$","then":{"field":"components","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:document","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-component-section' (Document Require Component Section). Requirement: The API contract MUST include a 'components' section. To fix: Ensure `components` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-external-docs":{"title":"Document Require External Docs","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-external-docs/","source":"compiled","description":"Defining external documentation provides a link to detailed API guides, tutorials, and reference material beyond the OpenAPI spec. Analysis shows 57.1% of APIs include external docs.","message":"External Docs MUST Be Defined","severity":"info","given":"$","then":{"field":"externalDocs","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-external-docs' (Document Require External Docs). Requirement: Defining external documentation provides a link to detailed API guides, tutorials, and reference material beyond the OpenAPI spec. Analysis shows 57.1% of APIs include external docs. To fix: Ensure `externalDocs` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-jsonschemadialect":{"title":"Document Require Jsonschemadialect","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-jsonschemadialect/","source":"spotlight","description":"openapi document should declare a `jsonSchemaDialect` property.","message":"Missing `jsonSchemaDialect`.","given":"$","severity":"info","then":{"field":"jsonSchemaDialect","function":"truthy"},"tags":["format:openapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-jsonschemadialect' (Document Require Jsonschemadialect). Requirement: openapi document should declare a `jsonSchemaDialect` property. To fix: Ensure `jsonSchemaDialect` is present and non-empty at each matching location. Guidance: Missing `jsonSchemaDialect`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-openapi":{"title":"Document Require Openapi","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-openapi/","source":"spotlight","description":"openapi document should declare a `openapi` property.","message":"Missing `openapi`.","given":"$","severity":"info","then":{"field":"openapi","function":"truthy"},"tags":["format:openapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-openapi' (Document Require Openapi). Requirement: openapi document should declare a `openapi` property. To fix: Ensure `openapi` is present and non-empty at each matching location. Guidance: Missing `openapi`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-path":{"title":"Document Require Path","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-path/","source":"spotlight","description":"openapi document should declare a `paths` property.","message":"Missing `paths`.","given":"$","severity":"info","then":{"field":"paths","function":"truthy"},"tags":["format:openapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-path' (Document Require Path). Requirement: openapi document should declare a `paths` property. To fix: Ensure `paths` is present and non-empty at each matching location. Guidance: Missing `paths`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-realistic-examples":{"title":"Document Require Realistic Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-realistic-examples/","source":"compiled","description":"API design SHOULD include real-like examples for request and response definitions.","message":"The {{property}} SHOULD include a real-like example. Add realistic examples to improve API usability.","severity":"info","given":"$..[?(@.example || @.examples)]","then":{"field":"example","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:examples","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-realistic-examples' (Document Require Realistic Examples). Requirement: API design SHOULD include real-like examples for request and response definitions. To fix: Ensure `example` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..[?(@.example || @.examples)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-server-defined":{"title":"Document Require Server Defined","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-server-defined/","source":"compiled","description":"Every OpenAPI should define at least one server URL. Analysis shows 97.2% of APIs define servers, providing consumers with the base URL needed to make requests.","message":"Servers MUST Be Defined","severity":"info","given":"$","then":{"field":"servers","function":"truthy"},"tags":["format:openapi","spec:document","experience:usability","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-server-defined' (Document Require Server Defined). Requirement: Every OpenAPI should define at least one server URL. Analysis shows 97.2% of APIs define servers, providing consumers with the base URL needed to make requests. To fix: Ensure `servers` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-require-webhooks":{"title":"Document Require Webhooks","reference":"https://spotlight-rules.com/spec/rules/openapi/document-require-webhooks/","source":"spotlight","description":"openapi document should declare a `webhooks` property.","message":"Missing `webhooks`.","given":"$","severity":"info","then":{"field":"webhooks","function":"truthy"},"tags":["format:openapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-require-webhooks' (Document Require Webhooks). Requirement: openapi document should declare a `webhooks` property. To fix: Ensure `webhooks` is present and non-empty at each matching location. Guidance: Missing `webhooks`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"document-spec-must-not-be-empty":{"title":"Document Spec Must Not Be Empty","reference":"https://spotlight-rules.com/spec/rules/openapi/document-spec-must-not-be-empty/","source":"compiled","description":"Spec should not be empty.","message":"{{error}}","severity":"info","given":"$","then":{"function":"trimble:is-valid-spec"},"tags":["format:openapi","spec:document","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'document-spec-must-not-be-empty' (Document Spec Must Not Be Empty). Requirement: Spec should not be empty. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"duplicated-entry-in-enum":{"title":"Duplicated Entry In Enum","reference":"https://spotlight-rules.com/spec/rules/openapi/duplicated-entry-in-enum/","source":"builtin","description":"Enum values must not have duplicate entry.","message":"{{error}}","severity":"info","given":["$..[?(@property !== 'properties' && @.enum && @.enum.constructor.name === 'Array')]"],"then":{"field":"enum","function":"oasSchema","functionOptions":{"schema":{"type":"array","uniqueItems":true}}},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'duplicated-entry-in-enum' (Duplicated Entry In Enum). Requirement: Enum values must not have duplicate entry. This rule is evaluated at the JSONPath `$..[?(@property !== 'properties' && @.enum && @.enum.constructor.name === 'Array')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"header-names-hyphenated-pascal-case":{"title":"Header Names Hyphenated Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/header-names-hyphenated-pascal-case/","source":"compiled","description":"All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation.","message":"'HTTP' headers MUST follow 'Hyphenated-Pascal-Case' notation","severity":"info","given":"$..parameters[?(@.in == 'header')].name","then":{"function":"pattern","functionOptions":{"match":"/^([A-Z][a-z0-9]-)*([A-Z][a-z0-9])+/"}},"tags":["format:openapi","spec:parameters","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'header-names-hyphenated-pascal-case' (Header Names Hyphenated Pascal Case). Requirement: All `HTTP` headers MUST use `Hyphenated-Pascal-Case` notation. To fix: Ensure the targeted value matches the regular expression `/^([A-Z][a-z0-9]-)*([A-Z][a-z0-9])+/`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'header')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"header-no-x-prefix":{"title":"Header No X Prefix","reference":"https://spotlight-rules.com/spec/rules/openapi/header-no-x-prefix/","source":"compiled","description":"'HTTP' headers SHOULD NOT start with 'X-' RFC6648.","message":"HTTP header '{{value}}' SHOULD NOT start with 'X-' in {{path}}","severity":"info","given":["$..parameters[?(@.in == 'header')].name"],"then":{"function":"pattern","functionOptions":{"match":"/^([^x]|.[^-])|RateLimit-/i"}},"tags":["format:openapi","spec:parameters","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'header-no-x-prefix' (Header No X Prefix). Requirement: 'HTTP' headers SHOULD NOT start with 'X-' RFC6648. To fix: Ensure the targeted value matches the regular expression `/^([^x]|.[^-])|RateLimit-/i`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'header')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"header-require-examples":{"title":"Header Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/header-require-examples/","source":"compiled","description":"Headers must include examples.","message":"{{description}}; missing {{property}}","severity":"info","given":"$..headers.*","then":{"function":"digitalocean:ensurePropertiesExample"},"tags":["format:openapi","spec:headers","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'header-require-examples' (Header Require Examples). Requirement: Headers must include examples. This rule is evaluated at the JSONPath `$..headers.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-contact":{"title":"Info Contact","reference":"https://spotlight-rules.com/spec/rules/openapi/info-contact/","source":"builtin","description":"Info object must have \"contact\" object.","message":"Info object must have \"contact\" object.","severity":"info","given":"$","then":{"field":"info.contact","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-contact' (Info Contact). Requirement: Info object must have \"contact\" object. To fix: Ensure `info.contact` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-contact-require-email":{"title":"Info Contact Require Email","reference":"https://spotlight-rules.com/spec/rules/openapi/info-contact-require-email/","source":"compiled","description":"Having a contact email address associated with the technical contract ensures that anyone who comes across the API has someone to email and get more information.","message":"Info MUST Have Contact Email","severity":"info","given":"$.info.contact","then":{"field":"email","function":"truthy"},"tags":["format:openapi","spec:info","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-contact-require-email' (Info Contact Require Email). Requirement: Having a contact email address associated with the technical contract ensures that anyone who comes across the API has someone to email and get more information. To fix: Ensure `email` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.contact` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-contact-require-name":{"title":"Info Contact Require Name","reference":"https://spotlight-rules.com/spec/rules/openapi/info-contact-require-name/","source":"compiled","description":"Having a contact name associated with the technical contract ensures that anyone who comes across the API knows who to contact.","message":"Info MUST Have Contact Name","severity":"info","given":"$.info.contact","then":{"field":"name","function":"truthy"},"tags":["format:openapi","spec:info","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-contact-require-name' (Info Contact Require Name). Requirement: Having a contact name associated with the technical contract ensures that anyone who comes across the API knows who to contact. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.contact` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-contact-require-url":{"title":"Info Contact Require URL","reference":"https://spotlight-rules.com/spec/rules/openapi/info-contact-require-url/","source":"compiled","description":"Having a contact url associated with the technical contract ensures that anyone who comes across the API knows where to go to contact someone.","message":"Info MUST Have Contact URL","severity":"info","given":"$.info.contact","then":{"field":"url","function":"truthy"},"tags":["format:openapi","spec:info","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-contact-require-url' (Info Contact Require URL). Requirement: Having a contact url associated with the technical contract ensures that anyone who comes across the API knows where to go to contact someone. To fix: Ensure `url` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.contact` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-description":{"title":"Info Description","reference":"https://spotlight-rules.com/spec/rules/openapi/info-description/","source":"builtin","description":"Info \"description\" must be present and non-empty string.","message":"Info \"description\" must be present and non-empty string.","severity":"info","given":"$","then":{"field":"info.description","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-description' (Info Description). Requirement: Info \"description\" must be present and non-empty string. To fix: Ensure `info.description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-description-length-limit":{"title":"Info Description Length Limit","reference":"https://spotlight-rules.com/spec/rules/openapi/info-description-length-limit/","source":"compiled","description":"Having a restriction on the length of the API description expressed as the OpenAPI info description helps provide constraints for consumers when adding a description, and keeps portals, landing pages, documentation, and discovery results more consistent.","message":"Info description MUST be less than 500 characters.","severity":"info","given":"$.info","then":{"field":"description","function":"length","functionOptions":{"max":500}},"tags":["format:openapi","spec:info","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-description-length-limit' (Info Description Length Limit). Requirement: Having a restriction on the length of the API description expressed as the OpenAPI info description helps provide constraints for consumers when adding a description, and keeps portals, landing pages, documentation, and discovery results more consistent. To fix: Ensure the length of `description` is at most 500. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-description-no-eval-tag":{"title":"Info Description No Eval Tag","reference":"https://spotlight-rules.com/spec/rules/openapi/info-description-no-eval-tag/","source":"compiled","description":"Eval functions MUST not be included in the description of an API, keeping descriptions to just the text that is needed, and relying on the rest of the OpenAPI to describe what is possible.","message":"Info Description MUST NOT Have Eval Tag","severity":"info","given":"$.info","then":{"field":"description","function":"pattern","functionOptions":{"notMatch":"^\\b(<eval)\\b"}},"tags":["format:openapi","spec:info","experience:security","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-description-no-eval-tag' (Info Description No Eval Tag). Requirement: Eval functions MUST not be included in the description of an API, keeping descriptions to just the text that is needed, and relying on the rest of the OpenAPI to describe what is possible. To fix: Ensure `description` does NOT match the regular expression `^\\b(<eval)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-description-no-script-tag":{"title":"Info Description No Script Tag","reference":"https://spotlight-rules.com/spec/rules/openapi/info-description-no-script-tag/","source":"compiled","description":"Script tags MUST not be included in the description of an API, keeping descriptions to just the text that is needed, and relying on the rest of the OpenAPI to describe what is possible.","message":"Info Description MUST NOT Have Script Tag","severity":"info","given":"$.info","then":{"field":"description","function":"pattern","functionOptions":{"notMatch":"^\\b(<script)\\b"}},"tags":["format:openapi","spec:info","experience:security","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-description-no-script-tag' (Info Description No Script Tag). Requirement: Script tags MUST not be included in the description of an API, keeping descriptions to just the text that is needed, and relying on the rest of the OpenAPI to describe what is possible. To fix: Ensure `description` does NOT match the regular expression `^\\b(<script)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-license":{"title":"Info License","reference":"https://spotlight-rules.com/spec/rules/openapi/info-license/","source":"builtin","description":"Info object must have \"license\" object.","message":"Info object must have \"license\" object.","severity":"info","given":"$","then":{"field":"info.license","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-license' (Info License). Requirement: Info object must have \"license\" object. To fix: Ensure `info.license` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-license-require-name":{"title":"Info License Require Name","reference":"https://spotlight-rules.com/spec/rules/openapi/info-license-require-name/","source":"compiled","description":"The license object should include a name property identifying the license type, such as Apache 2.0, MIT, or a proprietary license.","message":"Info License MUST Have Name","severity":"info","given":"$.info.license","then":{"field":"name","function":"truthy"},"tags":["format:openapi","spec:info","experience:governance","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-license-require-name' (Info License Require Name). Requirement: The license object should include a name property identifying the license type, such as Apache 2.0, MIT, or a proprietary license. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.license` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-license-require-url":{"title":"Info License Require URL","reference":"https://spotlight-rules.com/spec/rules/openapi/info-license-require-url/","source":"compiled","description":"The license object should include a URL linking to the full license text so API consumers can review the terms.","message":"Info License MUST Have URL","severity":"info","given":"$.info.license","then":{"field":"url","function":"truthy"},"tags":["format:openapi","spec:info","experience:governance","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-license-require-url' (Info License Require URL). Requirement: The license object should include a URL linking to the full license text so API consumers can review the terms. To fix: Ensure `url` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.license` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-microcks-extension-valid":{"title":"Info Microcks Extension Valid","reference":"https://spotlight-rules.com/spec/rules/openapi/info-microcks-extension-valid/","source":"compiled","description":"x-microcks extension must be valid.","message":"x-microcks extension must be valid","severity":"info","given":"$.info.x-microcks","then":{"function":"schema","functionOptions":{"schema":{"type":"object","properties":{"labels":{"type":"object","additionalProperties":{"type":"string"}}},"required":["labels"],"additionalProperties":false}}},"formats":["oas3","aas2","aas3"],"tags":["format:openapi","spec:info","experience:governance","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-microcks-extension-valid' (Info Microcks Extension Valid). Requirement: x-microcks extension must be valid. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.info.x-microcks` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-owasp-api9-document-version":{"title":"Info OWASP API9 Document Version","reference":"https://spotlight-rules.com/spec/rules/openapi/info-owasp-api9-document-version/","source":"spotlight","description":"The API should declare a version in info.version so every published version is inventoried and retired versions can be tracked (OWASP API9 — improper inventory management).","message":"API should declare info.version for inventory management.","given":"$.info","severity":"info","then":{"field":"version","function":"truthy"},"tags":["format:openapi","spec:info","experience:security","experience:governance","owasp:api9"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-owasp-api9-document-version' (Info OWASP API9 Document Version). Requirement: The API should declare a version in info.version so every published version is inventoried and retired versions can be tracked (OWASP API9 — improper inventory management). To fix: Ensure `version` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-api-identifier":{"title":"Info Require API Identifier","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-api-identifier/","source":"compiled","description":"The `#/info/x-api-id` field can be used to associate an identifier to an API. This is useful to track an API even when its `#/info/title` changes.","message":"API must have an unique identifier in x-api-id in #/info/x-api-id.","severity":"info","given":"$","then":{"field":"info.x-api-id","function":"truthy"},"tags":["format:openapi","spec:document","experience:discoverability","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-api-identifier' (Info Require API Identifier). Requirement: The `#/info/x-api-id` field can be used to associate an identifier to an API. This is useful to track an API even when its `#/info/title` changes. To fix: Ensure `info.x-api-id` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-contact-2":{"title":"Info Require Contact 2","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-contact-2/","source":"compiled","description":"Having a contact object associated with the technical contract ensures that anyone who comes across the API has someone to contact and get more information.","message":"Info MUST Have Contact Object","severity":"info","given":"$.info","then":{"field":"contact","function":"truthy"},"tags":["format:openapi","spec:info","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-contact-2' (Info Require Contact 2). Requirement: Having a contact object associated with the technical contract ensures that anyone who comes across the API has someone to contact and get more information. To fix: Ensure `contact` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-description":{"title":"Info Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-description/","source":"compiled","description":"Info section is missing a description.","message":"Info section is missing a description.","severity":"info","given":"$.info","then":{"field":"description","function":"truthy"},"formats":["oas3","oas3_1"],"tags":["format:openapi","spec:info","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-description' (Info Require Description). Requirement: Info section is missing a description. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-license":{"title":"Info Require License","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-license/","source":"compiled","description":"Having a license defined in the info object clarifies the terms under which the API can be used. Analysis shows only 44.4% of APIs define a license, but it is essential for API governance and compliance.","message":"Info MUST Have License","severity":"info","given":"$.info","then":{"field":"license","function":"truthy"},"tags":["format:openapi","spec:info","experience:governance","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-license' (Info Require License). Requirement: Having a license defined in the info object clarifies the terms under which the API can be used. Analysis shows only 44.4% of APIs define a license, but it is essential for API governance and compliance. To fix: Ensure `license` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-openapi-version-3x":{"title":"Info Require Openapi Version 3x","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-openapi-version-3x/","source":"compiled","description":"APIs should use OpenAPI 3.x specification. Analysis of 773 API specs shows 97% use OpenAPI 3.x, with 86% on 3.1.0, making it the dominant standard for modern API definitions.","message":"OpenAPI MUST Be Version 3.x","severity":"info","given":"$","then":{"field":"openapi","function":"pattern","functionOptions":{"match":"^3\\."}},"tags":["format:openapi","spec:document","experience:versioning","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-openapi-version-3x' (Info Require Openapi Version 3x). Requirement: APIs should use OpenAPI 3.x specification. Analysis of 773 API specs shows 97% use OpenAPI 3.x, with 86% on 3.1.0, making it the dominant standard for modern API definitions. To fix: Ensure `openapi` matches the regular expression `^3\\.`; rewrite any value that does not. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-summary":{"title":"Info Require Summary","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-summary/","source":"compiled","description":"The `#/info/x-summary` can be used to specify a brief, one-liner description of your API: this is very useful for catalog purposes (eg. this can be shown as your API subtitle in catalogs and developer portals). In OAS3.1 you can use the standard `#/info/summary` field.","message":"API MUST have an one-liner #/info/x-summary field containing a brief description.","severity":"info","given":"$","then":{"field":"info.x-summary","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:document","experience:documentation","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-summary' (Info Require Summary). Requirement: The `#/info/x-summary` can be used to specify a brief, one-liner description of your API: this is very useful for catalog purposes (eg. this can be shown as your API subtitle in catalogs and developer portals). In OAS3.1 you can use the standard `#/info/summary` field. To fix: Ensure `info.x-summary` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-terms-of-service":{"title":"Info Require Terms Of Service","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-terms-of-service/","source":"compiled","description":"API MUST reference the URL of the Terms of Service in `#/info/termsOfService`.","message":"API MUST reference the URL of the Terms of Service  in #/info/termsOfService.","severity":"info","given":"$","then":{"field":"info.termsOfService","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-terms-of-service' (Info Require Terms Of Service). Requirement: API MUST reference the URL of the Terms of Service in `#/info/termsOfService`. To fix: Ensure `info.termsOfService` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-require-title":{"title":"Info Require Title","reference":"https://spotlight-rules.com/spec/rules/openapi/info-require-title/","source":"compiled","description":"Having a intuitive and helpful title for your API using the OpenAPI info title is the first impression you will make on the consumers of your API.","message":"Info MUST Have Title","severity":"info","given":"$.info","then":{"field":"title","function":"truthy"},"tags":["format:openapi","spec:info","experience:documentation","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-require-title' (Info Require Title). Requirement: Having a intuitive and helpful title for your API using the OpenAPI info title is the first impression you will make on the consumers of your API. To fix: Ensure `title` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-skill-require-version":{"title":"Info Require Version","reference":"https://spotlight-rules.com/spec/rules/openapi/info-skill-require-version/","source":"compiled","description":"Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using Semantic or date-based versioning published to the info version property.","message":"Info MUST Have Version","severity":"info","given":"$.info","then":{"field":"version","function":"truthy"},"tags":["format:openapi","spec:info","experience:versioning"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-skill-require-version' (Info Require Version). Requirement: Publishing a version for your OpenAPI technical contract helps you communicate change with consumers using Semantic or date-based versioning published to the info version property. To fix: Ensure `version` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-title-capitalized":{"title":"Info Title Capitalized","reference":"https://spotlight-rules.com/spec/rules/openapi/info-title-capitalized/","source":"compiled","description":"Having a consistent casing for the title for your API helps provide constraints for teams naming the API, but also keep consistent with other APIs from across teams.","message":"Info Title Has First Characters Capitalized","severity":"info","given":"$.info.title","then":{"function":"pattern","functionOptions":{"match":"[A-Z]\\w*"}},"tags":["format:openapi","spec:info","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-title-capitalized' (Info Title Capitalized). Requirement: Having a consistent casing for the title for your API helps provide constraints for teams naming the API, but also keep consistent with other APIs from across teams. To fix: Ensure the targeted value matches the regular expression `[A-Z]\\w*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.info.title` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-title-max-length":{"title":"Info Title Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/info-title-max-length/","source":"compiled","description":"Having a limitation on the length of the title for your API helps provide constraints for teams naming it, but also keep consistent with other APIs from across teams.","message":"Info Title MUST Be Less Than 50 Characters","severity":"info","given":"$.info","then":{"field":"title","function":"length","functionOptions":{"max":50}},"tags":["format:openapi","spec:info","experience:consistency","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-title-max-length' (Info Title Max Length). Requirement: Having a limitation on the length of the title for your API helps provide constraints for teams naming it, but also keep consistent with other APIs from across teams. To fix: Ensure the length of `title` is at most 50. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-version-must-be-semver":{"title":"Info Version Must Be Semver","reference":"https://spotlight-rules.com/spec/rules/openapi/info-version-must-be-semver/","source":"compiled","description":"The API version field should follow [semantic versioning](https://semver.org/#semantic-versioning-specification-semver).","message":"Specs should follow semantic versioning. {{value}} is not a valid version.","severity":"info","given":"$.info.version","then":{"function":"pattern","functionOptions":{"match":"^[0-9]+.[0-9]+.[0-9]+(-[a-z0-9+.-]+)?"}},"tags":["format:openapi","spec:info","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-version-must-be-semver' (Info Version Must Be Semver). Requirement: The API version field should follow [semantic versioning](https://semver.org/#semantic-versioning-specification-semver). To fix: Ensure the targeted value matches the regular expression `^[0-9]+.[0-9]+.[0-9]+(-[a-z0-9+.-]+)?`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.info.version` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-version-must-use-semver":{"title":"Info Version Must Use Semver","reference":"https://spotlight-rules.com/spec/rules/openapi/info-version-must-use-semver/","source":"compiled","description":"Version should use semantic versioning. {{value}} is not a valid version.","message":"Version should use semantic versioning. {{value}} is not a valid version.","severity":"info","given":"$.info.version","then":{"function":"pattern","functionOptions":{"match":"^([0-9]+.[0-9]+.[0-9]+)$"}},"tags":["format:openapi","spec:info","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-version-must-use-semver' (Info Version Must Use Semver). Requirement: Version should use semantic versioning. {{value}} is not a valid version. To fix: Ensure the targeted value matches the regular expression `^([0-9]+.[0-9]+.[0-9]+)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.info.version` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"info-version-semantic-and-stable":{"title":"Info Version Semantic And Stable","reference":"https://spotlight-rules.com/spec/rules/openapi/info-version-semantic-and-stable/","source":"compiled","description":"The API contract MUST have a stable version and MUST follow semantic versioning (e.g., '1.0.0'). Words like 'SNAPSHOT' or 'RELEASE' are not allowed.","message":"{{description}}: {{error}}","severity":"info","given":"$.info.version","then":{"function":"pattern","functionOptions":{"match":"^(?!.*\\b(SNAPSHOT|RELEASE)\\b)(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$"}},"formats":["oas3"],"tags":["format:openapi","spec:info","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'info-version-semantic-and-stable' (Info Version Semantic And Stable). Requirement: The API contract MUST have a stable version and MUST follow semantic versioning (e.g., '1.0.0'). Words like 'SNAPSHOT' or 'RELEASE' are not allowed. To fix: Ensure the targeted value matches the regular expression `^(?!.*\\b(SNAPSHOT|RELEASE)\\b)(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.info.version` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"license-url":{"title":"License URL","reference":"https://spotlight-rules.com/spec/rules/openapi/license-url/","source":"builtin","description":"License object must include \"url\".","message":"License object must include \"url\".","severity":"info","given":"$","then":{"field":"info.license.url","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'license-url' (License URL). Requirement: License object must include \"url\". To fix: Ensure `info.license.url` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"limit-nested-sub-resources":{"title":"Limit Nested Sub Resources","reference":"https://spotlight-rules.com/spec/rules/openapi/limit-nested-sub-resources/","source":"compiled","description":"The hierarchy of nested resources SHOULD NOT contain more than 8 resource names in the path.","message":"The hierarchy of nested resources SHOULD NOT contain more than 8 resource names in the path.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^([^/]*/){9,}"}},"tags":["format:openapi","spec:paths","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'limit-nested-sub-resources' (Limit Nested Sub Resources). Requirement: The hierarchy of nested resources SHOULD NOT contain more than 8 resource names in the path. To fix: Ensure the targeted value does NOT match the regular expression `^([^/]*/){9,}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"limit-path-length":{"title":"Limit Path Length","reference":"https://spotlight-rules.com/spec/rules/openapi/limit-path-length/","source":"compiled","description":"APIs SHOULD NOT expand their total URL length beyond a few hundred characters.","message":"APIs SHOULD NOT expand their total URL length beyond a few hundred characters.","severity":"info","given":"$.paths.*~","then":{"function":"length","functionOptions":{"max":100}},"tags":["format:openapi","spec:paths","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'limit-path-length' (Limit Path Length). Requirement: APIs SHOULD NOT expand their total URL length beyond a few hundred characters. To fix: Ensure the length of the targeted value is at most 100. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"limit-path-parameter":{"title":"Limit Path Parameter","reference":"https://spotlight-rules.com/spec/rules/openapi/limit-path-parameter/","source":"compiled","description":"The URL path should not contain more than 3 dynamic path parameters.","message":"The URL path should not contain more than 3 dynamic path parameters.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^(.*{{1}.*){4,}"}},"tags":["format:openapi","spec:paths","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'limit-path-parameter' (Limit Path Parameter). Requirement: The URL path should not contain more than 3 dynamic path parameters. To fix: Ensure the targeted value does NOT match the regular expression `^(.*{{1}.*){4,}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"message-examples-form-complete-mocks":{"title":"Message Examples Form Complete Mocks","reference":"https://spotlight-rules.com/spec/rules/openapi/message-examples-form-complete-mocks/","source":"compiled","description":"Message example must match params examples to form full mocks.","message":"{{error}}","severity":"info","given":"$.channels.*","then":{"function":"microcks:aas-verify-mocks"},"formats":["aas2"],"tags":["format:openapi","spec:channels","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'message-examples-form-complete-mocks' (Message Examples Form Complete Mocks). Requirement: Message example must match params examples to form full mocks. This rule is evaluated at the JSONPath `$.channels.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"message-require-examples":{"title":"Message Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/message-require-examples/","source":"compiled","description":"Message must have examples.","message":"Message must have examples","severity":"info","given":"$.channels.*.[publish,subscribe].message","then":{"field":"examples","function":"truthy"},"formats":["aas2"],"tags":["format:openapi","spec:channels","spec:messages","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'message-require-examples' (Message Require Examples). Requirement: Message must have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.channels.*.[publish,subscribe].message` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"no-$ref-siblings":{"title":"No $ref Siblings","reference":"https://spotlight-rules.com/spec/rules/openapi/no-$ref-siblings/","source":"builtin","description":"Property must not be placed among $ref.","message":"{{error}}","severity":"info","given":"$..[?(@property === '$ref')]","then":{"function":"refSiblings"},"tags":["format:openapi","spec:schemas","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'no-$ref-siblings' (No $ref Siblings). Requirement: Property must not be placed among $ref. This rule is evaluated at the JSONPath `$..[?(@property === '$ref')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"no-eval-in-markdown":{"title":"No Eval In Markdown","reference":"https://spotlight-rules.com/spec/rules/openapi/no-eval-in-markdown/","source":"builtin","description":"Markdown descriptions must not have \"eval(\".","message":"Markdown descriptions must not have \"eval(\".","severity":"info","given":"$..[description,title]","then":{"function":"pattern","functionOptions":{"notMatch":"eval\\("}},"tags":["format:openapi","spec:document","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'no-eval-in-markdown' (No Eval In Markdown). Requirement: Markdown descriptions must not have \"eval(\". To fix: Ensure the targeted value does NOT match the regular expression `eval\\(`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..[description,title]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"no-script-tags-in-markdown":{"title":"No Script Tags In Markdown","reference":"https://spotlight-rules.com/spec/rules/openapi/no-script-tags-in-markdown/","source":"builtin","description":"Markdown descriptions must not have \"<script>\" tags.","message":"Markdown descriptions must not have \"<script>\" tags.","severity":"info","given":"$..[description,title]","then":{"function":"pattern","functionOptions":{"notMatch":"<script"}},"tags":["format:openapi","spec:document","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'no-script-tags-in-markdown' (No Script Tags In Markdown). Requirement: Markdown descriptions must not have \"<script>\" tags. To fix: Ensure the targeted value does NOT match the regular expression `<script`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..[description,title]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3_1-callbacks-in-webhook":{"title":"OAS3.1 Callbacks In Webhook","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3_1-callbacks-in-webhook/","description":"OAS3.1 Callbacks In Webhook.","source":"builtin","message":"Callbacks should not be defined in a webhook.","severity":"info","given":["$.webhooks[*][*].callbacks"],"then":{"function":"undefined"},"tags":["format:openapi","spec:document","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3_1-callbacks-in-webhook' (OAS3.1 Callbacks In Webhook). Requirement: OAS3.1 Callbacks In Webhook. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `$.webhooks[*][*].callbacks` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3_1-servers-in-webhook":{"title":"OAS3.1 Servers In Webhook","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3_1-servers-in-webhook/","description":"OAS3.1 Servers In Webhook.","source":"builtin","message":"Servers should not be defined in a webhook.","severity":"info","given":["$.webhooks.servers","$.webhooks[*][*].servers"],"then":{"function":"undefined"},"tags":["format:openapi","spec:servers","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3_1-servers-in-webhook' (OAS3.1 Servers In Webhook). Requirement: OAS3.1 Servers In Webhook. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `$.webhooks.servers | $.webhooks[*][*].servers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-api-servers":{"title":"OAS3 API Servers","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-api-servers/","source":"builtin","description":"OpenAPI \"servers\" must be present and non-empty array.","message":"OpenAPI \"servers\" must be present and non-empty array.","severity":"info","given":"$","then":{"field":"servers","function":"schema","functionOptions":{"dialect":"draft7","schema":{"items":{"type":"object"},"minItems":1,"type":"array"}}},"tags":["format:openapi","spec:document","experience:usability","experience:reliability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-api-servers' (OAS3 API Servers). Requirement: OpenAPI \"servers\" must be present and non-empty array. To fix: Adjust `servers` so it conforms to the schema this rule requires. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-callbacks-in-callbacks":{"title":"OAS3 Callbacks In Callbacks","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-callbacks-in-callbacks/","description":"OAS3 Callbacks In Callbacks.","source":"builtin","message":"Callbacks should not be defined within a callback","severity":"info","given":["#OperationObject.callbacks[*][*][*].callbacks"],"then":{"function":"undefined"},"tags":["format:openapi","spec:document","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-callbacks-in-callbacks' (OAS3 Callbacks In Callbacks). Requirement: OAS3 Callbacks In Callbacks. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `#OperationObject.callbacks[*][*][*].callbacks` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-examples-value-or-externalValue":{"title":"OAS3 Examples Value Or ExternalValue","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-examples-value-or-externalValue/","source":"builtin","description":"Examples must have either \"value\" or \"externalValue\" field.","message":"Examples must have either \"value\" or \"externalValue\" field.","severity":"info","given":["$.components.examples[*]","$.paths[*][*]..content[*].examples[*]","$.paths[*][*]..parameters[*].examples[*]","$.components.parameters[*].examples[*]","$.paths[*][*]..headers[*].examples[*]","$.components.headers[*].examples[*]"],"then":{"function":"xor","functionOptions":{"properties":["externalValue","value"]}},"tags":["format:openapi","spec:paths","spec:parameters","spec:headers","spec:media-types","spec:components","spec:examples","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-examples-value-or-externalValue' (OAS3 Examples Value Or ExternalValue). Requirement: Examples must have either \"value\" or \"externalValue\" field. To fix: Include exactly one of: externalValue, value. This rule is evaluated at the JSONPath `$.components.examples[*] | $.paths[*][*]..content[*].examples[*] | $.paths[*][*]..parameters[*].examples[*] | $.components.parameters[*].examples[*] | $.paths[*][*]..headers[*].examples[*] | $.components.headers[*].examples[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-operation-security-defined":{"title":"OAS3 Operation Security Defined","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-operation-security-defined/","source":"builtin","description":"Operation \"security\" values must match a scheme defined in the \"components.securitySchemes\" object.","message":"{{error}}","severity":"info","given":"#SecurityRequirementObject","then":{"function":"oasSecurityDefined","functionOptions":{"oasVersion":3}},"tags":["owasp:api5","format:openapi","spec:security","experience:security","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-operation-security-defined' (OAS3 Operation Security Defined). Requirement: Operation \"security\" values must match a scheme defined in the \"components.securitySchemes\" object. This rule is evaluated at the JSONPath `#SecurityRequirementObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-parameter-description":{"title":"OAS3 Parameter Description","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-parameter-description/","source":"builtin","description":"Parameter objects must have \"description\".","message":"Parameter objects must have \"description\".","severity":"info","given":["#PathItem.parameters[?(@ && @.in)]","#OperationObject.parameters[?(@ && @.in)]","$.components.parameters[?(@ && @.in)]"],"then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:components","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-parameter-description' (OAS3 Parameter Description). Requirement: Parameter objects must have \"description\". To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `#PathItem.parameters[?(@ && @.in)] | #OperationObject.parameters[?(@ && @.in)] | $.components.parameters[?(@ && @.in)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-schema":{"title":"OAS3 Schema","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-schema/","source":"builtin","description":"Validate structure of OpenAPI v3 specification.","message":"{{error}}.","severity":"info","given":"$","then":{"function":"oasDocumentSchema"},"tags":["format:openapi","spec:document","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-schema' (OAS3 Schema). Requirement: Validate structure of OpenAPI v3 specification. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-server-not-example.com":{"title":"OAS3 Server Not Example.com","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-server-not-example.com/","source":"builtin","description":"Server URL must not point at example.com.","message":"Server URL must not point at example.com.","severity":"info","given":"$.servers[*].url","then":{"function":"pattern","functionOptions":{"notMatch":"example\\.com"}},"tags":["format:openapi","spec:servers","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-server-not-example.com' (OAS3 Server Not Example.com). Requirement: Server URL must not point at example.com. To fix: Ensure the targeted value does NOT match the regular expression `example\\.com`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers[*].url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-server-trailing-slash":{"title":"OAS3 Server Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-server-trailing-slash/","source":"builtin","description":"Server URL must not have trailing slash.","message":"Server URL must not have trailing slash.","severity":"info","given":"$.servers[*].url","then":{"function":"pattern","functionOptions":{"notMatch":"./$"}},"tags":["format:openapi","spec:servers","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-server-trailing-slash' (OAS3 Server Trailing Slash). Requirement: Server URL must not have trailing slash. To fix: Ensure the targeted value does NOT match the regular expression `./$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers[*].url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-server-variables":{"title":"OAS3 Server Variables","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-server-variables/","source":"builtin","description":"Server variables must be defined and valid and there must be no unused variables.","message":"{{error}}","severity":"info","given":["$.servers[*]","#PathItem.servers[*]","#OperationObject.servers[*]","#LinkObject.server"],"then":{"function":"serverVariables","functionOptions":{"checkSubstitutions":true,"requireDefault":true}},"tags":["format:openapi","spec:servers","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-server-variables' (OAS3 Server Variables). Requirement: Server variables must be defined and valid and there must be no unused variables. This rule is evaluated at the JSONPath `$.servers[*] | #PathItem.servers[*] | #OperationObject.servers[*] | #LinkObject.server` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-unused-component":{"title":"OAS3 Unused Component","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-unused-component/","description":"OAS3 Unused Component.","source":"builtin","message":"Potentially unused component has been detected.","severity":"info","given":"$","then":{"function":"oasUnusedComponent"},"tags":["format:openapi","spec:document","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-unused-component' (OAS3 Unused Component). Requirement: OAS3 Unused Component. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-valid-media-example":{"title":"OAS3 Valid Media Example","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-valid-media-example/","source":"builtin","description":"Examples must be valid against their defined schema.","message":"{{error}}","severity":"info","given":["$..content..[?(@ && @.schema && (@.example !== void 0 || @.examples))]","$..headers..[?(@ && @.schema && (@.example !== void 0 || @.examples))]","$..parameters..[?(@ && @.schema && (@.example !== void 0 || @.examples))]"],"then":{"function":"oasExample","functionOptions":{"schemaField":"schema","oasVersion":3,"type":"media"}},"tags":["format:openapi","spec:parameters","spec:headers","spec:media-types","spec:schemas","spec:examples","experience:data-modeling","experience:documentation","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-valid-media-example' (OAS3 Valid Media Example). Requirement: Examples must be valid against their defined schema. This rule is evaluated at the JSONPath `$..content..[?(@ && @.schema && (@.example !== void 0 || @.examples))] | $..headers..[?(@ && @.schema && (@.example !== void 0 || @.examples))] | $..parameters..[?(@ && @.schema && (@.example !== void 0 || @.examples))]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"oas3-valid-schema-example":{"title":"OAS3 Valid Schema Example","reference":"https://spotlight-rules.com/spec/rules/openapi/oas3-valid-schema-example/","source":"builtin","description":"Examples must be valid against their defined schema.","message":"{{error}}","severity":"info","given":["$.components.schemas..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]","$..content..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]","$..headers..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]","$..parameters..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]"],"then":{"function":"oasExample","functionOptions":{"schemaField":"$","oasVersion":3,"type":"schema"}},"tags":["format:openapi","spec:parameters","spec:headers","spec:media-types","spec:schemas","spec:components","spec:examples","experience:data-modeling","experience:documentation","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'oas3-valid-schema-example' (OAS3 Valid Schema Example). Requirement: Examples must be valid against their defined schema. This rule is evaluated at the JSONPath `$.components.schemas..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))] | $..content..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))] | $..headers..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))] | $..parameters..[?(@property !== 'properties' && @ && (@ && @.example !== void 0 || @.default !== void 0) && (@.enum || @.type || @.format || @.$ref || @.properties || @.items))]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"openapi-tags":{"title":"Openapi Tags","reference":"https://spotlight-rules.com/spec/rules/openapi/openapi-tags/","source":"builtin","description":"OpenAPI object must have non-empty \"tags\" array.","message":"OpenAPI object must have non-empty \"tags\" array.","severity":"info","given":"$","then":{"field":"tags","function":"schema","functionOptions":{"dialect":"draft7","schema":{"type":"array","minItems":1}}},"tags":["format:openapi","spec:document","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'openapi-tags' (Openapi Tags). Requirement: OpenAPI object must have non-empty \"tags\" array. To fix: Adjust `tags` so it conforms to the schema this rule requires. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"openapi-tags-alphabetical":{"title":"Openapi Tags Alphabetical","reference":"https://spotlight-rules.com/spec/rules/openapi/openapi-tags-alphabetical/","source":"builtin","description":"OpenAPI object must have alphabetical \"tags\".","message":"OpenAPI object must have alphabetical \"tags\".","severity":"info","given":"$","then":{"field":"tags","function":"alphabetical","functionOptions":{"keyedBy":"name"}},"tags":["format:openapi","spec:document","experience:consistency","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'openapi-tags-alphabetical' (Openapi Tags Alphabetical). Requirement: OpenAPI object must have alphabetical \"tags\". To fix: Sort the entries by `name` into ascending alphabetical order. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"openapi-tags-uniqueness":{"title":"Openapi Tags Uniqueness","reference":"https://spotlight-rules.com/spec/rules/openapi/openapi-tags-uniqueness/","source":"builtin","description":"Each tag must have a unique name.","message":"{{error}}","severity":"info","given":"$.tags","then":{"function":"uniquenessTags"},"tags":["format:openapi","spec:tags","experience:consistency","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'openapi-tags-uniqueness' (Openapi Tags Uniqueness). Requirement: Each tag must have a unique name. This rule is evaluated at the JSONPath `$.tags` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-collection-support-filtering":{"title":"Operation Collection Support Filtering","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-collection-support-filtering/","source":"spotlight","description":"Collection GET operations should support filtering via a filter query parameter (e.g. filter or filter[field]).","message":"Collection should support a filter query parameter.","given":"$.paths[*].get","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"pattern":"^filter"},"in":{"const":"query"}}}}}},"tags":["format:openapi","spec:parameters","topic:pagination","experience:usability","experience:discoverability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-collection-support-filtering' (Operation Collection Support Filtering). Requirement: Collection GET operations should support filtering via a filter query parameter (e.g. filter or filter[field]). To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*].get` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-collection-support-sorting":{"title":"Operation Collection Support Sorting","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-collection-support-sorting/","source":"spotlight","description":"Collection GET operations should support sorting via a sort or order query parameter.","message":"Collection should support a sort/order query parameter.","given":"$.paths[*].get","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"pattern":"^(sort|order)"},"in":{"const":"query"}}}}}},"tags":["format:openapi","spec:parameters","topic:pagination","experience:usability","experience:discoverability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-collection-support-sorting' (Operation Collection Support Sorting). Requirement: Collection GET operations should support sorting via a sort or order query parameter. To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*].get` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-collection-support-sparse-fieldsets":{"title":"Operation Collection Support Sparse Fieldsets","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-collection-support-sparse-fieldsets/","source":"spotlight","description":"GET operations should support sparse fieldsets via a fields query parameter so clients can request only the fields they need.","message":"Operation should support a fields (sparse fieldset) query parameter.","given":"$.paths[*].get","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"pattern":"^fields"},"in":{"const":"query"}}}}}},"tags":["format:openapi","spec:parameters","topic:pagination","experience:usability","experience:reliability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-collection-support-sparse-fieldsets' (Operation Collection Support Sparse Fieldsets). Requirement: GET operations should support sparse fieldsets via a fields query parameter so clients can request only the fields they need. To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*].get` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-define-429-response":{"title":"Operation Define 429 Response","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-define-429-response/","source":"compiled","description":"APIs should define a 429 Too Many Requests response to document rate limiting behavior. Analysis shows 429 appears in 671 operations, confirming rate limiting is a common API pattern.","message":"Operations MUST Have 429 Response","severity":"info","given":"$.paths.*[get,post,put,patch,delete].responses","then":{"field":"429","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","topic:rate-limiting","experience:error-handling","experience:reliability","experience:performance","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-define-429-response' (Operation Define 429 Response). Requirement: APIs should define a 429 Too Many Requests response to document rate limiting behavior. Analysis shows 429 appears in 671 operations, confirming rate limiting is a common API pattern. To fix: Ensure `429` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,put,patch,delete].responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-define-500-response":{"title":"Operation Define 500 Response","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-define-500-response/","source":"compiled","description":"Every endpoint SHOULD have a 500 response.","message":"Every endpoint SHOULD have a 500 response.","severity":"info","given":"$.paths[*][*]","then":{"field":"responses.500","function":"truthy"},"tags":["format:openapi","spec:paths","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-define-500-response' (Operation Define 500 Response). Requirement: Every endpoint SHOULD have a 500 response. To fix: Ensure `responses.500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-deprecated-require-description":{"title":"Operation Deprecated Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-deprecated-require-description/","source":"spotlight","description":"Deprecated operations should have a description explaining the deprecation and the migration path / successor.","message":"Deprecated operation should describe the deprecation and successor.","given":"$.paths[*][?(@ && @.deprecated == true)]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:paths","topic:deprecation","experience:versioning","experience:documentation","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-deprecated-require-description' (Operation Deprecated Require Description). Requirement: Deprecated operations should have a description explaining the deprecation and the migration path / successor. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][?(@ && @.deprecated == true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-description":{"title":"Operation Description","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-description/","source":"builtin","description":"Operation \"description\" must be present and non-empty string.","message":"Operation \"description\" must be present and non-empty string.","severity":"info","given":"#OperationObject","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-description' (Operation Description). Requirement: Operation \"description\" must be present and non-empty string. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `#OperationObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-description-max-length":{"title":"Operation Description Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-description-max-length/","severity":"info","source":"compiled","description":"Having a length limitation for each description of each API operation helps apply constraints to how you describe your APIs, while helping drive consistency across APIs when it comes to search, documentation, and other ways an API is made available.","message":"Operation Description MUST Be Less Than 250 Characters","given":"$.paths.*[get,post,patch,put,delete]","then":[{"field":"description","function":"length","functionOptions":{"max":250}}],"tags":["format:openapi","spec:paths","spec:operations","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-description-max-length' (Operation Description Max Length). Requirement: Having a length limitation for each description of each API operation helps apply constraints to how you describe your APIs, while helping drive consistency across APIs when it comes to search, documentation, and other ways an API is made available. To fix: Ensure the length of `description` is at most 250. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-examples-form-complete-mocks":{"title":"Operation Examples Form Complete Mocks","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-examples-form-complete-mocks/","source":"compiled","description":"Response example must match required params examples to form full mocks.","message":"{{error}}","severity":"info","given":"$.paths.*.*","then":{"function":"microcks:oas-verify-mocks"},"formats":["oas3"],"tags":["format:openapi","spec:paths","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-examples-form-complete-mocks' (Operation Examples Form Complete Mocks). Requirement: Response example must match required params examples to form full mocks. This rule is evaluated at the JSONPath `$.paths.*.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-get-require-security":{"title":"Operation Get Require Security","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-get-require-security/","source":"compiled","description":"Your API should be protected by a `security` rule either at global or operation level. Operations should be protected specially when they are tied to non-idempotent HTTP methods like `POST`, `PUT`, `PATCH` and `DELETE`. This is done with one or more non-empty `security` rules. Security rules are defined in the `securityScheme` section. An example of a security rule applied at global level. ``` security: - BasicAuth: [] paths: /books: {} /users: {} securitySchemes: BasicAuth: scheme: http type: basic ``` An example of a security rule applied at operation level, which eventually overrides the global one ``` paths: /books: post: security: - AccessToken: [] securitySchemes: BasicAuth: scheme: http type: basic AccessToken: scheme: http type: bearer bearerFormat: JWT ```.","message":"The following operation is not protected by a `security` rule: {{path}}","severity":"info","given":["$.paths.*.get"],"then":[{"field":"security","function":"schema","functionOptions":{"schema":{"items":{"type":"object","minProperties":1},"minItems":1,"type":"array"}}}],"formats":["oas3"],"tags":["owasp:api2","format:openapi","spec:paths","spec:operations","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-get-require-security' (Operation Get Require Security). Requirement: Your API should be protected by a `security` rule either at global or operation level. Operations should be protected specially when they are tied to non-idempotent HTTP methods like `POST`, `PUT`, `PATCH` and `DELETE`. This is done with one or more non-empty `security` rules. Security rules are defined in the `securityScheme` section. An example of a security rule applied at global level. ``` security: - BasicAuth: [] paths: /books: {} /users: {} securitySchemes: BasicAuth: scheme: http type: basic ``` An example of a security rule applied at operation level, which eventually overrides the global one ``` paths: /books: post: security: - AccessToken: [] securitySchemes: BasicAuth: scheme: http type: basic AccessToken: scheme: http type: bearer bearerFormat: JWT ```. To fix: Adjust `security` so it conforms to the schema this rule requires. Guidance: The following operation is not protected by a `security` rule. This rule is evaluated at the JSONPath `$.paths.*.get` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-get-support-if-modified-since":{"title":"Operation Get Support If Modified Since","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-get-support-if-modified-since/","source":"spotlight","description":"GET operations should accept an If-Modified-Since request header to enable date-based conditional requests.","message":"Operation should accept a `If-Modified-Since` request header.","given":"$.paths[*][get]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name"],"properties":{"name":{"const":"If-Modified-Since"}}}}}},"tags":["format:openapi","spec:parameters","topic:conditional-requests","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-get-support-if-modified-since' (Operation Get Support If Modified Since). Requirement: GET operations should accept an If-Modified-Since request header to enable date-based conditional requests. To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `If-Modified-Since` request header. This rule is evaluated at the JSONPath `$.paths[*][get]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-get-support-if-none-match":{"title":"Operation Get Support If None Match","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-get-support-if-none-match/","source":"spotlight","description":"GET operations should accept an If-None-Match request header to enable ETag-based conditional requests (304 responses).","message":"Operation should accept a `If-None-Match` request header.","given":"$.paths[*][get]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name"],"properties":{"name":{"const":"If-None-Match"}}}}}},"tags":["format:openapi","spec:parameters","topic:conditional-requests","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-get-support-if-none-match' (Operation Get Support If None Match). Requirement: GET operations should accept an If-None-Match request header to enable ETag-based conditional requests (304 responses). To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `If-None-Match` request header. This rule is evaluated at the JSONPath `$.paths[*][get]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-id-camel-case":{"title":"Operation ID Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-id-camel-case/","source":"compiled","description":"Operation identifiers provide a unique way to identify each individual API, and requiring them to have consistent casing reduces friction when generating SDKs and automating around APIs.","message":"Operation Identifier MUST Be camelCase","severity":"info","given":"$.paths.*[get,post,patch,put,delete].operationId","then":[{"function":"pattern","functionOptions":{"match":"^[a-z]+(?:[A-Z][a-z]+)*$"}}],"tags":["format:openapi","spec:paths","spec:operations","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-id-camel-case' (Operation ID Camel Case). Requirement: Operation identifiers provide a unique way to identify each individual API, and requiring them to have consistent casing reduces friction when generating SDKs and automating around APIs. To fix: Ensure the targeted value matches the regular expression `^[a-z]+(?:[A-Z][a-z]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete].operationId` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-id-url-safe":{"title":"Operation ID URL Safe","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-id-url-safe/","source":"compiled","description":"OperationId must use URL friendly characters.","message":"OperationId must use URL friendly characters.","severity":"info","given":"$.paths[*][*]","then":{"field":"operationId","function":"pattern","functionOptions":{"match":"^[A-Za-z0-9-._~:/?#\\[\\]@!\\$&'()*+,;=]*$"}},"formats":["oas3","oas3_1"],"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-id-url-safe' (Operation ID URL Safe). Requirement: OperationId must use URL friendly characters. To fix: Ensure `operationId` matches the regular expression `^[A-Za-z0-9-._~:/?#\\[\\]@!\\$&'()*+,;=]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*][*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-microcks-extension-valid":{"title":"Operation Microcks Extension Valid","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-microcks-extension-valid/","source":"compiled","description":"x-microcks-operation extension must be valid.","message":"x-microcks-operation extension must be valid","severity":"info","given":["$.paths.*.*.x-microcks-operation","$.channels.*.[publish,subscribe].x-microcks-operation","$.operations.*.x-microcks-operation"],"then":{"function":"schema","functionOptions":{"schema":{"type":"object","properties":{"delay":{"type":"number","format":"int32"},"frequency":{"type":"number","format":"int32"},"dispatcher":{"type":"string"},"dispatcherRules":{"type":"string"},"parameterConstraints":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"in":{"type":"string","enum":["path","query","header"]},"required":{"type":"boolean"},"recopy":{"type":"boolean"},"mustMatchRegexp":{"type":"string"}},"required":["name","in"]}}},"additionalProperties":false}}},"formats":["oas3","aas2","aas3"],"tags":["format:openapi","spec:channels","spec:paths","experience:governance","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-microcks-extension-valid' (Operation Microcks Extension Valid). Requirement: x-microcks-operation extension must be valid. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths.*.*.x-microcks-operation | $.channels.*.[publish,subscribe].x-microcks-operation | $.operations.*.x-microcks-operation` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-mutation-support-idempotency-key":{"title":"Operation Mutation Support Idempotency Key","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-mutation-support-idempotency-key/","source":"spotlight","description":"POST and PATCH operations should accept an Idempotency-Key request header so clients can safely retry without creating duplicates.","message":"Mutation should accept an Idempotency-Key header for safe retries.","given":"$.paths[*][post,patch]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"const":"Idempotency-Key"},"in":{"const":"header"}}}}}},"tags":["format:openapi","spec:parameters","topic:idempotency","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-mutation-support-idempotency-key' (Operation Mutation Support Idempotency Key). Requirement: POST and PATCH operations should accept an Idempotency-Key request header so clients can safely retry without creating duplicates. To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][post,patch]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-operationId":{"title":"Operation OperationId","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-operationId/","source":"builtin","description":"Operation must have \"operationId\".","message":"Operation must have \"operationId\".","severity":"info","given":"#OperationObject","then":{"field":"operationId","function":"truthy"},"tags":["format:openapi","spec:document","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-operationId' (Operation OperationId). Requirement: Operation must have \"operationId\". To fix: Ensure `operationId` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `#OperationObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-operationId-unique":{"title":"Operation OperationId Unique","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-operationId-unique/","source":"builtin","description":"Every operation must have unique \"operationId\".","message":"Every operation must have unique \"operationId\".","severity":"info","given":"$.paths","then":{"function":"oasOpIdUnique"},"tags":["format:openapi","spec:paths","experience:consistency","experience:naming","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-operationId-unique' (Operation OperationId Unique). Requirement: Every operation must have unique \"operationId\". This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-operationId-valid-in-url":{"title":"Operation OperationId Valid In URL","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-operationId-valid-in-url/","description":"Operation OperationId Valid In URL.","source":"builtin","message":"operationId must not characters that are invalid when used in URL.","severity":"info","given":"#OperationObject","then":{"field":"operationId","function":"pattern","functionOptions":{"match":"^[A-Za-z0-9-._~:/?#\\[\\]@!\\$&'()*+,;=]*$"}},"tags":["format:openapi","spec:document","experience:naming","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-operationId-valid-in-url' (Operation OperationId Valid In URL). Requirement: Operation OperationId Valid In URL. To fix: Ensure `operationId` matches the regular expression `^[A-Za-z0-9-._~:/?#\\[\\]@!\\$&'()*+,;=]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `#OperationObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-parameters":{"title":"Operation Parameters","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-parameters/","source":"builtin","description":"Operation parameters are unique and non-repeating.","message":"{{error}}","severity":"info","given":"#OperationObject.parameters","then":{"function":"oasOpParams"},"tags":["format:openapi","spec:parameters","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-parameters' (Operation Parameters). Requirement: Operation parameters are unique and non-repeating. This rule is evaluated at the JSONPath `#OperationObject.parameters` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-patch-must-have-request-body":{"title":"Operation Patch Must Have Request Body","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-patch-must-have-request-body/","source":"compiled","description":"PATCH operations must have a request body.","message":"PATCH operations must have a request body.","severity":"info","given":"$.paths[*].patch","then":{"field":"requestBody","function":"schema","functionOptions":{"schema":{"type":"object"}}},"tags":["format:openapi","spec:paths","spec:operations","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-patch-must-have-request-body' (Operation Patch Must Have Request Body). Requirement: PATCH operations must have a request body. To fix: Adjust `requestBody` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*].patch` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-post-not-for-retrieval":{"title":"Operation Post Not For Retrieval","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-post-not-for-retrieval/","source":"compiled","description":"POST requests SHOULD NOT be used for retrieving information. Use GET instead.","message":"POST requests SHOULD NOT be used for retrieving information.","severity":"info","given":"$.paths[*].post","then":{"field":"summary","function":"pattern","functionOptions":{"notMatch":"(retrieve|fetch|get|read)"},"message":"{{description}}: {{error}}"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-post-not-for-retrieval' (Operation Post Not For Retrieval). Requirement: POST requests SHOULD NOT be used for retrieving information. Use GET instead. To fix: Ensure `summary` does NOT match the regular expression `(retrieve|fetch|get|read)`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].post` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-post-require-request-body":{"title":"Operation Post Require Request Body","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-post-require-request-body/","source":"compiled","description":"POST HTTP methods can have a request body, providing a structured payload for configuring each API request.","message":"POST Requests MUST Have a Body","severity":"info","given":"$.paths.*.post","then":{"field":"requestBody","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-post-require-request-body' (Operation Post Require Request Body). Requirement: POST HTTP methods can have a request body, providing a structured payload for configuring each API request. To fix: Ensure `requestBody` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.post` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-put-require-request-body":{"title":"Operation Put Require Request Body","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-put-require-request-body/","source":"compiled","description":"PUT requests MUST have a request body.","message":"PUT requests MUST have a request body.","severity":"info","given":"$.paths[*].put","then":{"field":"requestBody","function":"truthy","message":"{{description}}: {{error}}"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-put-require-request-body' (Operation Put Require Request Body). Requirement: PUT requests MUST have a request body. To fix: Ensure `requestBody` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].put` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-ref-resource-file":{"title":"Operation Ref Resource File","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-ref-resource-file/","source":"compiled","description":"Endpoint must a $ref to a file in resources/.","message":"{{description}}; {{value}} incorrect","severity":"info","given":"$.paths.*.$ref","then":{"function":"pattern","functionOptions":{"match":"^resources/.*yml$"}},"tags":["format:openapi","spec:paths","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-ref-resource-file' (Operation Ref Resource File). Requirement: Endpoint must a $ref to a file in resources/. To fix: Ensure the targeted value matches the regular expression `^resources/.*yml$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*.$ref` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-description":{"title":"Operation Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-description/","source":"compiled","description":"Having a paragraph or two description of each API operation helps API consumers understand what is possible with each API request.","message":"Operation MUST Have Description","severity":"info","given":"$.paths.*[get,post,patch,put,delete]","then":[{"field":"description","function":"truthy"}],"tags":["format:openapi","spec:paths","spec:operations","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-description' (Operation Require Description). Requirement: Having a paragraph or two description of each API operation helps API consumers understand what is possible with each API request. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-id":{"title":"Operation Require ID","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-id/","source":"compiled","description":"Every operation should have an operationId for SDK generation and documentation linking. Analysis shows operationId styles across 8878 operations with camelCase dominant at 92%.","message":"Operation MUST Have operationId","severity":"info","given":"$.paths.*[get,post,put,patch,delete]","then":{"field":"operationId","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-id' (Operation Require ID). Requirement: Every operation should have an operationId for SDK generation and documentation linking. Analysis shows operationId styles across 8878 operations with camelCase dominant at 92%. To fix: Ensure `operationId` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-identifier":{"title":"Operation Require Identifier","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-identifier/","source":"compiled","description":"Operation identifiers provide a unique way to identify each individual API, which then used for SDK generation and other automation.","message":"Operation MUST Have Identifier","severity":"info","given":"$.paths.*[get,post,patch,put,delete]","then":[{"field":"operationId","function":"truthy"}],"tags":["format:openapi","spec:paths","spec:operations","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-identifier' (Operation Require Identifier). Requirement: Operation identifiers provide a unique way to identify each individual API, which then used for SDK generation and other automation. To fix: Ensure `operationId` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-one-tag":{"title":"Operation Require One Tag","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-one-tag/","source":"compiled","description":"Having tags applied to each API operations helps organize and group APIs in portals, documentation, search, and other ways in which APIs are made available.","message":"MUST Be At Least One Operation Tag","severity":"info","given":"$.paths.*[get,post,patch,put,delete]","then":{"field":"tags","function":"length","functionOptions":{"min":1}},"tags":["format:openapi","spec:paths","spec:operations","experience:discoverability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-one-tag' (Operation Require One Tag). Requirement: Having tags applied to each API operations helps organize and group APIs in portals, documentation, search, and other ways in which APIs are made available. To fix: Ensure the length of `tags` is at least 1. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-response":{"title":"Operation Require Response","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-response/","source":"compiled","description":"Check if every request has their respective responses.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"trimble:check-for-response-in-every-request"},"tags":["format:openapi","spec:paths","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-response' (Operation Require Response). Requirement: Check if every request has their respective responses. This rule is evaluated at the JSONPath `$.paths.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-security":{"title":"Operation Require Security","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-security/","source":"compiled","description":"Check operation security is defined.","message":"Check operation security is defined.","severity":"info","given":"$.paths.*.*","then":{"field":"security","function":"truthy"},"tags":["owasp:api5","format:openapi","spec:paths","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-security' (Operation Require Security). Requirement: Check operation security is defined. To fix: Ensure `security` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-security-2":{"title":"Operation Require Security 2","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-security-2/","source":"compiled","description":"Each API operation should have a security definition referencing the central security scheme express for an OpenAPI.","message":"Operations MUST Have a Security Definition","severity":"info","given":"$.paths.*[get,post,patch,put,delete]","then":{"field":"security","function":"truthy"},"tags":["owasp:api5","format:openapi","spec:paths","spec:operations","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-security-2' (Operation Require Security 2). Requirement: Each API operation should have a security definition referencing the central security scheme express for an OpenAPI. To fix: Ensure `security` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-summary":{"title":"Operation Require Summary","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-summary/","source":"compiled","description":"Having short and intuitive summary for each API operation helps API consumers understand what is possible with each API request.","message":"Operation MUST Have a Summary","severity":"info","given":"$.paths.*[get,post,patch,put,delete]","then":[{"field":"summary","function":"truthy"}],"tags":["format:openapi","spec:paths","spec:operations","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-summary' (Operation Require Summary). Requirement: Having short and intuitive summary for each API operation helps API consumers understand what is possible with each API request. To fix: Ensure `summary` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-require-tag":{"title":"Operation Require Tag","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-require-tag/","source":"compiled","description":"Having tags applied to each API operations helps organize and group APIs in portals, documentation, search, and other ways in which APIs are made available.","message":"Operations MUST Have Tags","severity":"info","given":"$.paths.*[get,post,patch,put,delete]","then":[{"field":"tags","function":"truthy"}],"tags":["format:openapi","spec:paths","spec:operations","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-require-tag' (Operation Require Tag). Requirement: Having tags applied to each API operations helps organize and group APIs in portals, documentation, search, and other ways in which APIs are made available. To fix: Ensure `tags` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-security-use-defined-scheme":{"title":"Operation Security Use Defined Scheme","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-security-use-defined-scheme/","source":"compiled","description":"Check operation security uses a defined security scheme.","message":"Check operation security uses a defined security scheme.","severity":"info","given":"$.paths[*][*]..security.*","then":{"function":"schema","functionOptions":{"schema":{"anyOf":[{"required":["bearer_auth"]},{"required":["inference_bearer_auth"]}]}}},"tags":["owasp:api5","format:openapi","spec:security","spec:paths","experience:security","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-security-use-defined-scheme' (Operation Security Use Defined Scheme). Requirement: Check operation security uses a defined security scheme. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][*]..security.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-singular-tag":{"title":"Operation Singular Tag","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-singular-tag/","source":"builtin","description":"Operation must not have more than a single tag.","message":"Operation must not have more than a single tag.","severity":"info","given":"#OperationObject","then":{"field":"tags","function":"length","functionOptions":{"max":1}},"tags":["format:openapi","spec:document","experience:consistency","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-singular-tag' (Operation Singular Tag). Requirement: Operation must not have more than a single tag. To fix: Ensure the length of `tags` is at most 1. This rule is evaluated at the JSONPath `#OperationObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-success-response":{"title":"Operation Success Response","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-success-response/","source":"builtin","description":"Operation must have at least one \"2xx\" or \"3xx\" response.","message":"Operation must have at least one \"2xx\" or \"3xx\" response.","severity":"info","given":"#OperationObject","then":{"field":"responses","function":"oasOpSuccessResponse"},"tags":["format:openapi","spec:document","experience:error-handling","experience:reliability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-success-response' (Operation Success Response). Requirement: Operation must have at least one \"2xx\" or \"3xx\" response. This rule is evaluated at the JSONPath `#OperationObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-summary-description-differ":{"title":"Operation Summary Description Differ","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-summary-description-differ/","source":"compiled","description":"Operation summaries and description should not match.","message":"{{error}}","severity":"info","given":["$.paths[*].[get,post,put,patch,delete]"],"then":{"function":"trimble:operation-summary-description"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-summary-description-differ' (Operation Summary Description Differ). Requirement: Operation summaries and description should not match. This rule is evaluated at the JSONPath `$.paths[*].[get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-summary-max-length":{"title":"Operation Summary Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-summary-max-length/","severity":"info","source":"compiled","description":"Apply length constraints to the operation summary helps keep them consistent for publishing in documentation.","message":"Operation Summary MUST Be Less Than 50 Characters","given":"$.paths.*[get,post,patch,put,delete]","then":[{"field":"summary","function":"length","functionOptions":{"max":50}}],"tags":["format:openapi","spec:paths","spec:operations","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-summary-max-length' (Operation Summary Max Length). Requirement: Apply length constraints to the operation summary helps keep them consistent for publishing in documentation. To fix: Ensure the length of `summary` is at most 50. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-summary-no-period":{"title":"Operation Summary No Period","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-summary-no-period/","source":"compiled","description":"Operation summaries should not have a period, keeping the primary summary for each API as consistent as possible for publishing in documentation.","message":"Operation MUST Not Have a Period.","severity":"info","given":"$.paths[*][*].summary","then":{"function":"pattern","functionOptions":{"notMatch":"\\.$"}},"tags":["format:openapi","spec:paths","experience:consistency","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-summary-no-period' (Operation Summary No Period). Requirement: Operation summaries should not have a period, keeping the primary summary for each API as consistent as possible for publishing in documentation. To fix: Ensure the targeted value does NOT match the regular expression `\\.$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*][*].summary` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-tag-defined":{"title":"Operation Tag Defined","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-tag-defined/","source":"builtin","description":"Operation tags must be defined in global tags.","message":"Operation tags must be defined in global tags.","severity":"info","given":"$","then":{"function":"oasTagDefined"},"tags":["format:openapi","spec:document","experience:discoverability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-tag-defined' (Operation Tag Defined). Requirement: Operation tags must be defined in global tags. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-tag-title-case":{"title":"Operation Tag Title Case","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-tag-title-case/","source":"compiled","description":"Having the first letter of each word applied as a tag to API operations helps keep a consistent layout when published via search, documentation, and other ways APIs are made available.","message":"Operation Tag Names MUST Have First Letter in Each Word Capitalized","severity":"info","given":"$.paths.*[get,post,patch,put,delete].tags.*","then":{"function":"pattern","functionOptions":{"match":"[A-Z]\\w*"}},"tags":["format:openapi","spec:paths","spec:operations","spec:tags","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-tag-title-case' (Operation Tag Title Case). Requirement: Having the first letter of each word applied as a tag to API operations helps keep a consistent layout when published via search, documentation, and other ways APIs are made available. To fix: Ensure the targeted value matches the regular expression `[A-Z]\\w*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*[get,post,patch,put,delete].tags.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-tags":{"title":"Operation Tags","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-tags/","source":"builtin","description":"Operation must have non-empty \"tags\" array.","message":"Operation must have non-empty \"tags\" array.","severity":"info","given":"#OperationObject","then":{"field":"tags","function":"schema","functionOptions":{"dialect":"draft7","schema":{"type":"array","minItems":1}}},"tags":["format:openapi","spec:document","experience:discoverability","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-tags' (Operation Tags). Requirement: Operation must have non-empty \"tags\" array. To fix: Adjust `tags` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `#OperationObject` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-use-ref":{"title":"Operation Use Ref","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-use-ref/","source":"compiled","description":"Endpoint must be a $ref.","message":"{{description}}; {{property}} incorrect","severity":"info","given":"$.paths.*.*","then":{"field":"$ref","function":"truthy"},"tags":["format:openapi","spec:paths","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-use-ref' (Operation Use Ref). Requirement: Endpoint must be a $ref. To fix: Ensure `$ref` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-well-understood-status-codes":{"title":"Operation Well Understood Status Codes","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-well-understood-status-codes/","source":"compiled","description":"MUST use standard HTTP status codes [150].","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"baloise:assert-http-codes-for-operation","functionOptions":{"wellUnderstood":{"200":["ALL"],"201":["POST","PUT"],"202":["POST","PUT","DELETE","PATCH"],"204":["PUT","DELETE","PATCH"],"207":["POST"],"301":["ALL"],"303":["PATCH","POST","PUT","DELETE"],"304":["GET","HEAD"],"400":["ALL"],"401":["ALL"],"403":["ALL"],"404":["ALL"],"405":["ALL"],"406":["ALL"],"408":["ALL"],"409":["POST","PUT","DELETE","PATCH"],"410":["ALL"],"412":["PUT","DELETE","PATCH"],"415":["POST","PUT","DELETE","PATCH"],"422":["ALL"],"423":["PUT","DELETE","PATCH"],"428":["ALL"],"429":["ALL"],"500":["ALL"],"501":["ALL"],"503":["ALL"],"default":["ALL"]}}},"tags":["format:openapi","spec:paths","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-well-understood-status-codes' (Operation Well Understood Status Codes). Requirement: MUST use standard HTTP status codes [150]. This rule is evaluated at the JSONPath `$.paths.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-write-support-if-match":{"title":"Operation Write Support If Match","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-write-support-if-match/","source":"spotlight","description":"Write operations should accept an If-Match request header to enable optimistic concurrency / conditional writes.","message":"Operation should accept a `If-Match` request header.","given":"$.paths[*][put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name"],"properties":{"name":{"const":"If-Match"}}}}}},"tags":["format:openapi","spec:parameters","topic:conditional-requests","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-write-support-if-match' (Operation Write Support If Match). Requirement: Write operations should accept an If-Match request header to enable optimistic concurrency / conditional writes. To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `If-Match` request header. This rule is evaluated at the JSONPath `$.paths[*][put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"operation-write-support-if-unmodified-since":{"title":"Operation Write Support If Unmodified Since","reference":"https://spotlight-rules.com/spec/rules/openapi/operation-write-support-if-unmodified-since/","source":"spotlight","description":"Write operations should accept an If-Unmodified-Since request header to enable date-based optimistic concurrency / conditional writes.","message":"Operation should accept a `If-Unmodified-Since` request header.","given":"$.paths[*][put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name"],"properties":{"name":{"const":"If-Unmodified-Since"}}}}}},"tags":["format:openapi","spec:parameters","topic:conditional-requests","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'operation-write-support-if-unmodified-since' (Operation Write Support If Unmodified Since). Requirement: Write operations should accept an If-Unmodified-Since request header to enable date-based optimistic concurrency / conditional writes. To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `If-Unmodified-Since` request header. This rule is evaluated at the JSONPath `$.paths[*][put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-array-require-items":{"title":"Parameter Array Require Items","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-array-require-items/","source":"compiled","description":"Parameters that are of an array type should always have the items defined, being explicit about what is continued as part of the array.","message":"Parameter Schema Array MUST Have Items","severity":"info","given":"$.components.parameters.schema[?(@.type=='array')]","then":{"field":"items","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:schemas","spec:components","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-array-require-items' (Parameter Array Require Items). Requirement: Parameters that are of an array type should always have the items defined, being explicit about what is continued as part of the array. To fix: Ensure `items` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.schema[?(@.type=='array')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-array-typed-items":{"title":"Parameter Array Typed Items","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-array-typed-items/","source":"compiled","description":"Array parameters must have an items attribute with a type.","message":"{{error}}","severity":"info","given":"$..*.parameters[*]","then":{"function":"digitalocean:ensureAllArraysHaveItemTypes"},"tags":["format:openapi","spec:parameters","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-array-typed-items' (Parameter Array Typed Items). Requirement: Array parameters must have an items attribute with a type. This rule is evaluated at the JSONPath `$..*.parameters[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-avoid-integer-id":{"title":"Parameter Avoid Integer ID","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-avoid-integer-id/","source":"compiled","description":"Avoid exposing IDs as an integer, UUIDs or other interoperable strings are preferred.","message":"Avoid exposing IDs as an integer, UUIDs or other interoperable strings are preferred.","severity":"info","given":"$.paths..parameters[*].[?(@property === \"name\" && (@ === \"id\" || @ === \"ID\" || @ === \"Id\"))]^.schema","then":{"function":"schema","functionOptions":{"schema":{"type":"object","not":{"properties":{"type":{"const":"integer"}}},"properties":{"format":{"const":"uuid"}}}}},"tags":["format:openapi","spec:paths","spec:parameters","spec:schemas","experience:security","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-avoid-integer-id' (Parameter Avoid Integer ID). Requirement: Avoid exposing IDs as an integer, UUIDs or other interoperable strings are preferred. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths..parameters[*].[?(@property === \"name\" && (@ === \"id\" || @ === \"ID\" || @ === \"Id\"))]^.schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-collection-limit-param-default":{"title":"Parameter Collection Limit Param Default","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-collection-limit-param-default/","source":"spotlight","description":"The limit / page-size query parameter should declare a default so the page size is predictable when the caller omits it.","message":"limit parameter should declare a default.","given":"$.paths[*].get.parameters[?(@ && @.in == 'query' && (@.name == 'limit' || @.name == 'per_page' || @.name == 'page_size' || @.name == 'pageSize'))].schema","severity":"info","then":{"field":"default","function":"truthy"},"tags":["format:openapi","spec:parameters","topic:pagination","experience:pagination","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-collection-limit-param-default' (Parameter Collection Limit Param Default). Requirement: The limit / page-size query parameter should declare a default so the page size is predictable when the caller omits it. To fix: Ensure `default` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.parameters[?(@ && @.in == 'query' && (@.name == 'limit' || @.name == 'per_page' || @.name == 'page_size' || @.name == 'pageSize'))].schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-collection-limit-param-maximum":{"title":"Parameter Collection Limit Param Maximum","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-collection-limit-param-maximum/","source":"spotlight","description":"The limit / page-size query parameter should declare a maximum so a caller cannot request an unbounded page (OWASP API4 — unrestricted resource consumption).","message":"limit parameter should declare a maximum.","given":"$.paths[*].get.parameters[?(@ && @.in == 'query' && (@.name == 'limit' || @.name == 'per_page' || @.name == 'page_size' || @.name == 'pageSize'))].schema","severity":"info","then":{"field":"maximum","function":"truthy"},"tags":["format:openapi","spec:parameters","topic:pagination","experience:pagination","experience:reliability","experience:performance","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-collection-limit-param-maximum' (Parameter Collection Limit Param Maximum). Requirement: The limit / page-size query parameter should declare a maximum so a caller cannot request an unbounded page (OWASP API4 — unrestricted resource consumption). To fix: Ensure `maximum` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.parameters[?(@ && @.in == 'query' && (@.name == 'limit' || @.name == 'per_page' || @.name == 'page_size' || @.name == 'pageSize'))].schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-deprecated-require-description":{"title":"Parameter Deprecated Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-deprecated-require-description/","source":"spotlight","description":"Deprecated parameters should have a description explaining the deprecation and what to use instead.","message":"Deprecated parameter should describe the deprecation.","given":"$..parameters[?(@ && @.deprecated == true)]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:parameters","topic:deprecation","experience:versioning","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-deprecated-require-description' (Parameter Deprecated Require Description). Requirement: Deprecated parameters should have a description explaining the deprecation and what to use instead. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..parameters[?(@ && @.deprecated == true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-description-max-length":{"title":"Parameter Description Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-description-max-length/","severity":"info","source":"compiled","description":"Limiting the length of parameters description forces us to be more concise in how we describe each parameter, while keeping our documentation and other ways descriptions show up in discovery and portals more consistent.","message":"Parameters Description MUST Be Less Than 500 Characters","given":"$.components.parameters.*","then":{"field":"summary","function":"length","functionOptions":{"max":500}},"tags":["format:openapi","spec:parameters","spec:components","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-description-max-length' (Parameter Description Max Length). Requirement: Limiting the length of parameters description forces us to be more concise in how we describe each parameter, while keeping our documentation and other ways descriptions show up in discovery and portals more consistent. To fix: Ensure the length of `summary` is at most 500. This rule is evaluated at the JSONPath `$.components.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-enum-upper-snake-case":{"title":"Parameter Enum Upper Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-enum-upper-snake-case/","source":"compiled","description":"Keeping parameters enumerator casing consistent across APIs helps reduce confusion by consumers, and can keep aligned with services and applications putting an API to work.","message":"Parameters Enums MUST Must Be Upper Snake Case","severity":"info","given":"$.components.parameters.*.enum.*","then":{"function":"pattern","functionOptions":{"notMatch":"^[A-Z]+(?:_[A-Z]+)*$"}},"tags":["format:openapi","spec:parameters","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-enum-upper-snake-case' (Parameter Enum Upper Snake Case). Requirement: Keeping parameters enumerator casing consistent across APIs helps reduce confusion by consumers, and can keep aligned with services and applications putting an API to work. To fix: Ensure the targeted value does NOT match the regular expression `^[A-Z]+(?:_[A-Z]+)*$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.components.parameters.*.enum.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-filter-param-only-on-get":{"title":"Parameter Filter Param Only On Get","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-filter-param-only-on-get/","source":"compiled","description":"Only GET-based endpoints SHOULD have have the query parameter 'filter'.","message":"Only GET-based endpoints SHOULD have have the query parameter 'filter'.","severity":"info","given":"$.paths.*[?(@property!='get')].parameters.[?(@.in=='query' && @.name=='filter')].name","then":{"function":"falsy"},"tags":["format:openapi","spec:paths","spec:operations","spec:parameters","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-filter-param-only-on-get' (Parameter Filter Param Only On Get). Requirement: Only GET-based endpoints SHOULD have have the query parameter 'filter'. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.*[?(@property!='get')].parameters.[?(@.in=='query' && @.name=='filter')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-integer-require-maximum":{"title":"Parameter Integer Require Maximum","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-integer-require-maximum/","source":"compiled","description":"Parameters that are of the integer schema type must have their maximum value set, defining the shape of parameter data passed in with a request.","message":"Parameter Schema Type Integer Maximum","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":{"field":"maximum","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-integer-require-maximum' (Parameter Integer Require Maximum). Requirement: Parameters that are of the integer schema type must have their maximum value set, defining the shape of parameter data passed in with a request. To fix: Ensure `maximum` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-integer-require-minimum":{"title":"Parameter Integer Require Minimum","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-integer-require-minimum/","source":"compiled","description":"Parameters that are of the integer schema type must have their minimum value set, defining the shape of parameter data passed in with a request.","message":"Parameter Schema Type Integer Minimum","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":{"field":"minimum","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-integer-require-minimum' (Parameter Integer Require Minimum). Requirement: Parameters that are of the integer schema type must have their minimum value set, defining the shape of parameter data passed in with a request. To fix: Ensure `minimum` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-keys-snake-case":{"title":"Parameter Keys Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-keys-snake-case/","source":"compiled","description":"parameter key must be snake cased (e.g. snake_case).","message":"{{error}}","severity":"info","given":"$.components['parameters'].*~","then":{"function":"digitalocean:ensureSnakeCaseWithDigits"},"tags":["format:openapi","spec:parameters","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-keys-snake-case' (Parameter Keys Snake Case). Requirement: parameter key must be snake cased (e.g. snake_case). This rule is evaluated at the JSONPath `$.components['parameters'].*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-name-max-length":{"title":"Parameter Name Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-name-max-length/","severity":"info","source":"compiled","description":"Providing short and concise names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests.","message":"Parameters Name Length MUST Be Less Than 25 Characters","given":"$.components.parameters[?(@.in=='path')].name","then":{"field":"summary","function":"length","functionOptions":{"max":25}},"tags":["format:openapi","spec:parameters","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-name-max-length' (Parameter Name Max Length). Requirement: Providing short and concise names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests. To fix: Ensure the length of `summary` is at most 25. This rule is evaluated at the JSONPath `$.components.parameters[?(@.in=='path')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-names-camel-case":{"title":"Parameter Names Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-names-camel-case/","source":"compiled","description":"Providing parameters with consistent naming helps make it easier for API consumers to understand how they are able to configure their API requests.","message":"Parameters Names MUST Be Camel Case","severity":"info","given":"$.components.parameters.*","then":[{"field":"name","function":"pattern","functionOptions":{"notMatch":"^[a-z]+(?:[A-Z][a-z]+)*$"}},{"field":"name","function":"pattern","functionOptions":{"match":"^[A-Z](([a-z0-9]+[A-Z]?)*)$"}}],"tags":["format:openapi","spec:parameters","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-names-camel-case' (Parameter Names Camel Case). Requirement: Providing parameters with consistent naming helps make it easier for API consumers to understand how they are able to configure their API requests. To fix: Ensure `name` does NOT match the regular expression `^[a-z]+(?:[A-Z][a-z]+)*$`; rename or rewrite any value that does. Also: Ensure `name` matches the regular expression `^[A-Z](([a-z0-9]+[A-Z]?)*)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-no-api-keys-in-query":{"title":"Parameter No API Keys In Query","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-no-api-keys-in-query/","source":"compiled","description":"Query parameters MUST not contain sensitive information, like API tokens or keys.","message":"Query parameters MUST not contain sensitive information, like API tokens or keys.","severity":"info","given":"$.paths.*.*.parameters[?(@.in=='query')].name","then":{"function":"pattern","functionOptions":{"notMatch":"apiKey|token"}},"tags":["format:openapi","spec:paths","spec:parameters","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-no-api-keys-in-query' (Parameter No API Keys In Query). Requirement: Query parameters MUST not contain sensitive information, like API tokens or keys. To fix: Ensure the targeted value does NOT match the regular expression `apiKey|token`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*.*.parameters[?(@.in=='query')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-no-forbidden-http-header":{"title":"Parameter No Forbidden HTTP Header","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-no-forbidden-http-header/","source":"compiled","description":"OAS do not allow using the following HTTP headers in a specification file: Authorization, Content-Type and Accept. You MUST use the associate functionalities provided by OAS, instead.","message":"{{error}} in {{path}} {{value}}","severity":"info","given":["$..parameters[?(@.in == 'header')].name","$.[responses][*].headers.*~"],"then":{"function":"pattern","functionOptions":{"notMatch":"/^(accept|content-type|authorization)$/i"}},"tags":["format:openapi","spec:parameters","spec:responses","spec:headers","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-no-forbidden-http-header' (Parameter No Forbidden HTTP Header). Requirement: OAS do not allow using the following HTTP headers in a specification file: Authorization, Content-Type and Accept. You MUST use the associate functionalities provided by OAS, instead. To fix: Ensure the targeted value does NOT match the regular expression `/^(accept|content-type|authorization)$/i`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'header')].name | $.[responses][*].headers.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-no-hybrid-and-root-filtering":{"title":"Parameter No Hybrid And Root Filtering","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-no-hybrid-and-root-filtering/","source":"compiled","description":"Hybrid filtering MAY be offered on multiple attributes, but MUST never exist if a root \"filter\" query parameter is present.","message":"Hybrid filtering MAY be offered on multiple attributes, but MUST never exist if a root \"filter\" query parameter is present.","severity":"info","given":"$.paths..get.parameters^","then":{"function":"schema","functionOptions":{"schema":{"type":"object","properties":{"parameters":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"in":{"type":"string"}}}}},"allOf":[{"if":{"properties":{"parameters":{"type":"array","contains":{"type":"object","properties":{"name":{"const":"filter"}}}}}},"then":{"not":{"properties":{"parameters":{"type":"array","contains":{"type":"object","properties":{"name":{"type":"string","pattern":"\\w+Filter"}}}}}}}}]}}},"tags":["format:openapi","spec:paths","spec:operations","spec:parameters","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-no-hybrid-and-root-filtering' (Parameter No Hybrid And Root Filtering). Requirement: Hybrid filtering MAY be offered on multiple attributes, but MUST never exist if a root \"filter\" query parameter is present. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths..get.parameters^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-no-id-query":{"title":"Parameter No ID Query","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-no-id-query/","source":"compiled","description":"Resource identifier filtering is not allowed as a query parameter. Use the resource identifier in the URL path.","message":"Resource identifier filtering is not allowed as a query parameter.","severity":"info","given":"$.paths..get.parameters.[?(@.in=='query' && @.name=='id')]","then":{"field":"name","function":"pattern","functionOptions":{"notMatch":"^id$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:parameters","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-no-id-query' (Parameter No ID Query). Requirement: Resource identifier filtering is not allowed as a query parameter. Use the resource identifier in the URL path. To fix: Ensure `name` does NOT match the regular expression `^id$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths..get.parameters.[?(@.in=='query' && @.name=='id')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-no-x-prefixed-request-header":{"title":"Parameter No X Prefixed Request Header","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-no-x-prefixed-request-header/","source":"compiled","description":"Do not use headers with X-.","message":"Headers cannot start with X-. More: https://tools.ietf.org/html/rfc6648","severity":"info","given":"$..parameters.[?(@.in === 'header')].name","then":{"function":"pattern","functionOptions":{"notMatch":"^(x|X)-"}},"tags":["format:openapi","spec:parameters","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-no-x-prefixed-request-header' (Parameter No X Prefixed Request Header). Requirement: Do not use headers with X-. To fix: Ensure the targeted value does NOT match the regular expression `^(x|X)-`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..parameters.[?(@.in === 'header')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-optional-include-examples":{"title":"Parameter Optional Include Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-optional-include-examples/","source":"compiled","description":"Optional param should have examples.","message":"Optional param should have examples","severity":"info","given":"$..parameters[?(@ && @.required != true)]","then":{"field":"examples","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:parameters","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-optional-include-examples' (Parameter Optional Include Examples). Requirement: Optional param should have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..parameters[?(@ && @.required != true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-owasp-api1-no-numeric-ids":{"title":"Parameter OWASP API1 No Numeric IDs","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-owasp-api1-no-numeric-ids/","source":"spotlight","description":"Path parameters should not be sequential integers (BOLA / object enumeration, OWASP API1) — use a non-guessable identifier such as a UUID.","message":"Path parameter should not be an integer (use a non-enumerable id, e.g. UUID).","given":"$.paths[*][*].parameters[?(@ && @.in == 'path')].schema","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"object","properties":{"type":{"not":{"enum":["integer","number"]}}}}}},"tags":["format:openapi","spec:parameters","experience:security","owasp:api1"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-owasp-api1-no-numeric-ids' (Parameter OWASP API1 No Numeric IDs). Requirement: Path parameters should not be sequential integers (BOLA / object enumeration, OWASP API1) — use a non-guessable identifier such as a UUID. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][*].parameters[?(@ && @.in == 'path')].schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-pagination-params-in-query":{"title":"Parameter Pagination Params In Query","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-pagination-params-in-query/","source":"compiled","description":"Pagination parameters like page, limit, offset, and cursor should be passed as query parameters, not in headers or path segments. Analysis confirms 100% of pagination parameters observed are query parameters.","message":"Pagination Parameters MUST Be Query Parameters","severity":"info","given":"$.paths[*].get.parameters[?(@.name == 'page' || @.name == 'limit' || @.name == 'offset' || @.name == 'cursor' || @.name == 'per_page' || @.name == 'page_size')]","then":{"field":"in","function":"pattern","functionOptions":{"match":"query"}},"tags":["format:openapi","spec:paths","spec:operations","spec:parameters","topic:pagination","experience:pagination","experience:consistency","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-pagination-params-in-query' (Parameter Pagination Params In Query). Requirement: Pagination parameters like page, limit, offset, and cursor should be passed as query parameters, not in headers or path segments. Analysis confirms 100% of pagination parameters observed are query parameters. To fix: Ensure `in` matches the regular expression `query`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*].get.parameters[?(@.name == 'page' || @.name == 'limit' || @.name == 'offset' || @.name == 'cursor' || @.name == 'per_page' || @.name == 'page_size')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-query-allowed-characters":{"title":"Parameter Query Allowed Characters","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-query-allowed-characters/","source":"compiled","description":"Query parameter keys MUST include only alpha-numeric characters and periods: [Aa0-Zz9]'.","message":"Query parameter keys MUST include only alpha-numeric characters and periods: [Aa0-Zz9]'.","severity":"info","given":"$.paths.*.*.parameters[?(@.in=='query')].name","then":{"function":"pattern","functionOptions":{"match":"^[A-Za-z0-9\\.]+$"}},"tags":["format:openapi","spec:paths","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-query-allowed-characters' (Parameter Query Allowed Characters). Requirement: Query parameter keys MUST include only alpha-numeric characters and periods: [Aa0-Zz9]'. To fix: Ensure the targeted value matches the regular expression `^[A-Za-z0-9\\.]+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*.*.parameters[?(@.in=='query')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-query-camel-case":{"title":"Parameter Query Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-query-camel-case/","source":"compiled","description":"MUST query parameter names must be ASCII camelCase [130a].","message":"Query parameter name has to be ASCII camelCase","severity":"info","given":"$.paths.*.*.parameters[?(@ && @.in=='query')].name","then":{"function":"pattern","functionOptions":{"match":"^[a-z]+((\\d)|([A-Z0-9][a-z0-9]+))*([A-Z])?$"}},"tags":["format:openapi","spec:paths","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-query-camel-case' (Parameter Query Camel Case). Requirement: MUST query parameter names must be ASCII camelCase [130a]. To fix: Ensure the targeted value matches the regular expression `^[a-z]+((\\d)|([A-Z0-9][a-z0-9]+))*([A-Z])?$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*.*.parameters[?(@ && @.in=='query')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-query-must-be-optional":{"title":"Parameter Query Must Be Optional","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-query-must-be-optional/","source":"compiled","description":"Query parameters MUST be optional.","message":"Query parameters MUST be optional.","severity":"info","given":"$.paths.*.*.parameters[?(@.in=='query')].required","then":{"function":"falsy"},"tags":["format:openapi","spec:paths","spec:parameters","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-query-must-be-optional' (Parameter Query Must Be Optional). Requirement: Query parameters MUST be optional. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.*.*.parameters[?(@.in=='query')].required` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-require-description":{"title":"Parameter Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-require-description/","severity":"info","source":"compiled","description":"Having a parameters description provides more depth to what a parameter does and will be displayed via documentation, and other tooling used across the API lifecycle.","message":"Parameters MUST Have a Description","given":"$.paths.*.*.parameters.*","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:paths","spec:parameters","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-require-description' (Parameter Require Description). Requirement: Having a parameters description provides more depth to what a parameter does and will be displayed via documentation, and other tooling used across the API lifecycle. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.*.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-require-examples":{"title":"Parameter Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-require-examples/","source":"compiled","description":"Parameters must include examples.","message":"{{description}}; missing {{property}}","severity":"info","given":"$..parameters.*","then":{"function":"xor","functionOptions":{"properties":["example","examples"]}},"tags":["format:openapi","spec:parameters","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-require-examples' (Parameter Require Examples). Requirement: Parameters must include examples. To fix: Include exactly one of: example, examples. This rule is evaluated at the JSONPath `$..parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-require-in":{"title":"Parameter Require In","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-require-in/","severity":"info","source":"compiled","description":"Providing an in property for parameters gets explicit about whether a parameter is in the path, query, or a header, making it clear to consumers where they can configure their request.","message":"Parameters In Property MUST Be Set","given":"$.components.parameters.*","then":{"field":"in","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:components","experience:data-modeling","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-require-in' (Parameter Require In). Requirement: Providing an in property for parameters gets explicit about whether a parameter is in the path, query, or a header, making it clear to consumers where they can configure their request. To fix: Ensure `in` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-require-name":{"title":"Parameter Require Name","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-require-name/","source":"compiled","description":"Providing a simple, intuitive, and consistent names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests.","message":"Parameters MUST Have a Name","severity":"info","given":"$.components.parameters.*","then":{"field":"name","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:components","experience:naming","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-require-name' (Parameter Require Name). Requirement: Providing a simple, intuitive, and consistent names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-require-required-flag":{"title":"Parameter Require Required Flag","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-require-required-flag/","source":"compiled","description":"Providrequiredg an required property for parameters gets explicit about whether a parameter is required the path, query, or a header, making it clear to consumers where they can configure their request.","message":"Parameters Required Property MUST Be Set","severity":"info","given":"$.components.parameters.*","then":{"field":"required","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:components","experience:data-modeling","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-require-required-flag' (Parameter Require Required Flag). Requirement: Providrequiredg an required property for parameters gets explicit about whether a parameter is required the path, query, or a header, making it clear to consumers where they can configure their request. To fix: Ensure `required` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-require-schema":{"title":"Parameter Require Schema","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-require-schema/","severity":"info","source":"compiled","description":"Parameters must always possess a schema to help define the format and shape of the parameter, setting expections with consumers about what should be passed in.","message":"Parameters MUST Have Schema","given":"$.components.parameters.*","then":{"field":"schema","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:components","experience:data-modeling","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-require-schema' (Parameter Require Schema). Requirement: Parameters must always possess a schema to help define the format and shape of the parameter, setting expections with consumers about what should be passed in. To fix: Ensure `schema` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-required-require-examples":{"title":"Parameter Required Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-required-require-examples/","source":"compiled","description":"Required param must have examples.","message":"Required param must have examples","severity":"info","given":"$..parameters[?(@ && @.required == true)]","then":{"field":"examples","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:parameters","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-required-require-examples' (Parameter Required Require Examples). Requirement: Required param must have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..parameters[?(@ && @.required == true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-schema-require-type":{"title":"Parameter Schema Require Type","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-schema-require-type/","source":"compiled","description":"Parameters must always have their schema type defined, being precise about what type of data can be inputted and used to configure an API request.","message":"Parameter Schema Type","severity":"info","given":"$.components.parameters.*.schema","then":{"field":"type","function":"truthy"},"tags":["format:openapi","spec:parameters","spec:schemas","spec:components","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-schema-require-type' (Parameter Schema Require Type). Requirement: Parameters must always have their schema type defined, being precise about what type of data can be inputted and used to configure an API request. To fix: Ensure `type` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.*.schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-schema-use-ref":{"title":"Parameter Schema Use Ref","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-schema-use-ref/","source":"compiled","description":"Parameters must always use a schema reference that utilizes reusable schema that are defined as part of a centralized schema components library.","message":"Parameters MUST Use Schema Reference","severity":"info","given":"$.components.parameters.*.schema","then":{"field":"$ref","function":"falsy"},"tags":["format:openapi","spec:parameters","spec:schemas","spec:components","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-schema-use-ref' (Parameter Schema Use Ref). Requirement: Parameters must always use a schema reference that utilizes reusable schema that are defined as part of a centralized schema components library. To fix: Ensure `$ref` is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.*.schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-sort-param-only-on-get":{"title":"Parameter Sort Param Only On Get","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-sort-param-only-on-get/","source":"compiled","description":"Non-GET endpoints MUST NOT have sorting query parameters. Parameter names such as sort, sorting, orderBy, etc.","message":"Non-GET endpoints MUST NOT have sorting query parameters.","severity":"info","given":"$.paths.*[?(@property!='get')].parameters.[?(@.in=='query')]","then":{"field":"name","function":"pattern","functionOptions":{"notMatch":"^sort|sorting|sortBy|order|ordering|orderBy$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:parameters","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-sort-param-only-on-get' (Parameter Sort Param Only On Get). Requirement: Non-GET endpoints MUST NOT have sorting query parameters. Parameter names such as sort, sorting, orderBy, etc. To fix: Ensure `name` does NOT match the regular expression `^sort|sorting|sortBy|order|ordering|orderBy$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*[?(@property!='get')].parameters.[?(@.in=='query')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-string-require-max-length":{"title":"Parameter String Require Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-string-require-max-length/","source":"compiled","description":"Parameters that are of the string schema type must have their maximum value set, defining the shape of parameter data passed in with a request.","message":"Parameter Schema Type String MaxLength","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":{"field":"maxLength","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-string-require-max-length' (Parameter String Require Max Length). Requirement: Parameters that are of the string schema type must have their maximum value set, defining the shape of parameter data passed in with a request. To fix: Ensure `maxLength` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-string-require-min-length":{"title":"Parameter String Require Min Length","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-string-require-min-length/","source":"compiled","description":"Parameters that are of the string schema type must have their minimum value set, defining the shape of parameter data passed in with a request.","message":"Parameter Schema Type String MinLength","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":{"field":"minLength","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-string-require-min-length' (Parameter String Require Min Length). Requirement: Parameters that are of the string schema type must have their minimum value set, defining the shape of parameter data passed in with a request. To fix: Ensure `minLength` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"parameter-string-require-pattern":{"title":"Parameter String Require Pattern","reference":"https://spotlight-rules.com/spec/rules/openapi/parameter-string-require-pattern/","source":"compiled","description":"Parameters that are of the string schema type must have a pattern set, using a regex to define the shape of parameter data passed in with a request.","message":"Parameter Schema Type String Pattern","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":{"field":"pattern","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'parameter-string-require-pattern' (Parameter String Require Pattern). Requirement: Parameters that are of the string schema type must have a pattern set, using a regex to define the shape of parameter data passed in with a request. To fix: Ensure `pattern` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-cors-support-options-preflight":{"title":"Path CORS Support Options Preflight","reference":"https://spotlight-rules.com/spec/rules/openapi/path-cors-support-options-preflight/","source":"spotlight","description":"Resources should expose an OPTIONS operation so browsers can complete a CORS preflight. (Many teams handle preflight at the gateway and treat CORS as operational — enable this only if you document CORS in the spec.).","message":"Path should expose an OPTIONS operation for CORS preflight.","given":"$.paths[*]","severity":"info","then":{"field":"options","function":"truthy"},"tags":["format:openapi","spec:paths","topic:cors","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-cors-support-options-preflight' (Path CORS Support Options Preflight). Requirement: Resources should expose an OPTIONS operation so browsers can complete a CORS preflight. (Many teams handle preflight at the gateway and treat CORS as operational — enable this only if you document CORS in the spec.). To fix: Ensure `options` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-declarations-must-exist":{"title":"Path Declarations Must Exist","reference":"https://spotlight-rules.com/spec/rules/openapi/path-declarations-must-exist/","description":"Path Declarations Must Exist.","source":"builtin","message":"Path parameter declarations must not be empty, ex.\"/given/{}\" is invalid.","severity":"info","given":"$.paths","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"{}"}},"tags":["format:openapi","spec:paths","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-declarations-must-exist' (Path Declarations Must Exist). Requirement: Path Declarations Must Exist. To fix: Ensure `@key` does NOT match the regular expression `{}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-delete-no-response-body":{"title":"Path Delete No Response Body","reference":"https://spotlight-rules.com/spec/rules/openapi/path-delete-no-response-body/","source":"compiled","description":"Check if the delete response does not have any body.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"trimble:delete-must-not-return-body"},"tags":["format:openapi","spec:paths","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-delete-no-response-body' (Path Delete No Response Body). Requirement: Check if the delete response does not have any body. This rule is evaluated at the JSONPath `$.paths.*.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-get-response-support-json":{"title":"Path Get Response Support JSON","reference":"https://spotlight-rules.com/spec/rules/openapi/path-get-response-support-json/","source":"compiled","description":"All APIs returning structured data SHOULD support JSON as the default format.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"trimble:check-if-response-body-json-in-get-response"},"tags":["format:openapi","spec:paths","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-get-response-support-json' (Path Get Response Support JSON). Requirement: All APIs returning structured data SHOULD support JSON as the default format. This rule is evaluated at the JSONPath `$.paths.*.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-include-version":{"title":"Path Include Version","reference":"https://spotlight-rules.com/spec/rules/openapi/path-include-version/","source":"compiled","description":"Path must include the version.","message":"{{description}}; {{property}} incorrect","severity":"info","given":"$.paths[?(@property!='/<upload_url>')]~","then":{"function":"pattern","functionOptions":{"match":"^(/v[12]/.*|/api/v[12]/.*)$"}},"tags":["format:openapi","spec:paths","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-include-version' (Path Include Version). Requirement: Path must include the version. To fix: Ensure the targeted value matches the regular expression `^(/v[12]/.*|/api/v[12]/.*)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[?(@property!='/<upload_url>')]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-keys-no-trailing-slash":{"title":"Path Keys No Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/openapi/path-keys-no-trailing-slash/","description":"Path Keys No Trailing Slash.","source":"builtin","message":"Path must not end with slash.","severity":"info","given":"$.paths","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":".+\\/$"}},"tags":["format:openapi","spec:paths","experience:consistency","experience:naming"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-keys-no-trailing-slash' (Path Keys No Trailing Slash). Requirement: Path Keys No Trailing Slash. To fix: Ensure `@key` does NOT match the regular expression `.+\\/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-max-nesting-depth":{"title":"Path Max Nesting Depth","reference":"https://spotlight-rules.com/spec/rules/openapi/path-max-nesting-depth/","source":"compiled","description":"API paths should not exceed 4 levels of nesting depth. Analysis of 6627 paths across 773 specs shows an average depth of 3.04 segments, with deeper paths indicating overly complex resource hierarchies.","message":"Path Nesting MUST NOT Exceed 4 Levels","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"notMatch":"^(/[^/]+){5,}"}},"tags":["format:openapi","spec:paths","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-max-nesting-depth' (Path Max Nesting Depth). Requirement: API paths should not exceed 4 levels of nesting depth. Analysis of 6627 paths across 773 specs shows an average depth of 3.04 segments, with deeper paths indicating overly complex resource hierarchies. To fix: Ensure the targeted value does NOT match the regular expression `^(/[^/]+){5,}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-api-prefix-in":{"title":"Path No API Prefix In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-api-prefix-in/","source":"compiled","description":"A resource SHOULD NOT contain 'api' as a prefix in or a part of the path.","message":"A resource SHOULD NOT contain 'api' as a prefix in or a part of the path.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"/api|/api/|-api/"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-api-prefix-in' (Path No API Prefix In). Requirement: A resource SHOULD NOT contain 'api' as a prefix in or a part of the path. To fix: Ensure the targeted value does NOT match the regular expression `/api|/api/|-api/`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-empty-segment":{"title":"Path No Empty Segment","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-empty-segment/","source":"compiled","description":"A resource MUST use normalized paths without empty path segments.","message":"A resource MUST use normalized paths without empty path segments.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"//"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-empty-segment' (Path No Empty Segment). Requirement: A resource MUST use normalized paths without empty path segments. To fix: Ensure the targeted value does NOT match the regular expression `//`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-environment-names-in":{"title":"Path No Environment Names In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-environment-names-in/","source":"compiled","description":"API paths MUST NOT indicate environment names.","message":"API paths MUST NOT indicate environment names.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"/prod/|/preprod/|/dev/|/test/|/integration/|/stage/"}},"tags":["format:openapi","spec:paths","experience:naming","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-environment-names-in' (Path No Environment Names In). Requirement: API paths MUST NOT indicate environment names. To fix: Ensure the targeted value does NOT match the regular expression `/prod/|/preprod/|/dev/|/test/|/integration/|/stage/`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-file-extension-in":{"title":"Path No File Extension In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-file-extension-in/","source":"compiled","description":"A resource SHOULD NOT make use of an extension at any point in the path.","message":"A resource SHOULD NOT make use of an extension at any point in the path.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"\\."}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-file-extension-in' (Path No File Extension In). Requirement: A resource SHOULD NOT make use of an extension at any point in the path. To fix: Ensure the targeted value does NOT match the regular expression `\\.`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-file-extensions":{"title":"Path No File Extensions","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-file-extensions/","source":"compiled","description":"API paths should not include file extensions like .json or .xml. Content negotiation should be handled through Accept headers rather than path suffixes.","message":"Paths MUST NOT Contain File Extensions","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"notMatch":"\\.(json|xml|html|yaml|yml|csv|pdf)$"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-file-extensions' (Path No File Extensions). Requirement: API paths should not include file extensions like .json or .xml. Content negotiation should be handled through Accept headers rather than path suffixes. To fix: Ensure the targeted value does NOT match the regular expression `\\.(json|xml|html|yaml|yml|csv|pdf)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-format-extensions-in":{"title":"Path No Format Extensions In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-format-extensions-in/","source":"compiled","description":"Request and Response media type formats MUST NOT be implied using extensions on resources (i.e. .json or .xml). Instead, use the standard resource path with the appropriate Content-Type header.","message":"Request and Response media type formats MUST NOT be implied using extensions on resources (i.e.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"\\.json|\\.xml|\\.yml|\\.yaml"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-format-extensions-in' (Path No Format Extensions In). Requirement: Request and Response media type formats MUST NOT be implied using extensions on resources (i.e. .json or .xml). Instead, use the standard resource path with the appropriate Content-Type header. To fix: Ensure the targeted value does NOT match the regular expression `\\.json|\\.xml|\\.yml|\\.yaml`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-http-method-names":{"title":"Path No HTTP Method Names","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-http-method-names/","source":"compiled","description":"When you design a REST API, you don't usually need to mention terms like `get`, `delete` and so on in your `paths`, because this information is conveyed by the HTTP method. Instead of using ``` POST /books/1234/delete HTTP/1.1 Host: api.example ``` You can simply call ``` DELETE /books/1234 HTTP/1.1 Host: api.example ``` Similarly you don't need verbs like `list` or `create` because the HTTP Semantics RFC7231 supports this kind of actions natively with proper methods and status code. Instead of ``` POST /create/user HTTP/1.1 Host: api.example Content-Type: application/json {\"given_name\": \"Mario\"} ``` You can use ``` POST /create/user HTTP/1.1 Host: api.example Content-Type: application/json {\"given_name\": \"Mario\"} ``` returning a proper response ``` HTTP/1.1 201 Created Location: /users/1234 ``` This simplifies securing your API as you know beforehand the kind of action which is going to be performed.","message":"API \"path\" contains a name of an http method. {{error}}","severity":"info","given":["$.paths[?(@property.match( /\\/(get|post|put|delete|patch)[\\/A-Z_\\-]?/ ))]~","$.paths[?(@property.match( /\\/(create|remove|list)[\\/A-Z_\\-]?/ ))]~"],"then":{"field":"@key","function":"undefined"},"tags":["format:openapi","spec:paths","spec:operations","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-http-method-names' (Path No HTTP Method Names). Requirement: When you design a REST API, you don't usually need to mention terms like `get`, `delete` and so on in your `paths`, because this information is conveyed by the HTTP method. Instead of using ``` POST /books/1234/delete HTTP/1.1 Host: api.example ``` You can simply call ``` DELETE /books/1234 HTTP/1.1 Host: api.example ``` Similarly you don't need verbs like `list` or `create` because the HTTP Semantics RFC7231 supports this kind of actions natively with proper methods and status code. Instead of ``` POST /create/user HTTP/1.1 Host: api.example Content-Type: application/json {\"given_name\": \"Mario\"} ``` You can use ``` POST /create/user HTTP/1.1 Host: api.example Content-Type: application/json {\"given_name\": \"Mario\"} ``` returning a proper response ``` HTTP/1.1 201 Created Location: /users/1234 ``` This simplifies securing your API as you know beforehand the kind of action which is going to be performed. To fix: Remove `@key` from each matching location. This rule is evaluated at the JSONPath `$.paths[?(@property.match( /\\/(get|post|put|delete|patch)[\\/A-Z_\\-]?/ ))]~ | $.paths[?(@property.match( /\\/(create|remove|list)[\\/A-Z_\\-]?/ ))]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-http-methods-in":{"title":"Path No HTTP Methods In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-http-methods-in/","source":"compiled","description":"A resource SHOULD NOT contain HTTP methods.","message":"A resource SHOULD NOT contain HTTP methods.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"(\\/get|\\/post|\\/put|\\/delete|\\/patch)"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-http-methods-in' (Path No HTTP Methods In). Requirement: A resource SHOULD NOT contain HTTP methods. To fix: Ensure the targeted value does NOT match the regular expression `(\\/get|\\/post|\\/put|\\/delete|\\/patch)`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-http-verbs":{"title":"Path No HTTP Verbs","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-http-verbs/","severity":"info","source":"compiled","description":"HTTP verbs should be not be in URL paths.","message":"{{property}} has HTTP verb in path: {{error}}","given":"$.paths[*]~","then":{"function":"trimble:no-http-verbs-in-path"},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-http-verbs' (Path No HTTP Verbs). Requirement: HTTP verbs should be not be in URL paths. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-invalid-symbols":{"title":"Path No Invalid Symbols","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-invalid-symbols/","source":"compiled","description":"Check if the given endpoint has queryparameter.","message":"{{error}}","severity":"info","given":"$.paths[*]~","then":{"function":"trimble:invalid-symbol-in-path"},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-invalid-symbols' (Path No Invalid Symbols). Requirement: Check if the given endpoint has queryparameter. This rule is evaluated at the JSONPath `$.paths.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-query-string":{"title":"Path No Query String","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-query-string/","source":"compiled","description":"Path must not include query string.","message":"Path must not include query string.","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"notMatch":"\\?"}},"formats":["oas3","oas3_1"],"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-query-string' (Path No Query String). Requirement: Path must not include query string. To fix: Ensure the targeted value does NOT match the regular expression `\\?`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-query-strings-in":{"title":"Path No Query Strings In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-query-strings-in/","source":"compiled","description":"Paths SHOULD NOT have query parameters in them. They should be defined separately in the OpenAPI.","message":"Paths SHOULD NOT have query parameters in them. They should be defined separately in the OpenAPI.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"\\?"}},"tags":["format:openapi","spec:paths","experience:consistency","experience:naming"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-query-strings-in' (Path No Query Strings In). Requirement: Paths SHOULD NOT have query parameters in them. They should be defined separately in the OpenAPI. To fix: Ensure the targeted value does NOT match the regular expression `\\?`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-technology-leak-in":{"title":"Path No Technology Leak In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-technology-leak-in/","source":"compiled","description":"A resource MUST NOT leak or expose format or technology-specific information at any point in the path.","message":"A resource MUST NOT leak or expose format or technology-specific information at any point in the path.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"(.php|.asp|.jsp|.cgi|.psp|.json|.xml)"}},"tags":["format:openapi","spec:paths","experience:security","experience:naming"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-technology-leak-in' (Path No Technology Leak In). Requirement: A resource MUST NOT leak or expose format or technology-specific information at any point in the path. To fix: Ensure the targeted value does NOT match the regular expression `(.php|.asp|.jsp|.cgi|.psp|.json|.xml)`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-trailing-slash":{"title":"Path No Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-trailing-slash/","source":"compiled","description":"Path must not end with a slash.","message":"Path must not end with a slash.","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"notMatch":".+\\/$"}},"formats":["oas3","oas3_1"],"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-trailing-slash' (Path No Trailing Slash). Requirement: Path must not end with a slash. To fix: Ensure the targeted value does NOT match the regular expression `.+\\/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-trailing-slash-in":{"title":"Path No Trailing Slash In","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-trailing-slash-in/","source":"compiled","description":"A resource MUST be addressable without a trailing slash on the path.","message":"A resource MUST be addressable without a trailing slash on the path.","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"notMatch":"/$"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-trailing-slash-in' (Path No Trailing Slash In). Requirement: A resource MUST be addressable without a trailing slash on the path. To fix: Ensure the targeted value does NOT match the regular expression `/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-verbs":{"title":"Path No Verbs","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-verbs/","source":"compiled","description":"API paths MUST be resource-focused and MUST NOT include verbs like 'get', 'update', 'create', or 'delete'.","message":"Path '{{path}}' includes a verb (e.g., 'get', 'update', 'create', 'delete'). API paths SHOULD be resource-focused.","severity":"info","given":"$.paths[*]~","then":{"function":"pattern","functionOptions":{"notMatch":"/\\b(get|update|create|delete|fetch|retrieve)\\b/"}},"formats":["oas3"],"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-verbs' (Path No Verbs). Requirement: API paths MUST be resource-focused and MUST NOT include verbs like 'get', 'update', 'create', or 'delete'. To fix: Ensure the targeted value does NOT match the regular expression `/\\b(get|update|create|delete|fetch|retrieve)\\b/`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-version-segment":{"title":"Path No Version Segment","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-version-segment/","source":"compiled","description":"API paths should not contain version numbers like v1 or v2. API versioning should be handled through headers, query parameters, or server URLs rather than embedded in resource paths.","message":"Paths MUST NOT Contain API Version","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"notMatch":"/v[0-9]"}},"tags":["format:openapi","spec:paths","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-version-segment' (Path No Version Segment). Requirement: API paths should not contain version numbers like v1 or v2. API versioning should be handled through headers, query parameters, or server URLs rather than embedded in resource paths. To fix: Ensure the targeted value does NOT match the regular expression `/v[0-9]`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-no-x-prefixed-response-header":{"title":"Path No X Prefixed Response Header","reference":"https://spotlight-rules.com/spec/rules/openapi/path-no-x-prefixed-response-header/","source":"compiled","description":"Do not use headers with X-.","message":"Headers cannot start with X-, so please find a new name for {{property}}. More: https://tools.ietf.org/html/rfc6648","severity":"info","given":"$..headers.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^(x|X)-"}},"tags":["format:openapi","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-no-x-prefixed-response-header' (Path No X Prefixed Response Header). Requirement: Do not use headers with X-. To fix: Ensure the targeted value does NOT match the regular expression `^(x|X)-`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..headers.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-not-include-query":{"title":"Path Not Include Query","reference":"https://spotlight-rules.com/spec/rules/openapi/path-not-include-query/","source":"builtin","description":"Path must not include query string.","message":"Path must not include query string.","severity":"info","given":"$.paths","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"\\?"}},"tags":["format:openapi","spec:paths","experience:consistency","experience:naming"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-not-include-query' (Path Not Include Query). Requirement: Path must not include query string. To fix: Ensure `@key` does NOT match the regular expression `\\?`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-parameter-camel-case":{"title":"Path Parameter Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/path-parameter-camel-case/","source":"compiled","description":"Path parameters MUST follow camelCase.","message":"{{property}} path parameter is not camelCase: {{error}}","severity":"info","given":"$..parameters[?(@.in == 'path')].name","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-zA-Z0-9]+$"}},"tags":["format:openapi","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-parameter-camel-case' (Path Parameter Camel Case). Requirement: Path parameters MUST follow camelCase. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-zA-Z0-9]+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'path')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-parameter-constant-case":{"title":"Path Parameter Constant Case","reference":"https://spotlight-rules.com/spec/rules/openapi/path-parameter-constant-case/","source":"default","description":"Path parameters MUST follow CONSTANT_CASE (screaming snake_case).","message":"{{property}} path parameter is not CONSTANT_CASE: {{error}}","severity":"info","given":"$..parameters[?(@.in == 'path')].name","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"}},"tags":["format:openapi","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-parameter-constant-case' (Path Parameter Constant Case). Requirement: Path parameters MUST follow CONSTANT_CASE (screaming snake_case). To fix: Ensure the targeted value matches the regular expression `^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'path')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-parameter-kebab-case":{"title":"Path Parameter Kebab Case","reference":"https://spotlight-rules.com/spec/rules/openapi/path-parameter-kebab-case/","source":"default","description":"Path parameters MUST follow kebab-case.","message":"{{property}} path parameter is not kebab-case: {{error}}","severity":"info","given":"$..parameters[?(@.in == 'path')].name","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(-[a-z0-9]+)*$"}},"tags":["format:openapi","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-parameter-kebab-case' (Path Parameter Kebab Case). Requirement: Path parameters MUST follow kebab-case. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(-[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'path')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-parameter-not-empty":{"title":"Path Parameter Not Empty","reference":"https://spotlight-rules.com/spec/rules/openapi/path-parameter-not-empty/","source":"compiled","description":"Path parameter declarations must not be empty ex. `/api/{}` is invalid.","message":"Path parameter declarations must not be empty ex.","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"notMatch":"{}"}},"formats":["oas3","oas3_1"],"tags":["format:openapi","spec:paths","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-parameter-not-empty' (Path Parameter Not Empty). Requirement: Path parameter declarations must not be empty ex. `/api/{}` is invalid. To fix: Ensure the targeted value does NOT match the regular expression `{}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-parameter-pascal-case":{"title":"Path Parameter Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/path-parameter-pascal-case/","source":"default","description":"Path parameters MUST follow PascalCase.","message":"{{property}} path parameter is not PascalCase: {{error}}","severity":"info","given":"$..parameters[?(@.in == 'path')].name","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][a-zA-Z0-9]+$"}},"tags":["format:openapi","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-parameter-pascal-case' (Path Parameter Pascal Case). Requirement: Path parameters MUST follow PascalCase. To fix: Ensure the targeted value matches the regular expression `^[A-Z][a-zA-Z0-9]+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'path')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-parameter-snake-case":{"title":"Path Parameter Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/path-parameter-snake-case/","source":"default","description":"Path parameters MUST follow snake_case.","message":"{{property}} path parameter is not snake_case: {{error}}","severity":"info","given":"$..parameters[?(@.in == 'path')].name","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(_[a-z0-9]+)*$"}},"tags":["format:openapi","spec:parameters","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-parameter-snake-case' (Path Parameter Snake Case). Requirement: Path parameters MUST follow snake_case. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(_[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..parameters[?(@.in == 'path')].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-params":{"title":"Path Params","reference":"https://spotlight-rules.com/spec/rules/openapi/path-params/","source":"builtin","description":"Path parameters must be defined and valid.","message":"{{error}}","severity":"info","given":"$.paths","then":{"function":"oasPathParam"},"tags":["format:openapi","spec:paths","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-params' (Path Params). Requirement: Path parameters must be defined and valid. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-params-declared-in-block":{"title":"Path Params Declared In Block","reference":"https://spotlight-rules.com/spec/rules/openapi/path-params-declared-in-block/","source":"compiled","description":"Check for the path parameter in the parameter block.","message":"{{error}}","severity":"info","given":"$.paths","then":{"function":"trimble:check-for-path-parameter"},"tags":["format:openapi","spec:paths","experience:consistency","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-params-declared-in-block' (Path Params Declared In Block). Requirement: Check for the path parameter in the parameter block. This rule is evaluated at the JSONPath `$.paths.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-require-query-parameter":{"title":"Path Require Query Parameter","reference":"https://spotlight-rules.com/spec/rules/openapi/path-require-query-parameter/","source":"compiled","description":"Check if the given resource path has queryparameter.","message":"{{error}}","severity":"info","given":"$.paths[*]~","then":{"function":"trimble:check-for-query-parameter-in-every-path"},"tags":["format:openapi","spec:paths","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-require-query-parameter' (Path Require Query Parameter). Requirement: Check if the given resource path has queryparameter. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-require-tracing-header":{"title":"Path Require Tracing Header","reference":"https://spotlight-rules.com/spec/rules/openapi/path-require-tracing-header/","source":"compiled","description":"MUST use b3 or w3c tracing [233a].","message":"Header X-B3-Traceid, X-B3-Spanid or traceparent (w3c) missing","severity":"info","given":"$.paths.*","then":{"function":"baloise:validate-tracing"},"tags":["format:openapi","spec:paths","topic:tracing","experience:reliability","experience:governance","experience:observability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-require-tracing-header' (Path Require Tracing Header). Requirement: MUST use b3 or w3c tracing [233a]. This rule is evaluated at the JSONPath `$.paths.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-require-valid-http-verb":{"title":"Path Require Valid HTTP Verb","reference":"https://spotlight-rules.com/spec/rules/openapi/path-require-valid-http-verb/","source":"compiled","description":"All APIs MUST have a valid http verb.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"field":"@key","function":"trimble:does-spec-contains-valid-http-verbs"},"tags":["format:openapi","spec:paths","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-require-valid-http-verb' (Path Require Valid HTTP Verb). Requirement: All APIs MUST have a valid http verb. This rule is evaluated at the JSONPath `$.paths.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-resources-plural":{"title":"Path Resources Plural","reference":"https://spotlight-rules.com/spec/rules/openapi/path-resources-plural/","source":"compiled","description":"Resource names in paths should use plural nouns to maintain consistency and follow REST conventions for collection-oriented resource design.","message":"Path Resources Should Be Plural","severity":"info","given":"$.paths","then":{"function":"pattern","functionOptions":{"match":"^(/[a-z].*s(/\\{[^}]+\\})?)*$"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-resources-plural' (Path Resources Plural). Requirement: Resource names in paths should use plural nouns to maintain consistency and follow REST conventions for collection-oriented resource design. To fix: Ensure the targeted value matches the regular expression `^(/[a-z].*s(/\\{[^}]+\\})?)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-segment-kebab-case":{"title":"Path Segment Kebab Case","reference":"https://spotlight-rules.com/spec/rules/openapi/path-segment-kebab-case/","source":"compiled","description":"All YAML/JSON paths MUST follow kebab-case.","message":"{{property}} is not kebab-case: {{error}}","severity":"info","given":"$.paths[*]~","then":{"function":"pattern","functionOptions":{"match":"^/([a-z0-9]+(-[a-z0-9]+)*)?(/[a-z0-9]+(-[a-z0-9]+)*|/{.+})*$"}},"tags":["format:openapi","spec:paths","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-segment-kebab-case' (Path Segment Kebab Case). Requirement: All YAML/JSON paths MUST follow kebab-case. To fix: Ensure the targeted value matches the regular expression `^/([a-z0-9]+(-[a-z0-9]+)*)?(/[a-z0-9]+(-[a-z0-9]+)*|/{.+})*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-success-response-require-description":{"title":"Path Success Response Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/path-success-response-require-description/","source":"compiled","description":"Check if the response description is appropriate for all requests.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"trimble:check-description-for-all-success-responses"},"tags":["format:openapi","spec:paths","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-success-response-require-description' (Path Success Response Require Description). Requirement: Check if the response description is appropriate for all requests. This rule is evaluated at the JSONPath `$.paths.*.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-uri-versioning-single-version":{"title":"Path URI Versioning Single Version","reference":"https://spotlight-rules.com/spec/rules/openapi/path-uri-versioning-single-version/","source":"compiled","description":"CAN use correct URI versioning [115a].","message":"Path can contain correct URI versioning","severity":"info","given":"$.paths.*~","then":{"function":"pattern","functionOptions":{"match":"^((?!.*\\/v\\d+(\\/.*)?\\/v\\d+)\\/.*)$"}},"tags":["format:openapi","spec:paths","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-uri-versioning-single-version' (Path URI Versioning Single Version). Requirement: CAN use correct URI versioning [115a]. To fix: Ensure the targeted value matches the regular expression `^((?!.*\\/v\\d+(\\/.*)?\\/v\\d+)\\/.*)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-use-standard-http-methods":{"title":"Path Use Standard HTTP Methods","reference":"https://spotlight-rules.com/spec/rules/openapi/path-use-standard-http-methods/","source":"compiled","description":"Operations MUST use only the common HTTP methods as outlined in the standards guide, and must be in lower-case.","message":"Operations MUST use only the common HTTP methods as outlined in the standards guide, and must be in lower-case.","severity":"info","given":"$.paths[*].*~","then":{"field":"method","function":"enumeration","functionOptions":{"values":["get","post","put","patch","delete","head","options"]}},"tags":["format:openapi","spec:paths","experience:consistency","experience:naming"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-use-standard-http-methods' (Path Use Standard HTTP Methods). Requirement: Operations MUST use only the common HTTP methods as outlined in the standards guide, and must be in lower-case. To fix: Set `method` to one of the allowed values: get, post, put, patch, delete, head, options. This rule is evaluated at the JSONPath `$.paths[*].*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"path-write-response-support-json":{"title":"Path Write Response Support JSON","reference":"https://spotlight-rules.com/spec/rules/openapi/path-write-response-support-json/","source":"compiled","description":"All APIs returning structured data SHOULD support JSON as the default format.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"trimble:check-if-application-or-json-in-put-and-post-response"},"tags":["format:openapi","spec:paths","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'path-write-response-support-json' (Path Write Response Support JSON). Requirement: All APIs returning structured data SHOULD support JSON as the default format. This rule is evaluated at the JSONPath `$.paths.*.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-body-must-use-json-content-type":{"title":"Request Body Must Use JSON Content Type","reference":"https://spotlight-rules.com/spec/rules/openapi/request-body-must-use-json-content-type/","source":"compiled","description":"Request bodies should use application/json as the primary content type for consistency across API operations and client implementations.","message":"Request Body MUST Use application/json Content Type","severity":"info","given":"$.paths.*[post,put,patch].requestBody.content","then":{"field":"application/json","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","spec:media-types","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-body-must-use-json-content-type' (Request Body Must Use JSON Content Type). Requirement: Request bodies should use application/json as the primary content type for consistency across API operations and client implementations. To fix: Ensure `application/json` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[post,put,patch].requestBody.content` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-content-require-examples":{"title":"Request Content Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/request-content-require-examples/","source":"compiled","description":"Request with content must have examples.","message":"Request with content must have examples","severity":"info","given":"$.paths..requestBody..content.*","then":{"field":"examples","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-content-require-examples' (Request Content Require Examples). Requirement: Request with content must have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths..requestBody..content.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-delete-must-not-have-body":{"title":"Request Delete Must Not Have Body","reference":"https://spotlight-rules.com/spec/rules/openapi/request-delete-must-not-have-body/","source":"compiled","description":"DELETE operations must not accept a request body.","message":"DELETE operations must not accept a request body.","severity":"info","given":"$.paths[*].delete.requestBody","then":{"function":"undefined"},"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-delete-must-not-have-body' (Request Delete Must Not Have Body). Requirement: DELETE operations must not accept a request body. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `$.paths[*].delete.requestBody` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-delete-no-body":{"title":"Request Delete No Body","reference":"https://spotlight-rules.com/spec/rules/openapi/request-delete-no-body/","source":"compiled","description":"DELETE requests MUST NOT have a request body.","message":"DELETE requests MUST NOT have a request body.","severity":"info","given":"$.paths[*].delete.requestBody","then":{"function":"falsy","message":"{{description}}: {{error}}"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-delete-no-body' (Request Delete No Body). Requirement: DELETE requests MUST NOT have a request body. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths[*].delete.requestBody` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-get-must-not-have-body":{"title":"Request Get Must Not Have Body","reference":"https://spotlight-rules.com/spec/rules/openapi/request-get-must-not-have-body/","source":"compiled","description":"A `GET` request MUST NOT accept a request body.","message":"A `GET` request MUST NOT accept a request body.","severity":"info","given":"$.paths[*][get].requestBody","then":{"function":"undefined"},"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-get-must-not-have-body' (Request Get Must Not Have Body). Requirement: A `GET` request MUST NOT accept a request body. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `$.paths[*][get].requestBody` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-get-no-body":{"title":"Request Get No Body","reference":"https://spotlight-rules.com/spec/rules/openapi/request-get-no-body/","source":"compiled","description":"GET requests MUST NOT have a request body.","message":"GET requests MUST NOT have a request body.","severity":"info","given":"$.paths[*].get.requestBody","then":{"function":"falsy","message":"{{description}}: {{error}}"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-get-no-body' (Request Get No Body). Requirement: GET requests MUST NOT have a request body. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.requestBody` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-head-must-not-have-body":{"title":"Request Head Must Not Have Body","reference":"https://spotlight-rules.com/spec/rules/openapi/request-head-must-not-have-body/","source":"compiled","description":"A `HEAD` request MUST NOT accept a request body.","message":"A `HEAD` request MUST NOT accept a request body.","severity":"info","given":"$.paths[*][head].requestBody","then":{"function":"undefined"},"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-head-must-not-have-body' (Request Head Must Not Have Body). Requirement: A `HEAD` request MUST NOT accept a request body. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `$.paths[*][head].requestBody` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-header-names-pascal-case":{"title":"Request Header Names Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/request-header-names-pascal-case/","source":"compiled","description":"Headers should be pascal-case. See Italian recommendation RAC_REST_NAME_003.","message":"{{value}} {{error}} in {{path}}","severity":"info","given":["$.[parameters][?(@.in==\"header\")].name"],"then":{"function":"casing","functionOptions":{"type":"pascal","separator":{"char":"-"}}},"tags":["format:openapi","spec:parameters","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-header-names-pascal-case' (Request Header Names Pascal Case). Requirement: Headers should be pascal-case. See Italian recommendation RAC_REST_NAME_003. To fix: Rename the targeted key or value to PascalCase (e.g. `UserName`) at each matching location, updating every reference to it. This rule is evaluated at the JSONPath `$.[parameters][?(@.in==\"header\")].name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-options-must-not-have-body":{"title":"Request Options Must Not Have Body","reference":"https://spotlight-rules.com/spec/rules/openapi/request-options-must-not-have-body/","source":"compiled","description":"An `OPTIONS` request MUST NOT accept a request body.","message":"An `OPTIONS` request MUST NOT accept a request body.","severity":"info","given":"$.paths[*][options].requestBody","then":{"function":"undefined"},"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-options-must-not-have-body' (Request Options Must Not Have Body). Requirement: An `OPTIONS` request MUST NOT accept a request body. To fix: Remove the targeted value from each matching location. This rule is evaluated at the JSONPath `$.paths[*][options].requestBody` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-patch-media-type-not-plain-json":{"title":"Request Patch Media Type Not Plain JSON","reference":"https://spotlight-rules.com/spec/rules/openapi/request-patch-media-type-not-plain-json/","source":"compiled","description":"The PATCH specification explicits that the request body contains a \"patch document\" describing the changes to be applied to the target resource. To avoid confusion, [this errata](https://www.rfc-editor.org/errata/eid3169) explains that `application/json` is not an appropriate media-type for `PATCH`. A correct example of PATCH using eg. `application/json-patch+json` media-type defined in RFC6902. ``` paths: /books/{book_id}: patch: requestBody: content: application/json-patch+json: schema: type: object example: [{ \"op\": \"add\", \"path\": \"/baz\", \"value\": \"qux\" }] ```.","message":"application/json is not an appropriate media-type for PATCH. {{path}}","severity":"info","given":"$.[patch][requestBody][content]","then":{"field":"application/json","function":"falsy"},"formats":["oas3"],"tags":["format:openapi","spec:operations","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-patch-media-type-not-plain-json' (Request Patch Media Type Not Plain JSON). Requirement: The PATCH specification explicits that the request body contains a \"patch document\" describing the changes to be applied to the target resource. To avoid confusion, [this errata](https://www.rfc-editor.org/errata/eid3169) explains that `application/json` is not an appropriate media-type for `PATCH`. A correct example of PATCH using eg. `application/json-patch+json` media-type defined in RFC6902. ``` paths: /books/{book_id}: patch: requestBody: content: application/json-patch+json: schema: type: object example: [{ \"op\": \"add\", \"path\": \"/baz\", \"value\": \"qux\" }] ```. To fix: Ensure `application/json` is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.[patch][requestBody][content]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-post-collection-require-paging-object":{"title":"Request Post Collection Require Paging Object","reference":"https://spotlight-rules.com/spec/rules/openapi/request-post-collection-require-paging-object/","source":"compiled","description":"POST collection endpoints MUST have a request body schema that includes paging parameters.","message":"POST collection endpoints MUST have a request body schema that includes paging parameters.","severity":"info","given":"$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}$/))].post.requestBody.content.application/json.schema.properties.paging","then":{"field":"type","function":"pattern","functionOptions":{"match":"object"}},"tags":["format:openapi","spec:paths","spec:operations","spec:request-body","spec:media-types","spec:schemas","topic:pagination","experience:pagination","experience:data-modeling","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-post-collection-require-paging-object' (Request Post Collection Require Paging Object). Requirement: POST collection endpoints MUST have a request body schema that includes paging parameters. To fix: Ensure `type` matches the regular expression `object`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}$/))].post.requestBody.content.application/json.schema.properties.paging` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-property-names-camel-case":{"title":"Request Property Names Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/request-property-names-camel-case/","source":"compiled","description":"MUST property names must be ASCII camelCase [118a].","message":"Property name has to be ASCII camelCase","severity":"info","given":"$.paths.*.*[responses,requestBody]..content..schema..properties.*~","then":{"function":"pattern","functionOptions":{"match":"^[a-z]+((\\d)|([A-Z0-9][a-z0-9]+))*([A-Z])?$"}},"tags":["format:openapi","spec:paths","spec:request-body","spec:responses","spec:media-types","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-property-names-camel-case' (Request Property Names Camel Case). Requirement: MUST property names must be ASCII camelCase [118a]. To fix: Ensure the targeted value matches the regular expression `^[a-z]+((\\d)|([A-Z0-9][a-z0-9]+))*([A-Z])?$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths.*.*[responses,requestBody]..content..schema..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-accept-encoding":{"title":"Request Support Accept Encoding","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-accept-encoding/","source":"spotlight","description":"Operations should accept an Accept-Encoding request header so clients can negotiate a compressed (e.g. gzip) response.","message":"Operation should accept an Accept-Encoding header.","given":"$.paths[*][get,post,put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"const":"Accept-Encoding"},"in":{"const":"header"}}}}}},"tags":["format:openapi","spec:parameters","topic:content-negotiation","experience:usability","experience:reliability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-accept-encoding' (Request Support Accept Encoding). Requirement: Operations should accept an Accept-Encoding request header so clients can negotiate a compressed (e.g. gzip) response. To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-accept-language":{"title":"Request Support Accept Language","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-accept-language/","source":"spotlight","description":"Operations should accept an Accept-Language request header so clients can negotiate a localized response (i18n).","message":"Operation should accept an Accept-Language header.","given":"$.paths[*][get,post,put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"const":"Accept-Language"},"in":{"const":"header"}}}}}},"tags":["format:openapi","spec:parameters","topic:content-negotiation","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-accept-language' (Request Support Accept Language). Requirement: Operations should accept an Accept-Language request header so clients can negotiate a localized response (i18n). To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-baggage":{"title":"Request Support Baggage","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-baggage/","source":"spotlight","description":"Operations should accept a baggage request header (W3C Baggage / OpenTelemetry) so application-defined context propagates across services.","message":"Operation should accept a `baggage` request header.","given":"$.paths[*][get,post,put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"const":"baggage"},"in":{"const":"header"}}}}}},"tags":["format:openapi","spec:parameters","topic:tracing","experience:reliability","experience:usability","experience:observability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-baggage' (Request Support Baggage). Requirement: Operations should accept a baggage request header (W3C Baggage / OpenTelemetry) so application-defined context propagates across services. To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `baggage` request header. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-correlation-id":{"title":"Request Support Correlation ID","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-correlation-id/","source":"spotlight","description":"Operations should accept a correlation / request ID request header (e.g. Correlation-Id or X-Request-Id) so a caller-supplied id can be traced end to end.","message":"Operation should accept a `Correlation-Id` request header.","given":"$.paths[*][get,post,put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"pattern":"^([Xx]-)?([Cc]orrelation|[Rr]equest)-[Ii][Dd]$"},"in":{"const":"header"}}}}}},"tags":["format:openapi","spec:parameters","topic:tracing","experience:reliability","experience:usability","experience:observability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-correlation-id' (Request Support Correlation ID). Requirement: Operations should accept a correlation / request ID request header (e.g. Correlation-Id or X-Request-Id) so a caller-supplied id can be traced end to end. To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `Correlation-Id` request header. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-form-urlencoded-media-type":{"title":"Request Support Form Urlencoded Media Type","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-form-urlencoded-media-type/","source":"default","description":"Every request MUST support `application/x-www-form-urlencoded` media type.","message":"{{description}}: {{error}}","severity":"info","given":"$.paths.[*].requestBody.content[?(@property.indexOf('urlencoded') === -1)]^","then":{"function":"falsy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-form-urlencoded-media-type' (Request Support Form Urlencoded Media Type). Requirement: Every request MUST support `application/x-www-form-urlencoded` media type. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.[*].requestBody.content[?(@property.indexOf('urlencoded') === -1)]^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-json-media-type":{"title":"Request Support JSON Media Type","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-json-media-type/","source":"compiled","description":"Every request MUST support `application/json` media type.","message":"{{description}}: {{error}}","severity":"info","given":"$.paths.[*].requestBody.content[?(@property.indexOf('json') === -1)]^","then":{"function":"falsy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-json-media-type' (Request Support JSON Media Type). Requirement: Every request MUST support `application/json` media type. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.[*].requestBody.content[?(@property.indexOf('json') === -1)]^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-json-media-type-2":{"title":"Request Support JSON Media Type 2","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-json-media-type-2/","source":"compiled","description":"Every request MUST support `application/json` media type.","message":"Every request MUST support `application/json` media type.","severity":"info","given":"$.paths[*][*].requestBody.content","then":{"function":"schema","functionOptions":{"schema":{"type":"object","properties":{"application/json":true},"required":["application/json"]}}},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-json-media-type-2' (Request Support JSON Media Type 2). Requirement: Every request MUST support `application/json` media type. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][*].requestBody.content` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-multipart-media-type":{"title":"Request Support Multipart Media Type","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-multipart-media-type/","source":"default","description":"Every request MUST support `multipart/form-data` media type.","message":"{{description}}: {{error}}","severity":"info","given":"$.paths.[*].requestBody.content[?(@property.indexOf('multipart') === -1)]^","then":{"function":"falsy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-multipart-media-type' (Request Support Multipart Media Type). Requirement: Every request MUST support `multipart/form-data` media type. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.[*].requestBody.content[?(@property.indexOf('multipart') === -1)]^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-text-plain-media-type":{"title":"Request Support Text Plain Media Type","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-text-plain-media-type/","source":"default","description":"Every request MUST support `text/plain` media type.","message":"{{description}}: {{error}}","severity":"info","given":"$.paths.[*].requestBody.content[?(@property.indexOf('plain') === -1)]^","then":{"function":"falsy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-text-plain-media-type' (Request Support Text Plain Media Type). Requirement: Every request MUST support `text/plain` media type. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.[*].requestBody.content[?(@property.indexOf('plain') === -1)]^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-tracestate":{"title":"Request Support Tracestate","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-tracestate/","source":"spotlight","description":"Operations should accept a tracestate request header (W3C Trace Context) so vendor-specific trace state propagates alongside traceparent.","message":"Operation should accept a `tracestate` request header.","given":"$.paths[*][get,post,put,patch,delete]","severity":"info","then":{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","contains":{"type":"object","required":["name","in"],"properties":{"name":{"const":"tracestate"},"in":{"const":"header"}}}}}},"tags":["format:openapi","spec:parameters","topic:tracing","experience:reliability","experience:usability","experience:observability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-tracestate' (Request Support Tracestate). Requirement: Operations should accept a tracestate request header (W3C Trace Context) so vendor-specific trace state propagates alongside traceparent. To fix: Adjust `parameters` so it conforms to the schema this rule requires. Guidance: Operation should accept a `tracestate` request header. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"request-support-xml-media-type":{"title":"Request Support XML Media Type","reference":"https://spotlight-rules.com/spec/rules/openapi/request-support-xml-media-type/","source":"default","description":"Every request MUST support `application/xml` media type.","message":"{{description}}: {{error}}","severity":"info","given":"$.paths.[*].requestBody.content[?(@property.indexOf('xml') === -1)]^","then":{"function":"falsy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:request-body","spec:media-types","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'request-support-xml-media-type' (Request Support XML Media Type). Requirement: Every request MUST support `application/xml` media type. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.[*].requestBody.content[?(@property.indexOf('xml') === -1)]^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-202-location-header":{"title":"Response 202 Location Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-202-location-header/","source":"spotlight","description":"202 Accepted responses should document a Location header pointing at the status or result resource clients can poll for the long-running operation.","message":"202 Accepted responses should document a Location header.","given":"$.paths[*][*].responses['202'].headers","severity":"info","then":{"field":"Location","function":"truthy"},"tags":["format:openapi","spec:responses","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-202-location-header' (Response 202 Location Header). Requirement: 202 Accepted responses should document a Location header pointing at the status or result resource clients can poll for the long-running operation. To fix: Ensure `Location` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][*].responses['202'].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-202-retry-after":{"title":"Response 202 Retry After","reference":"https://spotlight-rules.com/spec/rules/openapi/response-202-retry-after/","source":"spotlight","description":"202 Accepted responses should document a Retry-After header suggesting how long clients should wait before polling the status resource.","message":"202 Accepted responses should document a Retry-After header.","given":"$.paths[*][*].responses['202'].headers","severity":"info","then":{"field":"Retry-After","function":"truthy"},"tags":["format:openapi","spec:responses","topic:rate-limiting","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-202-retry-after' (Response 202 Retry After). Requirement: 202 Accepted responses should document a Retry-After header suggesting how long clients should wait before polling the status resource. To fix: Ensure `Retry-After` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][*].responses['202'].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-206-require-content-range":{"title":"Response 206 Require Content Range","reference":"https://spotlight-rules.com/spec/rules/openapi/response-206-require-content-range/","source":"compiled","description":"Check if the get response code 206 has content-type and content-range.","message":"{{error}}","severity":"info","given":"$.paths.*","then":{"function":"trimble:check-content-type-for-206-get-response-code"},"tags":["format:openapi","spec:paths","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-206-require-content-range' (Response 206 Require Content Range). Requirement: Check if the get response code 206 has content-type and content-range. This rule is evaluated at the JSONPath `$.paths.*.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-400-require-body":{"title":"Response 400 Require Body","reference":"https://spotlight-rules.com/spec/rules/openapi/response-400-require-body/","source":"compiled","description":"All 400 responses must include a response body.","message":"All 400 responses must include a response body.","severity":"info","given":["$.paths.*.*.responses['400']"],"then":{"field":"content","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-400-require-body' (Response 400 Require Body). Requirement: All 400 responses must include a response body. To fix: Ensure `content` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.*.responses['400']` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-body-must-be-object":{"title":"Response Body Must Be Object","reference":"https://spotlight-rules.com/spec/rules/openapi/response-body-must-be-object/","source":"compiled","description":"Response bodies must be an object type.","message":"Response bodies must be an object type.","severity":"info","given":"$.paths[*][*].responses[*].content.application/json.schema.type","then":{"function":"pattern","functionOptions":{"match":"object"}},"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-body-must-be-object' (Response Body Must Be Object). Requirement: Response bodies must be an object type. To fix: Ensure the targeted value matches the regular expression `object`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*].content.application/json.schema.type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-cache-header-no-conflict":{"title":"Response Cache Header No Conflict","reference":"https://spotlight-rules.com/spec/rules/openapi/response-cache-header-no-conflict/","source":"compiled","description":"Cache usage SHOULD be extensively detailed in the `description` property to avoid data leaks or the usage of stale data. This rule should ensure in some way that the api provider documented extensively the cache usage to avoid data leaks or usage of stale data. For now this ruleset tests: * the presence of following keywords in the `description`: `max-age`, `private`, `no-store`, `no-cache`. * that one and only one between Expires and Cache-Control is used. `Cache-Control` and `Expires` should not be used in conjuction, because `Cache-Control` overrides `Expires` when `max-age` is set. Instead if neither `Cache-Control` or `Expires` are set, clients MAY use euristic cache like described in RFC7234.","message":"{{error}}","severity":"info","given":"$.[responses][?(@property[0] == \"2\" )][headers]","then":[{"function":"xor","functionOptions":{"properties":["Expires","Cache-Control"]}}],"formats":["oas3"],"tags":["format:openapi","spec:responses","spec:headers","topic:caching","experience:reliability","experience:consistency","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-cache-header-no-conflict' (Response Cache Header No Conflict). Requirement: Cache usage SHOULD be extensively detailed in the `description` property to avoid data leaks or the usage of stale data. This rule should ensure in some way that the api provider documented extensively the cache usage to avoid data leaks or usage of stale data. For now this ruleset tests: * the presence of following keywords in the `description`: `max-age`, `private`, `no-store`, `no-cache`. * that one and only one between Expires and Cache-Control is used. `Cache-Control` and `Expires` should not be used in conjuction, because `Cache-Control` overrides `Expires` when `max-age` is set. Instead if neither `Cache-Control` or `Expires` are set, clients MAY use euristic cache like described in RFC7234. To fix: Include exactly one of: Expires, Cache-Control. This rule is evaluated at the JSONPath `$.[responses][?(@property[0] == \"2\" )][headers]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-code-must-be-valid":{"title":"Response Code Must Be Valid","reference":"https://spotlight-rules.com/spec/rules/openapi/response-code-must-be-valid/","source":"compiled","description":"All APIs should return a valid http response code.","message":"{{error}}","severity":"info","given":"$..responses","then":{"field":"@key","function":"trimble:valid-http-response"},"tags":["format:openapi","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-code-must-be-valid' (Response Code Must Be Valid). Requirement: All APIs should return a valid http response code. This rule is evaluated at the JSONPath `$..responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-collection-require-results-array":{"title":"Response Collection Require Results Array","reference":"https://spotlight-rules.com/spec/rules/openapi/response-collection-require-results-array/","source":"compiled","description":"Response bodies must have a root element called results and is an array of objects.","message":"Response bodies must have a root element called results and is an array of objects.","severity":"info","given":"$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}$/))].get.responses['200'].content.application/json.schema.properties.results","then":[{"field":"type","function":"pattern","functionOptions":{"match":"array"}},{"field":"items.type","function":"pattern","functionOptions":{"match":"object"}}],"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","spec:schemas","topic:pagination","experience:pagination","experience:data-modeling","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-collection-require-results-array' (Response Collection Require Results Array). Requirement: Response bodies must have a root element called results and is an array of objects. To fix: Ensure `type` matches the regular expression `array`; rewrite any value that does not. Also: Ensure `items.type` matches the regular expression `object`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}$/))].get.responses['200'].content.application/json.schema.properties.results` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-collection-support-paging":{"title":"Response Collection Support Paging","reference":"https://spotlight-rules.com/spec/rules/openapi/response-collection-support-paging/","source":"compiled","description":"Response bodies from collection endpoints SHOULD offer paging capability.","message":"Response bodies from collection endpoints SHOULD offer paging capability.","severity":"info","given":"$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}.*$/))].get.responses['200'].content.application/json.schema.properties","then":[{"field":"paging","function":"truthy"},{"field":"paging","function":"pattern","functionOptions":{"match":"object"}},{"field":"paging.type","function":"pattern","functionOptions":{"match":"object"}}],"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","spec:schemas","topic:pagination","experience:pagination","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-collection-support-paging' (Response Collection Support Paging). Requirement: Response bodies from collection endpoints SHOULD offer paging capability. To fix: Ensure `paging` is present and non-empty at each matching location. Also: Ensure `paging` matches the regular expression `object`; rewrite any value that does not. Also: Ensure `paging.type` matches the regular expression `object`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}.*$/))].get.responses['200'].content.application/json.schema.properties` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-content-require-examples":{"title":"Response Content Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/response-content-require-examples/","source":"compiled","description":"Response with content must have examples.","message":"Response with content must have examples","severity":"info","given":"$.paths..responses..content.*","then":{"field":"examples","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-content-require-examples' (Response Content Require Examples). Requirement: Response with content must have examples. To fix: Ensure `examples` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths..responses..content.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-cors-allow-origin-no-wildcard":{"title":"Response CORS Allow Origin No Wildcard","reference":"https://spotlight-rules.com/spec/rules/openapi/response-cors-allow-origin-no-wildcard/","source":"spotlight","description":"If an Access-Control-Allow-Origin response header is documented, it should not hard-code a wildcard (*) — reflect specific allowed origins instead, especially for authenticated APIs (OWASP API8 security misconfiguration). Note: the project treats CORS as operational (see no-operational-headers-in-spec); this is a defensive check for specs that do document it.","message":"Access-Control-Allow-Origin should not be a wildcard (*).","given":"$..responses.*.headers['Access-Control-Allow-Origin'].schema","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"not":{"anyOf":[{"required":["const"],"properties":{"const":{"const":"*"}}},{"required":["default"],"properties":{"default":{"const":"*"}}},{"required":["example"],"properties":{"example":{"const":"*"}}}]}}}},"tags":["format:openapi","spec:responses","topic:cors","experience:security","owasp:api8"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-cors-allow-origin-no-wildcard' (Response CORS Allow Origin No Wildcard). Requirement: If an Access-Control-Allow-Origin response header is documented, it should not hard-code a wildcard (*) — reflect specific allowed origins instead, especially for authenticated APIs (OWASP API8 security misconfiguration). Note: the project treats CORS as operational (see no-operational-headers-in-spec); this is a defensive check for specs that do document it. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$..responses.*.headers['Access-Control-Allow-Origin'].schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-custom-header-naming-format":{"title":"Response Custom Header Naming Format","reference":"https://spotlight-rules.com/spec/rules/openapi/response-custom-header-naming-format/","source":"compiled","description":"Custom headers MUST NOT be longer than 50 chars, and MUST only contain alphanumeric and dash chars, and MUST begin with Sps- not X-.","message":"Custom headers MUST NOT be longer than 50 chars, and MUST only contain alphanumeric and dash chars, and MUST begin with Sps- not X-.","severity":"info","given":"$.paths[*][*].responses[*].headers.*~","then":{"function":"pattern","functionOptions":{"match":"^(Sps-[a-zA-Z0-9-]{1,50}|Accept|Access-Control.*|Authorization|Cache-Control|Content-Disposition|Content-Language|Content-Length|Content-Type|Date|ETag|Host|If-Match|If-None-Match|Location|Origin|User-Agent)$"}},"tags":["format:openapi","spec:paths","spec:responses","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-custom-header-naming-format' (Response Custom Header Naming Format). Requirement: Custom headers MUST NOT be longer than 50 chars, and MUST only contain alphanumeric and dash chars, and MUST begin with Sps- not X-. To fix: Ensure the targeted value matches the regular expression `^(Sps-[a-zA-Z0-9-]{1,50}|Accept|Access-Control.*|Authorization|Cache-Control|Content-Disposition|Content-Language|Content-Length|Content-Type|Date|ETag|Host|If-Match|If-None-Match|Location|Origin|User-Agent)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*].headers.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-default-content-language-en-us":{"title":"Response Default Content Language En Us","reference":"https://spotlight-rules.com/spec/rules/openapi/response-default-content-language-en-us/","source":"compiled","description":"Content-Language is optional but MUST default locale to en-US when none provided.","message":"Content-Language is optional but MUST default locale to en-US when none provided.","severity":"info","given":"$.paths[*][*].responses[*].headers.Content-Language.schema.default","then":{"function":"pattern","functionOptions":{"match":"en-US"}},"tags":["format:openapi","spec:paths","spec:responses","spec:headers","spec:media-types","spec:schemas","topic:content-negotiation","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-default-content-language-en-us' (Response Default Content Language En Us). Requirement: Content-Language is optional but MUST default locale to en-US when none provided. To fix: Ensure the targeted value matches the regular expression `en-US`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*].headers.Content-Language.schema.default` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-define-401":{"title":"Response Define 401","reference":"https://spotlight-rules.com/spec/rules/openapi/response-define-401/","source":"compiled","description":"Responses should contain common response - 401 (unauthorized).","message":"{{description}}. Missing {{property}}","severity":"info","given":"$.paths..responses","then":{"field":"401","function":"truthy"},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-define-401' (Response Define 401). Requirement: Responses should contain common response - 401 (unauthorized). To fix: Ensure `401` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths..responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-define-404":{"title":"Response Define 404","reference":"https://spotlight-rules.com/spec/rules/openapi/response-define-404/","source":"compiled","description":"Responses should contain common response - 404 (not found).","message":"{{description}}. Missing {{property}}","severity":"info","given":"$.paths[?(@property.match(/.*\\/{.*}.*/))]..responses","then":{"field":"404","function":"truthy"},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-define-404' (Response Define 404). Requirement: Responses should contain common response - 404 (not found). To fix: Ensure `404` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[?(@property.match(/.*\\/{.*}.*/))]..responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-define-429":{"title":"Response Define 429","reference":"https://spotlight-rules.com/spec/rules/openapi/response-define-429/","source":"compiled","description":"Responses should contain common response - 429 (too many requests).","message":"{{description}}. Missing {{property}}","severity":"info","given":"$.paths..responses","then":{"field":"429","function":"truthy"},"tags":["format:openapi","spec:paths","spec:responses","topic:rate-limiting","experience:error-handling","experience:reliability","experience:performance","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-define-429' (Response Define 429). Requirement: Responses should contain common response - 429 (too many requests). To fix: Ensure `429` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths..responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-define-500":{"title":"Response Define 500","reference":"https://spotlight-rules.com/spec/rules/openapi/response-define-500/","source":"compiled","description":"Responses should contain common response - 500 (server error).","message":"{{description}}. Missing {{property}}","severity":"info","given":"$.paths..responses","then":{"field":"500","function":"truthy"},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-define-500' (Response Define 500). Requirement: Responses should contain common response - 500 (server error). To fix: Ensure `500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths..responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-404-use-schema-ref":{"title":"Response Delete 404 Use Schema Ref","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-404-use-schema-ref/","source":"compiled","description":"DELETE 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response.","message":"DELETE 404 Responses MUST Use Schema Reference","severity":"info","given":"$.paths.*.delete.responses.404","then":{"field":"$ref","function":"falsy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-404-use-schema-ref' (Response Delete 404 Use Schema Ref). Requirement: DELETE 404 not found HTTP status codes have a schema references to standardize the response payload returned for the error response. To fix: Ensure `$ref` is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.*.delete.responses.404` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-codes-allowed":{"title":"Response Delete Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-codes-allowed/","source":"compiled","description":"DELETE operations should not return 200 or 201 status codes.","message":"DELETE operations should not return 200 or 201 status codes.","severity":"info","given":"$.paths[*].delete.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^(200|201)$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-codes-allowed' (Response Delete Codes Allowed). Requirement: DELETE operations should not return 200 or 201 status codes. To fix: Ensure `@key` does NOT match the regular expression `^(200|201)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].delete.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-define-204":{"title":"Response Delete Define 204","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-define-204/","source":"compiled","description":"DELETE responses should have a 204 success HTTP status codes, communicating a success created response to consumers.","message":"DELETE 204 Status Code","severity":"info","given":"$.paths.*.delete.responses","then":{"field":"204","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-define-204' (Response Delete Define 204). Requirement: DELETE responses should have a 204 success HTTP status codes, communicating a success created response to consumers. To fix: Ensure `204` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.delete.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-define-401":{"title":"Response Delete Define 401","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-define-401/","source":"compiled","description":"DELETE operations should define a 401 Unauthorized response to document authentication requirements for destructive operations.","message":"DELETE MUST Have 401 Response","severity":"info","given":"$.paths[*].delete.responses","then":{"field":"401","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:security","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-define-401' (Response Delete Define 401). Requirement: DELETE operations should define a 401 Unauthorized response to document authentication requirements for destructive operations. To fix: Ensure `401` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].delete.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-define-500":{"title":"Response Delete Define 500","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-define-500/","source":"compiled","description":"DELETE responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers.","message":"DELETE Responses MUST Have 500 Status Codes","severity":"info","given":"$.paths.*.delete.responses","then":{"field":"500","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-define-500' (Response Delete Define 500). Requirement: DELETE responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers. To fix: Ensure `500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.delete.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-must-not-return-body":{"title":"Response Delete Must Not Return Body","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-must-not-return-body/","source":"compiled","description":"DELETE operations must not have a response body.","message":"DELETE operations must not have a response body.","severity":"info","given":"$.paths.*.delete.responses[202,204].content","then":{"function":"falsy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-must-not-return-body' (Response Delete Must Not Return Body). Requirement: DELETE operations must not have a response body. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.*.delete.responses[202,204].content` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-delete-require-204":{"title":"Response Delete Require 204","reference":"https://spotlight-rules.com/spec/rules/openapi/response-delete-require-204/","source":"compiled","description":"All DELETE methods MUST have a 204 response.","message":"All DELETE methods MUST have a 204 response.","severity":"info","given":["$.paths[*].delete.responses"],"then":{"field":"204","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:consistency","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-delete-require-204' (Response Delete Require 204). Requirement: All DELETE methods MUST have a 204 response. To fix: Ensure `204` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].delete.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-deprecated-operation-deprecation-header":{"title":"Response Deprecated Operation Deprecation Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-deprecated-operation-deprecation-header/","source":"spotlight","description":"Deprecated operations should document a Deprecation response header (RFC 9745) signalling that the resource is deprecated.","message":"Deprecated operation should document a Deprecation header.","given":"$.paths[*][?(@ && @.deprecated == true)].responses[*].headers","severity":"info","then":{"field":"Deprecation","function":"truthy"},"tags":["format:openapi","spec:responses","topic:deprecation","experience:versioning","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-deprecated-operation-deprecation-header' (Response Deprecated Operation Deprecation Header). Requirement: Deprecated operations should document a Deprecation response header (RFC 9745) signalling that the resource is deprecated. To fix: Ensure `Deprecation` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][?(@ && @.deprecated == true)].responses[*].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-deprecated-operation-sunset-header":{"title":"Response Deprecated Operation Sunset Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-deprecated-operation-sunset-header/","source":"spotlight","description":"Deprecated operations should document a Sunset response header (RFC 8594) telling clients when the operation will be removed.","message":"Deprecated operation should document a Sunset header.","given":"$.paths[*][?(@ && @.deprecated == true)].responses[*].headers","severity":"info","then":{"field":"Sunset","function":"truthy"},"tags":["format:openapi","spec:responses","topic:deprecation","experience:versioning","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-deprecated-operation-sunset-header' (Response Deprecated Operation Sunset Header). Requirement: Deprecated operations should document a Sunset response header (RFC 8594) telling clients when the operation will be removed. To fix: Ensure `Sunset` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][?(@ && @.deprecated == true)].responses[*].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-match-problem-schema":{"title":"Response Error Match Problem Schema","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-match-problem-schema/","source":"compiled","description":"WARN: This rule is under implementation and just provides an hint. Error management is a key enabler of a resilient API ecosystem. Enforcing a consistent schema for errors between different APIs, enables client to properly implement an error management strategy, with positive impacts for users. This rule inspects the schema returned by an error response and verifies whether it contains the main properties defined in RFC 9457: `status`, `title` and `detail`. An example of a valid payload is ``` { \"title\": \"Not Found\", \"status\": 404, \"detail\": \"Book does not exist; id: 123\" } ``` See recommendation RAC_REST_NAME_007.","message":"Your schema doesn't seem to match RFC 9457. Are you sure it is ok? {{path}}","severity":"info","given":"$.paths.[*].responses[?(@property.match(/^(4|5|default)/))][[schema]]","then":{"function":"schema","functionOptions":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"title":{"type":"string"},"detail":{"type":"string"}}}}},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","spec:schemas","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-match-problem-schema' (Response Error Match Problem Schema). Requirement: WARN: This rule is under implementation and just provides an hint. Error management is a key enabler of a resilient API ecosystem. Enforcing a consistent schema for errors between different APIs, enables client to properly implement an error management strategy, with positive impacts for users. This rule inspects the schema returned by an error response and verifies whether it contains the main properties defined in RFC 9457: `status`, `title` and `detail`. An example of a valid payload is ``` { \"title\": \"Not Found\", \"status\": 404, \"detail\": \"Book does not exist; id: 123\" } ``` See recommendation RAC_REST_NAME_007. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths.[*].responses[?(@property.match(/^(4|5|default)/))][[schema]]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-require-description":{"title":"Response Error Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-require-description/","source":"compiled","description":"Check if the response description is appropriate for all requests.","message":"{{error}}","severity":"info","given":"$.paths.*.*.responses","then":{"function":"trimble:check-description-for-all-error-responses"},"tags":["format:openapi","spec:paths","spec:responses","experience:documentation","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-require-description' (Response Error Require Description). Requirement: Check if the response description is appropriate for all requests. This rule is evaluated at the JSONPath `$.paths.*.*.responses.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-schema-problem-property-names":{"title":"Response Error Schema Problem Property Names","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-schema-problem-property-names/","source":"compiled","description":"WARN: This rule is under implementation and just provides an hint. Error management is a key enabler of a resilient API ecosystem. Enforcing a consistent schema for errors between different APIs, enables client to properly implement an error management strategy, with positive impacts for users. Errors should return RFC 9457 objects. Instead, this schema seems to use non standard properties such as: `message`, `msg` and `code`. An error of the following form ``` { \"msg\": \"Book with id: 123 does not exist.\", \"code\": 6063 } ``` can be expressed in RFC 9457 with ``` { \"detail\": \"Book with id: 123 does not exist.\", \"type\": \"https://api.example/v1/errors/6063\", \"status\": 404, \"title\": \"Not Found\" } ``` Returning an URI in `type`, instead of an opaque `code` can help the client in better identifying the error; moreover the URI though it should not be dereferenced automatically, can return an actual resource providing guidance in addressing the issue. See recommendation RAC_REST_NAME_007.","message":"Error response doesn't seem to match RFC 9457. Are you sure it is ok? {{path}}","severity":"info","given":"$.[responses][?(@property.match(/^(4|5|default)/))][[schema]][properties].*~","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"message|code|msg"}},"formats":["oas3"],"tags":["format:openapi","spec:responses","spec:schemas","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-schema-problem-property-names' (Response Error Schema Problem Property Names). Requirement: WARN: This rule is under implementation and just provides an hint. Error management is a key enabler of a resilient API ecosystem. Enforcing a consistent schema for errors between different APIs, enables client to properly implement an error management strategy, with positive impacts for users. Errors should return RFC 9457 objects. Instead, this schema seems to use non standard properties such as: `message`, `msg` and `code`. An error of the following form ``` { \"msg\": \"Book with id: 123 does not exist.\", \"code\": 6063 } ``` can be expressed in RFC 9457 with ``` { \"detail\": \"Book with id: 123 does not exist.\", \"type\": \"https://api.example/v1/errors/6063\", \"status\": 404, \"title\": \"Not Found\" } ``` Returning an URI in `type`, instead of an opaque `code` can help the client in better identifying the error; moreover the URI though it should not be dereferenced automatically, can return an actual resource providing guidance in addressing the issue. See recommendation RAC_REST_NAME_007. To fix: Ensure `@key` does NOT match the regular expression `message|code|msg`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.[responses][?(@property.match(/^(4|5|default)/))][[schema]][properties].*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-standard-payload":{"title":"Response Error Standard Payload","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-standard-payload/","source":"compiled","description":"All 4XX and 5XX response codes must follow Trimble API Standard.","message":"{{error}}","severity":"info","given":"$.paths.*.*.responses","then":{"function":"trimble:check-standard-for-error-payload"},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-standard-payload' (Response Error Standard Payload). Requirement: All 4XX and 5XX response codes must follow Trimble API Standard. This rule is evaluated at the JSONPath `$.paths.*.*.responses.` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-use-problem-json":{"title":"Response Error Use Problem JSON","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-use-problem-json/","source":"default","description":"All 4xx and 5xx error responses MUST use the `application/problem+json` media type (RFC 9457, which obsoleted RFC 7807).","message":"Error response documents MUST use the application/problem+json media type: {{error}}","severity":"info","given":"$.paths..responses[?( @property >= 400 && @property < 600)].content[*]~","then":{"function":"enumeration","functionOptions":{"values":["application/problem+json"]}},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:consistency","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-use-problem-json' (Response Error Use Problem JSON). Requirement: All 4xx and 5xx error responses MUST use the `application/problem+json` media type (RFC 9457, which obsoleted RFC 7807). To fix: Set the targeted value to one of the allowed values: application/problem+json. This rule is evaluated at the JSONPath `$.paths..responses[?( @property >= 400 && @property < 600)].content[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-use-problem-type":{"title":"Response Error Use Problem Type","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-use-problem-type/","source":"compiled","description":"Error management is a key enabler of a resilient API ecosystem. Enforcing a consistent schema for errors between different APIs, enables client to properly implement an error management strategy, with positive impacts for users. Error responses should return one of the media-type defined in RFC 9457: - `application/problem+json` - `application/problem+xml` An example of a valid response: ``` responses: \"503\": content: application/problem+json: schema: ... ```.","message":"Error responses should support RFC 9457 in {{path}}.","severity":"info","given":"$.paths.[*].responses[?(@property.match(/^(4|5|default)/))].content.*~","then":{"function":"enumeration","functionOptions":{"values":["application/problem+xml","application/problem+json"]}},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-use-problem-type' (Response Error Use Problem Type). Requirement: Error management is a key enabler of a resilient API ecosystem. Enforcing a consistent schema for errors between different APIs, enables client to properly implement an error management strategy, with positive impacts for users. Error responses should return one of the media-type defined in RFC 9457: - `application/problem+json` - `application/problem+xml` An example of a valid response: ``` responses: \"503\": content: application/problem+json: schema: ... ```. To fix: Set the targeted value to one of the allowed values: application/problem+xml, application/problem+json. This rule is evaluated at the JSONPath `$.paths.[*].responses[?(@property.match(/^(4|5|default)/))].content.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-error-use-problem-type-2":{"title":"Response Error Use Problem Type 2","reference":"https://spotlight-rules.com/spec/rules/openapi/response-error-use-problem-type-2/","source":"compiled","description":"Every error response SHOULD support RFC 9457.","message":"Every error response SHOULD support RFC 9457.","severity":"info","given":"$.paths...responses[?(@property.match(/^(4|5)/))].content.*~","then":{"function":"enumeration","functionOptions":{"values":["application/problem+xml","application/problem+json"]}},"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-error-use-problem-type-2' (Response Error Use Problem Type 2). Requirement: Every error response SHOULD support RFC 9457. To fix: Set the targeted value to one of the allowed values: application/problem+xml, application/problem+json. This rule is evaluated at the JSONPath `$.paths...responses[?(@property.match(/^(4|5)/))].content.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-cache-control":{"title":"Response Get Cache Control","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-cache-control/","source":"spotlight","description":"GET success responses should define a Cache-Control header so clients and intermediaries know how to cache the representation.","message":"GET success responses should define a `Cache-Control` header.","given":"$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers","severity":"info","then":{"field":"Cache-Control","function":"truthy"},"tags":["format:openapi","spec:responses","topic:caching","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-cache-control' (Response Get Cache Control). Requirement: GET success responses should define a Cache-Control header so clients and intermediaries know how to cache the representation. To fix: Ensure `Cache-Control` is present and non-empty at each matching location. Guidance: GET success responses should define a `Cache-Control` header. This rule is evaluated at the JSONPath `$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-codes-allowed":{"title":"Response Get Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-codes-allowed/","source":"compiled","description":"GET operations should not use status codes 201, 202, 204, 409, 412.","message":"GET operations should not use status codes 201, 202, 204, 409, 412.","severity":"info","given":"$.paths[*].get.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^(201|202|204|409|412)$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-codes-allowed' (Response Get Codes Allowed). Requirement: GET operations should not use status codes 201, 202, 204, 409, 412. To fix: Ensure `@key` does NOT match the regular expression `^(201|202|204|409|412)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].get.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-define-200":{"title":"Response Get Define 200","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-define-200/","source":"compiled","description":"GET responses should have a 200 success HTTP status codes, communicating a successful response to consumers.","message":"GET Responses MUST Have 200 Status Codes","severity":"info","given":"$.paths.*.get.responses","then":{"field":"200","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-define-200' (Response Get Define 200). Requirement: GET responses should have a 200 success HTTP status codes, communicating a successful response to consumers. To fix: Ensure `200` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.get.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-define-401":{"title":"Response Get Define 401","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-define-401/","source":"compiled","description":"GET operations should define a 401 Unauthorized response. Analysis of 773 specs shows 401 is the second most common response code with 4805 occurrences, confirming authentication errors must be documented.","message":"GET MUST Have 401 Response","severity":"info","given":"$.paths[*].get.responses","then":{"field":"401","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:security","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-define-401' (Response Get Define 401). Requirement: GET operations should define a 401 Unauthorized response. Analysis of 773 specs shows 401 is the second most common response code with 4805 occurrences, confirming authentication errors must be documented. To fix: Ensure `401` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-define-500":{"title":"Response Get Define 500","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-define-500/","source":"compiled","description":"GET responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers.","message":"GET Responses MUST Have 500 Status Code","severity":"info","given":"$.paths.*.get.responses","then":{"field":"500","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-define-500' (Response Get Define 500). Requirement: GET responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers. To fix: Ensure `500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.get.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-document-304-not-modified":{"title":"Response Get Document 304 Not Modified","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-document-304-not-modified/","source":"spotlight","description":"GET operations should document a 304 Not Modified response so ETag/Last-Modified conditional requests are handled.","message":"Operation should document a `304` response.","given":"$.paths[*][get].responses","severity":"info","then":{"field":"304","function":"truthy"},"tags":["format:openapi","spec:responses","topic:conditional-requests","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-document-304-not-modified' (Response Get Document 304 Not Modified). Requirement: GET operations should document a 304 Not Modified response so ETag/Last-Modified conditional requests are handled. To fix: Ensure `304` is present and non-empty at each matching location. Guidance: Operation should document a `304` response. This rule is evaluated at the JSONPath `$.paths[*][get].responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-etag":{"title":"Response Get ETag","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-etag/","source":"spotlight","description":"GET success responses should define an ETag header to enable validation-based caching and conditional requests.","message":"GET success responses should define a `ETag` header.","given":"$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers","severity":"info","then":{"field":"ETag","function":"truthy"},"tags":["format:openapi","spec:responses","topic:caching","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-etag' (Response Get ETag). Requirement: GET success responses should define an ETag header to enable validation-based caching and conditional requests. To fix: Ensure `ETag` is present and non-empty at each matching location. Guidance: GET success responses should define a `ETag` header. This rule is evaluated at the JSONPath `$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-last-modified":{"title":"Response Get Last Modified","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-last-modified/","source":"spotlight","description":"GET success responses should define a Last-Modified header to enable date-based conditional requests.","message":"GET success responses should define a `Last-Modified` header.","given":"$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers","severity":"info","then":{"field":"Last-Modified","function":"truthy"},"tags":["format:openapi","spec:responses","topic:caching","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-last-modified' (Response Get Last Modified). Requirement: GET success responses should define a Last-Modified header to enable date-based conditional requests. To fix: Ensure `Last-Modified` is present and non-empty at each matching location. Guidance: GET success responses should define a `Last-Modified` header. This rule is evaluated at the JSONPath `$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-link-header":{"title":"Response Get Link Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-link-header/","source":"spotlight","description":"GET success responses should provide a Link header (RFC 8288) with rel next/prev/first/last for pagination and navigation — the header-based alternative to an in-body paging object.","message":"GET responses should provide a Link header (RFC 8288) for pagination/navigation.","given":"$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers","severity":"info","then":{"field":"Link","function":"truthy"},"tags":["format:openapi","spec:responses","topic:pagination","experience:pagination","experience:discoverability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-link-header' (Response Get Link Header). Requirement: GET success responses should provide a Link header (RFC 8288) with rel next/prev/first/last for pagination and navigation — the header-based alternative to an in-body paging object. To fix: Ensure `Link` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-must-return-200":{"title":"Response Get Must Return 200","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-must-return-200/","source":"compiled","description":"GET operations must always return 200 status code.","message":"GET operations must always return 200 status code.","severity":"info","given":"$.paths[*].get.responses","then":[{"field":"200","function":"truthy"}],"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-must-return-200' (Response Get Must Return 200). Requirement: GET operations must always return 200 status code. To fix: Ensure `200` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-must-return-body":{"title":"Response Get Must Return Body","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-must-return-body/","source":"compiled","description":"A `GET` operation must return a response body.","message":"A `GET` operation must return a response body.","severity":"info","given":"$.paths[*].get.responses[*]","then":{"field":"content","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-must-return-body' (Response Get Must Return Body). Requirement: A `GET` operation must return a response body. To fix: Ensure `content` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].get.responses[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-get-vary":{"title":"Response Get Vary","reference":"https://spotlight-rules.com/spec/rules/openapi/response-get-vary/","source":"spotlight","description":"GET success responses should define a Vary header so caches key correctly on the request headers that affect the representation.","message":"GET success responses should define a `Vary` header.","given":"$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers","severity":"info","then":{"field":"Vary","function":"truthy"},"tags":["format:openapi","spec:responses","topic:caching","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-get-vary' (Response Get Vary). Requirement: GET success responses should define a Vary header so caches key correctly on the request headers that affect the representation. To fix: Ensure `Vary` is present and non-empty at each matching location. Guidance: GET success responses should define a `Vary` header. This rule is evaluated at the JSONPath `$.paths[*].get.responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-head-codes-allowed":{"title":"Response Head Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-head-codes-allowed/","source":"compiled","description":"HEAD operations should not return 201, 202, 204, 409, 412 status codes.","message":"HEAD operations should not return 201, 202, 204, 409, 412 status codes.","severity":"info","given":"$.paths[*].head.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^(201|202|204|409|412)$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-head-codes-allowed' (Response Head Codes Allowed). Requirement: HEAD operations should not return 201, 202, 204, 409, 412 status codes. To fix: Ensure `@key` does NOT match the regular expression `^(201|202|204|409|412)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].head.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-head-must-not-return-body":{"title":"Response Head Must Not Return Body","reference":"https://spotlight-rules.com/spec/rules/openapi/response-head-must-not-return-body/","source":"compiled","description":"HEAD operations should not return a response body for success.","message":"HEAD operations should not return a response body for success.","severity":"info","given":"$.paths.*.head.responses[200].content","then":{"function":"falsy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-head-must-not-return-body' (Response Head Must Not Return Body). Requirement: HEAD operations should not return a response body for success. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.*.head.responses[200].content` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-header-names-pascal-case":{"title":"Response Header Names Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/response-header-names-pascal-case/","source":"compiled","description":"Headers should be pascal-case. See Italian recommendation RAC_REST_NAME_003.","message":"Header {{error}}: {{path}}","severity":"info","given":["$.[responses][*].headers.*~"],"then":{"function":"casing","functionOptions":{"type":"pascal","separator":{"char":"-"}}},"tags":["format:openapi","spec:responses","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-header-names-pascal-case' (Response Header Names Pascal Case). Requirement: Headers should be pascal-case. See Italian recommendation RAC_REST_NAME_003. To fix: Rename the targeted key or value to PascalCase (e.g. `UserName`) at each matching location, updating every reference to it. This rule is evaluated at the JSONPath `$.[responses][*].headers.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-header-no-x-prefix":{"title":"Response Header No X Prefix","reference":"https://spotlight-rules.com/spec/rules/openapi/response-header-no-x-prefix/","source":"compiled","description":"'HTTP' headers SHOULD NOT start with 'X-' RFC6648.","message":"HTTP response header SHOULD NOT start with 'X-' in {{path}}","severity":"info","given":["$.[responses][*].headers.*~"],"then":{"function":"pattern","functionOptions":{"match":"/^([^x]|.[^-])|RateLimit-/i"}},"tags":["format:openapi","spec:responses","spec:headers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-header-no-x-prefix' (Response Header No X Prefix). Requirement: 'HTTP' headers SHOULD NOT start with 'X-' RFC6648. To fix: Ensure the targeted value matches the regular expression `/^([^x]|.[^-])|RateLimit-/i`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.[responses][*].headers.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-include-hypermedia-links":{"title":"Response Include Hypermedia Links","reference":"https://spotlight-rules.com/spec/rules/openapi/response-include-hypermedia-links/","source":"compiled","description":"The API contract MAY include hypermedia links to represent the state of resources and be navigable.","message":"{{description}}: {{error}}","severity":"info","given":"$.paths[*][*].responses[*]","then":{"field":"links","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","experience:discoverability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-include-hypermedia-links' (Response Include Hypermedia Links). Requirement: The API contract MAY include hypermedia links to represent the state of resources and be navigable. To fix: Ensure `links` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-include-ratelimit-header":{"title":"Response Include Ratelimit Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-include-ratelimit-header/","source":"compiled","description":"Response must include ratelimit-x headers.","message":"{{description}}; missing {{property}}","severity":"info","given":"$..responses.*","then":[{"field":"headers.ratelimit-limit","function":"truthy"},{"field":"headers.ratelimit-remaining","function":"truthy"},{"field":"headers.ratelimit-reset","function":"truthy"}],"tags":["format:openapi","spec:responses","topic:rate-limiting","experience:reliability","experience:documentation","experience:performance","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-include-ratelimit-header' (Response Include Ratelimit Header). Requirement: Response must include ratelimit-x headers. To fix: Ensure `headers.ratelimit-limit` is present and non-empty at each matching location. Also: Ensure `headers.ratelimit-remaining` is present and non-empty at each matching location. Also: Ensure `headers.ratelimit-reset` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..responses.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-keys-snake-case":{"title":"Response Keys Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/response-keys-snake-case/","source":"compiled","description":"response key must be snake cased (e.g. snake_case).","message":"{{error}}","severity":"info","given":"$.components['responses'].*~","then":{"function":"digitalocean:ensureSnakeCaseWithDigits"},"tags":["format:openapi","spec:responses","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-keys-snake-case' (Response Keys Snake Case). Requirement: response key must be snake cased (e.g. snake_case). This rule is evaluated at the JSONPath `$.components['responses'].*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-location-header-only-on-201":{"title":"Response Location Header Only On 201","reference":"https://spotlight-rules.com/spec/rules/openapi/response-location-header-only-on-201/","source":"compiled","description":"Location header MUST NOT be present in non-201 responses.","message":"Location header MUST NOT be present in non-201 responses.","severity":"info","given":"$.paths[*][*].responses[?(@property !== '201')].headers","then":{"field":"Location","function":"falsy"},"tags":["format:openapi","spec:paths","spec:responses","spec:headers","experience:consistency","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-location-header-only-on-201' (Response Location Header Only On 201). Requirement: Location header MUST NOT be present in non-201 responses. To fix: Ensure `Location` is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths[*][*].responses[?(@property !== '201')].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-must-use-json-content-type":{"title":"Response Must Use JSON Content Type","reference":"https://spotlight-rules.com/spec/rules/openapi/response-must-use-json-content-type/","source":"compiled","description":"API responses should use application/json as the primary content type. Analysis of 773 specs shows application/json is used by 92% of APIs, making it the universal standard for modern REST APIs.","message":"Response MUST Use application/json Content Type","severity":"info","given":"$.paths.*[get,post,put,patch,delete].responses[*].content","then":{"field":"application/json","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","experience:consistency","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-must-use-json-content-type' (Response Must Use JSON Content Type). Requirement: API responses should use application/json as the primary content type. Analysis of 773 specs shows application/json is used by 92% of APIs, making it the universal standard for modern REST APIs. To fix: Ensure `application/json` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*[get,post,put,patch,delete].responses[*].content` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-names-pascal-case":{"title":"Response Names Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/response-names-pascal-case/","source":"compiled","description":"Response names SHOULD be written in PascalCase.","message":"{{property}} is not PascalCase: {{error}}","severity":"info","given":"$.components.responses.*~","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:responses","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-names-pascal-case' (Response Names Pascal Case). Requirement: Response names SHOULD be written in PascalCase. To fix: Ensure the targeted value matches the regular expression `^[A-Z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.responses.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-no-operational-header-in-spec":{"title":"Response No Operational Header In Spec","reference":"https://spotlight-rules.com/spec/rules/openapi/response-no-operational-header-in-spec/","source":"compiled","description":"Access-Control-*, Content-Type, and Accept Headers SHOULD NOT be specified explicitly in a spec as it an operational concern.","message":"Access-Control-*, Content-Type, and Accept Headers SHOULD NOT be specified explicitly in a spec as it an operational concern.","severity":"info","given":"$.paths[*][*].responses[*].headers","then":{"function":"pattern","functionOptions":{"notMatch":"^(Access-Control-.*|Content-Type|Accept)$"}},"tags":["format:openapi","spec:paths","spec:responses","spec:headers","topic:cors","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-no-operational-header-in-spec' (Response No Operational Header In Spec). Requirement: Access-Control-*, Content-Type, and Accept Headers SHOULD NOT be specified explicitly in a spec as it an operational concern. To fix: Ensure the targeted value does NOT match the regular expression `^(Access-Control-.*|Content-Type|Accept)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-no-sensitive-data-in-header":{"title":"Response No Sensitive Data In Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-no-sensitive-data-in-header/","source":"compiled","description":"Headers MUST NOT contain sensitive data.","message":"Headers MUST NOT contain sensitive data.","severity":"info","given":"$.paths[*][*].responses[*].headers.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^(SPS-Token|SPS-Password|SPS-Identity|Password)$"}},"tags":["format:openapi","spec:paths","spec:responses","spec:headers","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-no-sensitive-data-in-header' (Response No Sensitive Data In Header). Requirement: Headers MUST NOT contain sensitive data. To fix: Ensure the targeted value does NOT match the regular expression `^(SPS-Token|SPS-Password|SPS-Identity|Password)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*].headers.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-options-codes-allowed":{"title":"Response Options Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-options-codes-allowed/","source":"compiled","description":"OPTIONS operations should not return 201, 202, 409, 412 status codes.","message":"OPTIONS operations should not return 201, 202, 409, 412 status codes.","severity":"info","given":"$.paths[*].options.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^(201|202|409|412)$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-options-codes-allowed' (Response Options Codes Allowed). Requirement: OPTIONS operations should not return 201, 202, 409, 412 status codes. To fix: Ensure `@key` does NOT match the regular expression `^(201|202|409|412)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].options.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-options-must-not-return-body":{"title":"Response Options Must Not Return Body","reference":"https://spotlight-rules.com/spec/rules/openapi/response-options-must-not-return-body/","source":"compiled","description":"OPTIONS operations should not return a response body for success.","message":"OPTIONS operations should not return a response body for success.","severity":"info","given":"$.paths.*.options.responses[200, 204].content","then":{"function":"falsy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","experience:consistency","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-options-must-not-return-body' (Response Options Must Not Return Body). Requirement: OPTIONS operations should not return a response body for success. To fix: Ensure the targeted value is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.paths.*.options.responses[200, 204].content` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-owasp-api3-define-error-validation":{"title":"Response OWASP API3 Define Error Validation","reference":"https://spotlight-rules.com/spec/rules/openapi/response-owasp-api3-define-error-validation/","source":"spotlight","description":"Write operations (POST/PUT/PATCH) should define a 400 or 422 validation error response (OWASP API3 — reject malformed or unexpected properties).","message":"Write operations should define a 400 or 422 validation error response.","given":"$.paths[*][post,put,patch].responses","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"object","anyOf":[{"required":["400"]},{"required":["422"]}]}}},"tags":["format:openapi","spec:responses","experience:security","owasp:api3"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-owasp-api3-define-error-validation' (Response OWASP API3 Define Error Validation). Requirement: Write operations (POST/PUT/PATCH) should define a 400 or 422 validation error response (OWASP API3 — reject malformed or unexpected properties). To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[*][post,put,patch].responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-owasp-api8-define-error-401":{"title":"Response OWASP API8 Define Error 401","reference":"https://spotlight-rules.com/spec/rules/openapi/response-owasp-api8-define-error-401/","source":"spotlight","description":"Operations should define a 401 Unauthorized response (OWASP API8 — security misconfiguration; document auth failures).","message":"Operation should define a 401 Unauthorized response.","given":"$.paths[*][get,post,put,patch,delete].responses","severity":"info","then":{"field":"401","function":"truthy"},"tags":["format:openapi","spec:responses","experience:security","owasp:api8"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-owasp-api8-define-error-401' (Response OWASP API8 Define Error 401). Requirement: Operations should define a 401 Unauthorized response (OWASP API8 — security misconfiguration; document auth failures). To fix: Ensure `401` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete].responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-owasp-api8-define-error-500":{"title":"Response OWASP API8 Define Error 500","reference":"https://spotlight-rules.com/spec/rules/openapi/response-owasp-api8-define-error-500/","source":"spotlight","description":"Operations should define a 500 Internal Server Error response (OWASP API8 — document server-error behavior).","message":"Operation should define a 500 Internal Server Error response.","given":"$.paths[*][get,post,put,patch,delete].responses","severity":"info","then":{"field":"500","function":"truthy"},"tags":["format:openapi","spec:responses","experience:security","owasp:api8"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-owasp-api8-define-error-500' (Response OWASP API8 Define Error 500). Requirement: Operations should define a 500 Internal Server Error response (OWASP API8 — document server-error behavior). To fix: Ensure `500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*][get,post,put,patch,delete].responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-patch-codes-allowed":{"title":"Response Patch Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-patch-codes-allowed/","source":"compiled","description":"PATCH operations should not return 201 status code.","message":"PATCH operations should not return 201 status code.","severity":"info","given":"$.paths[*].patch.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^201$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-patch-codes-allowed' (Response Patch Codes Allowed). Requirement: PATCH operations should not return 201 status code. To fix: Ensure `@key` does NOT match the regular expression `^201$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].patch.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-patch-define-200":{"title":"Response Patch Define 200","reference":"https://spotlight-rules.com/spec/rules/openapi/response-patch-define-200/","source":"compiled","description":"PATCH operations should define a 200 OK response for successful partial updates. Analysis shows PATCH is used in 17.7% of APIs.","message":"PATCH MUST Have 200 Response","severity":"info","given":"$.paths[*].patch.responses","then":{"field":"200","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-patch-define-200' (Response Patch Define 200). Requirement: PATCH operations should define a 200 OK response for successful partial updates. Analysis shows PATCH is used in 17.7% of APIs. To fix: Ensure `200` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].patch.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-patch-define-400":{"title":"Response Patch Define 400","reference":"https://spotlight-rules.com/spec/rules/openapi/response-patch-define-400/","source":"compiled","description":"PATCH operations should define a 400 Bad Request response for validation errors on partial update payloads.","message":"PATCH MUST Have 400 Response","severity":"info","given":"$.paths[*].patch.responses","then":{"field":"400","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-patch-define-400' (Response Patch Define 400). Requirement: PATCH operations should define a 400 Bad Request response for validation errors on partial update payloads. To fix: Ensure `400` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].patch.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-patch-define-404":{"title":"Response Patch Define 404","reference":"https://spotlight-rules.com/spec/rules/openapi/response-patch-define-404/","source":"compiled","description":"PATCH operations should define a 404 Not Found response for cases where the resource to be updated does not exist.","message":"PATCH MUST Have 404 Response","severity":"info","given":"$.paths[*].patch.responses","then":{"field":"404","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-patch-define-404' (Response Patch Define 404). Requirement: PATCH operations should define a 404 Not Found response for cases where the resource to be updated does not exist. To fix: Ensure `404` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].patch.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-post-codes-allowed":{"title":"Response Post Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-post-codes-allowed/","source":"compiled","description":"POST operations should not return 412 status codes.","message":"POST operations should not return 412 status codes.","severity":"info","given":"$.paths[*].post.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"412"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-post-codes-allowed' (Response Post Codes Allowed). Requirement: POST operations should not return 412 status codes. To fix: Ensure `@key` does NOT match the regular expression `412`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].post.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-post-define-201":{"title":"Response Post Define 201","reference":"https://spotlight-rules.com/spec/rules/openapi/response-post-define-201/","source":"compiled","description":"POST responses should have a 201 success HTTP status codes, communicating a success created response to consumers.","message":"POST Responses MUST Have 201 Status Codes","severity":"info","given":"$.paths[*].post.responses","then":{"field":"201","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:reliability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-post-define-201' (Response Post Define 201). Requirement: POST responses should have a 201 success HTTP status codes, communicating a success created response to consumers. To fix: Ensure `201` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].post.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-post-define-400":{"title":"Response Post Define 400","reference":"https://spotlight-rules.com/spec/rules/openapi/response-post-define-400/","source":"compiled","description":"POST operations should define a 400 Bad Request response for input validation errors. Analysis shows 400 is the 4th most common response code across 2516 operations.","message":"POST MUST Have 400 Response","severity":"info","given":"$.paths[*].post.responses","then":{"field":"400","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-post-define-400' (Response Post Define 400). Requirement: POST operations should define a 400 Bad Request response for input validation errors. Analysis shows 400 is the 4th most common response code across 2516 operations. To fix: Ensure `400` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].post.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-post-define-401":{"title":"Response Post Define 401","reference":"https://spotlight-rules.com/spec/rules/openapi/response-post-define-401/","source":"compiled","description":"POST operations should define a 401 Unauthorized response to document authentication requirements for write operations.","message":"POST MUST Have 401 Response","severity":"info","given":"$.paths[*].post.responses","then":{"field":"401","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:security","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-post-define-401' (Response Post Define 401). Requirement: POST operations should define a 401 Unauthorized response to document authentication requirements for write operations. To fix: Ensure `401` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].post.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-post-define-500":{"title":"Response Post Define 500","reference":"https://spotlight-rules.com/spec/rules/openapi/response-post-define-500/","source":"compiled","description":"POST responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers.","message":"POST Responses MUST Have 500 Status Codes","severity":"info","given":"$.paths.*.post.responses","then":{"field":"500","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-post-define-500' (Response Post Define 500). Requirement: POST responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers. To fix: Ensure `500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.post.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-post-require-201-or-202":{"title":"Response Post Require 201 Or 202","reference":"https://spotlight-rules.com/spec/rules/openapi/response-post-require-201-or-202/","source":"compiled","description":"All POST methods MUST have a 201 or 202 response.","message":"All POST methods MUST have a 201 or 202 response.","severity":"info","given":["$.paths[*].post.responses"],"then":{"function":"trimble:operation-post-201-202-status-code"},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:consistency","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-post-require-201-or-202' (Response Post Require 201 Or 202). Requirement: All POST methods MUST have a 201 or 202 response. This rule is evaluated at the JSONPath `$.paths[*].post.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-prefer-400-over-422":{"title":"Response Prefer 400 Over 422","reference":"https://spotlight-rules.com/spec/rules/openapi/response-prefer-400-over-422/","source":"compiled","description":"MUST use standard HTTP status codes [150a].","message":"Prefer 400 over 422 as response code","severity":"info","given":"$.paths.*.*.responses.422","then":{"field":"422","function":"defined"},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-prefer-400-over-422' (Response Prefer 400 Over 422). Requirement: MUST use standard HTTP status codes [150a]. To fix: Ensure `422` is defined at each matching location. This rule is evaluated at the JSONPath `$.paths.*.*.responses.422` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-put-codes-allowed":{"title":"Response Put Codes Allowed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-put-codes-allowed/","source":"compiled","description":"PUT operations should not return 200 or 201 status codes.","message":"PUT operations should not return 200 or 201 status codes.","severity":"info","given":"$.paths[*].put.responses","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^(200|201)$"}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-put-codes-allowed' (Response Put Codes Allowed). Requirement: PUT operations should not return 200 or 201 status codes. To fix: Ensure `@key` does NOT match the regular expression `^(200|201)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.paths[*].put.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-put-define-400":{"title":"Response Put Define 400","reference":"https://spotlight-rules.com/spec/rules/openapi/response-put-define-400/","source":"compiled","description":"PUT responses should have a 400 not found HTTP status code, communicating nothing was found to consumers.","message":"PUT Responses MUST Have 400 Status Codes","severity":"info","given":"$.paths.*.put.responses","then":{"field":"400","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-put-define-400' (Response Put Define 400). Requirement: PUT responses should have a 400 not found HTTP status code, communicating nothing was found to consumers. To fix: Ensure `400` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.put.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-put-define-401":{"title":"Response Put Define 401","reference":"https://spotlight-rules.com/spec/rules/openapi/response-put-define-401/","source":"compiled","description":"PUT operations should define a 401 Unauthorized response to document authentication requirements for update operations.","message":"PUT MUST Have 401 Response","severity":"info","given":"$.paths[*].put.responses","then":{"field":"401","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:security","experience:error-handling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-put-define-401' (Response Put Define 401). Requirement: PUT operations should define a 401 Unauthorized response to document authentication requirements for update operations. To fix: Ensure `401` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths[*].put.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-put-define-500":{"title":"Response Put Define 500","reference":"https://spotlight-rules.com/spec/rules/openapi/response-put-define-500/","source":"compiled","description":"PUT responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers.","message":"PUT Responses MUST Have 500 Status Codes","severity":"info","given":"$.paths.*.put.responses","then":{"field":"500","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-put-define-500' (Response Put Define 500). Requirement: PUT responses should have a 500 internal server erorr HTTP status code, communicating the API had a problem to consumers. To fix: Ensure `500` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.put.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-ratelimit-header":{"title":"Response Ratelimit Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-ratelimit-header/","source":"spotlight","description":"Responses should define the structured RateLimit header (current IETF draft) conveying quota, remaining, and reset in one field — the modern successor to the RateLimit-Limit/Remaining/Reset triplet.","message":"Responses should define a `RateLimit` header.","given":"$..responses.*","severity":"info","then":{"field":"headers.RateLimit","function":"truthy"},"tags":["format:openapi","spec:responses","topic:rate-limiting","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-ratelimit-header' (Response Ratelimit Header). Requirement: Responses should define the structured RateLimit header (current IETF draft) conveying quota, remaining, and reset in one field — the modern successor to the RateLimit-Limit/Remaining/Reset triplet. To fix: Ensure `headers.RateLimit` is present and non-empty at each matching location. Guidance: Responses should define a `RateLimit` header. This rule is evaluated at the JSONPath `$..responses.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-ratelimit-policy":{"title":"Response Ratelimit Policy","reference":"https://spotlight-rules.com/spec/rules/openapi/response-ratelimit-policy/","source":"spotlight","description":"Responses should define a RateLimit-Policy header documenting the quota policy and window (e.g. 100;w=60), so clients understand the limits in effect.","message":"Responses should define a `RateLimit-Policy` header.","given":"$..responses.*","severity":"info","then":{"field":"headers.RateLimit-Policy","function":"truthy"},"tags":["format:openapi","spec:responses","topic:rate-limiting","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-ratelimit-policy' (Response Ratelimit Policy). Requirement: Responses should define a RateLimit-Policy header documenting the quota policy and window (e.g. 100;w=60), so clients understand the limits in effect. To fix: Ensure `headers.RateLimit-Policy` is present and non-empty at each matching location. Guidance: Responses should define a `RateLimit-Policy` header. This rule is evaluated at the JSONPath `$..responses.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-require-status-health-check-path":{"title":"Response Require Status Health Check Path","reference":"https://spotlight-rules.com/spec/rules/openapi/response-require-status-health-check-path/","source":"compiled","description":"You must define a `/status` path that can be used to health-check the API. Using this path avoids the arbitrary usage of a server URL for health-check scope. The `/status` endpoint should return a `application/problem+json` response containing a successful status code if the service is working correctly. The service provider is free to define the implementation logic for this path.","message":"The \"/status\" path used to health-check the API must be defined. {{error}}","severity":"info","given":"$","then":{"field":"paths./status.get.responses.200","function":"truthy"},"tags":["format:openapi","spec:document","experience:reliability","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-require-status-health-check-path' (Response Require Status Health Check Path). Requirement: You must define a `/status` path that can be used to health-check the API. Using this path avoids the arbitrary usage of a server URL for health-check scope. The `/status` endpoint should return a `application/problem+json` response containing a successful status code if the service is working correctly. The service provider is free to define the implementation logic for this path. To fix: Ensure `paths./status.get.responses.200` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-return-correlation-id":{"title":"Response Return Correlation ID","reference":"https://spotlight-rules.com/spec/rules/openapi/response-return-correlation-id/","source":"spotlight","description":"Responses should return a correlation / request ID header (e.g. Request-Id or X-Correlation-Id) so callers can correlate a response with their request and with server-side logs.","message":"Responses should return a correlation / request ID header.","given":"$..responses.*","severity":"info","then":{"field":"headers","function":"schema","functionOptions":{"schema":{"type":"object","anyOf":[{"required":["Request-Id"]},{"required":["X-Request-Id"]},{"required":["X-Request-ID"]},{"required":["Correlation-Id"]},{"required":["X-Correlation-Id"]},{"required":["X-Correlation-ID"]}]}}},"tags":["format:openapi","spec:responses","topic:tracing","experience:reliability","experience:usability","experience:observability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-return-correlation-id' (Response Return Correlation ID). Requirement: Responses should return a correlation / request ID header (e.g. Request-Id or X-Correlation-Id) so callers can correlate a response with their request and with server-side logs. To fix: Adjust `headers` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$..responses.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-status-path-problem-schema-fields":{"title":"Response Status Path Problem Schema Fields","reference":"https://spotlight-rules.com/spec/rules/openapi/response-status-path-problem-schema-fields/","source":"compiled","description":"\"/status\" schema is not a Problem object.","message":"{{error}} {{path}}","severity":"info","given":"$.paths.'/status'.get.responses.200.content.[[schema]]","then":[{"function":"truthy","field":"properties.status"},{"function":"truthy","field":"properties.title"},{"function":"truthy","field":"properties.detail"}],"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","spec:schemas","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-status-path-problem-schema-fields' (Response Status Path Problem Schema Fields). Requirement: \"/status\" schema is not a Problem object. To fix: Ensure `properties.status` is present and non-empty at each matching location. Also: Ensure `properties.title` is present and non-empty at each matching location. Also: Ensure `properties.detail` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.'/status'.get.responses.200.content.[[schema]]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-status-path-return-problem-type":{"title":"Response Status Path Return Problem Type","reference":"https://spotlight-rules.com/spec/rules/openapi/response-status-path-return-problem-type/","source":"compiled","description":"\"/status\" must return a Problem object.","message":"{{error}}","severity":"info","given":"$.paths.'/status'.get.responses.200.content.*~","then":{"function":"enumeration","functionOptions":{"values":["application/problem+xml","application/problem+json"]}},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","spec:media-types","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-status-path-return-problem-type' (Response Status Path Return Problem Type). Requirement: \"/status\" must return a Problem object. To fix: Set the targeted value to one of the allowed values: application/problem+xml, application/problem+json. This rule is evaluated at the JSONPath `$.paths.'/status'.get.responses.200.content.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-success-require-ratelimit-header":{"title":"Response Success Require Ratelimit Header","reference":"https://spotlight-rules.com/spec/rules/openapi/response-success-require-ratelimit-header/","source":"compiled","description":"Ratelimiting API preserves a service and limits attack scenario [see API4:2019 Lack of Resources & Rate Limiting](https://owasp.org/www-project-api-security). APIs should use the following headers at least on successful responses: - `X-RateLimit-Limit`: number of total requests in a give time window - `X-RateLimit-Remaining`: remaining requests in the current window - `X-RateLimit-Reset`: number of seconds before the window resets An example set of headers is the following ``` X-Ratelimit-Limit: 100 X-Ratelimit-Remaining: 40 X-Ratelimit-Reset: 12 ``` A standardization proposal for ratelimit headers is ongoning inside the IETF HTTPAPI Workgroup. See [the draft](https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/).","message":"Missing ratelimit headers. {{property}} {{error}} {{path}}","severity":"info","given":"$.[responses][?(@property[0] == \"2\" )][headers]","then":[{"functionOptions":{"properties":["X-RateLimit-Limit","RateLimit-Limit"]},"function":"xor"},{"functionOptions":{"properties":["X-RateLimit-Remaining","RateLimit-Remaining"]},"function":"xor"},{"functionOptions":{"properties":["X-RateLimit-Reset","RateLimit-Reset"]},"function":"xor"}],"formats":["oas3"],"tags":["format:openapi","spec:responses","spec:headers","topic:rate-limiting","experience:reliability","experience:security","experience:performance","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-success-require-ratelimit-header' (Response Success Require Ratelimit Header). Requirement: Ratelimiting API preserves a service and limits attack scenario [see API4:2019 Lack of Resources & Rate Limiting](https://owasp.org/www-project-api-security). APIs should use the following headers at least on successful responses: - `X-RateLimit-Limit`: number of total requests in a give time window - `X-RateLimit-Remaining`: remaining requests in the current window - `X-RateLimit-Reset`: number of seconds before the window resets An example set of headers is the following ``` X-Ratelimit-Limit: 100 X-Ratelimit-Remaining: 40 X-Ratelimit-Reset: 12 ``` A standardization proposal for ratelimit headers is ongoning inside the IETF HTTPAPI Workgroup. See [the draft](https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/). To fix: Include exactly one of: X-RateLimit-Limit, RateLimit-Limit. Also: Include exactly one of: X-RateLimit-Remaining, RateLimit-Remaining. Also: Include exactly one of: X-RateLimit-Reset, RateLimit-Reset. This rule is evaluated at the JSONPath `$.[responses][?(@property[0] == \"2\" )][headers]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-success-use-hal-json":{"title":"Response Success Use HAL JSON","reference":"https://spotlight-rules.com/spec/rules/openapi/response-success-use-hal-json/","source":"default","description":"All 2xx success responses MUST use the `application/hal+json` media type.","message":"Success response documents MUST use the application/hal+json media type: {{error}}","severity":"info","given":"$.paths..responses[?( @property >= 200 && @property < 300 && @property != 204)].content[*]~","then":{"function":"enumeration","functionOptions":{"values":["application/hal+json"]}},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-success-use-hal-json' (Response Success Use HAL JSON). Requirement: All 2xx success responses MUST use the `application/hal+json` media type. To fix: Set the targeted value to one of the allowed values: application/hal+json. This rule is evaluated at the JSONPath `$.paths..responses[?( @property >= 200 && @property < 300 && @property != 204)].content[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-throttled-require-retry-after":{"title":"Response Throttled Require Retry After","reference":"https://spotlight-rules.com/spec/rules/openapi/response-throttled-require-retry-after/","source":"compiled","description":"When a client is either: * throttled out with a 429 status code; * warned about a temporary server issue with a 503 status code; the server should explicitly communicate how long to wait before issuing further requests using the Retry-After header. Retry-After is defined in RFC7231.","message":"Missing ratelimit header: {{property}} in {{path}}","severity":"info","given":"$.[responses][?(@property == \"429\" || @property == \"503\"  )][headers]","then":{"field":"Retry-After","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:responses","spec:headers","topic:rate-limiting","experience:reliability","experience:error-handling","experience:performance","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-throttled-require-retry-after' (Response Throttled Require Retry After). Requirement: When a client is either: * throttled out with a 429 status code; * warned about a temporary server issue with a 503 status code; the server should explicitly communicate how long to wait before issuing further requests using the Retry-After header. Retry-After is defined in RFC7231. To fix: Ensure `Retry-After` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.[responses][?(@property == \"429\" || @property == \"503\" )][headers]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-use-json-api":{"title":"Response Use JSON API","reference":"https://spotlight-rules.com/spec/rules/openapi/response-use-json-api/","source":"default","description":"All responses MUST use the JSON:API `application/vnd.api+json` media type.","message":"Response documents MUST use the application/vnd.api+json (JSON:API) media type: {{error}}","severity":"info","given":"$.paths..responses[?( @property >= 200 && @property < 600 && @property != 204)].content[*]~","then":{"function":"enumeration","functionOptions":{"values":["application/vnd.api+json"]}},"formats":["oas3"],"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-use-json-api' (Response Use JSON API). Requirement: All responses MUST use the JSON:API `application/vnd.api+json` media type. To fix: Set the targeted value to one of the allowed values: application/vnd.api+json. This rule is evaluated at the JSONPath `$.paths..responses[?( @property >= 200 && @property < 600 && @property != 204)].content[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-use-standard-mime-types":{"title":"Response Use Standard Mime Types","reference":"https://spotlight-rules.com/spec/rules/openapi/response-use-standard-mime-types/","source":"compiled","description":"MIME types MUST be standard (application/json, application/problem+json, application/problem+xml) or use custom format application/vnd.*.","message":"MIME types MUST be standard (application/json, application/problem+json, application/problem+xml) or use custom format application/vnd.*.","severity":"info","given":"$.paths[*][*].responses[*].content.*~","then":{"function":"pattern","functionOptions":{"match":"^application/(json|problem\\+json|problem\\+xml|vnd\\..*)$"}},"tags":["format:openapi","spec:paths","spec:responses","spec:media-types","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-use-standard-mime-types' (Response Use Standard Mime Types). Requirement: MIME types MUST be standard (application/json, application/problem+json, application/problem+xml) or use custom format application/vnd.*. To fix: Ensure the targeted value matches the regular expression `^application/(json|problem\\+json|problem\\+xml|vnd\\..*)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.paths[*][*].responses[*].content.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-use-standard-status-codes":{"title":"Response Use Standard Status Codes","reference":"https://spotlight-rules.com/spec/rules/openapi/response-use-standard-status-codes/","source":"compiled","description":"MUST use standard HTTP status codes [150a].","message":"{{property}} is not a standardized response code","severity":"info","given":"$.paths.*.*.responses.*~","then":{"function":"enumeration","functionOptions":{"values":["100","101","200","201","202","203","204","205","206","207","300","301","302","303","304","305","307","400","401","402","403","404","405","406","407","408","409","410","411","412","413","414","415","416","417","422","423","426","428","429","431","500","501","502","503","504","505","511","default"]}},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-use-standard-status-codes' (Response Use Standard Status Codes). Requirement: MUST use standard HTTP status codes [150a]. To fix: Set the targeted value to one of the allowed values: 100, 101, 200, 201, 202, 203, 204, 205, 206, 207, 300, 301, 302, 303, 304, 305, 307, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 422, 423, 426, 428, 429, 431, 500, 501, 502, 503, 504, 505, 511, default. This rule is evaluated at the JSONPath `$.paths.*.*.responses.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-use-standard-status-codes-2":{"title":"Response Use Standard Status Codes 2","reference":"https://spotlight-rules.com/spec/rules/openapi/response-use-standard-status-codes-2/","source":"compiled","description":"An API MUST return HTTP response codes in conformance with RFC-2616 and common usage.","message":"An API MUST return HTTP response codes in conformance with RFC-2616 and common usage.","severity":"info","given":"$.paths...responses.*~","then":{"function":"enumeration","functionOptions":{"values":["200","201","202","204","400","401","403","404","405","406","409","412","415","428","429","500"]}},"tags":["format:openapi","spec:paths","spec:responses","experience:error-handling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-use-standard-status-codes-2' (Response Use Standard Status Codes 2). Requirement: An API MUST return HTTP response codes in conformance with RFC-2616 and common usage. To fix: Set the targeted value to one of the allowed values: 200, 201, 202, 204, 400, 401, 403, 404, 405, 406, 409, 412, 415, 428, 429, 500. This rule is evaluated at the JSONPath `$.paths...responses.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-write-document-412-precondition-failed":{"title":"Response Write Document 412 Precondition Failed","reference":"https://spotlight-rules.com/spec/rules/openapi/response-write-document-412-precondition-failed/","source":"spotlight","description":"Write operations should document a 412 Precondition Failed response for failed conditional (If-Match) writes.","message":"Operation should document a `412` response.","given":"$.paths[*][put,patch,delete].responses","severity":"info","then":{"field":"412","function":"truthy"},"tags":["format:openapi","spec:responses","topic:conditional-requests","experience:reliability","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-write-document-412-precondition-failed' (Response Write Document 412 Precondition Failed). Requirement: Write operations should document a 412 Precondition Failed response for failed conditional (If-Match) writes. To fix: Ensure `412` is present and non-empty at each matching location. Guidance: Operation should document a `412` response. This rule is evaluated at the JSONPath `$.paths[*][put,patch,delete].responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-write-etag":{"title":"Response Write ETag","reference":"https://spotlight-rules.com/spec/rules/openapi/response-write-etag/","source":"spotlight","description":"Write success responses (POST/PUT/PATCH) should define an ETag header so clients receive the new entity tag after a write and can make subsequent conditional requests.","message":"Write success responses should define a `ETag` header.","given":"$.paths[*][post,put,patch].responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers","severity":"info","then":{"field":"ETag","function":"truthy"},"tags":["format:openapi","spec:responses","topic:caching","experience:reliability","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-write-etag' (Response Write ETag). Requirement: Write success responses (POST/PUT/PATCH) should define an ETag header so clients receive the new entity tag after a write and can make subsequent conditional requests. To fix: Ensure `ETag` is present and non-empty at each matching location. Guidance: Write success responses should define a `ETag` header. This rule is evaluated at the JSONPath `$.paths[*][post,put,patch].responses[?( @property >= 200 && @property < 300 && @property != 204 )].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"response-write-require-content-type":{"title":"Response Write Require Content Type","reference":"https://spotlight-rules.com/spec/rules/openapi/response-write-require-content-type/","source":"compiled","description":"All API responses MUST include the Content-Type header in all responses.","message":"{{error}}","severity":"info","given":["$.paths[*].post.responses","$.paths[*].put.responses"],"then":{"function":"trimble:check-for-content-type-in-put-and-post-responses"},"tags":["format:openapi","spec:paths","spec:operations","spec:responses","experience:consistency","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'response-write-require-content-type' (Response Write Require Content Type). Requirement: All API responses MUST include the Content-Type header in all responses. This rule is evaluated at the JSONPath `$.paths[*].post.responses | $.paths[*].put.responses` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-array-property-require-items":{"title":"Schema Array Property Require Items","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-array-property-require-items/","source":"compiled","description":"Schema properties that are of the type array must have an items property defined.","message":"Schema Array Properties MUST Have Items","severity":"info","given":"$.components.schemas.*.properties[?(@.type==\"array\")]","then":{"field":"items","function":"truthy"},"tags":["format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-array-property-require-items' (Schema Array Property Require Items). Requirement: Schema properties that are of the type array must have an items property defined. To fix: Ensure `items` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type==\"array\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-array-property-require-max-items":{"title":"Schema Array Property Require Max Items","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-array-property-require-max-items/","source":"compiled","description":"Schema properties that are of the type array should have a max items property defined.","message":"Schema Array Properties MUST Have Max Items","severity":"info","given":"$.components.schemas.*.properties[?(@.type==\"array\")]","then":[{"field":"maxItems","function":"truthy"}],"tags":["owasp:api4","format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-array-property-require-max-items' (Schema Array Property Require Max Items). Requirement: Schema properties that are of the type array should have a max items property defined. To fix: Ensure `maxItems` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type==\"array\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-array-property-require-min-items":{"title":"Schema Array Property Require Min Items","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-array-property-require-min-items/","source":"compiled","description":"Schema properties that are of the type array should have a min items property defined.","message":"Schema Array Properties MUST Have Min Items","severity":"info","given":"$.components.schemas.*.properties[?(@.type==\"array\")]","then":[{"field":"minItems","function":"truthy"}],"tags":["format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-array-property-require-min-items' (Schema Array Property Require Min Items). Requirement: Schema properties that are of the type array should have a min items property defined. To fix: Ensure `minItems` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type==\"array\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-array-property-typed-items":{"title":"Schema Array Property Typed Items","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-array-property-typed-items/","source":"compiled","description":"Array properties must have an items attribute with a type.","message":"{{error}}","severity":"info","given":"$..*.properties[*]","then":{"function":"digitalocean:ensureAllArraysHaveItemTypes"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-array-property-typed-items' (Schema Array Property Typed Items). Requirement: Array properties must have an items attribute with a type. This rule is evaluated at the JSONPath `$..*.properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-array-require-min-max-items":{"title":"Schema Array Require Min Max Items","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-array-require-min-max-items/","source":"compiled","description":"Array size should be limited to mitigate resource exhaustion attacks. This can be done using `maxItems` and `minItems`, like in the example below. ``` Limited: type: array maxItems: 10 items: type: string format: date ``` You should ensure that the schema referenced in `items` is constrained too. If you delegate input validation to a library or framework, be sure to test it thoroughly and ensure that it verifies `maxItems`.","message":"Schema of type array must specify maxItems and minItems. {{path}} {{error}}","severity":"info","given":["$.[?(@.type==\"array\")]"],"then":[{"field":"maxItems","function":"defined"},{"field":"minItems","function":"defined"}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-array-require-min-max-items' (Schema Array Require Min Max Items). Requirement: Array size should be limited to mitigate resource exhaustion attacks. This can be done using `maxItems` and `minItems`, like in the example below. ``` Limited: type: array maxItems: 10 items: type: string format: date ``` You should ensure that the schema referenced in `items` is constrained too. If you delegate input validation to a library or framework, be sure to test it thoroughly and ensure that it verifies `maxItems`. To fix: Ensure `maxItems` is defined at each matching location. Also: Ensure `minItems` is defined at each matching location. This rule is evaluated at the JSONPath `$.[?(@.type==\"array\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-boolean-no-prefix":{"title":"Schema Boolean No Prefix","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-boolean-no-prefix/","source":"compiled","description":"Boolean properties SHOULD NOT use is, has, or another prefix.","message":"Boolean properties SHOULD NOT use is, has, or another prefix.","severity":"info","given":"$..properties[?(@ && @.type == 'boolean')]~","then":{"function":"pattern","functionOptions":{"notMatch":"^(is|has|was|will|needs|uses|should|can)([A-Z]|$).*"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-boolean-no-prefix' (Schema Boolean No Prefix). Requirement: Boolean properties SHOULD NOT use is, has, or another prefix. To fix: Ensure the targeted value does NOT match the regular expression `^(is|has|was|will|needs|uses|should|can)([A-Z]|$).*`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..properties[?(@ && @.type == 'boolean')]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-collection-require-pagination-params":{"title":"Schema Collection Require Pagination Params","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-collection-require-pagination-params/","source":"compiled","description":"Collection GET endpoints SHOULD support pagination using query parameters. Offset or cursor based pagination is required.","message":"Collection GET endpoints SHOULD support pagination using query parameters.","severity":"info","given":"$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}\\/*.*/))].get","then":[{"field":"parameters","function":"schema","functionOptions":{"schema":{"type":"array","items":{"type":"object"},"contains":{"type":"object","properties":{"name":{"const":"limit"},"in":{"const":"query"}}},"allOf":[{"anyOf":[{"contains":{"type":"object","properties":{"name":{"const":"offset"},"in":{"const":"query"}}}},{"contains":{"type":"object","properties":{"name":{"const":"cursor"},"in":{"const":"query"}}}},{"contains":{"type":"object","properties":{"name":{"const":"page"},"in":{"const":"query"}}}}]}]}}}],"tags":["format:openapi","spec:paths","spec:operations","topic:pagination","experience:pagination","experience:usability","experience:performance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-collection-require-pagination-params' (Schema Collection Require Pagination Params). Requirement: Collection GET endpoints SHOULD support pagination using query parameters. Offset or cursor based pagination is required. To fix: Adjust `parameters` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.paths[?(!@property.match(/.*\\/\\{[^}]+\\}\\/*.*/))].get` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-created-datetime-must-be-date-time":{"title":"Schema Created Datetime Must Be Date Time","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-created-datetime-must-be-date-time/","source":"compiled","description":"createdDateTime MUST use a data type of 'string' with the format 'date-time'.","message":"createdDateTime MUST use a data type of 'string' with the format 'date-time'.","severity":"info","given":"$..properties.createdDateTime","then":[{"field":"type","function":"pattern","functionOptions":{"match":"^string$"}},{"field":"format","function":"truthy"},{"field":"format","function":"pattern","functionOptions":{"match":"^date-time$"}}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-created-datetime-must-be-date-time' (Schema Created Datetime Must Be Date Time). Requirement: createdDateTime MUST use a data type of 'string' with the format 'date-time'. To fix: Ensure `type` matches the regular expression `^string$`; rewrite any value that does not. Also: Ensure `format` is present and non-empty at each matching location. Also: Ensure `format` matches the regular expression `^date-time$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..properties.createdDateTime` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-createdby-property-must-be-string":{"title":"Schema Createdby Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-createdby-property-must-be-string/","source":"compiled","description":"createdBy MUST use a data type of 'string'.","message":"createdBy MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"createdBy\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-createdby-property-must-be-string' (Schema Createdby Property Must Be String). Requirement: createdBy MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"createdBy\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-date-time-property-require-format":{"title":"Schema Date Time Property Require Format","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-date-time-property-require-format/","source":"spotlight","description":"Date/time string properties (createdAt, updated_at, *_date, timestamp, …) should declare a format such as date-time (RFC 3339) so the value is unambiguous and machine-validatable.","message":"Date/time string property should declare a format (e.g. date-time).","given":"$..properties[?( @property.match(/(_at$|_date$|_time$|At$|Date$|Time$|timestamp)/i) && @.type == 'string' )]","severity":"info","then":{"field":"format","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-date-time-property-require-format' (Schema Date Time Property Require Format). Requirement: Date/time string properties (createdAt, updated_at, *_date, timestamp, …) should declare a format such as date-time (RFC 3339) so the value is unambiguous and machine-validatable. To fix: Ensure `format` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..properties[?( @property.match(/(_at$|_date$|_time$|At$|Date$|Time$|timestamp)/i) && @.type == 'string' )]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-definition-camel-case":{"title":"Schema Definition Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-definition-camel-case/","source":"default","description":"Schema definitions MUST follow camelCase.","message":"{{property}} schema definition is not camelCase: {{error}}","severity":"info","given":"$.definitions[*]~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-definition-camel-case' (Schema Definition Camel Case). Requirement: Schema definitions MUST follow camelCase. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-definition-constant-case":{"title":"Schema Definition Constant Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-definition-constant-case/","source":"default","description":"Schema definitions MUST follow CONSTANT_CASE (screaming snake_case).","message":"{{property}} schema definition is not CONSTANT_CASE: {{error}}","severity":"info","given":"$.definitions[*]~","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-definition-constant-case' (Schema Definition Constant Case). Requirement: Schema definitions MUST follow CONSTANT_CASE (screaming snake_case). To fix: Ensure the targeted value matches the regular expression `^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-definition-kebab-case":{"title":"Schema Definition Kebab Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-definition-kebab-case/","source":"default","description":"Schema definitions MUST follow kebab-case.","message":"{{property}} schema definition is not kebab-case: {{error}}","severity":"info","given":"$.definitions[*]~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(-[a-z0-9]+)*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-definition-kebab-case' (Schema Definition Kebab Case). Requirement: Schema definitions MUST follow kebab-case. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(-[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-definition-pascal-case":{"title":"Schema Definition Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-definition-pascal-case/","source":"default","description":"Schema definitions MUST follow PascalCase.","message":"{{property}} schema definition is not PascalCase: {{error}}","severity":"info","given":"$.definitions[*]~","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-definition-pascal-case' (Schema Definition Pascal Case). Requirement: Schema definitions MUST follow PascalCase. To fix: Ensure the targeted value matches the regular expression `^[A-Z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-definition-snake-case":{"title":"Schema Definition Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-definition-snake-case/","source":"default","description":"Schema definitions MUST follow snake_case.","message":"{{property}} schema definition is not snake_case: {{error}}","severity":"info","given":"$.definitions[*]~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(_[a-z0-9]+)*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-definition-snake-case' (Schema Definition Snake Case). Requirement: Schema definitions MUST follow snake_case. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(_[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-deletedby-property-must-be-string":{"title":"Schema Deletedby Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-deletedby-property-must-be-string/","source":"compiled","description":"deletedBy MUST use a data type of 'string'.","message":"deletedBy MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"deletedBy\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-deletedby-property-must-be-string' (Schema Deletedby Property Must Be String). Requirement: deletedBy MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"deletedBy\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-deprecated-property-require-description":{"title":"Schema Deprecated Property Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-deprecated-property-require-description/","source":"spotlight","description":"Deprecated schema properties should have a description explaining the deprecation and the replacement field.","message":"Deprecated property should describe the deprecation.","given":"$..properties[?(@ && @.deprecated == true)]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:schemas","topic:deprecation","experience:versioning","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-deprecated-property-require-description' (Schema Deprecated Property Require Description). Requirement: Deprecated schema properties should have a description explaining the deprecation and the replacement field. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..properties[?(@ && @.deprecated == true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-description-max-length":{"title":"Schema Description Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-description-max-length/","source":"compiled","description":"Schema should have a length limit applied, restricting how long schema descriptions can be, helping keep them concise and consistent.","message":"Schema Description MUST be Less Than 250 Characters","severity":"info","given":"$.components.schemas.*","then":{"field":"description","function":"length","functionOptions":{"max":250}},"tags":["format:openapi","spec:schemas","spec:components","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-description-max-length' (Schema Description Max Length). Requirement: Schema should have a length limit applied, restricting how long schema descriptions can be, helping keep them concise and consistent. To fix: Ensure the length of `description` is at most 250. This rule is evaluated at the JSONPath `$.components.schemas.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-description-property-must-be-string":{"title":"Schema Description Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-description-property-must-be-string/","source":"compiled","description":"description MUST use a data type of 'string'.","message":"description MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"description\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-description-property-must-be-string' (Schema Description Property Must Be String). Requirement: description MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"description\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-enum-not-empty":{"title":"Schema Enum Not Empty","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-enum-not-empty/","source":"spotlight","description":"An enum should declare at least one value — an empty enum permits nothing and is almost always a mistake.","message":"enum should not be empty.","given":"$..enum","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"array","minItems":1}}},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-enum-not-empty' (Schema Enum Not Empty). Requirement: An enum should declare at least one value — an empty enum permits nothing and is almost always a mistake. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$..enum` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-fingerprint-property-must-be-string":{"title":"Schema Fingerprint Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-fingerprint-property-must-be-string/","source":"compiled","description":"Fingerprint values MUST use a data type of `string`.","message":"Fingerprint values MUST use a data type of `string`.","severity":"info","given":"$..[?(@property === \"fingerprint\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-fingerprint-property-must-be-string' (Schema Fingerprint Property Must Be String). Requirement: Fingerprint values MUST use a data type of `string`. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"fingerprint\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-get-define-404-response":{"title":"Schema Get Define 404 Response","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-get-define-404-response/","source":"compiled","description":"GET responses should have a 404 not found HTTP status code, communicating that nothing was found to consumers.","message":"GET Responses MUST Have 404 Status Code","severity":"info","given":"$.paths.*.get[?(@.properties)]","then":{"field":"404","function":"truthy"},"tags":["format:openapi","spec:paths","spec:operations","spec:schemas","experience:error-handling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-get-define-404-response' (Schema Get Define 404 Response). Requirement: GET responses should have a 404 not found HTTP status code, communicating that nothing was found to consumers. To fix: Ensure `404` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.paths.*.get[?(@.properties)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-id-property-must-be-string":{"title":"Schema ID Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-id-property-must-be-string/","source":"compiled","description":"id SHOULD use a data type of 'string'.","message":"id SHOULD use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"id\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-id-property-must-be-string' (Schema ID Property Must Be String). Requirement: id SHOULD use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"id\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-integer-format-allowed-values":{"title":"Schema Integer Format Allowed Values","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-integer-format-allowed-values/","source":"compiled","description":"To improve interoperability, integer and number formats are constrained to a shared subset. See recommendation RAC_REST_FORMAT_004.","message":"Type format is \"{{value}}\", expected one of [int32, int64]. {{path}}","severity":"info","given":"$.[?(@.type==\"integer\")]\n","then":{"field":"format","function":"enumeration","functionOptions":{"values":["int32","int64"]}},"formats":["oas3"],"tags":["format:openapi","spec:document","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-integer-format-allowed-values' (Schema Integer Format Allowed Values). Requirement: To improve interoperability, integer and number formats are constrained to a shared subset. See recommendation RAC_REST_FORMAT_004. To fix: Set `format` to one of the allowed values: int32, int64. This rule is evaluated at the JSONPath `$.[?(@.type==\"integer\")] ` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-integer-require-format":{"title":"Schema Integer Require Format","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-integer-require-format/","source":"compiled","description":"Schema of type number or integer must specify a format to express the associated datatype, eg. `int32`, `int64`, ... You can express similar requirements using the `minimum` and `maximum` properties. See recommendation RAC_REST_FORMAT_004.","message":"Schema of type number or integer must specify a format. {{path}}","severity":"info","given":"$.[?(@.type==\"integer\")]\n","then":{"field":"format","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:document","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-integer-require-format' (Schema Integer Require Format). Requirement: Schema of type number or integer must specify a format to express the associated datatype, eg. `int32`, `int64`, ... You can express similar requirements using the `minimum` and `maximum` properties. See recommendation RAC_REST_FORMAT_004. To fix: Ensure `format` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.[?(@.type==\"integer\")] ` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-keys-snake-case":{"title":"Schema Keys Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-keys-snake-case/","source":"compiled","description":"schema key must be snake cased (e.g. snake_case).","message":"{{error}}","severity":"info","given":"$.components['schemas'].*~","then":{"function":"digitalocean:ensureSnakeCaseWithDigits"},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-keys-snake-case' (Schema Keys Snake Case). Requirement: schema key must be snake cased (e.g. snake_case). This rule is evaluated at the JSONPath `$.components['schemas'].*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-modified-datetime-must-be-date-time":{"title":"Schema Modified Datetime Must Be Date Time","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-modified-datetime-must-be-date-time/","source":"compiled","description":"modifiedDateTime MUST use a data type of 'string' with the format 'date-time'.","message":"modifiedDateTime MUST use a data type of 'string' with the format 'date-time'.","severity":"info","given":"$..properties.modifiedDateTime","then":[{"field":"type","function":"pattern","functionOptions":{"match":"^string$"}},{"field":"format","function":"truthy"},{"field":"format","function":"pattern","functionOptions":{"match":"^date-time$"}}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-modified-datetime-must-be-date-time' (Schema Modified Datetime Must Be Date Time). Requirement: modifiedDateTime MUST use a data type of 'string' with the format 'date-time'. To fix: Ensure `type` matches the regular expression `^string$`; rewrite any value that does not. Also: Ensure `format` is present and non-empty at each matching location. Also: Ensure `format` matches the regular expression `^date-time$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..properties.modifiedDateTime` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-modifiedby-property-must-be-string":{"title":"Schema Modifiedby Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-modifiedby-property-must-be-string/","source":"compiled","description":"modifiedBy MUST use a data type of 'string'.","message":"modifiedBy MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"modifiedBy\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-modifiedby-property-must-be-string' (Schema Modifiedby Property Must Be String). Requirement: modifiedBy MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"modifiedBy\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-monetary-property-avoid-float":{"title":"Schema Monetary Property Avoid Float","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-monetary-property-avoid-float/","source":"spotlight","description":"Monetary properties (amount, price, cost, fee, balance, …) should avoid floating-point numbers, which lose precision — use an integer of minor units or a decimal string instead.","message":"Monetary property should not be a floating-point number.","given":"$..properties[?( @property.match(/(amount|price|cost|total|fee|balance|subtotal)/i) )]","severity":"info","then":{"field":"type","function":"pattern","functionOptions":{"notMatch":"^number$"}},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-monetary-property-avoid-float' (Schema Monetary Property Avoid Float). Requirement: Monetary properties (amount, price, cost, fee, balance, …) should avoid floating-point numbers, which lose precision — use an integer of minor units or a decimal string instead. To fix: Ensure `type` does NOT match the regular expression `^number$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..properties[?( @property.match(/(amount|price|cost|total|fee|balance|subtotal)/i) )]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-name-max-length":{"title":"Schema Name Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-name-max-length/","source":"compiled","description":"Schema should have a length limit applied keeping the names of schema consistent across APIs.","message":"Schema Names MUST Be Less Than 25 Characters","severity":"info","given":"$.components.schemas","then":{"field":"@key","function":"length","functionOptions":{"max":25}},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-name-max-length' (Schema Name Max Length). Requirement: Schema should have a length limit applied keeping the names of schema consistent across APIs. To fix: Ensure the length of `@key` is at most 25. This rule is evaluated at the JSONPath `$.components.schemas` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-name-property-must-be-string":{"title":"Schema Name Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-name-property-must-be-string/","source":"compiled","description":"name MUST use a data type of 'string'.","message":"name MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"name\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-name-property-must-be-string' (Schema Name Property Must Be String). Requirement: name MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"name\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-names-pascal-case":{"title":"Schema Names Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-names-pascal-case/","source":"compiled","description":"Schema names SHOULD be written in PascalCase.","message":"{{property}} is not PascalCase: {{error}}","severity":"info","given":"$.components.schemas.*~","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-names-pascal-case' (Schema Names Pascal Case). Requirement: Schema names SHOULD be written in PascalCase. To fix: Ensure the targeted value matches the regular expression `^[A-Z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.schemas.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-number-format-allowed-values":{"title":"Schema Number Format Allowed Values","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-number-format-allowed-values/","source":"compiled","description":"To improve interoperability, integer and number formats are constrained to a shared subset. See recommendation RAC_REST_FORMAT_004.","message":"Type format is \"{{value}}\", expected one of [decimal32, decimal64, decimal128, float, double]. {{path}}","severity":"info","given":"$.[?(@.type==\"number\")]\n","then":{"field":"format","function":"enumeration","functionOptions":{"values":["decimal32","decimal64","float","double","decimal128"]}},"formats":["oas3"],"tags":["format:openapi","spec:document","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-number-format-allowed-values' (Schema Number Format Allowed Values). Requirement: To improve interoperability, integer and number formats are constrained to a shared subset. See recommendation RAC_REST_FORMAT_004. To fix: Set `format` to one of the allowed values: decimal32, decimal64, float, double, decimal128. This rule is evaluated at the JSONPath `$.[?(@.type==\"number\")] ` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-number-property-require-maximum":{"title":"Schema Number Property Require Maximum","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-number-property-require-maximum/","source":"compiled","description":"Schema properties that are of the type number should have a maximum property defined.","message":"Schema Number Properties MUST Have Maximum","severity":"info","given":"$.components.schemas.*.properties[?(@.type==\"number\")]","then":[{"field":"maximum","function":"defined"}],"tags":["owasp:api4","format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-number-property-require-maximum' (Schema Number Property Require Maximum). Requirement: Schema properties that are of the type number should have a maximum property defined. To fix: Ensure `maximum` is defined at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type==\"number\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-number-property-require-minimum":{"title":"Schema Number Property Require Minimum","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-number-property-require-minimum/","source":"compiled","description":"Schema properties that are of the type number should have a minimum property defined.","message":"Schema Number Properties MUST Have Minimum","severity":"info","given":"$.components.schemas.*.properties[?(@.type==\"number\")]","then":[{"field":"minimum","function":"defined"}],"tags":["owasp:api4","format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-number-property-require-minimum' (Schema Number Property Require Minimum). Requirement: Schema properties that are of the type number should have a minimum property defined. To fix: Ensure `minimum` is defined at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type==\"number\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-number-require-format":{"title":"Schema Number Require Format","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-number-require-format/","source":"compiled","description":"Schema of type number or integer must specify a format to express the associated datatype, eg. `int32`, `int64`, ... You can express similar requirements using the `minimum` and `maximum` properties. See recommendation RAC_REST_FORMAT_004.","message":"Schema of type number or integer must specify a format. {{path}}","severity":"info","given":"$.[?(@.type==\"number\")]","then":{"field":"format","function":"truthy"},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-number-require-format' (Schema Number Require Format). Requirement: Schema of type number or integer must specify a format to express the associated datatype, eg. `int32`, `int64`, ... You can express similar requirements using the `minimum` and `maximum` properties. See recommendation RAC_REST_FORMAT_004. To fix: Ensure `format` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.[?(@.type==\"number\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-number-require-min-max":{"title":"Schema Number Require Min Max","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-number-require-min-max/","source":"compiled","description":"Numeric values should be limited in size to mitigate resource exhaustion using `maximum` and `minimum`. If you delegate input validation to a library or framework, be sure to test it thoroughly.","message":"Schema of type number or integer must specify a maximum and a minimum. {{path}} {{error}}","severity":"info","given":["$.[?(@.type==\"number\")]","$.[?(@.type==\"integer\")]"],"then":[{"field":"maximum","function":"defined"},{"field":"minimum","function":"defined"}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-number-require-min-max' (Schema Number Require Min Max). Requirement: Numeric values should be limited in size to mitigate resource exhaustion using `maximum` and `minimum`. If you delegate input validation to a library or framework, be sure to test it thoroughly. To fix: Ensure `maximum` is defined at each matching location. Also: Ensure `minimum` is defined at each matching location. This rule is evaluated at the JSONPath `$.[?(@.type==\"number\")] | $.[?(@.type==\"integer\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-object-constrain-additional-property":{"title":"Schema Object Constrain Additional Property","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-object-constrain-additional-property/","source":"compiled","description":"By default, jsonschema allows additionalProperties. This means that schema validators can be bypassed using further, unspecified fields. While forbidding additionalProperties can create rigidity and hinder the evolution of an API - eg making it hard to accept new parameters or fields - it is possible that this flexibility can be used to bypass the schema validator and force the application to process unwanted information. Disable `additionalProperties` with `false` ``` Person: type: object additionalProperties: false properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` Or constraint them using `maxProperties` ``` Person: type: object additionalProperties: type: string pattern: /+39[0-9]{,14}/ maxProperties: 3 properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` - no additionalProperties - constrained additionalProperties.","message":"Objects should not allow additionalProperties. Disable them with `additionalProperties: false` or constraint them.","severity":"info","given":["$.[?(@.type==\"object\" && @.additionalProperties &&  @.additionalProperties!=true &&  @.additionalProperties!=false )]"],"then":[{"field":"maxProperties","function":"defined"}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling","owasp:api3"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-object-constrain-additional-property' (Schema Object Constrain Additional Property). Requirement: By default, jsonschema allows additionalProperties. This means that schema validators can be bypassed using further, unspecified fields. While forbidding additionalProperties can create rigidity and hinder the evolution of an API - eg making it hard to accept new parameters or fields - it is possible that this flexibility can be used to bypass the schema validator and force the application to process unwanted information. Disable `additionalProperties` with `false` ``` Person: type: object additionalProperties: false properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` Or constraint them using `maxProperties` ``` Person: type: object additionalProperties: type: string pattern: /+39[0-9]{,14}/ maxProperties: 3 properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` - no additionalProperties - constrained additionalProperties. To fix: Ensure `maxProperties` is defined at each matching location. Guidance: Objects should not allow additionalProperties. Disable them with `additionalProperties: false` or constraint them. This rule is evaluated at the JSONPath `$.[?(@.type==\"object\" && @.additionalProperties && @.additionalProperties!=true && @.additionalProperties!=false )]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-object-disallow-additional-property":{"title":"Schema Object Disallow Additional Property","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-object-disallow-additional-property/","source":"compiled","description":"By default, jsonschema allows additionalProperties. This means that schema validators can be bypassed using further, unspecified fields. While forbidding additionalProperties can create rigidity and hinder the evolution of an API - eg making it hard to accept new parameters or fields - it is possible that this flexibility can be used to bypass the schema validator and force the application to process unwanted information. Disable `additionalProperties` with `false` ``` Person: type: object additionalProperties: false properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` Or constraint them using `maxProperties` ``` Person: type: object additionalProperties: type: string pattern: /+39[0-9]{,14}/ maxProperties: 3 properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` - no additionalProperties - constrained additionalProperties.","message":"Objects should not allow additionalProperties. Disable them with `additionalProperties: false` or constraint them.","severity":"info","given":["$.[?(@.type==\"object\" && @.additionalProperties==true)]"],"then":[{"field":"additionalProperties","function":"falsy"}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling","owasp:api3"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-object-disallow-additional-property' (Schema Object Disallow Additional Property). Requirement: By default, jsonschema allows additionalProperties. This means that schema validators can be bypassed using further, unspecified fields. While forbidding additionalProperties can create rigidity and hinder the evolution of an API - eg making it hard to accept new parameters or fields - it is possible that this flexibility can be used to bypass the schema validator and force the application to process unwanted information. Disable `additionalProperties` with `false` ``` Person: type: object additionalProperties: false properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` Or constraint them using `maxProperties` ``` Person: type: object additionalProperties: type: string pattern: /+39[0-9]{,14}/ maxProperties: 3 properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` - no additionalProperties - constrained additionalProperties. To fix: Ensure `additionalProperties` is absent or empty (falsy) at each matching location. Guidance: Objects should not allow additionalProperties. Disable them with `additionalProperties: false` or constraint them. This rule is evaluated at the JSONPath `$.[?(@.type==\"object\" && @.additionalProperties==true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-object-set-additional-property":{"title":"Schema Object Set Additional Property","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-object-set-additional-property/","source":"compiled","description":"By default, jsonschema allows additionalProperties. This means that schema validators can be bypassed using further, unspecified fields. While forbidding additionalProperties can create rigidity and hinder the evolution of an API - eg making it hard to accept new parameters or fields - it is possible that this flexibility can be used to bypass the schema validator and force the application to process unwanted information. Disable `additionalProperties` with `false` ``` Person: type: object additionalProperties: false properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` Or constraint them using `maxProperties` ``` Person: type: object additionalProperties: type: string pattern: /+39[0-9]{,14}/ maxProperties: 3 properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` - no additionalProperties - constrained additionalProperties. @.additionalProperties)]`).","message":"Objects should not allow additionalProperties. Disable them with `additionalProperties: false` or constraint them.","severity":"info","given":["$.[?(@.type==\"object\" && ! @.additionalProperties)]"],"then":[{"field":"additionalProperties","function":"defined"}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling","owasp:api3"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-object-set-additional-property' (Schema Object Set Additional Property). Requirement: By default, jsonschema allows additionalProperties. This means that schema validators can be bypassed using further, unspecified fields. While forbidding additionalProperties can create rigidity and hinder the evolution of an API - eg making it hard to accept new parameters or fields - it is possible that this flexibility can be used to bypass the schema validator and force the application to process unwanted information. Disable `additionalProperties` with `false` ``` Person: type: object additionalProperties: false properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` Or constraint them using `maxProperties` ``` Person: type: object additionalProperties: type: string pattern: /+39[0-9]{,14}/ maxProperties: 3 properties: given_name: type: string pattern: [a-zA-Z ]{24} ``` - no additionalProperties - constrained additionalProperties. @.additionalProperties)]`). To fix: Ensure `additionalProperties` is defined at each matching location. Guidance: Objects should not allow additionalProperties. Disable them with `additionalProperties: false` or constraint them. This rule is evaluated at the JSONPath `$.[?(@.type==\"object\" && ! @.additionalProperties)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-orgid-property-must-be-string":{"title":"Schema Orgid Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-orgid-property-must-be-string/","source":"compiled","description":"orgId MUST use a data type of 'string'.","message":"orgId MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"orgId\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-orgid-property-must-be-string' (Schema Orgid Property Must Be String). Requirement: orgId MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"orgId\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-owasp-api4-integer-format":{"title":"Schema OWASP API4 Integer Format","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-owasp-api4-integer-format/","source":"spotlight","description":"Integer properties should declare a format (int32 / int64) so their range is bounded (OWASP API4 — unrestricted resource consumption).","message":"Integer property should declare a format (int32 or int64).","given":"$..properties[?(@ && @.type == 'integer')]","severity":"info","then":{"field":"format","function":"truthy"},"tags":["format:openapi","spec:schemas","experience:security","owasp:api4"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-owasp-api4-integer-format' (Schema OWASP API4 Integer Format). Requirement: Integer properties should declare a format (int32 / int64) so their range is bounded (OWASP API4 — unrestricted resource consumption). To fix: Ensure `format` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$..properties[?(@ && @.type == 'integer')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-camel-case":{"title":"Schema Property Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-camel-case/","source":"default","description":"Schema properties MUST follow camelCase.","message":"{{property}} schema property is not camelCase: {{error}}","severity":"info","given":"$.definitions..properties[*]~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-camel-case' (Schema Property Camel Case). Requirement: Schema properties MUST follow camelCase. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions..properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-camel-case-3":{"title":"Schema Property Camel Case 3","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-camel-case-3/","source":"compiled","description":"Schema property names should use camelCase. Analysis of 773 specs shows camelCase is the dominant convention at 65% (12958 properties), followed by snake_case at 33% (6661 properties).","message":"Schema Properties MUST Use camelCase","severity":"info","given":"$.components.schemas[*].properties","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-camel-case-3' (Schema Property Camel Case 3). Requirement: Schema property names should use camelCase. Analysis of 773 specs shows camelCase is the dominant convention at 65% (12958 properties), followed by snake_case at 33% (6661 properties). To fix: Ensure the targeted value matches the regular expression `^[a-z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.schemas[*].properties` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-constant-case":{"title":"Schema Property Constant Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-constant-case/","source":"default","description":"Schema properties MUST follow CONSTANT_CASE (screaming snake_case).","message":"{{property}} schema property is not CONSTANT_CASE: {{error}}","severity":"info","given":"$.definitions..properties[*]~","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-constant-case' (Schema Property Constant Case). Requirement: Schema properties MUST follow CONSTANT_CASE (screaming snake_case). To fix: Ensure the targeted value matches the regular expression `^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions..properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-description-max-length":{"title":"Schema Property Description Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-description-max-length/","source":"compiled","description":"Schema property descriptions should have a length limit applied, applying constraints to writing descriptions, and keeping consistent across APIs.","message":"Schema Properties Description MUST Have 250 Characters","severity":"info","given":"$.components.schemas.*.properties[?(@.type == 'string')]","then":{"field":"description","function":"length","functionOptions":{"max":250}},"tags":["format:openapi","spec:schemas","spec:components","experience:documentation","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-description-max-length' (Schema Property Description Max Length). Requirement: Schema property descriptions should have a length limit applied, applying constraints to writing descriptions, and keeping consistent across APIs. To fix: Ensure the length of `description` is at most 250. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type == 'string')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-enum-upper-snake-case":{"title":"Schema Property Enum Upper Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-enum-upper-snake-case/","source":"compiled","description":"Schema property enumerators are consistent casing, keeping all entries upper snake case, and consistent across all APIs.","message":"Schema Property Enum MUST Be Upper Snake Case","severity":"info","given":"$.components.schemas.*.properties.*.enum.*","then":{"function":"pattern","functionOptions":{"match":"^[A-Z]+(?:_[A-Z]+)*$"}},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-enum-upper-snake-case' (Schema Property Enum Upper Snake Case). Requirement: Schema property enumerators are consistent casing, keeping all entries upper snake case, and consistent across all APIs. To fix: Ensure the targeted value matches the regular expression `^[A-Z]+(?:_[A-Z]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.schemas.*.properties.*.enum.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-kebab-case":{"title":"Schema Property Kebab Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-kebab-case/","source":"default","description":"Schema properties MUST follow kebab-case.","message":"{{property}} schema property is not kebab-case: {{error}}","severity":"info","given":"$.definitions..properties[*]~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(-[a-z0-9]+)*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-kebab-case' (Schema Property Kebab Case). Requirement: Schema properties MUST follow kebab-case. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(-[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions..properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-names-camel-case":{"title":"Schema Property Names Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-names-camel-case/","source":"compiled","description":"Schema property names are camel case, providing consistent casing across all the schema properties used by APIs.","message":"Schema Property Names MUST Be camelCase.","severity":"info","given":"$.components.schemas.*.properties","then":[{"field":"@key","function":"pattern","functionOptions":{"notMatch":"^[A-Z][a-z0-9]*[A-Z0-9][a-z0-9]+[A-Za-z0-9]*$"}}],"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-names-camel-case' (Schema Property Names Camel Case). Requirement: Schema property names are camel case, providing consistent casing across all the schema properties used by APIs. To fix: Ensure `@key` does NOT match the regular expression `^[A-Z][a-z0-9]*[A-Z0-9][a-z0-9]+[A-Za-z0-9]*$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.components.schemas.*.properties` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-names-camel-case-2":{"title":"Schema Property Names Camel Case 2","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-names-camel-case-2/","source":"compiled","description":"Property names and acronyms MUST be in camelCase.","message":"Property names and acronyms MUST be in camelCase.","severity":"info","given":"$..properties.*~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(([A-Z]{2}|[A-Z])[a-z0-9]+)*$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-names-camel-case-2' (Schema Property Names Camel Case 2). Requirement: Property names and acronyms MUST be in camelCase. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(([A-Z]{2}|[A-Z])[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-names-length-limit":{"title":"Schema Property Names Length Limit","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-names-length-limit/","source":"compiled","description":"Schema property names have a length restriction applied, keeping names consistent, and avoiding being too long.","message":"Schema Properties Name Length","severity":"info","given":"$.components.schemas.*.properties","then":{"field":"@key","function":"length","functionOptions":{"max":25}},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-names-length-limit' (Schema Property Names Length Limit). Requirement: Schema property names have a length restriction applied, keeping names consistent, and avoiding being too long. To fix: Ensure the length of `@key` is at most 25. This rule is evaluated at the JSONPath `$.components.schemas.*.properties` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-no-language-keywords":{"title":"Schema Property No Language Keywords","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-no-language-keywords/","source":"compiled","description":"Names that may conflict with keywords in common programming languages SHOULD NOT be used.","message":"Names that may conflict with keywords in common programming languages SHOULD NOT be used.","severity":"info","given":"$..properties.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^(abstract|for|new|switch|assert|default|goto|package|synchronized|boolean|do|if|private|this|break|double|implements|throw|byte|else|import|public|throws|case|enum|instanceof|return|transient|catch|extends|int|short|try|char|final|interface|static|void|class|finally|long|volatile|const|float|native|super|while)$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-no-language-keywords' (Schema Property No Language Keywords). Requirement: Names that may conflict with keywords in common programming languages SHOULD NOT be used. To fix: Ensure the targeted value does NOT match the regular expression `^(abstract|for|new|switch|assert|default|goto|package|synchronized|boolean|do|if|private|this|break|double|implements|throw|byte|else|import|public|throws|case|enum|instanceof|return|transient|catch|extends|int|short|try|char|final|interface|static|void|class|finally|long|volatile|const|float|native|super|while)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-no-prepositions":{"title":"Schema Property No Prepositions","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-no-prepositions/","source":"compiled","description":"Property names SHOULD NOT include prepositions (e.g. \"for\", \"during\", \"at\", etc.).","message":"Property names SHOULD NOT include prepositions (e.g.","severity":"info","given":"$..properties.*~","then":{"function":"pattern","functionOptions":{"notMatch":"(^(about|above|across|after|against|among|around|at|before|behind|below|beside|between|down|during|for|from|in|inside|into|near|of|off|on|out|over|through|to|toward|under|up|with|as|but|like|since|than|till|unlike|until|upon|within|without)([A-Z]|$)|.*(About|Above|Across|After|Against|Among|Around|At|Before|Behind|Below|Beside|Between|Down|During|For|From|In|Inside|Into|Near|Of|Off|On|Out|Over|Through|To|Toward|Under|Up|With|As|But|Like|Since|Than|Till|Unlike|Until|Upon|Within|Without)([A-Z]|$)).*"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-no-prepositions' (Schema Property No Prepositions). Requirement: Property names SHOULD NOT include prepositions (e.g. \"for\", \"during\", \"at\", etc.). To fix: Ensure the targeted value does NOT match the regular expression `(^(about|above|across|after|against|among|around|at|before|behind|below|beside|between|down|during|for|from|in|inside|into|near|of|off|on|out|over|through|to|toward|under|up|with|as|but|like|since|than|till|unlike|until|upon|within|without)([A-Z]|$)|.*(About|Above|Across|After|Against|Among|Around|At|Before|Behind|Below|Beside|Between|Down|During|For|From|In|Inside|Into|Near|Of|Off|On|Out|Over|Through|To|Toward|Under|Up|With|As|But|Like|Since|Than|Till|Unlike|Until|Upon|Within|Without)([A-Z]|$)).*`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-pascal-case":{"title":"Schema Property Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-pascal-case/","source":"default","description":"Schema properties MUST follow PascalCase.","message":"{{property}} schema property is not PascalCase: {{error}}","severity":"info","given":"$.definitions..properties[*]~","then":{"function":"pattern","functionOptions":{"match":"^[A-Z][a-zA-Z0-9]*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-pascal-case' (Schema Property Pascal Case). Requirement: Schema properties MUST follow PascalCase. To fix: Ensure the targeted value matches the regular expression `^[A-Z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions..properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-require-description":{"title":"Schema Property Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-require-description/","source":"compiled","description":"Schema properties should have descriptions that provide a narrative of the property contains, and how it can be used.","message":"Schema Properties MUST Have Description","severity":"info","given":"$.components.schemas.*.properties[?(@.type == 'string')]","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:schemas","spec:components","experience:documentation","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-require-description' (Schema Property Require Description). Requirement: Schema properties should have descriptions that provide a narrative of the property contains, and how it can be used. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type == 'string')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-require-examples":{"title":"Schema Property Require Examples","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-require-examples/","source":"compiled","description":"Object properties must include examples.","message":"{{description}}; {{property}}","severity":"info","given":"$..properties..properties.*","then":{"function":"digitalocean:ensurePropertiesExample"},"tags":["format:openapi","spec:schemas","experience:documentation","experience:usability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-require-examples' (Schema Property Require Examples). Requirement: Object properties must include examples. This rule is evaluated at the JSONPath `$..properties..properties.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-require-type":{"title":"Schema Property Require Type","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-require-type/","source":"compiled","description":"Schema properties must have a type defined.","message":"{{error}}","severity":"info","given":"$..properties.*","then":{"function":"digitalocean:ensureSchemaHasType"},"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-require-type' (Schema Property Require Type). Requirement: Schema properties must have a type defined. This rule is evaluated at the JSONPath `$..properties.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-property-snake-case":{"title":"Schema Property Snake Case","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-property-snake-case/","source":"default","description":"Schema properties MUST follow snake_case.","message":"{{property}} schema property is not snake_case: {{error}}","severity":"info","given":"$.definitions..properties[*]~","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-z0-9]*(_[a-z0-9]+)*$"}},"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-property-snake-case' (Schema Property Snake Case). Requirement: Schema properties MUST follow snake_case. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-z0-9]*(_[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.definitions..properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-ref-property-must-be-string":{"title":"Schema Ref Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-ref-property-must-be-string/","source":"compiled","description":"ref MUST use a data type of 'string'.","message":"ref MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"ref\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-ref-property-must-be-string' (Schema Ref Property Must Be String). Requirement: ref MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"ref\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-ref-property-require-format":{"title":"Schema Ref Property Require Format","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-ref-property-require-format/","source":"compiled","description":"Property with the name 'ref' MUST use a format 'sps-ref'.","message":"Property with the name 'ref' MUST use a format 'sps-ref'.","severity":"info","given":"$..properties..[?((@property=== \"ref\" || @property === \"Ref\") && @.$ref == null && @.allOf == null && @.oneOf == null && @.type != null)]","then":[{"field":"format","function":"truthy"},{"field":"format","function":"pattern","functionOptions":{"match":"^sps-ref$"}}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-ref-property-require-format' (Schema Ref Property Require Format). Requirement: Property with the name 'ref' MUST use a format 'sps-ref'. To fix: Ensure `format` is present and non-empty at each matching location. Also: Ensure `format` matches the regular expression `^sps-ref$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..properties..[?((@property=== \"ref\" || @property === \"Ref\") && @.$ref == null && @.allOf == null && @.oneOf == null && @.type != null)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-ref-property-standard":{"title":"Schema Ref Property Standard","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-ref-property-standard/","source":"compiled","description":"Properties following 'sps-ref' format MUST use the standardized schema - maxLength (255), minLength(7), pattern (includes 'sps'), type (string).","message":"{{property}} is not provided or not following required schema values.","severity":"info","given":"$..[?(@property=== \"format\" && @ == \"sps-ref\")]^","then":[{"function":"schema","functionOptions":{"schema":{"type":"object","required":["maxLength","minLength","type","pattern"],"properties":{"maxLength":{"type":"integer","minimum":255,"maximum":255},"minLength":{"type":"integer","minimum":7,"maximum":7},"type":{"type":"string"},"pattern":{"type":"string"}}}}},{"field":"pattern","function":"pattern","functionOptions":{"match":"sps"}},{"field":"type","function":"pattern","functionOptions":{"match":"^string$"}}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-ref-property-standard' (Schema Ref Property Standard). Requirement: Properties following 'sps-ref' format MUST use the standardized schema - maxLength (255), minLength(7), pattern (includes 'sps'), type (string). To fix: Adjust the targeted value so it conforms to the schema this rule requires. Also: Ensure `pattern` matches the regular expression `sps`; rewrite any value that does not. Also: Ensure `type` matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property=== \"format\" && @ == \"sps-ref\")]^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-requestid-property-must-be-string":{"title":"Schema Requestid Property Must Be String","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-requestid-property-must-be-string/","source":"compiled","description":"requestId MUST use a data type of 'string'.","message":"requestId MUST use a data type of 'string'.","severity":"info","given":"$..[?(@property === \"requestId\")].type","then":{"function":"pattern","functionOptions":{"match":"^string$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","topic:tracing","experience:data-modeling","experience:consistency","experience:observability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-requestid-property-must-be-string' (Schema Requestid Property Must Be String). Requirement: requestId MUST use a data type of 'string'. To fix: Ensure the targeted value matches the regular expression `^string$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$..[?(@property === \"requestId\")].type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-require-description":{"title":"Schema Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-require-description/","source":"compiled","description":"Schema should have descriptions that provide a narrative of what a schema object is for, and how it can be used, leaving examples to demonstrate what can actually be expected.","message":"Schema MUST Have a Description.","severity":"info","given":"$.components.schemas.*","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:schemas","spec:components","experience:documentation","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-require-description' (Schema Require Description). Requirement: Schema should have descriptions that provide a narrative of what a schema object is for, and how it can be used, leaving examples to demonstrate what can actually be expected. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-require-info-object":{"title":"Schema Require Info Object","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-require-info-object/","source":"compiled","description":"Having an info object provides much of the metadata needed for the collection of APIs described in an OpenAPI.","message":"Info Object MUST Exist","severity":"info","given":"$","then":{"field":"info","function":"truthy"},"tags":["format:openapi","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-require-info-object' (Schema Require Info Object). Requirement: Having an info object provides much of the metadata needed for the collection of APIs described in an OpenAPI. To fix: Ensure `info` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-require-name":{"title":"Schema Require Name","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-require-name/","source":"compiled","description":"Schema names, keeping the naming of them consistent across APIs, standardizing how consumers can use in their applications.","message":"Schema Names MUST Exist","severity":"info","given":"$.components.schemas","then":{"field":"@key","function":"truthy"},"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-require-name' (Schema Require Name). Requirement: Schema names, keeping the naming of them consistent across APIs, standardizing how consumers can use in their applications. To fix: Ensure `@key` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-require-tag-object":{"title":"Schema Require Tag Object","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-require-tag-object/","source":"compiled","description":"There needs to be a central tags object applied to the OpenAPI, providing central tags that can be applied across all operations within an OpenAPI.","message":"OpenAPIs MUST Have a Tag Object","severity":"info","given":"$","then":{"field":"tags","function":"truthy"},"tags":["format:openapi","spec:document","experience:discoverability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-require-tag-object' (Schema Require Tag Object). Requirement: There needs to be a central tags object applied to the OpenAPI, providing central tags that can be applied across all operations within an OpenAPI. To fix: Ensure `tags` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-require-type":{"title":"Schema Require Type","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-require-type/","source":"compiled","description":"Schema should have a type defined, being explicit about type of data a schema describes and can be used to validate, helping standardize the type of data being made available.","message":"Schema MUST Have Type Property","severity":"info","given":"$.components.schemas.*","then":{"field":"type","function":"truthy"},"tags":["format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-require-type' (Schema Require Type). Requirement: Schema should have a type defined, being explicit about type of data a schema describes and can be used to validate, helping standardize the type of data being made available. To fix: Ensure `type` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-string-property-require-max-length":{"title":"Schema String Property Require Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-string-property-require-max-length/","source":"compiled","description":"Schema properties that are of the string type have the max length applied defining the shape of the property.","message":"Schema String Properties MUST Have Maximum Length","severity":"info","given":"$.components.schemas.*.properties[?(@.type == 'string')]","then":{"field":"maxLength","function":"truthy"},"tags":["owasp:api4","format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-string-property-require-max-length' (Schema String Property Require Max Length). Requirement: Schema properties that are of the string type have the max length applied defining the shape of the property. To fix: Ensure `maxLength` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type == 'string')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-string-property-require-min-length":{"title":"Schema String Property Require Min Length","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-string-property-require-min-length/","source":"compiled","description":"Schema properties that are of the string type have the min length applied defining the shape of the property.","message":"Schema String Properties MUST Have Minimum Length","severity":"info","given":"$.components.schemas.*.properties[?(@.type == 'string')]","then":{"field":"minLength","function":"truthy"},"tags":["format:openapi","spec:schemas","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-string-property-require-min-length' (Schema String Property Require Min Length). Requirement: Schema properties that are of the string type have the min length applied defining the shape of the property. To fix: Ensure `minLength` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas.*.properties[?(@.type == 'string')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-string-require-max-length":{"title":"Schema String Require Max Length","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-string-require-max-length/","source":"compiled","description":"String length should be limited to avoid an attacker to send very long strings to your service. You can do this in different ways: - specify a `maxLength` - constraint the possible values with an `enum` - use a constrained `format` like `date` or `date-time`. A constrained string using the `date` format. ``` ConstrainedString: type: string format: date ``` Another constrained string using `maxLength`. You can always add further constraints using a `pattern` or a `format`. ``` ZipCode: type: string maxLength: 5 pattern: '[0-9]{5}' ``` For further security, you can always limit string length even in conjunction with `format` and `pattern`.","message":"Strings (non enum) must specify a maximum length. {{path}} {{error}}","severity":"info","given":["$.[?(@.type==\"string\" && !@.enum && @.format!=\"date\" && @.format !=\"date-time\" )]"],"then":[{"field":"maxLength","function":"defined"}],"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-string-require-max-length' (Schema String Require Max Length). Requirement: String length should be limited to avoid an attacker to send very long strings to your service. You can do this in different ways: - specify a `maxLength` - constraint the possible values with an `enum` - use a constrained `format` like `date` or `date-time`. A constrained string using the `date` format. ``` ConstrainedString: type: string format: date ``` Another constrained string using `maxLength`. You can always add further constraints using a `pattern` or a `format`. ``` ZipCode: type: string maxLength: 5 pattern: '[0-9]{5}' ``` For further security, you can always limit string length even in conjunction with `format` and `pattern`. To fix: Ensure `maxLength` is defined at each matching location. This rule is evaluated at the JSONPath `$.[?(@.type==\"string\" && !@.enum && @.format!=\"date\" && @.format !=\"date-time\" )]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-string-require-pattern-or-format":{"title":"Schema String Require Pattern Or Format","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-string-require-pattern-or-format/","source":"compiled","description":"String length should be limited to avoid an attacker to send very long strings to your service. You can do this in different ways: - specify a `maxLength` - constraint the possible values with an `enum` - use a constrained `format` like `date` or `date-time`. A constrained string using the `date` format. ``` ConstrainedString: type: string format: date ``` Another constrained string using `maxLength`. You can always add further constraints using a `pattern` or a `format`. ``` ZipCode: type: string maxLength: 5 pattern: '[0-9]{5}' ``` For further security, you can always limit string length even in conjunction with `format` and `pattern`.","message":"Strings (non enum) must specify a pattern or a format. {{path}}","severity":"info","given":["$.[?(@.type==\"string\" && !@.enum && @.format!=\"date\" && @.format !=\"date-time\" )]"],"then":{"function":"schema","functionOptions":{"schema":{"type":"object","anyOf":[{"required":["pattern"]},{"required":["format"]}],"additionalProperties":true}}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:security","experience:data-modeling"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-string-require-pattern-or-format' (Schema String Require Pattern Or Format). Requirement: String length should be limited to avoid an attacker to send very long strings to your service. You can do this in different ways: - specify a `maxLength` - constraint the possible values with an `enum` - use a constrained `format` like `date` or `date-time`. A constrained string using the `date` format. ``` ConstrainedString: type: string format: date ``` Another constrained string using `maxLength`. You can always add further constraints using a `pattern` or a `format`. ``` ZipCode: type: string maxLength: 5 pattern: '[0-9]{5}' ``` For further security, you can always limit string length even in conjunction with `format` and `pattern`. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.[?(@.type==\"string\" && !@.enum && @.format!=\"date\" && @.format !=\"date-time\" )]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-use-fingerprint-not-hash":{"title":"Schema Use Fingerprint Not Hash","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-use-fingerprint-not-hash/","source":"compiled","description":"Rather than property names refering to the implementation for 'hash' or 'hashkey', you MUST use the property name 'fingerprint'.","message":"{{property}} is not using property name fingerprint.","severity":"info","given":"$.components.schemas..properties.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^hashkey|hashKey|hash$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-use-fingerprint-not-hash' (Schema Use Fingerprint Not Hash). Requirement: Rather than property names refering to the implementation for 'hash' or 'hashkey', you MUST use the property name 'fingerprint'. To fix: Ensure the targeted value does NOT match the regular expression `^hashkey|hashKey|hash$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.components.schemas..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-use-id-not-identifier":{"title":"Schema Use ID Not Identifier","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-use-id-not-identifier/","source":"compiled","description":"Use abbreviations instead of long form names, i.e. identifier SHOULD BE id.","message":"Use abbreviations instead of long form names, i.e.","severity":"info","given":"$..properties.*~","then":{"function":"pattern","functionOptions":{"notMatch":"^identifier$"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-use-id-not-identifier' (Schema Use ID Not Identifier). Requirement: Use abbreviations instead of long form names, i.e. identifier SHOULD BE id. To fix: Ensure the targeted value does NOT match the regular expression `^identifier$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-use-org-not-organization":{"title":"Schema Use Org Not Organization","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-use-org-not-organization/","source":"compiled","description":"Use abbreviations instead of long form names, i.e. organization SHOULD BE org.","message":"Use abbreviations instead of long form names, i.e.","severity":"info","given":"$..properties.*~","then":{"function":"pattern","functionOptions":{"notMatch":"(^organization([A-Z]|$)|Organization([A-Z]|$))"}},"formats":["oas3"],"tags":["format:openapi","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-use-org-not-organization' (Schema Use Org Not Organization). Requirement: Use abbreviations instead of long form names, i.e. organization SHOULD BE org. To fix: Ensure the targeted value does NOT match the regular expression `(^organization([A-Z]|$)|Organization([A-Z]|$))`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..properties.*~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"schema-write-operation-require-security":{"title":"Schema Write Operation Require Security","reference":"https://spotlight-rules.com/spec/rules/openapi/schema-write-operation-require-security/","source":"compiled","description":"Your API should be protected by a `security` rule either at global or operation level. Operations should be protected specially when they are tied to non-idempotent HTTP methods like `POST`, `PUT`, `PATCH` and `DELETE`. This is done with one or more non-empty `security` rules. Security rules are defined in the `securityScheme` section. An example of a security rule applied at global level. ``` security: - BasicAuth: [] paths: /books: {} /users: {} securitySchemes: BasicAuth: scheme: http type: basic ``` An example of a security rule applied at operation level, which eventually overrides the global one ``` paths: /books: post: security: - AccessToken: [] securitySchemes: BasicAuth: scheme: http type: basic AccessToken: scheme: http type: bearer bearerFormat: JWT ```.","message":"The following non-idempotent operation is not protected by a `security` rule: {{path}}","severity":"info","given":["$.paths.*[?(@property.match(/^(post|put|patch|delete)/))]"],"then":[{"field":"security","function":"schema","functionOptions":{"schema":{"items":{"type":"object","minProperties":1},"minItems":1,"type":"array"}}}],"formats":["oas3"],"tags":["owasp:api2","format:openapi","spec:paths","spec:operations","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'schema-write-operation-require-security' (Schema Write Operation Require Security). Requirement: Your API should be protected by a `security` rule either at global or operation level. Operations should be protected specially when they are tied to non-idempotent HTTP methods like `POST`, `PUT`, `PATCH` and `DELETE`. This is done with one or more non-empty `security` rules. Security rules are defined in the `securityScheme` section. An example of a security rule applied at global level. ``` security: - BasicAuth: [] paths: /books: {} /users: {} securitySchemes: BasicAuth: scheme: http type: basic ``` An example of a security rule applied at operation level, which eventually overrides the global one ``` paths: /books: post: security: - AccessToken: [] securitySchemes: BasicAuth: scheme: http type: basic AccessToken: scheme: http type: bearer bearerFormat: JWT ```. To fix: Adjust `security` so it conforms to the schema this rule requires. Guidance: The following non-idempotent operation is not protected by a `security` rule. This rule is evaluated at the JSONPath `$.paths.*[?(@property.match(/^(post|put|patch|delete)/))]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-bearer-scheme-require-bearer-format":{"title":"Security Bearer Scheme Require Bearer Format","reference":"https://spotlight-rules.com/spec/rules/openapi/security-bearer-scheme-require-bearer-format/","source":"spotlight","description":"HTTP bearer security schemes should declare a bearerFormat (e.g. JWT) so consumers know the token type and tooling can validate it.","message":"HTTP bearer scheme should declare a bearerFormat (e.g. JWT).","given":"$.components.securitySchemes[?(@ && @.type == 'http' && @.scheme == 'bearer')]","severity":"info","then":{"field":"bearerFormat","function":"truthy"},"tags":["format:openapi","spec:components","experience:security","owasp:api2"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-bearer-scheme-require-bearer-format' (Security Bearer Scheme Require Bearer Format). Requirement: HTTP bearer security schemes should declare a bearerFormat (e.g. JWT) so consumers know the token type and tooling can validate it. To fix: Ensure `bearerFormat` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.securitySchemes[?(@ && @.type == 'http' && @.scheme == 'bearer')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-jwt-scheme-require-description":{"title":"Security JWT Scheme Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/security-jwt-scheme-require-description/","severity":"info","source":"compiled","description":"Json Web Tokens RFC7519 is a compact, URL-safe means of representing claims to be transferred between two parties. JWT can be enclosed in encrypted or signed tokens like JWS and JWE. The [JOSE IANA registry](https://www.iana.org/assignments/jose/jose.xhtml) provides algorithms information. RFC8725 describes common pitfalls in the JWx specifications and in their implementations, such as: - the ability to ignore algorithms, eg. `{\"alg\": \"none\"}`; - using insecure algorithms like `RSASSA-PKCS1-v1_5` eg. `{\"alg\": \"RS256\"}`. An API using JWT should explicit in the `description` that the implementation conforms to RFC8725. ``` components: securitySchemes: JWTBearer: type: http scheme: bearer bearerFormat: JWT description: |- A bearer token in the format of a JWS and conformato to the specifications included in RFC8725. ```.","message":"JWT usage should be detailed in `description` {{error}}.","given":["$.[securitySchemes][?(@.bearerFormat==\"jwt\" || @.bearerFormat==\"JWT\")]"],"then":[{"field":"description","function":"truthy"},{"field":"description","function":"pattern","functionOptions":{"match":".*RFC8725.*"}}],"tags":["owasp:api2","format:openapi","spec:security","experience:security","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-jwt-scheme-require-description' (Security JWT Scheme Require Description). Requirement: Json Web Tokens RFC7519 is a compact, URL-safe means of representing claims to be transferred between two parties. JWT can be enclosed in encrypted or signed tokens like JWS and JWE. The [JOSE IANA registry](https://www.iana.org/assignments/jose/jose.xhtml) provides algorithms information. RFC8725 describes common pitfalls in the JWx specifications and in their implementations, such as: - the ability to ignore algorithms, eg. `{\"alg\": \"none\"}`; - using insecure algorithms like `RSASSA-PKCS1-v1_5` eg. `{\"alg\": \"RS256\"}`. An API using JWT should explicit in the `description` that the implementation conforms to RFC8725. ``` components: securitySchemes: JWTBearer: type: http scheme: bearer bearerFormat: JWT description: |- A bearer token in the format of a JWS and conformato to the specifications included in RFC8725. ```. To fix: Ensure `description` is present and non-empty at each matching location. Also: Ensure `description` matches the regular expression `.*RFC8725.*`; rewrite any value that does not. Guidance: JWT usage should be detailed in `description`. This rule is evaluated at the JSONPath `$.[securitySchemes][?(@.bearerFormat==\"jwt\" || @.bearerFormat==\"JWT\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-no-http-basic-auth":{"title":"Security No HTTP Basic Auth","reference":"https://spotlight-rules.com/spec/rules/openapi/security-no-http-basic-auth/","source":"compiled","description":"Consider a more secure alternative to HTTP Basic.","message":"HTTP Basic is an insecure way to pass credentials around, use an alternative.","severity":"info","given":"$.components.securitySchemes[*]","then":{"field":"scheme","function":"pattern","functionOptions":{"notMatch":"basic"}},"tags":["owasp:api2","format:openapi","spec:security","spec:components","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-no-http-basic-auth' (Security No HTTP Basic Auth). Requirement: Consider a more secure alternative to HTTP Basic. To fix: Ensure `scheme` does NOT match the regular expression `basic`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.components.securitySchemes[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-oauth-disallow-insecure-flows":{"title":"Security OAuth Disallow Insecure Flows","reference":"https://spotlight-rules.com/spec/rules/openapi/security-oauth-disallow-insecure-flows/","source":"compiled","description":"The OAuth2 authorization framework defines various [grant types](https://tools.ietf.org/html/rfc6749#section-1.3), most notably the [AuthorizationCode](https://tools.ietf.org/html/rfc6749#section-1.3.1) and the [Client Credentials](https://tools.ietf.org/html/rfc6749#section-1.3.4). Some grant types are now considered insecure and MUST not be used, including `implicit` and `password`. The new [OAuth2.1](https://tools.ietf.org/html/draft-ietf-oauth-v2-1-01) still in draft, removes them and suggests to replace the `implicit` with `authorizationCode` + PKCE defined in RFC7636.","message":"Do not use oauth2 insecure flow: \"{{property}}\".","severity":"info","given":["$.[?(@.type==\"oauth2\")].flows"],"then":[{"field":"implicit","function":"falsy"},{"field":"password","function":"falsy"}],"formats":["oas3"],"tags":["format:openapi","spec:security","experience:security","owasp:api2"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-oauth-disallow-insecure-flows' (Security OAuth Disallow Insecure Flows). Requirement: The OAuth2 authorization framework defines various [grant types](https://tools.ietf.org/html/rfc6749#section-1.3), most notably the [AuthorizationCode](https://tools.ietf.org/html/rfc6749#section-1.3.1) and the [Client Credentials](https://tools.ietf.org/html/rfc6749#section-1.3.4). Some grant types are now considered insecure and MUST not be used, including `implicit` and `password`. The new [OAuth2.1](https://tools.ietf.org/html/draft-ietf-oauth-v2-1-01) still in draft, removes them and suggests to replace the `implicit` with `authorizationCode` + PKCE defined in RFC7636. To fix: Ensure `implicit` is absent or empty (falsy) at each matching location. Also: Ensure `password` is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.[?(@.type==\"oauth2\")].flows` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-oauth-endpoints-require-https":{"title":"Security OAuth Endpoints Require HTTPS","reference":"https://spotlight-rules.com/spec/rules/openapi/security-oauth-endpoints-require-https/","source":"compiled","description":"OAuth2 endpoints must use `https://`.","message":"OAuth endpoints must use https://","severity":"info","given":["$.[securitySchemes][?(@.type==\"oauth2\")][*].[?(@property.match(/url$/i))]"],"then":[{"field":"value","function":"pattern","functionOptions":{"match":"^https://"}}],"formats":["oas3"],"tags":["owasp:api8","format:openapi","spec:security","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-oauth-endpoints-require-https' (Security OAuth Endpoints Require HTTPS). Requirement: OAuth2 endpoints must use `https://`. To fix: Ensure `value` matches the regular expression `^https://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.[securitySchemes][?(@.type==\"oauth2\")][*].[?(@property.match(/url$/i))]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-oauth-flow-require-scopes":{"title":"Security OAuth Flow Require Scopes","reference":"https://spotlight-rules.com/spec/rules/openapi/security-oauth-flow-require-scopes/","source":"spotlight","description":"OAuth2 flows should define scopes so authorization is granular and least-privilege rather than all-or-nothing.","message":"OAuth2 flow should define at least one scope.","given":"$.components.securitySchemes[?(@ && @.type == 'oauth2')].flows[*]","severity":"info","then":{"field":"scopes","function":"schema","functionOptions":{"schema":{"type":"object","minProperties":1}}},"tags":["format:openapi","spec:components","experience:security","experience:governance","owasp:api5"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-oauth-flow-require-scopes' (Security OAuth Flow Require Scopes). Requirement: OAuth2 flows should define scopes so authorization is granular and least-privilege rather than all-or-nothing. To fix: Adjust `scopes` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.components.securitySchemes[?(@ && @.type == 'oauth2')].flows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-oauth-scheme-require-description":{"title":"Security OAuth Scheme Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/security-oauth-scheme-require-description/","severity":"info","source":"compiled","description":"Json Web Tokens RFC7519 is a compact, URL-safe means of representing claims to be transferred between two parties. JWT can be enclosed in encrypted or signed tokens like JWS and JWE. The [JOSE IANA registry](https://www.iana.org/assignments/jose/jose.xhtml) provides algorithms information. RFC8725 describes common pitfalls in the JWx specifications and in their implementations, such as: - the ability to ignore algorithms, eg. `{\"alg\": \"none\"}`; - using insecure algorithms like `RSASSA-PKCS1-v1_5` eg. `{\"alg\": \"RS256\"}`. An API using JWT should explicit in the `description` that the implementation conforms to RFC8725. ``` components: securitySchemes: JWTBearer: type: http scheme: bearer bearerFormat: JWT description: |- A bearer token in the format of a JWS and conformato to the specifications included in RFC8725. ```.","message":"JWT usage should be detailed in `description` {{error}}.","given":["$.[securitySchemes][?(@.type==\"oauth2\")]"],"then":[{"field":"description","function":"truthy"},{"field":"description","function":"pattern","functionOptions":{"match":".*RFC8725.*"}}],"tags":["owasp:api2","format:openapi","spec:security","experience:security","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-oauth-scheme-require-description' (Security OAuth Scheme Require Description). Requirement: Json Web Tokens RFC7519 is a compact, URL-safe means of representing claims to be transferred between two parties. JWT can be enclosed in encrypted or signed tokens like JWS and JWE. The [JOSE IANA registry](https://www.iana.org/assignments/jose/jose.xhtml) provides algorithms information. RFC8725 describes common pitfalls in the JWx specifications and in their implementations, such as: - the ability to ignore algorithms, eg. `{\"alg\": \"none\"}`; - using insecure algorithms like `RSASSA-PKCS1-v1_5` eg. `{\"alg\": \"RS256\"}`. An API using JWT should explicit in the `description` that the implementation conforms to RFC8725. ``` components: securitySchemes: JWTBearer: type: http scheme: bearer bearerFormat: JWT description: |- A bearer token in the format of a JWS and conformato to the specifications included in RFC8725. ```. To fix: Ensure `description` is present and non-empty at each matching location. Also: Ensure `description` matches the regular expression `.*RFC8725.*`; rewrite any value that does not. Guidance: JWT usage should be detailed in `description`. This rule is evaluated at the JSONPath `$.[securitySchemes][?(@.type==\"oauth2\")]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-openidconnect-require-url":{"title":"Security OpenID-Connect Require URL","reference":"https://spotlight-rules.com/spec/rules/openapi/security-openidconnect-require-url/","source":"spotlight","description":"OpenID Connect security schemes should declare an openIdConnectUrl pointing at the discovery document so clients can configure themselves.","message":"openIdConnect scheme should declare an openIdConnectUrl.","given":"$.components.securitySchemes[?(@ && @.type == 'openIdConnect')]","severity":"info","then":{"field":"openIdConnectUrl","function":"truthy"},"tags":["format:openapi","spec:components","experience:security","owasp:api2"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-openidconnect-require-url' (Security OpenID-Connect Require URL). Requirement: OpenID Connect security schemes should declare an openIdConnectUrl pointing at the discovery document so clients can configure themselves. To fix: Ensure `openIdConnectUrl` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.securitySchemes[?(@ && @.type == 'openIdConnect')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-openidconnect-url-https":{"title":"Security OpenID-Connect URL HTTPS","reference":"https://spotlight-rules.com/spec/rules/openapi/security-openidconnect-url-https/","source":"spotlight","description":"The OpenID Connect discovery URL (openIdConnectUrl) should use https so token/identity configuration is not retrieved over an insecure channel.","message":"openIdConnectUrl should use https.","given":"$.components.securitySchemes[?(@ && @.type == 'openIdConnect')].openIdConnectUrl","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https://"}},"tags":["format:openapi","spec:components","experience:security","owasp:api8"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-openidconnect-url-https' (Security OpenID-Connect URL HTTPS). Requirement: The OpenID Connect discovery URL (openIdConnectUrl) should use https so token/identity configuration is not retrieved over an insecure channel. To fix: Ensure the targeted value matches the regular expression `^https://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.securitySchemes[?(@ && @.type == 'openIdConnect')].openIdConnectUrl` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-owasp-api2-auth-insecure-schemes":{"title":"Security OWASP API2 Auth Insecure Schemes","reference":"https://spotlight-rules.com/spec/rules/openapi/security-owasp-api2-auth-insecure-schemes/","source":"spotlight","description":"HTTP auth schemes should not use insecure mechanisms such as negotiate or oauth1 (OWASP API2). Prefer bearer with a vetted token.","message":"HTTP auth scheme is insecure (avoid negotiate / oauth1).","given":"$.components.securitySchemes[?(@ && @.type == 'http')].scheme","severity":"info","then":{"function":"pattern","functionOptions":{"notMatch":"^(negotiate|oauth)$"}},"tags":["format:openapi","spec:components","experience:security","owasp:api2"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-owasp-api2-auth-insecure-schemes' (Security OWASP API2 Auth Insecure Schemes). Requirement: HTTP auth schemes should not use insecure mechanisms such as negotiate or oauth1 (OWASP API2). Prefer bearer with a vetted token. To fix: Ensure the targeted value does NOT match the regular expression `^(negotiate|oauth)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.components.securitySchemes[?(@ && @.type == 'http')].scheme` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-owasp-api2-no-api-keys-in-url":{"title":"Security OWASP API2 No API Keys In URL","reference":"https://spotlight-rules.com/spec/rules/openapi/security-owasp-api2-no-api-keys-in-url/","source":"spotlight","description":"API key security schemes should be sent in a header or cookie, never in the query string or path (OWASP API2 — credentials leak into logs and history).","message":"apiKey scheme should be in a header or cookie, not the URL.","given":"$.components.securitySchemes[?(@ && @.type == 'apiKey')]","severity":"info","then":{"field":"in","function":"enumeration","functionOptions":{"values":["header","cookie"]}},"tags":["format:openapi","spec:components","experience:security","owasp:api2"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-owasp-api2-no-api-keys-in-url' (Security OWASP API2 No API Keys In URL). Requirement: API key security schemes should be sent in a header or cookie, never in the query string or path (OWASP API2 — credentials leak into logs and history). To fix: Set `in` to one of the allowed values: header, cookie. This rule is evaluated at the JSONPath `$.components.securitySchemes[?(@ && @.type == 'apiKey')]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-require-root":{"title":"Security Require Root","reference":"https://spotlight-rules.com/spec/rules/openapi/security-require-root/","source":"compiled","description":"The API contract MUST include a 'security' section at the root level.","message":"{{description}}: {{error}}","severity":"info","given":"$","then":{"field":"security","function":"truthy"},"formats":["oas3"],"tags":["owasp:api2","format:openapi","spec:document","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-require-root' (Security Require Root). Requirement: The API contract MUST include a 'security' section at the root level. To fix: Ensure `security` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-require-root-scheme":{"title":"Security Require Root Scheme","reference":"https://spotlight-rules.com/spec/rules/openapi/security-require-root-scheme/","source":"compiled","description":"Security field MUST be present at the root of the spec with at least one item (ie. HTTPBearer, Token, APIKey, etc.).","message":"Security field MUST be present at the root of the spec with at least one item (ie.","severity":"info","given":"$","then":{"field":"security","function":"schema","functionOptions":{"schema":{"type":"array","minItems":1}}},"tags":["owasp:api2","format:openapi","spec:document","experience:security","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-require-root-scheme' (Security Require Root Scheme). Requirement: Security field MUST be present at the root of the spec with at least one item (ie. HTTPBearer, Token, APIKey, etc.). To fix: Adjust `security` so it conforms to the schema this rule requires. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"security-scheme-require-description":{"title":"Security Scheme Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/security-scheme-require-description/","source":"spotlight","description":"Every security scheme should declare a description so consumers know how to authenticate (which token, where to get it, what scopes).","message":"Security scheme should have a description.","given":"$.components.securitySchemes[*]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:components","experience:security","owasp:api2"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'security-scheme-require-description' (Security Scheme Require Description). Requirement: Every security scheme should declare a description so consumers know how to authenticate (which token, where to get it, what scopes). To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.securitySchemes[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-must-not-specify-port":{"title":"Server Must Not Specify Port","reference":"https://spotlight-rules.com/spec/rules/openapi/server-must-not-specify-port/","source":"compiled","description":"Port MUST NOT be specified or required to use the API, except for 'localhost' testing in a spec.","message":"Port MUST NOT be specified or required to use the API, except for 'localhost' testing in a spec.","severity":"info","given":"$.servers..url","then":{"function":"pattern","functionOptions":{"notMatch":"(?!https?://localhost)(https?://.*):(\\d*)\\/?(.*)"}},"formats":["oas3"],"tags":["format:openapi","spec:servers","experience:usability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-must-not-specify-port' (Server Must Not Specify Port). Requirement: Port MUST NOT be specified or required to use the API, except for 'localhost' testing in a spec. To fix: Ensure the targeted value does NOT match the regular expression `(?!https?://localhost)(https?://.*):(\\d*)\\/?(.*)`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers..url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-must-use-https":{"title":"Server Must Use HTTPS","reference":"https://spotlight-rules.com/spec/rules/openapi/server-must-use-https/","source":"compiled","description":"Servers MUST be https and no other protocol is allowed unless using localhost.","message":"Servers MUST be https and no other protocol is allowed unless using localhost.","severity":"info","given":"$.servers..url","then":{"function":"pattern","functionOptions":{"match":"^(https:|http://localhost)"}},"formats":["oas3"],"tags":["owasp:api8","format:openapi","spec:servers","experience:security","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-must-use-https' (Server Must Use HTTPS). Requirement: Servers MUST be https and no other protocol is allowed unless using localhost. To fix: Ensure the targeted value matches the regular expression `^(https:|http://localhost)`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.servers..url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-on-approved-domain":{"title":"Server On Approved Domain","reference":"https://spotlight-rules.com/spec/rules/openapi/server-on-approved-domain/","source":"compiled","description":"APIs SHOULD be accessible under api.spscommerce.com.","message":"APIs SHOULD be accessible under api.spscommerce.com.","severity":"info","given":"$.servers..url","then":{"function":"pattern","functionOptions":{"match":"api.spscommerce.com|api.sps-internal.com|localhost"}},"formats":["oas3"],"tags":["format:openapi","spec:servers","experience:governance","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-on-approved-domain' (Server On Approved Domain). Requirement: APIs SHOULD be accessible under api.spscommerce.com. To fix: Ensure the targeted value matches the regular expression `api.spscommerce.com|api.sps-internal.com|localhost`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.servers..url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-require-description":{"title":"Server Require Description","reference":"https://spotlight-rules.com/spec/rules/openapi/server-require-description/","source":"compiled","description":"Servers must have a description.","message":"Server {{path}} must have a description.","severity":"info","given":["$.servers[*]","$.paths..servers"],"then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:servers","spec:paths","experience:documentation"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-require-description' (Server Require Description). Requirement: Servers must have a description. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.servers[*] | $.paths..servers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-require-https":{"title":"Server Require HTTPS","reference":"https://spotlight-rules.com/spec/rules/openapi/server-require-https/","source":"compiled","description":"ALL requests MUST go through `https` protocol only.","message":"Servers MUST be https and no other protocol is allowed.","severity":"info","given":"$.servers..url","then":{"function":"pattern","functionOptions":{"match":"/^https:/"}},"formats":["oas3"],"tags":["owasp:api8","format:openapi","spec:servers","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-require-https' (Server Require HTTPS). Requirement: ALL requests MUST go through `https` protocol only. To fix: Ensure the targeted value matches the regular expression `/^https:/`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.servers..url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-require-https-2":{"title":"Server Require HTTPS 2","reference":"https://spotlight-rules.com/spec/rules/openapi/server-require-https-2/","source":"compiled","description":"Servers must use https to ensure the origin of the responses and protect the integrity and the confidentiality of the communication. You can use `http://` only on sandboxes environment. Use `x-sandbox: true` to skip this kind of check.","message":"Non-sandbox url  {{value}} {{error}}. Add `x-sandbox: true` to skip this check on a specific server.","severity":"info","given":["$.servers[?(@[\"x-sandbox\"] != true)]","$.paths..servers[?(@[\"x-sandbox\"] != true)]"],"then":{"field":"url","function":"pattern","functionOptions":{"match":"^https://.*"}},"tags":["owasp:api8","format:openapi","spec:servers","spec:paths","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-require-https-2' (Server Require HTTPS 2). Requirement: Servers must use https to ensure the origin of the responses and protect the integrity and the confidentiality of the communication. You can use `http://` only on sandboxes environment. Use `x-sandbox: true` to skip this kind of check. To fix: Ensure `url` matches the regular expression `^https://.*`; rewrite any value that does not. Guidance: Non-sandbox url . Add `x-sandbox: true` to skip this check on a specific server. This rule is evaluated at the JSONPath `$.servers[?(@[\"x-sandbox\"] != true)] | $.paths..servers[?(@[\"x-sandbox\"] != true)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-url-include-version":{"title":"Server URL Include Version","reference":"https://spotlight-rules.com/spec/rules/openapi/server-url-include-version/","source":"compiled","description":"API URLs versions should meet the Trimble API Standards.","message":"{{error}}","severity":"info","given":"$.servers","then":{"function":"trimble:valid-version-checker"},"tags":["format:openapi","spec:servers","experience:versioning","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-url-include-version' (Server URL Include Version). Requirement: API URLs versions should meet the Trimble API Standards. This rule is evaluated at the JSONPath `$.servers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-url-meet-standards":{"title":"Server URL Meet Standards","reference":"https://spotlight-rules.com/spec/rules/openapi/server-url-meet-standards/","source":"compiled","description":"API URLs should meet the Trimble API Standards.","message":"{{error}}","severity":"info","given":"$.servers","then":{"function":"trimble:valid-url-checker"},"tags":["format:openapi","spec:servers","experience:consistency","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-url-meet-standards' (Server URL Meet Standards). Requirement: API URLs should meet the Trimble API Standards. This rule is evaluated at the JSONPath `$.servers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-url-must-be-lowercase":{"title":"Server URL Must Be Lowercase","reference":"https://spotlight-rules.com/spec/rules/openapi/server-url-must-be-lowercase/","source":"compiled","description":"Server URL SHOULD BE lowercase.","message":"Server URL SHOULD BE lowercase.","severity":"info","given":"$.servers..url","then":{"function":"pattern","functionOptions":{"match":"^[^A-Z]*$"}},"formats":["oas3"],"tags":["format:openapi","spec:servers","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-url-must-be-lowercase' (Server URL Must Be Lowercase). Requirement: Server URL SHOULD BE lowercase. To fix: Ensure the targeted value matches the regular expression `^[^A-Z]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.servers..url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"server-url-require-https":{"title":"Server URL Require HTTPS","reference":"https://spotlight-rules.com/spec/rules/openapi/server-url-require-https/","source":"compiled","description":"API server URLs should use HTTPS to ensure encrypted communication between clients and servers, protecting sensitive data in transit.","message":"Server URL MUST Use HTTPS","severity":"info","given":"$.servers[*]","then":{"field":"url","function":"pattern","functionOptions":{"match":"^https://"}},"tags":["owasp:api8","format:openapi","spec:servers","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'server-url-require-https' (Server URL Require HTTPS). Requirement: API server URLs should use HTTPS to ensure encrypted communication between clients and servers, protecting sensitive data in transit. To fix: Ensure `url` matches the regular expression `^https://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.servers[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-description":{"title":"Tag Description","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-description/","source":"builtin","description":"Tag object must have \"description\".","message":"Tag object must have \"description\".","severity":"info","given":"$.tags[*]","then":{"field":"description","function":"truthy"},"tags":["format:openapi","spec:tags","experience:documentation","experience:discoverability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-description' (Tag Description). Requirement: Tag object must have \"description\". To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-names-title-case":{"title":"Tag Names Title Case","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-names-title-case/","source":"compiled","description":"The first letter of each word in a tag being applied to APIs needs to be capitalized, keeping the tags being applied across APIs the same look and feel for organizing and publishing to documentation.","message":"Tag Names MUST Have First Letter in Each Word Capitalized","severity":"info","given":"$.tags.*.name","then":{"function":"pattern","functionOptions":{"match":"[A-Z]\\w*"}},"tags":["format:openapi","spec:tags","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-names-title-case' (Tag Names Title Case). Requirement: The first letter of each word in a tag being applied to APIs needs to be capitalized, keeping the tags being applied across APIs the same look and feel for organizing and publishing to documentation. To fix: Ensure the targeted value matches the regular expression `[A-Z]\\w*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.tags.*.name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-no-camel-case":{"title":"Tag No Camel Case","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-no-camel-case/","source":"compiled","description":"Detects a tag with camelCase (personalItem) text within it.","message":"Tag names cannot use Camel Case. Please rename {{value}}.","severity":"info","given":["$.tags[*].name","$.paths[*][*].tags[*]"],"then":{"function":"pattern","functionOptions":{"notMatch":"/^[a-z]+[A-Z][a-z]+$/g"}},"tags":["format:openapi","spec:paths","spec:tags","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-no-camel-case' (Tag No Camel Case). Requirement: Detects a tag with camelCase (personalItem) text within it. To fix: Ensure the targeted value does NOT match the regular expression `/^[a-z]+[A-Z][a-z]+$/g`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.tags[*].name | $.paths[*][*].tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-no-pascal-case":{"title":"Tag No Pascal Case","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-no-pascal-case/","source":"compiled","description":"Tag names cannot use Pascal Case. Please rename {{value}}.","message":"Tag names cannot use Pascal Case. Please rename {{value}}.","severity":"info","given":["$.tags[*].name","$.paths[*][*].tags[*]"],"then":{"function":"pattern","functionOptions":{"notMatch":"/[A-Z][a-z]+[A-Z][a-z]+$/g"}},"tags":["format:openapi","spec:paths","spec:tags","experience:naming","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-no-pascal-case' (Tag No Pascal Case). Requirement: Tag names cannot use Pascal Case. Please rename {{value}}. To fix: Ensure the targeted value does NOT match the regular expression `/[A-Z][a-z]+[A-Z][a-z]+$/g`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.tags[*].name | $.paths[*][*].tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-no-version-info":{"title":"Tag No Version Info","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-no-version-info/","source":"compiled","description":"Tag names cannot have version information {{value}}. Consider versioning your API.","message":"Tag names cannot have version information {{value}}. Consider versioning your API.","severity":"info","given":["$.tags[*].name","$.paths[*][*].tags[*]"],"then":{"function":"pattern","functionOptions":{"notMatch":"/(V|v)\\s?[0-9]+/g"}},"tags":["format:openapi","spec:paths","spec:tags","experience:naming","experience:versioning"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-no-version-info' (Tag No Version Info). Requirement: Tag names cannot have version information {{value}}. Consider versioning your API. To fix: Ensure the targeted value does NOT match the regular expression `/(V|v)\\s?[0-9]+/g`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.tags[*].name | $.paths[*][*].tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-require-at-least-one":{"title":"Tag Require At Least One","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-require-at-least-one/","source":"compiled","description":"There needs to be at least one tag applied to an OpenAPI, providing a key word or phrase that can be applied to API operations.","message":"MUST Be At Least One Tag","severity":"info","given":"$","then":{"field":"tags","function":"length","functionOptions":{"min":1}},"tags":["format:openapi","spec:document","experience:discoverability","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-require-at-least-one' (Tag Require At Least One). Requirement: There needs to be at least one tag applied to an OpenAPI, providing a key word or phrase that can be applied to API operations. To fix: Ensure the length of `tags` is at least 1. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"tag-require-name":{"title":"Tag Require Name","reference":"https://spotlight-rules.com/spec/rules/openapi/tag-require-name/","source":"compiled","description":"Tags used as part of an OpenAPI should have names, providing a simple key word or phrase that represents the tag being applied to APIs.","message":"Tags MUST Have a Name","severity":"info","given":"$.tags[*]","then":{"field":"name","function":"truthy"},"tags":["format:openapi","spec:tags","experience:discoverability","experience:naming"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'tag-require-name' (Tag Require Name). Requirement: Tags used as part of an OpenAPI should have names, providing a simple key word or phrase that represents the tag being applied to APIs. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"typed-enum":{"title":"Typed Enum","reference":"https://spotlight-rules.com/spec/rules/openapi/typed-enum/","source":"builtin","description":"Enum values must respect the specified type.","message":"{{error}}","severity":"info","given":"$..[?(@ && @.enum && @.type)]","then":{"function":"typedEnum"},"tags":["format:openapi","spec:document","experience:data-modeling","experience:consistency"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'typed-enum' (Typed Enum). Requirement: Enum values must respect the specified type. To fix: Make every enum value match the declared type. This rule is evaluated at the JSONPath `$..[?(@ && @.enum && @.type)]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid OpenAPI. Return only the complete corrected document, with no commentary."},"agentic-access-contract-declared":{"title":"Agentic Access Contract Declared","reference":"https://spotlight-rules.com/spec/rules/openapi/agentic-access-contract-declared/","description":"Every operation exposed to AI agents should declare an x-agentic-access execution contract so an agent knows what it may attempt, and what must be denied, constrained, or escalated.","source":"compiled","message":"Operation has no x-agentic-access contract — an agent cannot know what it may attempt.","severity":"info","given":"$.paths[*][get,post,put,patch,delete,options,head,trace]","then":{"field":"x-agentic-access","function":"truthy"},"tags":["format:openapi","spec:operations","topic:agentic-access","experience:agentic-access","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'agentic-access-contract-declared'. Requirement: every operation should declare an `x-agentic-access` object (action-class, consequence, scope, and — for state-changing actions — audience, subject, token constraints, escalation, and audit). To fix: add an `x-agentic-access` block to each operation, classifying the action an AI agent may take. Make the smallest change that satisfies the rule, keep the document valid OpenAPI, and return only the complete corrected document."},"agentic-access-core-fields":{"title":"Agentic Access Core Fields","reference":"https://spotlight-rules.com/spec/rules/openapi/agentic-access-core-fields/","description":"An x-agentic-access contract must declare action-class, consequence, subject, and a non-empty scope so the runtime decision layer has the token and policy context it needs.","source":"compiled","message":"x-agentic-access must declare action-class, consequence, subject, and a non-empty scope.","severity":"info","given":"$.paths[*][get,post,put,patch,delete,options,head,trace].x-agentic-access","then":{"function":"schema","functionOptions":{"schema":{"type":"object","required":["action-class","consequence","subject","scope"],"properties":{"action-class":{"enum":["connected","delegated","acting"]},"consequence":{"enum":["read","write","physical","safety-critical"]},"subject":{"enum":["required","optional","none"]},"scope":{"type":"array","minItems":1,"items":{"type":"string"}},"audience":{"type":"string"},"audit":{"enum":["required","none"]},"token":{"type":"object","properties":{"max-ttl":{"type":"integer","minimum":1},"exchange":{"type":"boolean"},"proof-of-possession":{"type":"boolean"},"purpose-required":{"type":"boolean"}}},"escalation":{"type":"object","properties":{"human-in-the-loop":{"enum":["required","conditional","none"]},"triggers":{"type":"array","items":{"enum":["abnormal","high-value","safety"]}},"approver":{"type":"string"}}}}}}},"tags":["format:openapi","spec:operations","topic:agentic-access","experience:agentic-access","experience:reliability"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'agentic-access-core-fields'. Requirement: each `x-agentic-access` object must declare `action-class` (connected|delegated|acting), `consequence` (read|write|physical|safety-critical), `subject` (required|optional|none), and a non-empty `scope` array. To fix: add the missing fields with valid enum values. Make the smallest change, keep the document valid OpenAPI, and return only the complete corrected document."},"agentic-access-consequence-requirements":{"title":"Agentic Access Consequence Requirements","reference":"https://spotlight-rules.com/spec/rules/openapi/agentic-access-consequence-requirements/","description":"Higher-consequence actions must bind an audience, require a subject, cap token lifetime, and be audited — just-enough privilege, just-in-time access, and an auditable production loop.","source":"compiled","message":"Higher-consequence action must bind audience, require a subject, cap token TTL, and be audited.","severity":"info","given":"$.paths[*][get,post,put,patch,delete,options,head,trace].x-agentic-access","then":{"function":"schema","functionOptions":{"schema":{"type":"object","allOf":[{"if":{"properties":{"consequence":{"const":"write"}}},"then":{"required":["audience","audit","token"],"properties":{"audit":{"const":"required"},"token":{"required":["max-ttl"],"properties":{"max-ttl":{"maximum":900}}}}}},{"if":{"properties":{"consequence":{"const":"physical"}}},"then":{"required":["audience","audit","subject","token"],"properties":{"subject":{"const":"required"},"audit":{"const":"required"},"token":{"required":["max-ttl"],"properties":{"max-ttl":{"maximum":300}}}}}},{"if":{"properties":{"consequence":{"const":"safety-critical"}}},"then":{"required":["audience","audit","subject","token"],"properties":{"subject":{"const":"required"},"audit":{"const":"required"},"token":{"required":["max-ttl"],"properties":{"max-ttl":{"maximum":120}}}}}}]}}},"tags":["format:openapi","spec:operations","topic:agentic-access","experience:agentic-access","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'agentic-access-consequence-requirements'. Requirement: for `x-agentic-access` where consequence is write/physical/safety-critical, declare `audience`, set `audit: required`, and set a short-lived `token.max-ttl` (≤900s write, ≤300s physical, ≤120s safety-critical); physical and safety-critical also require `subject: required`. To fix: add the missing constraints. Make the smallest change, keep the document valid OpenAPI, and return only the complete corrected document."},"agentic-access-safety-critical-human":{"title":"Agentic Access Safety Critical Human In The Loop","reference":"https://spotlight-rules.com/spec/rules/openapi/agentic-access-safety-critical-human/","description":"Safety-critical actions must require human-in-the-loop approval — step-up review for high-impact operations.","source":"compiled","message":"Safety-critical action must set escalation.human-in-the-loop = required.","severity":"info","given":"$.paths[*][get,post,put,patch,delete,options,head,trace].x-agentic-access","then":{"function":"schema","functionOptions":{"schema":{"type":"object","if":{"properties":{"consequence":{"const":"safety-critical"}},"required":["consequence"]},"then":{"required":["escalation"],"properties":{"escalation":{"type":"object","required":["human-in-the-loop"],"properties":{"human-in-the-loop":{"const":"required"}}}}}}}},"tags":["format:openapi","spec:operations","topic:agentic-access","experience:agentic-access","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'agentic-access-safety-critical-human'. Requirement: any `x-agentic-access` with `consequence: safety-critical` must set `escalation.human-in-the-loop: required`. To fix: add the escalation block requiring human approval. Make the smallest change, keep the document valid OpenAPI, and return only the complete corrected document."},"agentic-access-acting-escalation":{"title":"Agentic Access Acting Declares Escalation","reference":"https://spotlight-rules.com/spec/rules/openapi/agentic-access-acting-escalation/","description":"Any acting operation should declare an escalation policy — even 'none' by explicit decision — so runtime approval behavior is never left implicit.","source":"compiled","message":"Acting operation should declare escalation.human-in-the-loop (may be 'none' by decision).","severity":"info","given":"$.paths[*][get,post,put,patch,delete,options,head,trace].x-agentic-access","then":{"function":"schema","functionOptions":{"schema":{"type":"object","if":{"properties":{"action-class":{"const":"acting"}},"required":["action-class"]},"then":{"required":["escalation"],"properties":{"escalation":{"type":"object","required":["human-in-the-loop"]}}}}}},"tags":["format:openapi","spec:operations","topic:agentic-access","experience:agentic-access","experience:governance"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'agentic-access-acting-escalation'. Requirement: any `x-agentic-access` with `action-class: acting` must declare `escalation.human-in-the-loop` (required, conditional, or an explicit none). To fix: add the escalation block. Make the smallest change, keep the document valid OpenAPI, and return only the complete corrected document."},"agentic-access-delegation-token-exchange":{"title":"Agentic Access Delegation Token Exchange","reference":"https://spotlight-rules.com/spec/rules/openapi/agentic-access-delegation-token-exchange/","description":"Actions that act on behalf of a subject should require token exchange so delegation is scoped per action rather than relying on a broad standing token.","source":"compiled","message":"Action acts on behalf of a subject but does not require token.exchange = true.","severity":"info","given":"$.paths[*][get,post,put,patch,delete,options,head,trace].x-agentic-access","then":{"function":"schema","functionOptions":{"schema":{"type":"object","if":{"properties":{"subject":{"const":"required"}},"required":["subject"]},"then":{"required":["token"],"properties":{"token":{"type":"object","required":["exchange"],"properties":{"exchange":{"const":true}}}}}}}},"tags":["format:openapi","spec:operations","topic:agentic-access","experience:agentic-access","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'agentic-access-delegation-token-exchange'. Requirement: any `x-agentic-access` with `subject: required` must set `token.exchange: true` (RFC 8693 scoped delegation). To fix: add token.exchange. Make the smallest change, keep the document valid OpenAPI, and return only the complete corrected document."},"agentic-access-oauth-protected":{"title":"Agentic Access OAuth Protected","reference":"https://spotlight-rules.com/spec/rules/openapi/agentic-access-oauth-protected/","description":"Delegated or acting operations must carry a security requirement so agent actions are actually authorized at runtime, not merely described.","source":"compiled","message":"Delegated/acting operation for an agent declares no security requirement.","severity":"info","given":"$.paths[*][get,post,put,patch,delete,options,head,trace]","then":{"function":"schema","functionOptions":{"schema":{"type":"object","if":{"required":["x-agentic-access"],"properties":{"x-agentic-access":{"required":["action-class"],"properties":{"action-class":{"enum":["acting","delegated"]}}}}},"then":{"required":["security"],"properties":{"security":{"type":"array","minItems":1}}}}}},"tags":["format:openapi","spec:operations","topic:agentic-access","experience:agentic-access","experience:security"],"prompt":"You are editing an OpenAPI document to satisfy the Spotlight API governance rule 'agentic-access-oauth-protected'. Requirement: any operation whose `x-agentic-access.action-class` is acting or delegated must declare a non-empty `security` requirement (globally or on the operation). To fix: add a security requirement referencing an OAuth2 scheme. Make the smallest change, keep the document valid OpenAPI, and return only the complete corrected document."}},"apis-json":{"api-baseurl-https":{"title":"API Baseurl HTTPS","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-baseurl-https/","source":"spotlight","description":"Each API baseURL should be an https URL.","message":"API baseURL should use https.","given":"$.apis[*].baseURL","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https://"}},"tags":["format:apis-json","spec:apis","experience:security"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-baseurl-https' (API Baseurl HTTPS). Requirement: Each API baseURL should be an https URL. To fix: Ensure the targeted value matches the regular expression `^https://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.apis[*].baseURL` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-contact-include-email":{"title":"API Contact Include Email","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-contact-include-email/","source":"default","description":"The contact object in an APIs.json file allows for referencing the email address of a person or group. This property provides a convenient way for users to seek support for an API, using email as the default method to reach the team managing the API in production.","message":"API contact COULD have email.","severity":"info","given":"$.apis.*.contact.*","then":{"field":"email","function":"truthy"},"tags":["format:apis-json","spec:apis","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-contact-include-email' (API Contact Include Email). Requirement: The contact object in an APIs.json file allows for referencing the email address of a person or group. This property provides a convenient way for users to seek support for an API, using email as the default method to reach the team managing the API in production. To fix: Ensure `email` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.contact.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-contact-include-full-name":{"title":"API Contact Include Full Name","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-contact-include-full-name/","source":"default","description":"The contact object in an APIs.json file includes a full name (FN) property, which specifies the formatted text corresponding to the contact name in the vCard for an API. This provides a quick and clear way to assign a person, group, or other point of contact to an API for addressing questions and providing support.","message":"Contact Could Have FN","severity":"info","given":"$.apis.*.contact.*","then":{"field":"FN","function":"truthy"},"tags":["format:apis-json","spec:apis","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-contact-include-full-name' (API Contact Include Full Name). Requirement: The contact object in an APIs.json file includes a full name (FN) property, which specifies the formatted text corresponding to the contact name in the vCard for an API. This provides a quick and clear way to assign a person, group, or other point of contact to an API for addressing questions and providing support. To fix: Ensure `FN` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*.contact.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-entry-require-tag":{"title":"API Entry Require Tag","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-entry-require-tag/","source":"default","description":"Each API defined in an APIs.json artifact includes a property for adding one or more tags. These tags provide additional context about the resources or capabilities offered by the API, highlighting its business value and the domain in which it is applied.","message":"API MUST Have a Tags Object","severity":"info","given":"$.apis.*","then":{"field":"tags","function":"truthy"},"tags":["format:apis-json","spec:apis","experience:discoverability","experience:data-modeling"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-entry-require-tag' (API Entry Require Tag). Requirement: Each API defined in an APIs.json artifact includes a property for adding one or more tags. These tags provide additional context about the resources or capabilities offered by the API, highlighting its business value and the domain in which it is applied. To fix: Ensure `tags` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-include-about-page":{"title":"API Include About Page","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-include-about-page/","source":"default","description":"This property ensures provides a reference to an about page, either for the company, organization, or government agency behind an API, or specifically about the domain, team, and the APIs they produce.","message":"Has About","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(about|About)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-include-about-page' (API Include About Page). Requirement: This property ensures provides a reference to an about page, either for the company, organization, or government agency behind an API, or specifically about the domain, team, and the APIs they produce. To fix: Ensure `type` does NOT match the regular expression `\\b(about|About)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-include-contact":{"title":"API Include Contact","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-include-contact/","source":"default","description":"The contact object in an APIs.json file allows for associating a vCard that represents an individual or organizational entity. It includes common contact information such as a name, email, or other references, offering a standardized method for providing support for an API.","message":"API COULD have a contact.","severity":"info","given":"$.apis.*","then":{"field":"contact","function":"truthy"},"tags":["format:apis-json","spec:apis","experience:discoverability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-include-contact' (API Include Contact). Requirement: The contact object in an APIs.json file allows for associating a vCard that represents an individual or organizational entity. It includes common contact information such as a name, email, or other references, offering a standardized method for providing support for an API. To fix: Ensure `contact` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-go-sdk":{"title":"API Property Require Go SDK","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-go-sdk/","source":"default","description":"This property ensures that there is a Go SDK available for an API, making it easier for Go developers to integrate an API into their applications.","message":"Has Go SDK","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-sdk-go)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-go-sdk' (API Property Require Go SDK). Requirement: This property ensures that there is a Go SDK available for an API, making it easier for Go developers to integrate an API into their applications. To fix: Ensure `type` does NOT match the regular expression `\\b(api-sdk-go)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-java-sdk":{"title":"API Property Require Java SDK","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-java-sdk/","source":"default","description":"This property ensures that there is a Java SDK available for an API, making it easier for Java developers to integrate an API into their applications.","message":"Has Java SDK","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-sdk-java)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-java-sdk' (API Property Require Java SDK). Requirement: This property ensures that there is a Java SDK available for an API, making it easier for Java developers to integrate an API into their applications. To fix: Ensure `type` does NOT match the regular expression `\\b(api-sdk-java)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-linting-rules":{"title":"API Property Require Linting Rules","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-linting-rules/","source":"default","description":"This property ensures that an API has governance rules applied, usually as part of a central set of governance rules, defined by policy, or stages of the API lifecycle.","message":"Has Linting Rules","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-rules|OpenApiRules)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:consistency"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-linting-rules' (API Property Require Linting Rules). Requirement: This property ensures that an API has governance rules applied, usually as part of a central set of governance rules, defined by policy, or stages of the API lifecycle. To fix: Ensure `type` does NOT match the regular expression `\\b(api-rules|OpenApiRules)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-node-sdk":{"title":"API Property Require Node SDK","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-node-sdk/","source":"default","description":"This property ensures that there is a Node SDK available for an API, making it easier for Node developers to integrate an API into their applications.","message":"Has Node SDK","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-sdk-node)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-node-sdk' (API Property Require Node SDK). Requirement: This property ensures that there is a Node SDK available for an API, making it easier for Node developers to integrate an API into their applications. To fix: Ensure `type` does NOT match the regular expression `\\b(api-sdk-node)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-python-sdk":{"title":"API Property Require Python SDK","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-python-sdk/","source":"default","description":"This property ensures that there is a Python SDK available for an API, making it easier for Python developers to integrate an API into their applications.","message":"Has Python SDK","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-sdk-python)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-python-sdk' (API Property Require Python SDK). Requirement: This property ensures that there is a Python SDK available for an API, making it easier for Python developers to integrate an API into their applications. To fix: Ensure `type` does NOT match the regular expression `\\b(api-sdk-python)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-road-map":{"title":"API Property Require Road Map","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-road-map/","source":"default","description":"This property ensures there is a reference to the road map for an API or for the entire API operations within domain, line of business, or teams.","message":"Has a Road Map","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-road-map|road-map|Roadmap|Road Map|RoadMap)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:discoverability","experience:documentation","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-road-map' (API Property Require Road Map). Requirement: This property ensures there is a reference to the road map for an API or for the entire API operations within domain, line of business, or teams. To fix: Ensure `type` does NOT match the regular expression `\\b(api-road-map|road-map|Roadmap|Road Map|RoadMap)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-sandbox":{"title":"API Property Require Sandbox","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-sandbox/","source":"default","description":"This property ensures that an API has a reference to a sandbox for individual APIs or as part of common properties, providing sandbox, synthetic data, and mock servers for use in making test requests.","message":"Has a Blog","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(sandbox|Sandbox)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-sandbox' (API Property Require Sandbox). Requirement: This property ensures that an API has a reference to a sandbox for individual APIs or as part of common properties, providing sandbox, synthetic data, and mock servers for use in making test requests. To fix: Ensure `type` does NOT match the regular expression `\\b(sandbox|Sandbox)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-sdk":{"title":"API Property Require SDK","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-sdk/","source":"default","description":"This property ensures that there is an SDK available for an API, making it easier for developers to integrate an API into their applications.","message":"Has SDK","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(sdk|sdks|SDKs)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-sdk' (API Property Require SDK). Requirement: This property ensures that there is an SDK available for an API, making it easier for developers to integrate an API into their applications. To fix: Ensure `type` does NOT match the regular expression `\\b(sdk|sdks|SDKs)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-security-page":{"title":"API Property Require Security Page","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-security-page/","source":"default","description":"This property ensures there is a URL to the security page, providing details about how security is handled for an API.","message":"Has Security Path","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(Security|SecurityTesting)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:security","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-security-page' (API Property Require Security Page). Requirement: This property ensures there is a URL to the security page, providing details about how security is handled for an API. To fix: Ensure `type` does NOT match the regular expression `\\b(Security|SecurityTesting)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-signup":{"title":"API Property Require Signup","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-signup/","source":"default","description":"This property ensures there is a link to where you sign up for an API, making sure API consumers can access in a single click.","message":"Has a Sign Up","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(X-signup|signup|Sign Up|SignUp)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-signup' (API Property Require Signup). Requirement: This property ensures there is a link to where you sign up for an API, making sure API consumers can access in a single click. To fix: Ensure `type` does NOT match the regular expression `\\b(X-signup|signup|Sign Up|SignUp)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-status-page":{"title":"API Property Require Status Page","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-status-page/","source":"default","description":"This property ensures that there is a status page available for each API, providing the uptime status for any given moment, as well as historical data.","message":"Has a Status Page","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(x-status|status|Status|StatusPage)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:reliability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-status-page' (API Property Require Status Page). Requirement: This property ensures that there is a status page available for each API, providing the uptime status for any given moment, as well as historical data. To fix: Ensure `type` does NOT match the regular expression `\\b(x-status|status|Status|StatusPage)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-support-email":{"title":"API Property Require Support Email","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-support-email/","source":"default","description":"This property ensures that an API has email support, providing a valid email address that can be used to get API support.","message":"Has Support Email","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(support-email|SupportEmail)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-support-email' (API Property Require Support Email). Requirement: This property ensures that an API has email support, providing a valid email address that can be used to get API support. To fix: Ensure `type` does NOT match the regular expression `\\b(support-email|SupportEmail)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-support-issues-url":{"title":"API Property Require Support Issues URL","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-support-issues-url/","source":"default","description":"This property ensures that there are Git issues available to support an API, using the issues capability of GitHub, GitLab, or Bitbucket to support API consumers.","message":"Has Support Issues URL","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(SupportIssues|SupportGitHubIssues)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-support-issues-url' (API Property Require Support Issues URL). Requirement: This property ensures that there are Git issues available to support an API, using the issues capability of GitHub, GitLab, or Bitbucket to support API consumers. To fix: Ensure `type` does NOT match the regular expression `\\b(SupportIssues|SupportGitHubIssues)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-support-page":{"title":"API Property Require Support Page","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-support-page/","source":"default","description":"This property ensures that there is a support page available for an API, providing direct and in-direct support opportunities for each API or for entire API platform.","message":"Has Support Page","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(support|Support)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-support-page' (API Property Require Support Page). Requirement: This property ensures that there is a support page available for an API, providing direct and in-direct support opportunities for each API or for entire API platform. To fix: Ensure `type` does NOT match the regular expression `\\b(support|Support)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-team":{"title":"API Property Require Team","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-team/","source":"default","description":"This property ensures that there is a reference to the team behind an API, providing a reference to business and engineering stakeholders.","message":"Has a Team Defined","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(team|teams|Team|Teams)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-team' (API Property Require Team). Requirement: This property ensures that there is a reference to the team behind an API, providing a reference to business and engineering stakeholders. To fix: Ensure `type` does NOT match the regular expression `\\b(team|teams|Team|Teams)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-terms-of-service":{"title":"API Property Require Terms Of Service","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-terms-of-service/","source":"default","description":"This property ensures that an API has a reference to a terms of service, covering the legal side of using an API.","message":"Has an API Terms of Service","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-terms-of-service|terms-of-service|Terms of Service|TOS|TermsOfService)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-terms-of-service' (API Property Require Terms Of Service). Requirement: This property ensures that an API has a reference to a terms of service, covering the legal side of using an API. To fix: Ensure `type` does NOT match the regular expression `\\b(api-terms-of-service|terms-of-service|Terms of Service|TOS|TermsOfService)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-use-cases":{"title":"API Property Require Use Cases","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-use-cases/","source":"default","description":"This property ensures there is a reference to the use cases for an API, helping align an API with the who, what, how, and why of putting an API to work.","message":"Has Use Cases","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(UseCases)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-use-cases' (API Property Require Use Cases). Requirement: This property ensures there is a reference to the use cases for an API, helping align an API with the who, what, how, and why of putting an API to work. To fix: Ensure `type` does NOT match the regular expression `\\b(UseCases)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-valid-url":{"title":"API Property Require Valid URL","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-valid-url/","source":"default","description":"This property ensures that properties of an API or API contract all have valid URLs, checking if any of the URLs are not properly formed, or could be other formats.","message":"Property URLs Are Valid","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"url","function":"pattern","functionOptions":{"notMatch":"^((http|https)://)[-a-zA-Z0-9@:%._\\+~#?&//=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%._\\+~#?&//=]*)$"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:consistency","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-valid-url' (API Property Require Valid URL). Requirement: This property ensures that properties of an API or API contract all have valid URLs, checking if any of the URLs are not properly formed, or could be other formats. To fix: Ensure `url` does NOT match the regular expression `^((http|https)://)[-a-zA-Z0-9@:%._\\+~#?&//=]{2,256}\\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%._\\+~#?&//=]*)$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-skill-require-versioning":{"title":"API Property Require Versioning","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-skill-require-versioning/","source":"default","description":"This property ensures there is a reference to how APIs are versioned, providing a single place where teams can learn about how change is communicated.","message":"Has Versioning for API","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(versions|Versions|Versioning|versioning)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:versioning","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-skill-require-versioning' (API Property Require Versioning). Requirement: This property ensures there is a reference to how APIs are versioned, providing a single place where teams can learn about how change is communicated. To fix: Ensure `type` does NOT match the regular expression `\\b(versions|Versions|Versioning|versioning)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-video":{"title":"API Property Require Video","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-video/","source":"default","description":"This property ensures there is a reference to a video page or channel for an API.","message":"Has Videos for API","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(videos|Videos)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-video' (API Property Require Video). Requirement: This property ensures there is a reference to a video page or channel for an API. To fix: Ensure `type` does NOT match the regular expression `\\b(videos|Videos)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-require-vocabulary":{"title":"API Property Require Vocabulary","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-require-vocabulary/","source":"default","description":"This property ensures that there is a centralized vocabulary in use for guiding the creation and usage of tags, path segments, and other metadata associated with an APIs.","message":"Has Vocabulary","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(vocabulary|vocabularies|Vocabulary|Vocabularies)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:consistency","experience:naming","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-require-vocabulary' (API Property Require Vocabulary). Requirement: This property ensures that there is a centralized vocabulary in use for guiding the creation and usage of tags, path segments, and other metadata associated with an APIs. To fix: Ensure `type` does NOT match the regular expression `\\b(vocabulary|vocabularies|Vocabulary|Vocabularies)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-property-url-https":{"title":"API Property URL HTTPS","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-property-url-https/","source":"spotlight","description":"API property URLs (documentation, OpenAPI, etc.) should be https.","message":"API property url should use https.","given":"$.apis[*].properties[*].url","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https://"}},"tags":["format:apis-json","spec:schemas","experience:security"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-property-url-https' (API Property URL HTTPS). Requirement: API property URLs (documentation, OpenAPI, etc.) should be https. To fix: Ensure the targeted value matches the regular expression `^https://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.apis[*].properties[*].url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-require-aid":{"title":"API Require Aid","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-require-aid/","source":"default","description":"Every API should have a unique identifier, known as an AID (API Identifier). The APIs.json file, contract, or collection contains its own AID, which the API uses as part of its reference. Additionally, the API applies a slugified version of its name, resulting in a unique, human-readable identifier for the API.","message":"APIs MUST have an aid property.","severity":"info","given":"$.apis.*","then":{"field":"aid","function":"truthy"},"tags":["format:apis-json","spec:apis","experience:discoverability","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-require-aid' (API Require Aid). Requirement: Every API should have a unique identifier, known as an AID (API Identifier). The APIs.json file, contract, or collection contains its own AID, which the API uses as part of its reference. Additionally, the API applies a slugified version of its name, resulting in a unique, human-readable identifier for the API. To fix: Ensure `aid` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-require-base-url":{"title":"API Require Base URL","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-require-base-url/","source":"default","description":"Each API defined within an APIs.json artifact can specify the base URL for the API. This URL serves as a reference point for developers during onboarding and when making API calls. Additionally, it helps identify the API and validate the domain it is associated with.","message":"APIs MUST Have a Base URL","severity":"info","given":"$.apis.*","then":{"field":"baseURL","function":"truthy"},"tags":["format:apis-json","spec:apis","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-require-base-url' (API Require Base URL). Requirement: Each API defined within an APIs.json artifact can specify the base URL for the API. This URL serves as a reference point for developers during onboarding and when making API calls. Additionally, it helps identify the API and validate the domain it is associated with. To fix: Ensure `baseURL` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.apis.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"api-tag-require-upper-case":{"title":"API Tag Require Upper Case","reference":"https://spotlight-rules.com/spec/rules/apis-json/api-tag-require-upper-case/","source":"default","description":"Maintaining consistent casing for tags applied to individual APIs ensures a uniform appearance and enhances search and discovery. Each word in a tag should be capitalized, with the first letter of every word in a phrase treated the same way.","message":"API Tags MUST Be Upper Case","severity":"info","given":"$.apis.*.tags.*","then":{"function":"pattern","functionOptions":{"match":"[A-Z]\\w*"}},"tags":["format:apis-json","spec:apis","spec:tags","experience:naming","experience:consistency","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'api-tag-require-upper-case' (API Tag Require Upper Case). Requirement: Maintaining consistent casing for tags applied to individual APIs ensures a uniform appearance and enhances search and discovery. Each word in a tag should be capitalized, with the first letter of every word in a phrase treated the same way. To fix: Ensure the targeted value matches the regular expression `[A-Z]\\w*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.apis.*.tags.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-apis-json-url-https":{"title":"Document APIs JSON URL HTTPS","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-apis-json-url-https/","source":"spotlight","description":"The APIs.json url should be an https URL.","message":"APIs.json url should use https.","given":"$.url","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https://"}},"tags":["format:apis-json","spec:document","experience:security","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-apis-json-url-https' (Document APIs JSON URL HTTPS). Requirement: The APIs.json url should be an https URL. To fix: Ensure the targeted value matches the regular expression `^https://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-business-impact-canvas":{"title":"Document Include Business Impact Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-business-impact-canvas/","source":"default","description":"This ensures that an API has had the APIOps Business Impact Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Business Impact Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsBusinessImpactCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-business-impact-canvas' (Document Include Business Impact Canvas). Requirement: This ensures that an API has had the APIOps Business Impact Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsBusinessImpactCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-business-model-canvas":{"title":"Document Include Business Model Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-business-model-canvas/","source":"default","description":"This ensures that an API has had the APIOps Business Model Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Business Model Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsBusinessModelCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-business-model-canvas' (Document Include Business Model Canvas). Requirement: This ensures that an API has had the APIOps Business Model Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsBusinessModelCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-capacity-canvas":{"title":"Document Include Capacity Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-capacity-canvas/","source":"default","description":"This ensures that an API has had the APIOps Capacity Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Capacity Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsCapacityCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-capacity-canvas' (Document Include Capacity Canvas). Requirement: This ensures that an API has had the APIOps Capacity Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsCapacityCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-customer-journey-canvas":{"title":"Document Include Customer Journey Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-customer-journey-canvas/","source":"default","description":"This ensures that an API has had the APIOps Customer Journey Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Customer Journey Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsCustomerJourneyCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-customer-journey-canvas' (Document Include Customer Journey Canvas). Requirement: This ensures that an API has had the APIOps Customer Journey Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsCustomerJourneyCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-domain-canvas":{"title":"Document Include Domain Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-domain-canvas/","source":"default","description":"This ensures that an API has had the APIOps Domain Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Domain Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsDomainCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-domain-canvas' (Document Include Domain Canvas). Requirement: This ensures that an API has had the APIOps Domain Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsDomainCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-event-canvas":{"title":"Document Include Event Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-event-canvas/","source":"default","description":"This ensures that an API has had the APIOps Event Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Event Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsEventCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-event-canvas' (Document Include Event Canvas). Requirement: This ensures that an API has had the APIOps Event Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsEventCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-locations-canvas":{"title":"Document Include Locations Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-locations-canvas/","source":"default","description":"This ensures that an API has had the APIOps Locations Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Locations Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsLocationsCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-locations-canvas' (Document Include Locations Canvas). Requirement: This ensures that an API has had the APIOps Locations Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsLocationsCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-rest-canvas":{"title":"Document Include Rest Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-rest-canvas/","source":"default","description":"This ensures that an API has had the APIOps Locations Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Locations Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsRestCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-rest-canvas' (Document Include Rest Canvas). Requirement: This ensures that an API has had the APIOps Locations Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsRestCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-include-value-proposition-canvas":{"title":"Document Include Value Proposition Canvas","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-include-value-proposition-canvas/","source":"default","description":"This ensures that an API has had the APIOps Value Proposition Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance.","message":"Has APIOps Cycles Value Proposition Canvas","severity":"info","given":["$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIOpsValuePropositionCanvas)\\b"}}],"tags":["format:apis-json","spec:collection","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-include-value-proposition-canvas' (Document Include Value Proposition Canvas). Requirement: This ensures that an API has had the APIOps Value Proposition Canvas applied to the API, requiring that the canvas is present in the repository and registered in the APIs.json index for the API, helping with discovery and governance. To fix: Ensure `type` does NOT match the regular expression `\\b(APIOpsValuePropositionCanvas)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-access":{"title":"Document Require Access","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-access/","source":"spotlight","description":"apis-json document should declare a `access` property.","message":"Missing `access`.","given":"$","severity":"info","then":{"field":"access","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-access' (Document Require Access). Requirement: apis-json document should declare a `access` property. To fix: Ensure `access` is present and non-empty at each matching location. Guidance: Missing `access`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-aid":{"title":"Document Require Aid","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-aid/","source":"spotlight","description":"apis-json document should declare a `aid` property.","message":"Missing `aid`.","given":"$","severity":"info","then":{"field":"aid","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-aid' (Document Require Aid). Requirement: apis-json document should declare a `aid` property. To fix: Ensure `aid` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-apis":{"title":"Document Require APIs","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-apis/","source":"spotlight","description":"apis-json document should declare a `apis` property.","message":"Missing `apis`.","given":"$","severity":"info","then":{"field":"apis","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-apis' (Document Require APIs). Requirement: apis-json document should declare a `apis` property. To fix: Ensure `apis` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-common":{"title":"Document Require Common","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-common/","source":"spotlight","description":"apis-json document should declare a `common` property.","message":"Missing `common`.","given":"$","severity":"info","then":{"field":"common","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-common' (Document Require Common). Requirement: apis-json document should declare a `common` property. To fix: Ensure `common` is present and non-empty at each matching location. Guidance: Missing `common`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-created":{"title":"Document Require Created","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-created/","source":"spotlight","description":"apis-json document should declare a `created` property.","message":"Missing `created`.","given":"$","severity":"info","then":{"field":"created","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-created' (Document Require Created). Requirement: apis-json document should declare a `created` property. To fix: Ensure `created` is present and non-empty at each matching location. Guidance: Missing `created`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-description":{"title":"Document Require Description","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-description/","source":"spotlight","description":"apis-json document should declare a `description` property.","message":"Missing `description`.","given":"$","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-description' (Document Require Description). Requirement: apis-json document should declare a `description` property. To fix: Ensure `description` is present and non-empty at each matching location. Guidance: Missing `description`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-image":{"title":"Document Require Image","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-image/","source":"spotlight","description":"apis-json document should declare a `image` property.","message":"Missing `image`.","given":"$","severity":"info","then":{"field":"image","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-image' (Document Require Image). Requirement: apis-json document should declare a `image` property. To fix: Ensure `image` is present and non-empty at each matching location. Guidance: Missing `image`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-include":{"title":"Document Require Include","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-include/","source":"spotlight","description":"apis-json document should declare a `include` property.","message":"Missing `include`.","given":"$","severity":"info","then":{"field":"include","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-include' (Document Require Include). Requirement: apis-json document should declare a `include` property. To fix: Ensure `include` is present and non-empty at each matching location. Guidance: Missing `include`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-kind":{"title":"Document Require Kind","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-kind/","source":"spotlight","description":"apis-json document should declare a `kind` property.","message":"Missing `kind`.","given":"$","severity":"info","then":{"field":"kind","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-kind' (Document Require Kind). Requirement: apis-json document should declare a `kind` property. To fix: Ensure `kind` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-maintainer":{"title":"Document Require Maintainer","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-maintainer/","source":"spotlight","description":"apis-json document should declare a `maintainers` property.","message":"Missing `maintainers`.","given":"$","severity":"info","then":{"field":"maintainers","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-maintainer' (Document Require Maintainer). Requirement: apis-json document should declare a `maintainers` property. To fix: Ensure `maintainers` is present and non-empty at each matching location. Guidance: Missing `maintainers`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-modified":{"title":"Document Require Modified","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-modified/","source":"spotlight","description":"apis-json document should declare a `modified` property.","message":"Missing `modified`.","given":"$","severity":"info","then":{"field":"modified","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-modified' (Document Require Modified). Requirement: apis-json document should declare a `modified` property. To fix: Ensure `modified` is present and non-empty at each matching location. Guidance: Missing `modified`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-name":{"title":"Document Require Name","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-name/","source":"spotlight","description":"apis-json document should declare a `name` property.","message":"Missing `name`.","given":"$","severity":"info","then":{"field":"name","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-name' (Document Require Name). Requirement: apis-json document should declare a `name` property. To fix: Ensure `name` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-network":{"title":"Document Require Network","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-network/","source":"spotlight","description":"apis-json document should declare a `network` property.","message":"Missing `network`.","given":"$","severity":"info","then":{"field":"network","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-network' (Document Require Network). Requirement: apis-json document should declare a `network` property. To fix: Ensure `network` is present and non-empty at each matching location. Guidance: Missing `network`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-overlays":{"title":"Document Require Overlays","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-overlays/","source":"spotlight","description":"apis-json document should declare a `overlays` property.","message":"Missing `overlays`.","given":"$","severity":"info","then":{"field":"overlays","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-overlays' (Document Require Overlays). Requirement: apis-json document should declare a `overlays` property. To fix: Ensure `overlays` is present and non-empty at each matching location. Guidance: Missing `overlays`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-position":{"title":"Document Require Position","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-position/","source":"spotlight","description":"apis-json document should declare a `position` property.","message":"Missing `position`.","given":"$","severity":"info","then":{"field":"position","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-position' (Document Require Position). Requirement: apis-json document should declare a `position` property. To fix: Ensure `position` is present and non-empty at each matching location. Guidance: Missing `position`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-prompts":{"title":"Document Require Prompts","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-prompts/","source":"spotlight","description":"apis-json document should declare a `prompts` property.","message":"Missing `prompts`.","given":"$","severity":"info","then":{"field":"prompts","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-prompts' (Document Require Prompts). Requirement: apis-json document should declare a `prompts` property. To fix: Ensure `prompts` is present and non-empty at each matching location. Guidance: Missing `prompts`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-rating":{"title":"Document Require Rating","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-rating/","source":"spotlight","description":"apis-json document should declare a `rating` property.","message":"Missing `rating`.","given":"$","severity":"info","then":{"field":"rating","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-rating' (Document Require Rating). Requirement: apis-json document should declare a `rating` property. To fix: Ensure `rating` is present and non-empty at each matching location. Guidance: Missing `rating`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-rules":{"title":"Document Require Rules","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-rules/","source":"spotlight","description":"apis-json document should declare a `rules` property.","message":"Missing `rules`.","given":"$","severity":"info","then":{"field":"rules","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-rules' (Document Require Rules). Requirement: apis-json document should declare a `rules` property. To fix: Ensure `rules` is present and non-empty at each matching location. Guidance: Missing `rules`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-specificationversion":{"title":"Document Require Specificationversion","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-specificationversion/","source":"spotlight","description":"apis-json document should declare a `specificationVersion` property.","message":"Missing `specificationVersion`.","given":"$","severity":"info","then":{"field":"specificationVersion","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-specificationversion' (Document Require Specificationversion). Requirement: apis-json document should declare a `specificationVersion` property. To fix: Ensure `specificationVersion` is present and non-empty at each matching location. Guidance: Missing `specificationVersion`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-tag":{"title":"Document Require Tag","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-tag/","source":"spotlight","description":"apis-json document should declare a `tags` property.","message":"Missing `tags`.","given":"$","severity":"info","then":{"field":"tags","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-tag' (Document Require Tag). Requirement: apis-json document should declare a `tags` property. To fix: Ensure `tags` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-type":{"title":"Document Require Type","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-type/","source":"spotlight","description":"apis-json document should declare a `type` property.","message":"Missing `type`.","given":"$","severity":"info","then":{"field":"type","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-type' (Document Require Type). Requirement: apis-json document should declare a `type` property. To fix: Ensure `type` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-url":{"title":"Document Require URL","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-url/","source":"spotlight","description":"apis-json document should declare a `url` property.","message":"Missing `url`.","given":"$","severity":"info","then":{"field":"url","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-url' (Document Require URL). Requirement: apis-json document should declare a `url` property. To fix: Ensure `url` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-visibility":{"title":"Document Require Visibility","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-visibility/","source":"spotlight","description":"apis-json document should declare a `visibility` property.","message":"Missing `visibility`.","given":"$","severity":"info","then":{"field":"visibility","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-visibility' (Document Require Visibility). Requirement: apis-json document should declare a `visibility` property. To fix: Ensure `visibility` is present and non-empty at each matching location. Guidance: Missing `visibility`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"document-require-workflow":{"title":"Document Require Workflow","reference":"https://spotlight-rules.com/spec/rules/apis-json/document-require-workflow/","source":"spotlight","description":"apis-json document should declare a `workflows` property.","message":"Missing `workflows`.","given":"$","severity":"info","then":{"field":"workflows","function":"truthy"},"tags":["format:apis-json","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'document-require-workflow' (Document Require Workflow). Requirement: apis-json document should declare a `workflows` property. To fix: Ensure `workflows` is present and non-empty at each matching location. Guidance: Missing `workflows`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"info-apis-json-specification-version-format":{"title":"Info APIs JSON Specification Version Format","reference":"https://spotlight-rules.com/spec/rules/apis-json/info-apis-json-specification-version-format/","source":"spotlight","description":"specificationVersion should be a major.minor version (e.g. 0.21).","message":"specificationVersion should be major.minor.","given":"$.specificationVersion","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^\\d+\\.\\d+$"}},"tags":["format:apis-json","spec:document","experience:versioning","experience:consistency"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'info-apis-json-specification-version-format' (Info APIs JSON Specification Version Format). Requirement: specificationVersion should be a major.minor version (e.g. 0.21). To fix: Ensure the targeted value matches the regular expression `^\\d+\\.\\d+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.specificationVersion` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"maintainer-email-format":{"title":"Maintainer Email Format","reference":"https://spotlight-rules.com/spec/rules/apis-json/maintainer-email-format/","source":"spotlight","description":"A maintainer email should be a valid email address.","message":"Maintainer email should be a valid email.","given":"$.maintainers[*].email","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$"}},"tags":["format:apis-json","spec:maintainers","experience:consistency"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'maintainer-email-format' (Maintainer Email Format). Requirement: A maintainer email should be a valid email address. To fix: Ensure the targeted value matches the regular expression `^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.maintainers[*].email` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-api-lifecycle":{"title":"Schema Include API Lifecycle","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-api-lifecycle/","source":"default","description":"This property makes sure there is an API lifecycle schema defining all of the stages of a lifecycle and which policies get applied at each stage of the API lifecycle.","message":"Has an API Lifecycle","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(lifecycle|Lifecycle)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:versioning"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-api-lifecycle' (Schema Include API Lifecycle). Requirement: This property makes sure there is an API lifecycle schema defining all of the stages of a lifecycle and which policies get applied at each stage of the API lifecycle. To fix: Ensure `type` does NOT match the regular expression `\\b(lifecycle|Lifecycle)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-api-plan":{"title":"Schema Include API Plan","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-api-plan/","source":"default","description":"This property provides a link to the dedicated plans page that applies to an API, providing information about access tiers, rate limits, and features available for an API as part of a wider API business plan.","message":"Has API Plans","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-plans|Plans)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-api-plan' (Schema Include API Plan). Requirement: This property provides a link to the dedicated plans page that applies to an API, providing information about access tiers, rate limits, and features available for an API as part of a wider API business plan. To fix: Ensure `type` does NOT match the regular expression `\\b(api-plans|Plans)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-authentication-page":{"title":"Schema Include Authentication Page","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-authentication-page/","source":"default","description":"This property ensures that there is a human readable authentication page available that will provide what type of authentication is used and how it can be applied, as well as any services or tooling that API consumers can use to troubleshoot authentication with APIs.","message":"Has Authentication","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(Authentication)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:security","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-authentication-page' (Schema Include Authentication Page). Requirement: This property ensures that there is a human readable authentication page available that will provide what type of authentication is used and how it can be applied, as well as any services or tooling that API consumers can use to troubleshoot authentication with APIs. To fix: Ensure `type` does NOT match the regular expression `\\b(Authentication)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-blog":{"title":"Schema Include Blog","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-blog/","source":"default","description":"This property ensures that an API has a reference to a blog where anyone can find updates and other stories that will help keep API consumers and other stakeholders up to speed on what is happening with an API, and the larger operations.","message":"Has a Blog","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(blog|Blogs)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-blog' (Schema Include Blog). Requirement: This property ensures that an API has a reference to a blog where anyone can find updates and other stories that will help keep API consumers and other stakeholders up to speed on what is happening with an API, and the larger operations. To fix: Ensure `type` does NOT match the regular expression `\\b(blog|Blogs)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-blog-feed":{"title":"Schema Include Blog Feed","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-blog-feed/","source":"default","description":"This property ensures that blogs in support of APIs have an Atom or RSS feed of posts, allowing for the syndication of updates and information around individual APIs and the operations around them.","message":"Has a Blog Feed","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(blog-feed|BlogFeeds)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-blog-feed' (Schema Include Blog Feed). Requirement: This property ensures that blogs in support of APIs have an Atom or RSS feed of posts, allowing for the syndication of updates and information around individual APIs and the operations around them. To fix: Ensure `type` does NOT match the regular expression `\\b(blog-feed|BlogFeeds)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-business-validator":{"title":"Schema Include Business Validator","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-business-validator/","source":"default","description":"This property ensures that there is a link to the validator for the APIs.","message":"Has APIs.json (Business) Validator","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(OperationalValidation)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-business-validator' (Schema Include Business Validator). Requirement: This property ensures that there is a link to the validator for the APIs. To fix: Ensure `type` does NOT match the regular expression `\\b(OperationalValidation)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-change-log":{"title":"Schema Include Change Log","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-change-log/","source":"default","description":"This property ensures that than an individual API or API operations possesses a change log that catalogs all the changes that have occurred in a recent time frame, with historical and version information available if possible.","message":"Has Change Log","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-change-log|change-log|Change Log|Changelog|ChangeLog)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:versioning","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-change-log' (Schema Include Change Log). Requirement: This property ensures that than an individual API or API operations possesses a change log that catalogs all the changes that have occurred in a recent time frame, with historical and version information available if possible. To fix: Ensure `type` does NOT match the regular expression `\\b(api-change-log|change-log|Change Log|Changelog|ChangeLog)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-deprecation-policy":{"title":"Schema Include Deprecation Policy","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-deprecation-policy/","source":"default","description":"This property ensures that an API has a deprecation policy shared as part of the contract, communicating what the lifespan of APIs are, each individual version, as well as communication around the deprecation of APIs.","message":"Has Deprecation Policy","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-deprecation-policy|deprecation-policy|Deprecation|Deprecation Policy|DeprecationPolicy)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","topic:deprecation","experience:versioning","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-deprecation-policy' (Schema Include Deprecation Policy). Requirement: This property ensures that an API has a deprecation policy shared as part of the contract, communicating what the lifespan of APIs are, each individual version, as well as communication around the deprecation of APIs. To fix: Ensure `type` does NOT match the regular expression `\\b(api-deprecation-policy|deprecation-policy|Deprecation|Deprecation Policy|DeprecationPolicy)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-developer-portal":{"title":"Schema Include Developer Portal","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-developer-portal/","source":"default","description":"This property ensures there a developer portal associated with an API and that you can find a landing page for the API, documentation, SDKs, and other resources.","message":"Has Developer Portal","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-developer-portal|developer-portal|portal|Portal|Portals|DeveloperPortal)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:discoverability","experience:usability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-developer-portal' (Schema Include Developer Portal). Requirement: This property ensures there a developer portal associated with an API and that you can find a landing page for the API, documentation, SDKs, and other resources. To fix: Ensure `type` does NOT match the regular expression `\\b(api-developer-portal|developer-portal|portal|Portal|Portals|DeveloperPortal)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-discussion-forum":{"title":"Schema Include Discussion Forum","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-discussion-forum/","source":"default","description":"This property ensures that there is a link to a discussion forum, providing a way for consumers and producers to engage and support either other throughout the lifecycle.","message":"Has Discussion Forum","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(Forums|Forums|Discussions)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-discussion-forum' (Schema Include Discussion Forum). Requirement: This property ensures that there is a link to a discussion forum, providing a way for consumers and producers to engage and support either other throughout the lifecycle. To fix: Ensure `type` does NOT match the regular expression `\\b(Forums|Forums|Discussions)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-documentation":{"title":"Schema Include Documentation","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-documentation/","source":"default","description":"This property ensures that there is documentation published for an API, and API consumers will have a set of human-readable instructions for onboarding and integrating with HTTP APIs in their applications.","message":"Has Documentation","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(documentation|Documentation)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:usability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-documentation' (Schema Include Documentation). Requirement: This property ensures that there is documentation published for an API, and API consumers will have a set of human-readable instructions for onboarding and integrating with HTTP APIs in their applications. To fix: Ensure `type` does NOT match the regular expression `\\b(documentation|Documentation)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-examples":{"title":"Schema Include Examples","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-examples/","source":"default","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"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:usability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-examples' (Schema Include Examples). Requirement: 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. To fix: Ensure `type` does NOT match the regular expression `\\b(examples|Examples)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-feedback-email":{"title":"Schema Include Feedback Email","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-feedback-email/","source":"default","description":"This property ensures that there is an email available for API consumers to provide feedback.","message":"Has Feedback Email","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(feedback-email|FeedbackEmail)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-feedback-email' (Schema Include Feedback Email). Requirement: This property ensures that there is an email available for API consumers to provide feedback. To fix: Ensure `type` does NOT match the regular expression `\\b(feedback-email|FeedbackEmail)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-feedback-issues-url":{"title":"Schema Include Feedback Issues URL","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-feedback-issues-url/","source":"default","description":"This property ensures there is a URL to Git issues specifically for providing feedback.","message":"Has Feedback Issues URL","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(FeedbackIssues|FeedbackGitHubIssues)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-feedback-issues-url' (Schema Include Feedback Issues URL). Requirement: This property ensures there is a URL to Git issues specifically for providing feedback. To fix: Ensure `type` does NOT match the regular expression `\\b(FeedbackIssues|FeedbackGitHubIssues)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-gateway-reference":{"title":"Schema Include Gateway Reference","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-gateway-reference/","source":"default","description":"This property ensures that there is a reference to the gateway for an API, referencing where you can manage the configuration for each API.","message":"Has Staging Gateway for API","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(gateway|Gateway)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-gateway-reference' (Schema Include Gateway Reference). Requirement: This property ensures that there is a reference to the gateway for an API, referencing where you can manage the configuration for each API. To fix: Ensure `type` does NOT match the regular expression `\\b(gateway|Gateway)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-getting-started":{"title":"Schema Include Getting Started","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-getting-started/","source":"default","description":"This property ensures that there is a getting started link available, providing a reference for API consumers to get started with an API is as few steps as possible.","message":"Has Getting Started","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(GettingStarted)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:usability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-getting-started' (Schema Include Getting Started). Requirement: This property ensures that there is a getting started link available, providing a reference for API consumers to get started with an API is as few steps as possible. To fix: Ensure `type` does NOT match the regular expression `\\b(GettingStarted)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-github-action":{"title":"Schema Include Github Action","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-github-action/","source":"default","description":"This property ensures that a GitHub Actions CI/CD pipeline is available for an API, providing a link to the pipeline YAML artifact, which can be used to automate and govern the API as part of the build process.","message":"Has a GitHub Action","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(github-actions|GitHubActions)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:reliability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-github-action' (Schema Include Github Action). Requirement: This property ensures that a GitHub Actions CI/CD pipeline is available for an API, providing a link to the pipeline YAML artifact, which can be used to automate and govern the API as part of the build process. To fix: Ensure `type` does NOT match the regular expression `\\b(github-actions|GitHubActions)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-github-organization":{"title":"Schema Include Github Organization","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-github-organization/","source":"default","description":"This property ensures that an API is associated with GitHub organization, providing the URL to where you can engage with the operations surrounding an API.","message":"Has a GitHub Organization","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(github-organization|GitHubOrganization)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:discoverability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-github-organization' (Schema Include Github Organization). Requirement: This property ensures that an API is associated with GitHub organization, providing the URL to where you can engage with the operations surrounding an API. To fix: Ensure `type` does NOT match the regular expression `\\b(github-organization|GitHubOrganization)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-github-repository":{"title":"Schema Include Github Repository","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-github-repository/","source":"default","description":"This property ensures that an API possess a reference to a dedicated GitHub repository that is used to manage the Open, but also possible server and client code.","message":"Has a GitHub Repository","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(github-repository|GitHubRepository)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:discoverability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-github-repository' (Schema Include Github Repository). Requirement: This property ensures that an API possess a reference to a dedicated GitHub repository that is used to manage the Open, but also possible server and client code. To fix: Ensure `type` does NOT match the regular expression `\\b(github-repository|GitHubRepository)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-governance-policies":{"title":"Schema Include Governance Policies","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-governance-policies/","source":"default","description":"This property ensures there is a governance policies reference as part of an API contract, usually a common property pointing to a centralized set of policies that get applied.","message":"Has API Governance Policies","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-policies|Policies)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-governance-policies' (Schema Include Governance Policies). Requirement: This property ensures there is a governance policies reference as part of an API contract, usually a common property pointing to a centralized set of policies that get applied. To fix: Ensure `type` does NOT match the regular expression `\\b(api-policies|Policies)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-insomnia-collection":{"title":"Schema Include Insomnia Collection","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-insomnia-collection/","source":"default","description":"This property defines an Insomnia collection available for each API, providing executable artifacts that can be used in the Insomnia client for making calls, and executing automation workflows.","message":"Has Insomnia Collection","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(RunInInsomnia)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-insomnia-collection' (Schema Include Insomnia Collection). Requirement: This property defines an Insomnia collection available for each API, providing executable artifacts that can be used in the Insomnia client for making calls, and executing automation workflows. To fix: Ensure `type` does NOT match the regular expression `\\b(RunInInsomnia)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-interface-license":{"title":"Schema Include Interface License","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-interface-license/","source":"default","description":"This property ensures that an API Commons interface license exists for an API, providing a machine-readable reference for an API, as well as data, backend, and front-end code.","message":"Has Interface License","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-license|License|license|InterfaceLicense)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-interface-license' (Schema Include Interface License). Requirement: This property ensures that an API Commons interface license exists for an API, providing a machine-readable reference for an API, as well as data, backend, and front-end code. To fix: Ensure `type` does NOT match the regular expression `\\b(api-license|License|license|InterfaceLicense)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-mock-server":{"title":"Schema Include Mock Server","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-mock-server/","source":"default","description":"This property ensures that an API has a reference to a mock servers for individual APIs or as part of common properties, providing mocked deployments of an API that can be used for making test API calls.","message":"Has a Mock Server","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(mocks|Mocks|MockServers)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-mock-server' (Schema Include Mock Server). Requirement: This property ensures that an API has a reference to a mock servers for individual APIs or as part of common properties, providing mocked deployments of an API that can be used for making test API calls. To fix: Ensure `type` does NOT match the regular expression `\\b(mocks|Mocks|MockServers)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-openapi-definition":{"title":"Schema Include Openapi Definition","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-openapi-definition/","source":"default","description":"This property ensures that there is an OpenAPI present for an API, providing the technical contract that describes the surface area of an API.","message":"Has An OpenAPI","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(openapi|OpenAPI)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:documentation","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-openapi-definition' (Schema Include Openapi Definition). Requirement: This property ensures that there is an OpenAPI present for an API, providing the technical contract that describes the surface area of an API. To fix: Ensure `type` does NOT match the regular expression `\\b(openapi|OpenAPI)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-openapi-governance-rules":{"title":"Schema Include Openapi Governance Rules","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-openapi-governance-rules/","source":"default","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"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-openapi-governance-rules' (Schema Include Openapi Governance Rules). Requirement: 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. To fix: Ensure `type` does NOT match the regular expression `\\b(api-rules|ApiRules)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-openapi-validator":{"title":"Schema Include Openapi Validator","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-openapi-validator/","source":"default","description":"This property ensures that there is a link to the validator for the OpenAPI technical contract, allowing anyone to see the details of governance being applied.","message":"Has OpenAPI (Technical) Validator","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(APIValidation)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-openapi-validator' (Schema Include Openapi Validator). Requirement: This property ensures that there is a link to the validator for the OpenAPI technical contract, allowing anyone to see the details of governance being applied. To fix: Ensure `type` does NOT match the regular expression `\\b(APIValidation)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-operational-rules":{"title":"Schema Include Operational Rules","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-operational-rules/","source":"default","description":"This property ensures that an API has operational level rules for APIs.","message":"Has Operational Rules","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(operational-rules|OperationalRules)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-operational-rules' (Schema Include Operational Rules). Requirement: This property ensures that an API has operational level rules for APIs. To fix: Ensure `type` does NOT match the regular expression `\\b(operational-rules|OperationalRules)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-performance-testing":{"title":"Schema Include Performance Testing","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-performance-testing/","source":"default","description":"This property ensures that an API has performance testing in place, providing a URL to the performance testing, dashboard, or other resource.","message":"Has API Performance","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(Performance|PerformanceTesting)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:reliability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-performance-testing' (Schema Include Performance Testing). Requirement: This property ensures that an API has performance testing in place, providing a URL to the performance testing, dashboard, or other resource. To fix: Ensure `type` does NOT match the regular expression `\\b(Performance|PerformanceTesting)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-postman-collection":{"title":"Schema Include Postman Collection","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-postman-collection/","source":"default","description":"This property ensures that an API has at least one Postman Collection associated with it, providing automation, tests, and other executable derivatives of an APIs OpenAPI.","message":"Has a Postman Collection","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(PostmanCollection)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-postman-collection' (Schema Include Postman Collection). Requirement: This property ensures that an API has at least one Postman Collection associated with it, providing automation, tests, and other executable derivatives of an APIs OpenAPI. To fix: Ensure `type` does NOT match the regular expression `\\b(PostmanCollection)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-postman-public-workspace":{"title":"Schema Include Postman Public Workspace","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-postman-public-workspace/","source":"default","description":"This property ensures that an API is associated with a Postman Workspace, providing a single location that API producers and/or API consumers can engage around an API.","message":"Has Public Postman Workspace","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(postman-public-workspace|PostmanPublicWorkspace|PostmanWorkspace)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-postman-public-workspace' (Schema Include Postman Public Workspace). Requirement: This property ensures that an API is associated with a Postman Workspace, providing a single location that API producers and/or API consumers can engage around an API. To fix: Ensure `type` does NOT match the regular expression `\\b(postman-public-workspace|PostmanPublicWorkspace|PostmanWorkspace)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-pricing":{"title":"Schema Include Pricing","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-pricing/","source":"default","description":"This property provides a link to a pricing page that applies to an API, providing a breakdown of the costs associated with using an API.","message":"Has Pricing","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(Pricing)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-pricing' (Schema Include Pricing). Requirement: This property provides a link to a pricing page that applies to an API, providing a breakdown of the costs associated with using an API. To fix: Ensure `type` does NOT match the regular expression `\\b(Pricing)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-privacy-policy":{"title":"Schema Include Privacy Policy","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-privacy-policy/","source":"default","description":"This property provides a link to the privacy policy for an API, providing the legal details of how privacy is approached for each API.","message":"Has an API Privacy Policy","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(api-privacy-policy|privacy-policy|Privacy|Privacy Policy|PrivacyPolicy)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:governance","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-privacy-policy' (Schema Include Privacy Policy). Requirement: This property provides a link to the privacy policy for an API, providing the legal details of how privacy is approached for each API. To fix: Ensure `type` does NOT match the regular expression `\\b(api-privacy-policy|privacy-policy|Privacy|Privacy Policy|PrivacyPolicy)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-production-environment":{"title":"Schema Include Production Environment","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-production-environment/","source":"default","description":"This property ensures that there is a production environment available for an API, providing base URL, tokens, keys, and other key / value pairs that are needed to integrate with an API.","message":"Has a Production Environment","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(ProductionEnvironment)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:reliability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-production-environment' (Schema Include Production Environment). Requirement: This property ensures that there is a production environment available for an API, providing base URL, tokens, keys, and other key / value pairs that are needed to integrate with an API. To fix: Ensure `type` does NOT match the regular expression `\\b(ProductionEnvironment)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-questions-issues-url":{"title":"Schema Include Questions Issues URL","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-questions-issues-url/","source":"default","description":"This property ensures that an API has a dedicated link to Git issues for asking questions.","message":"Has Questions Issues URL","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(QuestionsIssues|QuestionsGitHubIssues)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-questions-issues-url' (Schema Include Questions Issues URL). Requirement: This property ensures that an API has a dedicated link to Git issues for asking questions. To fix: Ensure `type` does NOT match the regular expression `\\b(QuestionsIssues|QuestionsGitHubIssues)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-rate-limit-reference":{"title":"Schema Include Rate Limit Reference","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-rate-limit-reference/","source":"default","description":"This property ensures there is an API rate limits reference associated with API, ensuring the rate limits applied to an API are clearly communicated.","message":"Has an API Terms of Services","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(rate-limits|RateLimits|Rate Limits)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","topic:rate-limiting","experience:reliability","experience:documentation","experience:performance"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-rate-limit-reference' (Schema Include Rate Limit Reference). Requirement: This property ensures there is an API rate limits reference associated with API, ensuring the rate limits applied to an API are clearly communicated. To fix: Ensure `type` does NOT match the regular expression `\\b(rate-limits|RateLimits|Rate Limits)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-staging-environment":{"title":"Schema Include Staging Environment","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-staging-environment/","source":"default","description":"This property ensures that there is a staging environment available for an API, providing base URL, tokens, keys, and other key / value pairs that are needed to integrate with an API.","message":"Has a Stage Environment","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(StagingEnvironment)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:usability","experience:reliability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-staging-environment' (Schema Include Staging Environment). Requirement: This property ensures that there is a staging environment available for an API, providing base URL, tokens, keys, and other key / value pairs that are needed to integrate with an API. To fix: Ensure `type` does NOT match the regular expression `\\b(StagingEnvironment)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"schema-include-version-comparison":{"title":"Schema Include Version Comparison","reference":"https://spotlight-rules.com/spec/rules/apis-json/schema-include-version-comparison/","source":"default","description":"This property ensures that an API has the ability to compare two different versions of an API and see what the difference are between them.","message":"Has an API Comparison","severity":"info","given":["$.apis.*.properties.*","$.common.*"],"then":[{"field":"type","function":"pattern","functionOptions":{"notMatch":"\\b(compare|Compare)\\b"}}],"tags":["format:apis-json","spec:apis","spec:properties","experience:versioning","experience:documentation"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-version-comparison' (Schema Include Version Comparison). Requirement: This property ensures that an API has the ability to compare two different versions of an API and see what the difference are between them. To fix: Ensure `type` does NOT match the regular expression `\\b(compare|Compare)\\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"tag-apis-json-not-empty":{"title":"Tag APIs JSON Not Empty","reference":"https://spotlight-rules.com/spec/rules/apis-json/tag-apis-json-not-empty/","source":"spotlight","description":"If tags are declared they should not be empty — tags drive discovery in the catalog.","message":"tags should not be empty.","given":"$.tags","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"array","minItems":1}}},"tags":["format:apis-json","spec:tags","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'tag-apis-json-not-empty' (Tag APIs JSON Not Empty). Requirement: If tags are declared they should not be empty — tags drive discovery in the catalog. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.tags` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."},"tag-require-upper-case":{"title":"Tag Require Upper Case","reference":"https://spotlight-rules.com/spec/rules/apis-json/tag-require-upper-case/","source":"default","description":"Maintaining consistent casing for tags applied to APIs.json contracts ensures a uniform appearance and enhances search and discovery. Each word in a tag should be capitalized, with the first letter of every word in a phrase treated the same way.","message":"Tags Upper Case","severity":"info","given":"$.tags.*","then":{"function":"pattern","functionOptions":{"match":"[A-Z]\\w*"}},"tags":["format:apis-json","spec:tags","experience:naming","experience:consistency","experience:discoverability"],"prompt":"You are editing an APIs.json document to satisfy the Spotlight API governance rule 'tag-require-upper-case' (Tag Require Upper Case). Requirement: Maintaining consistent casing for tags applied to APIs.json contracts ensures a uniform appearance and enhances search and discovery. Each word in a tag should be capitalized, with the first letter of every word in a phrase treated the same way. To fix: Ensure the targeted value matches the regular expression `[A-Z]\\w*`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.tags.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary."}},"asyncapi":{"asyncapi-3-channel-no-empty-parameter":{"title":"Asyncapi 3 Channel No Empty Parameter","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-channel-no-empty-parameter/","source":"builtin","description":"Channel address must not have empty parameter substitution pattern.","message":"Channel address must not have empty parameter substitution pattern.","severity":"info","given":"$.channels.*","then":{"field":"address","function":"pattern","functionOptions":{"notMatch":"{}"}},"tags":["format:asyncapi","spec:channels","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-channel-no-empty-parameter' (Asyncapi 3 Channel No Empty Parameter). Requirement: Channel address must not have empty parameter substitution pattern. To fix: Ensure `address` does NOT match the regular expression `{}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.channels.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-channel-no-query-nor-fragment":{"title":"Asyncapi 3 Channel No Query Nor Fragment","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-channel-no-query-nor-fragment/","source":"builtin","description":"Channel address must not include query (\"?\") or fragment (\"#\") delimiter.","message":"Channel address must not include query (\"?\") or fragment (\"#\") delimiter.","severity":"info","given":"$.channels.*","then":{"field":"address","function":"pattern","functionOptions":{"notMatch":"[\\?#]"}},"tags":["format:asyncapi","spec:channels","experience:consistency","experience:naming"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-channel-no-query-nor-fragment' (Asyncapi 3 Channel No Query Nor Fragment). Requirement: Channel address must not include query (\"?\") or fragment (\"#\") delimiter. To fix: Ensure `address` does NOT match the regular expression `[\\?#]`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.channels.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-channel-no-trailing-slash":{"title":"Asyncapi 3 Channel No Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-channel-no-trailing-slash/","source":"builtin","description":"Channel address must not end with slash.","message":"Channel address must not end with slash.","severity":"info","given":"$.channels.*","then":{"field":"address","function":"pattern","functionOptions":{"notMatch":".+\\/$"}},"tags":["format:asyncapi","spec:channels","experience:consistency","experience:naming"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-channel-no-trailing-slash' (Asyncapi 3 Channel No Trailing Slash). Requirement: Channel address must not end with slash. To fix: Ensure `address` does NOT match the regular expression `.+\\/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.channels.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-channel-servers":{"title":"Asyncapi 3 Channel Servers","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-channel-servers/","source":"builtin","description":"Channel servers must be defined in the \"servers\" object.","message":"Channel servers must be defined in the \"servers\" object.","severity":"info","given":"$.channels.*","then":{"field":"$.servers.*.$ref","function":"pattern","functionOptions":{"match":"#\\/servers\\/"}},"tags":["format:asyncapi","spec:channels","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-channel-servers' (Asyncapi 3 Channel Servers). Requirement: Channel servers must be defined in the \"servers\" object. To fix: Ensure `$.servers.*.$ref` matches the regular expression `#\\/servers\\/`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.channels.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-document-unresolved":{"title":"Asyncapi 3 Document Unresolved","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-document-unresolved/","source":"builtin","description":"Checking if the AsyncAPI v3 document has valid structure before resolving references.","message":"{{error}}","severity":"info","given":"$","then":{"function":"","functionOptions":{"resolved":false}},"tags":["format:asyncapi","spec:document","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-document-unresolved' (Asyncapi 3 Document Unresolved). Requirement: Checking if the AsyncAPI v3 document has valid structure before resolving references. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-headers-schema-type-object":{"title":"Asyncapi 3 Headers Schema Type Object","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-headers-schema-type-object/","source":"builtin","description":"Headers schema type must be \"object\".","message":"Headers schema type must be \"object\" ({{error}}).","severity":"info","given":["$.components.messageTraits.*.headers","$.components.messages.*.headers","$.channels.*.messages.*.headers","$.channels.*.messages.*.traits[*].headers"],"then":{"function":"schema","functionOptions":{"allErrors":true,"schema":{"type":"object","properties":{"type":{"enum":["object"]}},"required":["type"]}}},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-headers-schema-type-object' (Asyncapi 3 Headers Schema Type Object). Requirement: Headers schema type must be \"object\". To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.components.messageTraits.*.headers | $.components.messages.*.headers | $.channels.*.messages.*.headers | $.channels.*.messages.*.traits[*].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-operation-description":{"title":"Asyncapi 3 Operation Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-operation-description/","source":"builtin","description":"Operation \"description\" must be present and non-empty string.","message":"Operation \"description\" must be present and non-empty string.","severity":"info","given":"$.operations.*","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:operations","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-operation-description' (Asyncapi 3 Operation Description). Requirement: Operation \"description\" must be present and non-empty string. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.operations.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-operation-security":{"title":"Asyncapi 3 Operation Security","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-operation-security/","source":"builtin","description":"Operation have to reference a defined security schemes.","message":"{{error}}","severity":"info","given":"$.operations.*.security.*","then":{"function":"asyncApiSecurity","functionOptions":{"objectType":"Operation"}},"tags":["format:asyncapi","spec:security","experience:security","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-operation-security' (Asyncapi 3 Operation Security). Requirement: Operation have to reference a defined security schemes. This rule is evaluated at the JSONPath `$.operations.*.security.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-payload-unsupported-schemaFormat":{"title":"Asyncapi 3 Payload Unsupported SchemaFormat","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-payload-unsupported-schemaFormat/","source":"builtin","description":"Message schema validation is only supported with default unspecified \"schemaFormat\".","message":"Message schema validation is only supported with default unspecified \"schemaFormat\".","severity":"info","given":["$.components.messages.*.payload","$.channels.*.messages.*.payload"],"then":{"field":"schemaFormat","function":"undefined"},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-payload-unsupported-schemaFormat' (Asyncapi 3 Payload Unsupported SchemaFormat). Requirement: Message schema validation is only supported with default unspecified \"schemaFormat\". To fix: Remove `schemaFormat` from each matching location. This rule is evaluated at the JSONPath `$.components.messages.*.payload | $.channels.*.messages.*.payload` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-server-no-empty-variable":{"title":"Asyncapi 3 Server No Empty Variable","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-server-no-empty-variable/","source":"builtin","description":"Server host and pathname must not have empty variable substitution pattern.","message":"Server host and pathname must not have empty variable substitution pattern.","severity":"info","given":["$.servers[*].host","$.servers[*].pathname"],"then":{"function":"pattern","functionOptions":{"notMatch":"{}"}},"tags":["format:asyncapi","spec:servers","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-server-no-empty-variable' (Asyncapi 3 Server No Empty Variable). Requirement: Server host and pathname must not have empty variable substitution pattern. To fix: Ensure the targeted value does NOT match the regular expression `{}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers[*].host | $.servers[*].pathname` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-server-no-trailing-slash":{"title":"Asyncapi 3 Server No Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-server-no-trailing-slash/","source":"builtin","description":"Server host must not end with slash.","message":"Server host must not end with slash.","severity":"info","given":"$.servers.*.host","then":{"function":"pattern","functionOptions":{"notMatch":"/$"}},"tags":["format:asyncapi","spec:servers","experience:consistency","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-server-no-trailing-slash' (Asyncapi 3 Server No Trailing Slash). Requirement: Server host must not end with slash. To fix: Ensure the targeted value does NOT match the regular expression `/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers.*.host` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-server-not-example-com":{"title":"Asyncapi 3 Server Not Example Com","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-server-not-example-com/","source":"builtin","description":"Server host must not point at example.com.","message":"Server host must not point at example.com.","severity":"info","given":"$.servers.*.host","then":{"function":"pattern","functionOptions":{"notMatch":"example\\.com"}},"tags":["format:asyncapi","spec:servers","experience:reliability","experience:usability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-server-not-example-com' (Asyncapi 3 Server Not Example Com). Requirement: Server host must not point at example.com. To fix: Ensure the targeted value does NOT match the regular expression `example\\.com`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers.*.host` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-tag-description":{"title":"Asyncapi 3 Tag Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-tag-description/","source":"builtin","description":"Tag object must have \"description\".","message":"Tag object must have \"description\".","severity":"info","given":"$.info.tags[*]","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:info","experience:documentation","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-tag-description' (Asyncapi 3 Tag Description). Requirement: Tag object must have \"description\". To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-tags":{"title":"Asyncapi 3 Tags","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-tags/","source":"builtin","description":"AsyncAPI document must have non-empty \"tags\" array.","message":"AsyncAPI document must have non-empty \"tags\" array.","severity":"info","given":["$.info"],"then":{"field":"tags","function":"truthy"},"tags":["format:asyncapi","spec:info","experience:discoverability","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-tags' (Asyncapi 3 Tags). Requirement: AsyncAPI document must have non-empty \"tags\" array. To fix: Ensure `tags` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-tags-alphabetical":{"title":"Asyncapi 3 Tags Alphabetical","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-tags-alphabetical/","source":"builtin","description":"AsyncAPI object must have alphabetical \"tags\".","message":"AsyncAPI object must have alphabetical \"tags\".","severity":"info","given":"$.info","then":{"field":"tags","function":"alphabetical","functionOptions":{"keyedBy":"name"}},"tags":["format:asyncapi","spec:info","experience:consistency","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-tags-alphabetical' (Asyncapi 3 Tags Alphabetical). Requirement: AsyncAPI object must have alphabetical \"tags\". To fix: Sort the entries by `name` into ascending alphabetical order. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-3-tags-uniqueness":{"title":"Asyncapi 3 Tags Uniqueness","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-3-tags-uniqueness/","source":"builtin","description":"Each tag must have a unique name.","message":"{{error}}","severity":"info","given":["$.info.tags","$.servers.*.tags","$.components.servers.*.tags","$.operations.*.tags","$.components.operations.*.tags","$.operations.*.traits.*.tags","$.components.operations.traits.*.tags","$.components.operationTraits.*.tags","$.channels.*.messages.*.tags","$.components.channels.*.messages.tags","$.components.messages.*.tags","$.channels.*..messages.*.traits.*.tags","$.components.channels.*.messages.*.traits.*.tags","$.components.messages.*.traits.*.tags","$.components.messageTraits.*.tags"],"then":{"function":"uniquenessTags"},"tags":["format:asyncapi","spec:info","spec:servers","spec:channels","spec:messages","spec:components","experience:consistency","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-3-tags-uniqueness' (Asyncapi 3 Tags Uniqueness). Requirement: Each tag must have a unique name. This rule is evaluated at the JSONPath `$.info.tags | $.servers.*.tags | $.components.servers.*.tags | $.operations.*.tags | $.components.operations.*.tags | $.operations.*.traits.*.tags | $.components.operations.traits.*.tags | $.components.operationTraits.*.tags | $.channels.*.messages.*.tags | $.components.channels.*.messages.tags | $.components.messages.*.tags | $.channels.*..messages.*.traits.*.tags | $.components.channels.*.messages.*.traits.*.tags | $.components.messages.*.traits.*.tags | $.components.messageTraits.*.tags` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-channel-no-empty-parameter":{"title":"Asyncapi Channel No Empty Parameter","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-channel-no-empty-parameter/","source":"builtin","description":"Channel path must not have empty parameter substitution pattern.","message":"Channel path must not have empty parameter substitution pattern.","severity":"info","given":"$.channels","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"{}"}},"tags":["format:asyncapi","spec:channels","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-channel-no-empty-parameter' (Asyncapi Channel No Empty Parameter). Requirement: Channel path must not have empty parameter substitution pattern. To fix: Ensure `@key` does NOT match the regular expression `{}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.channels` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-channel-no-query-nor-fragment":{"title":"Asyncapi Channel No Query Nor Fragment","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-channel-no-query-nor-fragment/","source":"builtin","description":"Channel path must not include query (\"?\") or fragment (\"#\") delimiter.","message":"Channel path must not include query (\"?\") or fragment (\"#\") delimiter.","severity":"info","given":"$.channels","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":"[\\?#]"}},"tags":["format:asyncapi","spec:channels","experience:consistency","experience:naming"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-channel-no-query-nor-fragment' (Asyncapi Channel No Query Nor Fragment). Requirement: Channel path must not include query (\"?\") or fragment (\"#\") delimiter. To fix: Ensure `@key` does NOT match the regular expression `[\\?#]`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.channels` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-channel-no-trailing-slash":{"title":"Asyncapi Channel No Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-channel-no-trailing-slash/","source":"builtin","description":"Channel path must not end with slash.","message":"Channel path must not end with slash.","severity":"info","given":"$.channels","then":{"field":"@key","function":"pattern","functionOptions":{"notMatch":".+\\/$"}},"tags":["format:asyncapi","spec:channels","experience:consistency","experience:naming"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-channel-no-trailing-slash' (Asyncapi Channel No Trailing Slash). Requirement: Channel path must not end with slash. To fix: Ensure `@key` does NOT match the regular expression `.+\\/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.channels` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-channel-parameters":{"title":"Asyncapi Channel Parameters","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-channel-parameters/","source":"builtin","description":"Channel parameters must be defined and there must be no redundant parameters.","message":"{{error}}","severity":"info","given":["$.channels.*","$.components.channels.*"],"then":{"function":"asyncApiChannelParameters"},"tags":["format:asyncapi","spec:channels","spec:components","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-channel-parameters' (Asyncapi Channel Parameters). Requirement: Channel parameters must be defined and there must be no redundant parameters. This rule is evaluated at the JSONPath `$.channels.* | $.components.channels.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-channel-servers":{"title":"Asyncapi Channel Servers","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-channel-servers/","source":"builtin","description":"Channel servers must be defined in the \"servers\" object.","message":"{{error}}","severity":"info","given":"$","then":{"function":"asyncApi2ChannelServers"},"tags":["format:asyncapi","spec:document","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-channel-servers' (Asyncapi Channel Servers). Requirement: Channel servers must be defined in the \"servers\" object. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-headers-schema-type-object":{"title":"Asyncapi Headers Schema Type Object","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-headers-schema-type-object/","source":"builtin","description":"Headers schema type must be \"object\".","message":"Headers schema type must be \"object\" ({{error}}).","severity":"info","given":["$.components.messageTraits.*.headers","$.components.messages.*.headers","$.channels.*.[publish,subscribe].message.headers","$.channels.*.[publish,subscribe].message.traits[*].headers"],"then":{"function":"schema","functionOptions":{"allErrors":true,"schema":{"type":"object","properties":{"type":{"enum":["object"]}},"required":["type"]}}},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-headers-schema-type-object' (Asyncapi Headers Schema Type Object). Requirement: Headers schema type must be \"object\". To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.components.messageTraits.*.headers | $.components.messages.*.headers | $.channels.*.[publish,subscribe].message.headers | $.channels.*.[publish,subscribe].message.traits[*].headers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-info-contact":{"title":"Asyncapi Info Contact","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-info-contact/","source":"builtin","description":"Info object must have \"contact\" object.","message":"Info object must have \"contact\" object.","severity":"info","given":"$","then":{"field":"info.contact","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:documentation","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-info-contact' (Asyncapi Info Contact). Requirement: Info object must have \"contact\" object. To fix: Ensure `info.contact` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-info-contact-properties":{"title":"Asyncapi Info Contact Properties","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-info-contact-properties/","source":"builtin","description":"Contact object must have \"name\", \"url\" and \"email\".","message":"Contact object must have \"name\", \"url\" and \"email\".","severity":"info","given":"$.info.contact","then":[{"field":"name","function":"truthy"},{"field":"url","function":"truthy"},{"field":"email","function":"truthy"}],"tags":["format:asyncapi","spec:info","experience:documentation","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-info-contact-properties' (Asyncapi Info Contact Properties). Requirement: Contact object must have \"name\", \"url\" and \"email\". To fix: Ensure `name` is present and non-empty at each matching location. Also: Ensure `url` is present and non-empty at each matching location. Also: Ensure `email` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info.contact` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-info-description":{"title":"Asyncapi Info Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-info-description/","source":"builtin","description":"Info \"description\" must be present and non-empty string.","message":"Info \"description\" must be present and non-empty string.","severity":"info","given":"$","then":{"field":"info.description","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-info-description' (Asyncapi Info Description). Requirement: Info \"description\" must be present and non-empty string. To fix: Ensure `info.description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-info-license":{"title":"Asyncapi Info License","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-info-license/","source":"builtin","description":"Info object must have \"license\" object.","message":"Info object must have \"license\" object.","severity":"info","given":"$","then":{"field":"info.license","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-info-license' (Asyncapi Info License). Requirement: Info object must have \"license\" object. To fix: Ensure `info.license` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-info-license-url":{"title":"Asyncapi Info License URL","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-info-license-url/","source":"builtin","description":"License object must include \"url\".","message":"License object must include \"url\".","severity":"info","given":"$","then":{"field":"info.license.url","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-info-license-url' (Asyncapi Info License URL). Requirement: License object must include \"url\". To fix: Ensure `info.license.url` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-latest-version":{"title":"Asyncapi Latest Version","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-latest-version/","source":"builtin","description":"Checking if the AsyncAPI document is using the latest version.","message":"The latest version is not used. You should update to the \"3.1.0\" version.","severity":"info","given":"$.asyncapi","then":{"function":"schema","functionOptions":{"schema":{"const":"3.1.0"}}},"tags":["format:asyncapi","spec:document","experience:versioning","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-latest-version' (Asyncapi Latest Version). Requirement: Checking if the AsyncAPI document is using the latest version. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.asyncapi` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-message-examples":{"title":"Asyncapi Message Examples","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-message-examples/","source":"builtin","description":"Examples of message object should follow by \"payload\" and \"headers\" schemas.","message":"{{error}}","severity":"info","given":["$.channels.*.[publish,subscribe].message","$.channels.*.[publish,subscribe].message.oneOf.*","$.components.channels.*.[publish,subscribe].message","$.components.channels.*.[publish,subscribe].message.oneOf.*","$.components.messages.*","$.channels.*.[publish,subscribe].message.traits.*","$.channels.*.[publish,subscribe].message.oneOf.*.traits.*","$.components.channels.*.[publish,subscribe].message.traits.*","$.components.channels.*.[publish,subscribe].message.oneOf.*.traits.*","$.components.messages.*.traits.*","$.components.messageTraits.*"],"then":{"function":"asyncApi2MessageExamplesValidation"},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","experience:data-modeling","experience:documentation","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-message-examples' (Asyncapi Message Examples). Requirement: Examples of message object should follow by \"payload\" and \"headers\" schemas. This rule is evaluated at the JSONPath `$.channels.*.[publish,subscribe].message | $.channels.*.[publish,subscribe].message.oneOf.* | $.components.channels.*.[publish,subscribe].message | $.components.channels.*.[publish,subscribe].message.oneOf.* | $.components.messages.* | $.channels.*.[publish,subscribe].message.traits.* | $.channels.*.[publish,subscribe].message.oneOf.*.traits.* | $.components.channels.*.[publish,subscribe].message.traits.* | $.components.channels.*.[publish,subscribe].message.oneOf.*.traits.* | $.components.messages.*.traits.* | $.components.messageTraits.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-message-messageId-uniqueness":{"title":"Asyncapi Message MessageId Uniqueness","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-message-messageId-uniqueness/","source":"builtin","description":"\"messageId\" must be unique across all the messages.","message":"\"messageId\" must be unique across all the messages.","severity":"info","given":"$","then":{"function":"asyncApi2MessageIdUniqueness"},"tags":["format:asyncapi","spec:document","experience:consistency","experience:naming","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-message-messageId-uniqueness' (Asyncapi Message MessageId Uniqueness). Requirement: \"messageId\" must be unique across all the messages. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-operation-description":{"title":"Asyncapi Operation Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-operation-description/","source":"builtin","description":"Operation \"description\" must be present and non-empty string.","message":"Operation \"description\" must be present and non-empty string.","severity":"info","given":"$.channels[*][publish,subscribe]","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:channels","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-operation-description' (Asyncapi Operation Description). Requirement: Operation \"description\" must be present and non-empty string. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.channels[*][publish,subscribe]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-operation-operationId":{"title":"Asyncapi Operation OperationId","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-operation-operationId/","source":"builtin","description":"Operation must have \"operationId\".","message":"Operation must have \"operationId\".","severity":"info","given":"$.channels[*][publish,subscribe]","then":{"field":"operationId","function":"truthy"},"tags":["format:asyncapi","spec:channels","experience:consistency","experience:usability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-operation-operationId' (Asyncapi Operation OperationId). Requirement: Operation must have \"operationId\". To fix: Ensure `operationId` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.channels[*][publish,subscribe]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-operation-operationId-uniqueness":{"title":"Asyncapi Operation OperationId Uniqueness","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-operation-operationId-uniqueness/","source":"builtin","description":"\"operationId\" must be unique across all the operations.","message":"\"operationId\" must be unique across all the operations.","severity":"info","given":"$","then":{"function":"asyncApi2OperationIdUniqueness"},"tags":["format:asyncapi","spec:document","experience:consistency","experience:naming","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-operation-operationId-uniqueness' (Asyncapi Operation OperationId Uniqueness). Requirement: \"operationId\" must be unique across all the operations. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-operation-security":{"title":"Asyncapi Operation Security","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-operation-security/","source":"builtin","description":"Operation have to reference a defined security schemes.","message":"{{error}}","severity":"info","given":"$.channels[*][publish,subscribe].security.*","then":{"function":"asyncApiSecurity","functionOptions":{"objectType":"Operation"}},"tags":["format:asyncapi","spec:channels","experience:security","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-operation-security' (Asyncapi Operation Security). Requirement: Operation have to reference a defined security schemes. This rule is evaluated at the JSONPath `$.channels[*][publish,subscribe].security.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-parameter-description":{"title":"Asyncapi Parameter Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-parameter-description/","source":"builtin","description":"Parameter objects must have \"description\".","message":"Parameter objects must have \"description\".","severity":"info","given":["$.components.parameters.*","$.channels.*.parameters.*"],"then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:channels","spec:components","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-parameter-description' (Asyncapi Parameter Description). Requirement: Parameter objects must have \"description\". To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.parameters.* | $.channels.*.parameters.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-payload":{"title":"Asyncapi Payload","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-payload/","source":"builtin","description":"Payloads must be valid against AsyncAPI Schema object.","message":"{{error}}","severity":"info","given":["$.components.messageTraits[?(@.schemaFormat === void 0)].payload","$.components.messages[?(@.schemaFormat === void 0)].payload","$.channels[*][publish,subscribe][?(@property === 'message' && @.schemaFormat === void 0)].payload"],"then":{"function":"asyncApiPayloadValidation"},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-payload' (Asyncapi Payload). Requirement: Payloads must be valid against AsyncAPI Schema object. This rule is evaluated at the JSONPath `$.components.messageTraits[?(@.schemaFormat === void 0)].payload | $.components.messages[?(@.schemaFormat === void 0)].payload | $.channels[*][publish,subscribe][?(@property === 'message' && @.schemaFormat === void 0)].payload` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-payload-default":{"title":"Asyncapi Payload Default","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-payload-default/","source":"builtin","description":"Default must be valid against its defined schema.","message":"{{error}}","severity":"info","given":["$.components.messageTraits[?(@.schemaFormat === void 0)].payload.default^","$.components.messages[?(@.schemaFormat === void 0)].payload.default^","$.channels[*][publish,subscribe][?(@property === 'message' && @.schemaFormat === void 0)].payload.default^"],"then":{"function":"asyncApiSchemaValidation","functionOptions":{"type":"default"}},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-payload-default' (Asyncapi Payload Default). Requirement: Default must be valid against its defined schema. This rule is evaluated at the JSONPath `$.components.messageTraits[?(@.schemaFormat === void 0)].payload.default^ | $.components.messages[?(@.schemaFormat === void 0)].payload.default^ | $.channels[*][publish,subscribe][?(@property === 'message' && @.schemaFormat === void 0)].payload.default^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-payload-examples":{"title":"Asyncapi Payload Examples","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-payload-examples/","source":"builtin","description":"Examples must be valid against their defined schema.","message":"{{error}}","severity":"info","given":["$.components.messageTraits[?(@.schemaFormat === void 0)].payload.examples^","$.components.messages[?(@.schemaFormat === void 0)].payload.examples^","$.channels[*][publish,subscribe][?(@property === 'message' && @.schemaFormat === void 0)].payload.examples^"],"then":{"function":"asyncApiSchemaValidation","functionOptions":{"type":"examples"}},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","spec:schemas","experience:data-modeling","experience:documentation","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-payload-examples' (Asyncapi Payload Examples). Requirement: Examples must be valid against their defined schema. This rule is evaluated at the JSONPath `$.components.messageTraits[?(@.schemaFormat === void 0)].payload.examples^ | $.components.messages[?(@.schemaFormat === void 0)].payload.examples^ | $.channels[*][publish,subscribe][?(@property === 'message' && @.schemaFormat === void 0)].payload.examples^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-payload-unsupported-schemaFormat":{"title":"Asyncapi Payload Unsupported SchemaFormat","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-payload-unsupported-schemaFormat/","source":"builtin","description":"Message schema validation is only supported with default unspecified \"schemaFormat\".","message":"Message schema validation is only supported with default unspecified \"schemaFormat\".","severity":"info","given":["$.components.messageTraits.*","$.components.messages.*","$.channels[*][publish,subscribe].message"],"then":{"field":"schemaFormat","function":"undefined"},"tags":["format:asyncapi","spec:channels","spec:messages","spec:components","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-payload-unsupported-schemaFormat' (Asyncapi Payload Unsupported SchemaFormat). Requirement: Message schema validation is only supported with default unspecified \"schemaFormat\". To fix: Remove `schemaFormat` from each matching location. This rule is evaluated at the JSONPath `$.components.messageTraits.* | $.components.messages.* | $.channels[*][publish,subscribe].message` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-schema":{"title":"Asyncapi Schema","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-schema/","source":"builtin","description":"Validate structure of AsyncAPI specification.","message":"{{error}}","severity":"info","given":"$","then":{"function":"","functionOptions":{"resolved":true}},"tags":["format:asyncapi","spec:document","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-schema' (Asyncapi Schema). Requirement: Validate structure of AsyncAPI specification. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-schema-default":{"title":"Asyncapi Schema Default","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-schema-default/","source":"builtin","description":"Default must be valid against its defined schema.","message":"{{error}}","severity":"info","given":["$.components.schemas.*.default^","$.components.parameters.*.schema.default^","$.channels.*.parameters.*.schema.default^"],"then":{"function":"asyncApiSchemaValidation","functionOptions":{"type":"default"}},"tags":["format:asyncapi","spec:channels","spec:components","spec:schemas","experience:data-modeling","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-schema-default' (Asyncapi Schema Default). Requirement: Default must be valid against its defined schema. This rule is evaluated at the JSONPath `$.components.schemas.*.default^ | $.components.parameters.*.schema.default^ | $.channels.*.parameters.*.schema.default^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-schema-examples":{"title":"Asyncapi Schema Examples","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-schema-examples/","source":"builtin","description":"Examples must be valid against their defined schema.","message":"{{error}}","severity":"info","given":["$.components.schemas.*.examples^","$.components.parameters.*.schema.examples^","$.channels.*.parameters.*.schema.examples^"],"then":{"function":"asyncApiSchemaValidation","functionOptions":{"type":"examples"}},"tags":["format:asyncapi","spec:channels","spec:components","spec:schemas","experience:data-modeling","experience:documentation","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-schema-examples' (Asyncapi Schema Examples). Requirement: Examples must be valid against their defined schema. This rule is evaluated at the JSONPath `$.components.schemas.*.examples^ | $.components.parameters.*.schema.examples^ | $.channels.*.parameters.*.schema.examples^` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-server-no-empty-variable":{"title":"Asyncapi Server No Empty Variable","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-server-no-empty-variable/","source":"builtin","description":"Server URL must not have empty variable substitution pattern.","message":"Server URL must not have empty variable substitution pattern.","severity":"info","given":"$.servers[*].url","then":{"function":"pattern","functionOptions":{"notMatch":"{}"}},"tags":["format:asyncapi","spec:servers","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-server-no-empty-variable' (Asyncapi Server No Empty Variable). Requirement: Server URL must not have empty variable substitution pattern. To fix: Ensure the targeted value does NOT match the regular expression `{}`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers[*].url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-server-no-trailing-slash":{"title":"Asyncapi Server No Trailing Slash","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-server-no-trailing-slash/","source":"builtin","description":"Server URL must not end with slash.","message":"Server URL must not end with slash.","severity":"info","given":"$.servers[*].url","then":{"function":"pattern","functionOptions":{"notMatch":"/$"}},"tags":["format:asyncapi","spec:servers","experience:consistency","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-server-no-trailing-slash' (Asyncapi Server No Trailing Slash). Requirement: Server URL must not end with slash. To fix: Ensure the targeted value does NOT match the regular expression `/$`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers[*].url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-server-not-example-com":{"title":"Asyncapi Server Not Example Com","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-server-not-example-com/","source":"builtin","description":"Server URL must not point at example.com.","message":"Server URL must not point at example.com.","severity":"info","given":"$.servers[*].url","then":{"function":"pattern","functionOptions":{"notMatch":"example\\.com"}},"tags":["format:asyncapi","spec:servers","experience:reliability","experience:usability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-server-not-example-com' (Asyncapi Server Not Example Com). Requirement: Server URL must not point at example.com. To fix: Ensure the targeted value does NOT match the regular expression `example\\.com`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.servers[*].url` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-server-security":{"title":"Asyncapi Server Security","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-server-security/","source":"builtin","description":"Server have to reference a defined security schemes.","message":"{{error}}","severity":"info","given":"$.servers.*.security.*","then":{"function":"asyncApiSecurity","functionOptions":{"objectType":"Server"}},"tags":["format:asyncapi","spec:servers","experience:security","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-server-security' (Asyncapi Server Security). Requirement: Server have to reference a defined security schemes. This rule is evaluated at the JSONPath `$.servers.*.security.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-server-variables":{"title":"Asyncapi Server Variables","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-server-variables/","source":"builtin","description":"Server variables must be defined and there must be no redundant variables.","message":"{{error}}","severity":"info","given":["$.servers.*","$.components.servers.*"],"then":{"function":"serverVariables"},"tags":["format:asyncapi","spec:servers","spec:components","experience:reliability","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-server-variables' (Asyncapi Server Variables). Requirement: Server variables must be defined and there must be no redundant variables. This rule is evaluated at the JSONPath `$.servers.* | $.components.servers.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-servers":{"title":"Asyncapi Servers","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-servers/","source":"builtin","description":"AsyncAPI object must have non-empty \"servers\" object.","message":"AsyncAPI object must have non-empty \"servers\" object.","severity":"info","given":"$","then":{"field":"servers","function":"schema","functionOptions":{"schema":{"type":"object","minProperties":1},"allErrors":true}},"tags":["format:asyncapi","spec:document","experience:usability","experience:reliability","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-servers' (Asyncapi Servers). Requirement: AsyncAPI object must have non-empty \"servers\" object. To fix: Adjust `servers` so it conforms to the schema this rule requires. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-tag-description":{"title":"Asyncapi Tag Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-tag-description/","source":"builtin","description":"Tag object must have \"description\".","message":"Tag object must have \"description\".","severity":"info","given":"$.tags[*]","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:tags","experience:documentation","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-tag-description' (Asyncapi Tag Description). Requirement: Tag object must have \"description\". To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.tags[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-tags":{"title":"Asyncapi Tags","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-tags/","source":"builtin","description":"AsyncAPI object must have non-empty \"tags\" array.","message":"AsyncAPI object must have non-empty \"tags\" array.","severity":"info","given":"$","then":{"field":"tags","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:discoverability","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-tags' (Asyncapi Tags). Requirement: AsyncAPI object must have non-empty \"tags\" array. To fix: Ensure `tags` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-tags-alphabetical":{"title":"Asyncapi Tags Alphabetical","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-tags-alphabetical/","source":"builtin","description":"AsyncAPI object must have alphabetical \"tags\".","message":"AsyncAPI object must have alphabetical \"tags\".","severity":"info","given":"$","then":{"field":"tags","function":"alphabetical","functionOptions":{"keyedBy":"name"}},"tags":["format:asyncapi","spec:document","experience:consistency","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-tags-alphabetical' (Asyncapi Tags Alphabetical). Requirement: AsyncAPI object must have alphabetical \"tags\". To fix: Sort the entries by `name` into ascending alphabetical order. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-tags-uniqueness":{"title":"Asyncapi Tags Uniqueness","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-tags-uniqueness/","source":"builtin","description":"Each tag must have a unique name.","message":"{{error}}","severity":"info","given":["$.tags","$.servers.*.tags","$.components.servers.*.tags","$.channels.*.[publish,subscribe].tags","$.components.channels.*.[publish,subscribe].tags","$.channels.*.[publish,subscribe].traits.*.tags","$.components.channels.*.[publish,subscribe].traits.*.tags","$.components.operationTraits.*.tags","$.channels.*.[publish,subscribe].message.tags","$.channels.*.[publish,subscribe].message.oneOf.*.tags","$.components.channels.*.[publish,subscribe].message.tags","$.components.channels.*.[publish,subscribe].message.oneOf.*.tags","$.components.messages.*.tags","$.channels.*.[publish,subscribe].message.traits.*.tags","$.channels.*.[publish,subscribe].message.oneOf.*.traits.*.tags","$.components.channels.*.[publish,subscribe].message.traits.*.tags","$.components.channels.*.[publish,subscribe].message.oneOf.*.traits.*.tags","$.components.messages.*.traits.*.tags","$.components.messageTraits.*.tags"],"then":{"function":"uniquenessTags"},"tags":["format:asyncapi","spec:servers","spec:channels","spec:messages","spec:components","experience:consistency","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-tags-uniqueness' (Asyncapi Tags Uniqueness). Requirement: Each tag must have a unique name. This rule is evaluated at the JSONPath `$.tags | $.servers.*.tags | $.components.servers.*.tags | $.channels.*.[publish,subscribe].tags | $.components.channels.*.[publish,subscribe].tags | $.channels.*.[publish,subscribe].traits.*.tags | $.components.channels.*.[publish,subscribe].traits.*.tags | $.components.operationTraits.*.tags | $.channels.*.[publish,subscribe].message.tags | $.channels.*.[publish,subscribe].message.oneOf.*.tags | $.components.channels.*.[publish,subscribe].message.tags | $.components.channels.*.[publish,subscribe].message.oneOf.*.tags | $.components.messages.*.tags | $.channels.*.[publish,subscribe].message.traits.*.tags | $.channels.*.[publish,subscribe].message.oneOf.*.traits.*.tags | $.components.channels.*.[publish,subscribe].message.traits.*.tags | $.components.channels.*.[publish,subscribe].message.oneOf.*.traits.*.tags | $.components.messages.*.traits.*.tags | $.components.messageTraits.*.tags` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-unused-components-schema":{"title":"Asyncapi Unused Components Schema","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-unused-components-schema/","source":"builtin","description":"Potentially unused components schema has been detected.","message":"Potentially unused components schema has been detected.","severity":"info","given":"$.components.schemas","then":{"function":"unreferencedReusableObject","functionOptions":{"reusableObjectsLocation":"#/components/schemas"}},"tags":["format:asyncapi","spec:components","spec:schemas","experience:consistency","experience:data-modeling"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-unused-components-schema' (Asyncapi Unused Components Schema). Requirement: Potentially unused components schema has been detected. To fix: Remove the unreferenced reusable object, or reference it where it is needed. This rule is evaluated at the JSONPath `$.components.schemas` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"asyncapi-unused-components-server":{"title":"Asyncapi Unused Components Server","reference":"https://spotlight-rules.com/spec/rules/asyncapi/asyncapi-unused-components-server/","source":"builtin","description":"Potentially unused components server has been detected.","message":"Potentially unused components server has been detected.","severity":"info","given":"$.components.servers","then":{"function":"unreferencedReusableObject","functionOptions":{"reusableObjectsLocation":"#/components/servers"}},"tags":["format:asyncapi","spec:servers","spec:components","experience:consistency","experience:reliability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'asyncapi-unused-components-server' (Asyncapi Unused Components Server). Requirement: Potentially unused components server has been detected. To fix: Remove the unreferenced reusable object, or reference it where it is needed. This rule is evaluated at the JSONPath `$.components.servers` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"channel-asyncapi-require-description":{"title":"Channel Asyncapi Require Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/channel-asyncapi-require-description/","source":"spotlight","description":"Channels should have a description of the messages they carry.","message":"Channel should have a description.","given":"$.channels[*]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:channels","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'channel-asyncapi-require-description' (Channel Asyncapi Require Description). Requirement: Channels should have a description of the messages they carry. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.channels[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"component-asyncapi-message-require-contenttype":{"title":"Component Asyncapi Message Require Contenttype","reference":"https://spotlight-rules.com/spec/rules/asyncapi/component-asyncapi-message-require-contenttype/","source":"spotlight","description":"Messages should declare a contentType (e.g. application/json).","message":"Message should declare a contentType.","given":"$.components.messages[*]","severity":"info","then":{"field":"contentType","function":"truthy"},"tags":["format:asyncapi","spec:components","experience:consistency","experience:data-modeling"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'component-asyncapi-message-require-contenttype' (Component Asyncapi Message Require Contenttype). Requirement: Messages should declare a contentType (e.g. application/json). To fix: Ensure `contentType` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"component-asyncapi-message-require-correlation-id":{"title":"Component Asyncapi Message Require Correlation ID","reference":"https://spotlight-rules.com/spec/rules/asyncapi/component-asyncapi-message-require-correlation-id/","source":"spotlight","description":"Messages should define a correlationId so events can be traced across services.","message":"Message should define a correlationId.","given":"$.components.messages[*]","severity":"info","then":{"field":"correlationId","function":"truthy"},"tags":["format:asyncapi","spec:components","topic:tracing","experience:reliability","experience:observability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'component-asyncapi-message-require-correlation-id' (Component Asyncapi Message Require Correlation ID). Requirement: Messages should define a correlationId so events can be traced across services. To fix: Ensure `correlationId` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"component-asyncapi-message-require-name":{"title":"Component Asyncapi Message Require Name","reference":"https://spotlight-rules.com/spec/rules/asyncapi/component-asyncapi-message-require-name/","source":"spotlight","description":"Messages should declare a name.","message":"Message should declare a name.","given":"$.components.messages[*]","severity":"info","then":{"field":"name","function":"truthy"},"tags":["format:asyncapi","spec:components","experience:documentation","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'component-asyncapi-message-require-name' (Component Asyncapi Message Require Name). Requirement: Messages should declare a name. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"component-asyncapi-message-require-payload":{"title":"Component Asyncapi Message Require Payload","reference":"https://spotlight-rules.com/spec/rules/asyncapi/component-asyncapi-message-require-payload/","source":"spotlight","description":"Messages should define a payload schema.","message":"Message should define a payload.","given":"$.components.messages[*]","severity":"info","then":{"field":"payload","function":"truthy"},"tags":["format:asyncapi","spec:components","experience:data-modeling"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'component-asyncapi-message-require-payload' (Component Asyncapi Message Require Payload). Requirement: Messages should define a payload schema. To fix: Ensure `payload` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"component-asyncapi-message-require-title":{"title":"Component Asyncapi Message Require Title","reference":"https://spotlight-rules.com/spec/rules/asyncapi/component-asyncapi-message-require-title/","source":"spotlight","description":"Messages should declare a human-readable title.","message":"Message should declare a title.","given":"$.components.messages[*]","severity":"info","then":{"field":"title","function":"truthy"},"tags":["format:asyncapi","spec:components","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'component-asyncapi-message-require-title' (Component Asyncapi Message Require Title). Requirement: Messages should declare a human-readable title. To fix: Ensure `title` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.messages[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-asyncapi":{"title":"Document Require Asyncapi","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-asyncapi/","source":"spotlight","description":"asyncapi document should declare a `asyncapi` property.","message":"Missing `asyncapi`.","given":"$","severity":"info","then":{"field":"asyncapi","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-asyncapi' (Document Require Asyncapi). Requirement: asyncapi document should declare a `asyncapi` property. To fix: Ensure `asyncapi` is present and non-empty at each matching location. Guidance: Missing `asyncapi`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-channel":{"title":"Document Require Channel","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-channel/","source":"spotlight","description":"asyncapi document should declare a `channels` property.","message":"Missing `channels`.","given":"$","severity":"info","then":{"field":"channels","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-channel' (Document Require Channel). Requirement: asyncapi document should declare a `channels` property. To fix: Ensure `channels` is present and non-empty at each matching location. Guidance: Missing `channels`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-component":{"title":"Document Require Component","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-component/","source":"spotlight","description":"asyncapi document should declare a `components` property.","message":"Missing `components`.","given":"$","severity":"info","then":{"field":"components","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-component' (Document Require Component). Requirement: asyncapi document should declare a `components` property. To fix: Ensure `components` is present and non-empty at each matching location. Guidance: Missing `components`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-defaultcontenttype":{"title":"Document Require Defaultcontenttype","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-defaultcontenttype/","source":"spotlight","description":"asyncapi document should declare a `defaultContentType` property.","message":"Missing `defaultContentType`.","given":"$","severity":"info","then":{"field":"defaultContentType","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-defaultcontenttype' (Document Require Defaultcontenttype). Requirement: asyncapi document should declare a `defaultContentType` property. To fix: Ensure `defaultContentType` is present and non-empty at each matching location. Guidance: Missing `defaultContentType`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-id":{"title":"Document Require ID","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-id/","source":"spotlight","description":"asyncapi document should declare a `id` property.","message":"Missing `id`.","given":"$","severity":"info","then":{"field":"id","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-id' (Document Require ID). Requirement: asyncapi document should declare a `id` property. To fix: Ensure `id` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-info":{"title":"Document Require Info","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-info/","source":"spotlight","description":"asyncapi document should declare a `info` property.","message":"Missing `info`.","given":"$","severity":"info","then":{"field":"info","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-info' (Document Require Info). Requirement: asyncapi document should declare a `info` property. To fix: Ensure `info` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-operation":{"title":"Document Require Operation","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-operation/","source":"spotlight","description":"asyncapi document should declare a `operations` property.","message":"Missing `operations`.","given":"$","severity":"info","then":{"field":"operations","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-operation' (Document Require Operation). Requirement: asyncapi document should declare a `operations` property. To fix: Ensure `operations` is present and non-empty at each matching location. Guidance: Missing `operations`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"document-require-server":{"title":"Document Require Server","reference":"https://spotlight-rules.com/spec/rules/asyncapi/document-require-server/","source":"spotlight","description":"asyncapi document should declare a `servers` property.","message":"Missing `servers`.","given":"$","severity":"info","then":{"field":"servers","function":"truthy"},"tags":["format:asyncapi","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'document-require-server' (Document Require Server). Requirement: asyncapi document should declare a `servers` property. To fix: Ensure `servers` is present and non-empty at each matching location. Guidance: Missing `servers`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"info-asyncapi-require-title":{"title":"Info Asyncapi Require Title","reference":"https://spotlight-rules.com/spec/rules/asyncapi/info-asyncapi-require-title/","source":"spotlight","description":"The API should declare an info.title.","message":"AsyncAPI info should have a title.","given":"$.info","severity":"info","then":{"field":"title","function":"truthy"},"tags":["format:asyncapi","spec:info","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'info-asyncapi-require-title' (Info Asyncapi Require Title). Requirement: The API should declare an info.title. To fix: Ensure `title` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"info-asyncapi-version-semver":{"title":"Info Asyncapi Version Semver","reference":"https://spotlight-rules.com/spec/rules/asyncapi/info-asyncapi-version-semver/","source":"spotlight","description":"info.version should be semantic (e.g. 1.0.0).","message":"AsyncAPI version should be semantic.","given":"$.info.version","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^\\d+\\.\\d+\\.\\d+"}},"tags":["format:asyncapi","spec:info","experience:versioning"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'info-asyncapi-version-semver' (Info Asyncapi Version Semver). Requirement: info.version should be semantic (e.g. 1.0.0). To fix: Ensure the targeted value matches the regular expression `^\\d+\\.\\d+\\.\\d+`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.info.version` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"operation-asyncapi-require-summary":{"title":"Operation Asyncapi Require Summary","reference":"https://spotlight-rules.com/spec/rules/asyncapi/operation-asyncapi-require-summary/","source":"spotlight","description":"Operations should have a short summary.","message":"Operation should have a summary.","given":"$.operations[*]","severity":"info","then":{"field":"summary","function":"truthy"},"tags":["format:asyncapi","spec:operations","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'operation-asyncapi-require-summary' (Operation Asyncapi Require Summary). Requirement: Operations should have a short summary. To fix: Ensure `summary` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.operations[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"operation-asyncapi-require-tag":{"title":"Operation Asyncapi Require Tag","reference":"https://spotlight-rules.com/spec/rules/asyncapi/operation-asyncapi-require-tag/","source":"spotlight","description":"Operations should declare tags for grouping.","message":"Operation should declare tags.","given":"$.operations[*]","severity":"info","then":{"field":"tags","function":"truthy"},"tags":["format:asyncapi","spec:operations","experience:documentation","experience:discoverability"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'operation-asyncapi-require-tag' (Operation Asyncapi Require Tag). Requirement: Operations should declare tags for grouping. To fix: Ensure `tags` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.operations[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"schema-asyncapi-property-camel-case":{"title":"Schema Asyncapi Property Camel Case","reference":"https://spotlight-rules.com/spec/rules/asyncapi/schema-asyncapi-property-camel-case/","source":"spotlight","description":"Schema property names should be camelCase.","message":"Schema property is not camelCase.","given":"$.components.schemas[*].properties[*]~","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-zA-Z0-9]*$"}},"tags":["format:asyncapi","spec:components","experience:naming","experience:consistency"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'schema-asyncapi-property-camel-case' (Schema Asyncapi Property Camel Case). Requirement: Schema property names should be camelCase. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.components.schemas[*].properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"schema-asyncapi-property-require-description":{"title":"Schema Asyncapi Property Require Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/schema-asyncapi-property-require-description/","source":"spotlight","description":"Schema properties should be documented with a description.","message":"Schema property should have a description.","given":"$.components.schemas[*].properties[*]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:components","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'schema-asyncapi-property-require-description' (Schema Asyncapi Property Require Description). Requirement: Schema properties should be documented with a description. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.components.schemas[*].properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."},"server-asyncapi-require-description":{"title":"Server Asyncapi Require Description","reference":"https://spotlight-rules.com/spec/rules/asyncapi/server-asyncapi-require-description/","source":"spotlight","description":"Servers should have a description identifying the environment/broker.","message":"Server should have a description.","given":"$.servers[*]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:asyncapi","spec:servers","experience:documentation"],"prompt":"You are editing an AsyncAPI document to satisfy the Spotlight API governance rule 'server-asyncapi-require-description' (Server Asyncapi Require Description). Requirement: Servers should have a description identifying the environment/broker. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.servers[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid AsyncAPI. Return only the complete corrected document, with no commentary."}},"arazzo":{"arazzo-document-schema":{"title":"Arazzo Document Schema","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-document-schema/","source":"builtin","description":"Arazzo Document must be valid against the Arazzo schema.","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoDocumentSchema"},"tags":["format:arazzo","spec:document","experience:data-modeling","experience:reliability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-document-schema' (Arazzo Document Schema). Requirement: Arazzo Document must be valid against the Arazzo schema. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-info-description":{"title":"Arazzo Info Description","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-info-description/","source":"builtin","description":"Info \"description\" should be present and non-empty string.","message":"Info \"description\" should be present and non-empty string.","severity":"info","given":"$","then":{"field":"info.description","function":"truthy"},"tags":["format:arazzo","spec:document","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-info-description' (Arazzo Info Description). Requirement: Info \"description\" should be present and non-empty string. To fix: Ensure `info.description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-info-summary":{"title":"Arazzo Info Summary","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-info-summary/","source":"builtin","description":"Info \"summary\" is recommended be present and be a non-empty string.","message":"Info \"summary\" is recommended be present and be a non-empty string.","severity":"info","given":"$","then":{"field":"info.summary","function":"truthy"},"tags":["format:arazzo","spec:document","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-info-summary' (Arazzo Info Summary). Requirement: Info \"summary\" is recommended be present and be a non-empty string. To fix: Ensure `info.summary` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-no-script-tags-in-markdown":{"title":"Arazzo No Script Tags In Markdown","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-no-script-tags-in-markdown/","source":"builtin","description":"Markdown descriptions must not have \"<script>\" tags.","message":"Markdown descriptions must not have \"<script>\" tags.","severity":"info","given":"$..[description,title]","then":{"function":"pattern","functionOptions":{"notMatch":"<script"}},"tags":["format:arazzo","spec:document","experience:security"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-no-script-tags-in-markdown' (Arazzo No Script Tags In Markdown). Requirement: Markdown descriptions must not have \"<script>\" tags. To fix: Ensure the targeted value does NOT match the regular expression `<script`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$..[description,title]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-source-descriptions-type":{"title":"Arazzo Source Descriptions Type","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-source-descriptions-type/","source":"builtin","description":"Source Description \"type\" should be present.","message":"Source Description \"type\" should be present.","severity":"info","given":"$.sourceDescriptions[*]","then":{"field":"type","function":"truthy"},"tags":["format:arazzo","spec:source-descriptions","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-source-descriptions-type' (Arazzo Source Descriptions Type). Requirement: Source Description \"type\" should be present. To fix: Ensure `type` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.sourceDescriptions[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-description":{"title":"Arazzo Step Description","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-description/","source":"builtin","description":"Step \"description\" should be present and non-empty string.","message":"Step \"description\" should be present and non-empty string.","severity":"info","given":"$.workflows[*].steps[*]","then":{"field":"description","function":"truthy"},"tags":["format:arazzo","spec:workflows","spec:steps","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-description' (Arazzo Step Description). Requirement: Step \"description\" should be present and non-empty string. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.workflows[*].steps[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-failure-actions-validation":{"title":"Arazzo Step Failure Actions Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-failure-actions-validation/","source":"builtin","description":"Every failure action must have a unique \"name\", and the fields \"workflowId\" and \"stepId\" are mutually exclusive.","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoStepFailureActionsValidation"},"tags":["format:arazzo","spec:document","experience:error-handling","experience:reliability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-failure-actions-validation' (Arazzo Step Failure Actions Validation). Requirement: Every failure action must have a unique \"name\", and the fields \"workflowId\" and \"stepId\" are mutually exclusive. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-operationPath":{"title":"Arazzo Step OperationPath","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-operationPath/","source":"builtin","description":"It is recommended to use \"operationId\" rather than \"operationPath\".","message":"It is recommended to use \"operationId\" rather than \"operationPath\".","severity":"info","given":"$.workflows[*].steps[*]","then":{"field":"operationPath","function":"falsy"},"tags":["format:arazzo","spec:workflows","spec:steps","experience:consistency","experience:usability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-operationPath' (Arazzo Step OperationPath). Requirement: It is recommended to use \"operationId\" rather than \"operationPath\". To fix: Ensure `operationPath` is absent or empty (falsy) at each matching location. This rule is evaluated at the JSONPath `$.workflows[*].steps[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-output-validation":{"title":"Arazzo Step Output Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-output-validation/","source":"builtin","description":"Every step output must have unique name and its value must be a valid runtime expression.","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoStepOutputNamesValidation"},"tags":["format:arazzo","spec:document","experience:data-modeling","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-output-validation' (Arazzo Step Output Validation). Requirement: Every step output must have unique name and its value must be a valid runtime expression. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-parameters-validation":{"title":"Arazzo Step Parameters Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-parameters-validation/","source":"builtin","description":"Step parameters and workflow parameters must valid.","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoStepParametersValidation"},"tags":["format:arazzo","spec:document","experience:reliability","experience:data-modeling"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-parameters-validation' (Arazzo Step Parameters Validation). Requirement: Step parameters and workflow parameters must valid. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-request-body-validation":{"title":"Arazzo Step Request Body Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-request-body-validation/","source":"builtin","description":"Every step request body must have a valid `contentType` and use of runtime expressions.","message":"Every step request body must have a valid `contentType` and use of runtime expressions.","severity":"info","given":"$","then":{"function":"arazzoStepRequestBodyValidation"},"tags":["format:arazzo","spec:document","experience:reliability","experience:data-modeling"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-request-body-validation' (Arazzo Step Request Body Validation). Requirement: Every step request body must have a valid `contentType` and use of runtime expressions. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-stepId":{"title":"Arazzo Step StepId","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-stepId/","source":"builtin","description":"Step \"stepId\" should follow the pattern \"^[A-Za-z0-9_\\-]+$\".","message":"Step \"stepId\" should follow the pattern \"^[A-Za-z0-9_\\-]+$\".","severity":"info","given":"$.workflows[*].steps[*]","then":{"field":"stepId","function":"pattern","functionOptions":{"match":"^[A-Za-z0-9_\\-]+$"}},"tags":["format:arazzo","spec:workflows","spec:steps","experience:naming","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-stepId' (Arazzo Step StepId). Requirement: Step \"stepId\" should follow the pattern \"^[A-Za-z0-9_\\-]+$\". To fix: Ensure `stepId` matches the regular expression `^[A-Za-z0-9_\\-]+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.workflows[*].steps[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-success-actions-validation":{"title":"Arazzo Step Success Actions Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-success-actions-validation/","source":"builtin","description":"Every success action must have a unique \"name\", and the fields \"workflowId\" and \"stepId\" are mutually exclusive.","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoStepSuccessActionsValidation"},"tags":["format:arazzo","spec:document","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-success-actions-validation' (Arazzo Step Success Actions Validation). Requirement: Every success action must have a unique \"name\", and the fields \"workflowId\" and \"stepId\" are mutually exclusive. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-success-criteria-validation":{"title":"Arazzo Step Success Criteria Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-success-criteria-validation/","source":"builtin","description":"Every success criteria must have a valid context, conditions, and types.","message":"{{error}}","severity":"info","given":"$.workflows[*]","then":{"function":"arazzoStepSuccessCriteriaValidation"},"tags":["format:arazzo","spec:workflows","experience:reliability","experience:error-handling"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-success-criteria-validation' (Arazzo Step Success Criteria Validation). Requirement: Every success criteria must have a valid context, conditions, and types. This rule is evaluated at the JSONPath `$.workflows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-step-validation":{"title":"Arazzo Step Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-step-validation/","source":"builtin","description":"Every step must have a valid \"stepId\" and an valid \"operationId\" or \"operationPath\" or \"workflowId\".","message":"Every step must have a valid \"stepId\" and an valid \"operationId\" or \"operationPath\" or \"workflowId\".","severity":"info","given":"$","then":{"function":"arazzoStepValidation"},"tags":["format:arazzo","spec:document","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-step-validation' (Arazzo Step Validation). Requirement: Every step must have a valid \"stepId\" and an valid \"operationId\" or \"operationPath\" or \"workflowId\". Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflow-depends-on-validation":{"title":"Arazzo Workflow Depends On Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflow-depends-on-validation/","source":"builtin","description":"Every workflow dependency must be valid.","message":"Every workflow dependency must be valid.","severity":"info","given":"$","then":{"function":"arazzoWorkflowDependsOnValidation"},"tags":["format:arazzo","spec:document","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflow-depends-on-validation' (Arazzo Workflow Depends On Validation). Requirement: Every workflow dependency must be valid. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflow-description":{"title":"Arazzo Workflow Description","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflow-description/","source":"builtin","description":"Workflow \"description\" should be present and non-empty string.","message":"Workflow \"description\" should be present and non-empty string.","severity":"info","given":"$.workflows[*]","then":{"field":"description","function":"truthy"},"tags":["format:arazzo","spec:workflows","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflow-description' (Arazzo Workflow Description). Requirement: Workflow \"description\" should be present and non-empty string. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.workflows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflow-output-validation":{"title":"Arazzo Workflow Output Validation","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflow-output-validation/","source":"builtin","description":"Every workflow output must have unique name and its value must be a valid runtime expression.","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoWorkflowOutputNamesValidation"},"tags":["format:arazzo","spec:document","experience:data-modeling","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflow-output-validation' (Arazzo Workflow Output Validation). Requirement: Every workflow output must have unique name and its value must be a valid runtime expression. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflow-stepId-unique":{"title":"Arazzo Workflow StepId Unique","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflow-stepId-unique/","source":"builtin","description":"Every step must have unique \"stepId\".","message":"{{error}}","severity":"info","given":"$.workflows[*]","then":{"function":"arazzoStepIdUniqueness"},"tags":["format:arazzo","spec:workflows","experience:consistency","experience:naming","experience:reliability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflow-stepId-unique' (Arazzo Workflow StepId Unique). Requirement: Every step must have unique \"stepId\". This rule is evaluated at the JSONPath `$.workflows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflow-summary":{"title":"Arazzo Workflow Summary","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflow-summary/","source":"builtin","description":"Workflow \"summary\" should be present and non-empty string.","message":"Workflow \"summary\" should be present and non-empty string.","severity":"info","given":"$.workflows[*]","then":{"field":"summary","function":"truthy"},"tags":["format:arazzo","spec:workflows","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflow-summary' (Arazzo Workflow Summary). Requirement: Workflow \"summary\" should be present and non-empty string. To fix: Ensure `summary` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.workflows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflow-workflowId":{"title":"Arazzo Workflow WorkflowId","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflow-workflowId/","source":"builtin","description":"Workflow \"workflowId\" should follow the pattern \"^[A-Za-z0-9_\\-]+$\".","message":"Workflow \"workflowId\" should follow the pattern \"^[A-Za-z0-9_\\-]+$\".","severity":"info","given":"$.workflows[*]","then":{"field":"workflowId","function":"pattern","functionOptions":{"match":"^[A-Za-z0-9_\\-]+$"}},"tags":["format:arazzo","spec:workflows","experience:naming","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflow-workflowId' (Arazzo Workflow WorkflowId). Requirement: Workflow \"workflowId\" should follow the pattern \"^[A-Za-z0-9_\\-]+$\". To fix: Ensure `workflowId` matches the regular expression `^[A-Za-z0-9_\\-]+$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.workflows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"arazzo-workflowId-unique":{"title":"Arazzo WorkflowId Unique","reference":"https://spotlight-rules.com/spec/rules/arazzo/arazzo-workflowId-unique/","source":"builtin","description":"Every workflow must have unique \"workflowId\".","message":"{{error}}","severity":"info","given":"$","then":{"function":"arazzoWorkflowIdUniqueness"},"tags":["format:arazzo","spec:document","experience:consistency","experience:naming","experience:reliability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'arazzo-workflowId-unique' (Arazzo WorkflowId Unique). Requirement: Every workflow must have unique \"workflowId\". Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"document-require-arazzo":{"title":"Document Require Arazzo","reference":"https://spotlight-rules.com/spec/rules/arazzo/document-require-arazzo/","source":"spotlight","description":"arazzo document should declare a `arazzo` property.","message":"Missing `arazzo`.","given":"$","severity":"info","then":{"field":"arazzo","function":"truthy"},"tags":["format:arazzo","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'document-require-arazzo' (Document Require Arazzo). Requirement: arazzo document should declare a `arazzo` property. To fix: Ensure `arazzo` is present and non-empty at each matching location. Guidance: Missing `arazzo`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"document-require-component":{"title":"Document Require Component","reference":"https://spotlight-rules.com/spec/rules/arazzo/document-require-component/","source":"spotlight","description":"arazzo document should declare a `components` property.","message":"Missing `components`.","given":"$","severity":"info","then":{"field":"components","function":"truthy"},"tags":["format:arazzo","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'document-require-component' (Document Require Component). Requirement: arazzo document should declare a `components` property. To fix: Ensure `components` is present and non-empty at each matching location. Guidance: Missing `components`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"document-require-info":{"title":"Document Require Info","reference":"https://spotlight-rules.com/spec/rules/arazzo/document-require-info/","source":"spotlight","description":"arazzo document should declare a `info` property.","message":"Missing `info`.","given":"$","severity":"info","then":{"field":"info","function":"truthy"},"tags":["format:arazzo","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'document-require-info' (Document Require Info). Requirement: arazzo document should declare a `info` property. To fix: Ensure `info` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"document-require-sourcedescriptions":{"title":"Document Require Sourcedescriptions","reference":"https://spotlight-rules.com/spec/rules/arazzo/document-require-sourcedescriptions/","source":"spotlight","description":"arazzo document should declare a `sourceDescriptions` property.","message":"Missing `sourceDescriptions`.","given":"$","severity":"info","then":{"field":"sourceDescriptions","function":"truthy"},"tags":["format:arazzo","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'document-require-sourcedescriptions' (Document Require Sourcedescriptions). Requirement: arazzo document should declare a `sourceDescriptions` property. To fix: Ensure `sourceDescriptions` is present and non-empty at each matching location. Guidance: Missing `sourceDescriptions`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"document-require-workflow":{"title":"Document Require Workflow","reference":"https://spotlight-rules.com/spec/rules/arazzo/document-require-workflow/","source":"spotlight","description":"arazzo document should declare a `workflows` property.","message":"Missing `workflows`.","given":"$","severity":"info","then":{"field":"workflows","function":"truthy"},"tags":["format:arazzo","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'document-require-workflow' (Document Require Workflow). Requirement: arazzo document should declare a `workflows` property. To fix: Ensure `workflows` is present and non-empty at each matching location. Guidance: Missing `workflows`. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"info-arazzo-require-title":{"title":"Info Arazzo Require Title","reference":"https://spotlight-rules.com/spec/rules/arazzo/info-arazzo-require-title/","source":"spotlight","description":"The Arazzo description should declare an info.title.","message":"Arazzo info should have a title.","given":"$.info","severity":"info","then":{"field":"title","function":"truthy"},"tags":["format:arazzo","spec:info","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'info-arazzo-require-title' (Info Arazzo Require Title). Requirement: The Arazzo description should declare an info.title. To fix: Ensure `title` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.info` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"source-arazzo-description-require-name":{"title":"Source Arazzo Description Require Name","reference":"https://spotlight-rules.com/spec/rules/arazzo/source-arazzo-description-require-name/","source":"spotlight","description":"Each source description should declare a name used to reference it from steps.","message":"Source description should have a name.","given":"$.sourceDescriptions[*]","severity":"info","then":{"field":"name","function":"truthy"},"tags":["format:arazzo","spec:source-descriptions","experience:consistency","experience:documentation"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'source-arazzo-description-require-name' (Source Arazzo Description Require Name). Requirement: Each source description should declare a name used to reference it from steps. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.sourceDescriptions[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"source-arazzo-description-require-url":{"title":"Source Arazzo Description Require URL","reference":"https://spotlight-rules.com/spec/rules/arazzo/source-arazzo-description-require-url/","source":"spotlight","description":"Each source description should declare a url to the referenced OpenAPI/Arazzo document.","message":"Source description should have a url.","given":"$.sourceDescriptions[*]","severity":"info","then":{"field":"url","function":"truthy"},"tags":["format:arazzo","spec:source-descriptions","experience:discoverability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'source-arazzo-description-require-url' (Source Arazzo Description Require URL). Requirement: Each source description should declare a url to the referenced OpenAPI/Arazzo document. To fix: Ensure `url` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.sourceDescriptions[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"workflow-arazzo-require-step":{"title":"Workflow Arazzo Require Step","reference":"https://spotlight-rules.com/spec/rules/arazzo/workflow-arazzo-require-step/","source":"spotlight","description":"A workflow should define at least one step.","message":"Workflow should define at least one step.","given":"$.workflows[*]","severity":"info","then":{"field":"steps","function":"schema","functionOptions":{"schema":{"type":"array","minItems":1}}},"tags":["format:arazzo","spec:workflows","experience:reliability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'workflow-arazzo-require-step' (Workflow Arazzo Require Step). Requirement: A workflow should define at least one step. To fix: Adjust `steps` so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.workflows[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"workflow-arazzo-step-require-operation":{"title":"Workflow Arazzo Step Require Operation","reference":"https://spotlight-rules.com/spec/rules/arazzo/workflow-arazzo-step-require-operation/","source":"spotlight","description":"Each step should reference an operation via operationId, operationPath, or a nested workflowId.","message":"Step should reference an operationId, operationPath, or workflowId.","given":"$.workflows[*].steps[*]","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"object","anyOf":[{"required":["operationId"]},{"required":["operationPath"]},{"required":["workflowId"]}]}}},"tags":["format:arazzo","spec:workflows","experience:reliability","experience:consistency"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'workflow-arazzo-step-require-operation' (Workflow Arazzo Step Require Operation). Requirement: Each step should reference an operation via operationId, operationPath, or a nested workflowId. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.workflows[*].steps[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."},"workflow-arazzo-step-require-success-criteria":{"title":"Workflow Arazzo Step Require Success Criteria","reference":"https://spotlight-rules.com/spec/rules/arazzo/workflow-arazzo-step-require-success-criteria/","source":"spotlight","description":"Steps should declare successCriteria so the workflow can assert each step succeeded.","message":"Step should declare successCriteria.","given":"$.workflows[*].steps[*]","severity":"info","then":{"field":"successCriteria","function":"truthy"},"tags":["format:arazzo","spec:workflows","experience:reliability"],"prompt":"You are editing an Arazzo document to satisfy the Spotlight API governance rule 'workflow-arazzo-step-require-success-criteria' (Workflow Arazzo Step Require Success Criteria). Requirement: Steps should declare successCriteria so the workflow can assert each step succeeded. To fix: Ensure `successCriteria` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.workflows[*].steps[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Arazzo. Return only the complete corrected document, with no commentary."}},"jsonschema":{"document-require-description":{"title":"Document Require Description","reference":"https://spotlight-rules.com/spec/rules/json-schema/document-require-description/","source":"default","description":"The `description` property should be present.","message":"description should be present","severity":"info","given":"$","then":{"field":"description","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:documentation","experience:data-modeling"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'document-require-description' (Document Require Description). Requirement: The `description` property should be present. To fix: Ensure `description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"document-require-id":{"title":"Document Require ID","reference":"https://spotlight-rules.com/spec/rules/json-schema/document-require-id/","source":"default","description":"The `$id` property should be present.","message":"$id should be present","severity":"info","given":"$","then":{"field":"$id","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'document-require-id' (Document Require ID). Requirement: The `$id` property should be present. To fix: Ensure `$id` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"document-require-property":{"title":"Document Require Property","reference":"https://spotlight-rules.com/spec/rules/json-schema/document-require-property/","source":"default","description":"The `properties` property should be present.","message":"properties should be present","severity":"info","given":"$","then":{"field":"properties","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'document-require-property' (Document Require Property). Requirement: The `properties` property should be present. To fix: Ensure `properties` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"document-require-required-list":{"title":"Document Require Required List","reference":"https://spotlight-rules.com/spec/rules/json-schema/document-require-required-list/","source":"default","description":"The `required` property should be present.","message":"required should be present","severity":"info","given":"$","then":{"field":"required","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'document-require-required-list' (Document Require Required List). Requirement: The `required` property should be present. To fix: Ensure `required` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"document-require-title":{"title":"Document Require Title","reference":"https://spotlight-rules.com/spec/rules/json-schema/document-require-title/","source":"default","description":"The `title` property should be present.","message":"title should be present","severity":"info","given":"$","then":{"field":"title","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:documentation","experience:data-modeling"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'document-require-title' (Document Require Title). Requirement: The `title` property should be present. To fix: Ensure `title` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"document-require-type":{"title":"Document Require Type","reference":"https://spotlight-rules.com/spec/rules/json-schema/document-require-type/","source":"default","description":"The `type` property should be present.","message":"type should be present","severity":"info","given":"$","then":{"field":"type","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'document-require-type' (Document Require Type). Requirement: The `type` property should be present. To fix: Ensure `type` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"schema-property-require-description":{"title":"Schema Property Require Description","reference":"https://spotlight-rules.com/spec/rules/json-schema/schema-property-require-description/","source":"default","description":"The `description` property of each property should be present.","message":"description should be present","severity":"info","given":"$.properties[*]","then":{"field":"description","function":"truthy"},"tags":["format:jsonschema","spec:properties","experience:documentation","experience:data-modeling"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'schema-property-require-description' (Schema Property Require Description). Requirement: The `description` property of each property should be present. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"schema-property-require-type":{"title":"Schema Property Require Type","reference":"https://spotlight-rules.com/spec/rules/json-schema/schema-property-require-type/","source":"default","description":"The `type` property of each property should be present.","message":"type should be present","severity":"info","given":"$.properties[*]","then":{"field":"type","function":"truthy"},"tags":["format:jsonschema","spec:properties","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'schema-property-require-type' (Schema Property Require Type). Requirement: The `type` property of each property should be present. To fix: Ensure `type` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."},"schema-require":{"title":"Schema Require","reference":"https://spotlight-rules.com/spec/rules/json-schema/schema-require/","source":"default","description":"The `$schema` property should be present.","message":"$schema should be present","severity":"info","given":"$","then":{"field":"$schema","function":"truthy"},"tags":["format:jsonschema","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Schema document to satisfy the Spotlight API governance rule 'schema-require' (Schema Require). Requirement: The `$schema` property should be present. To fix: Ensure `$schema` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Schema. Return only the complete corrected document, with no commentary."}},"json-structure":{"document-json-structure-id-uri":{"title":"Document JSON Structure ID URI","reference":"https://spotlight-rules.com/spec/rules/json-structure/document-json-structure-id-uri/","source":"spotlight","description":"$id should be a stable absolute URI (https:// or urn:) identifying the schema.","message":"$id should be an absolute URI.","given":"$.$id","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https?://|^urn:"}},"tags":["format:json-structure","spec:document","experience:consistency","experience:discoverability"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'document-json-structure-id-uri' (Document JSON Structure ID URI). Requirement: $id should be a stable absolute URI (https:// or urn:) identifying the schema. To fix: Ensure the targeted value matches the regular expression `^https?://|^urn:`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.$id` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"document-require-id":{"title":"Document Require ID","reference":"https://spotlight-rules.com/spec/rules/json-structure/document-require-id/","source":"default","description":"The `$id` property should be present.","message":"$id should be present","severity":"info","given":"$","then":{"field":"$id","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'document-require-id' (Document Require ID). Requirement: The `$id` property should be present. To fix: Ensure `$id` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"document-require-name":{"title":"Document Require Name","reference":"https://spotlight-rules.com/spec/rules/json-structure/document-require-name/","source":"default","description":"The `name` property should be present.","message":"name should be present","severity":"info","given":"$","then":{"field":"name","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'document-require-name' (Document Require Name). Requirement: The `name` property should be present. To fix: Ensure `name` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"document-require-property":{"title":"Document Require Property","reference":"https://spotlight-rules.com/spec/rules/json-structure/document-require-property/","source":"default","description":"The `properties` property should be present.","message":"properties should be present","severity":"info","given":"$","then":{"field":"properties","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'document-require-property' (Document Require Property). Requirement: The `properties` property should be present. To fix: Ensure `properties` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"document-require-type":{"title":"Document Require Type","reference":"https://spotlight-rules.com/spec/rules/json-structure/document-require-type/","source":"default","description":"The `type` property should be present.","message":"type should be present","severity":"info","given":"$","then":{"field":"type","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'document-require-type' (Document Require Type). Requirement: The `type` property should be present. To fix: Ensure `type` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-json-structure-property-camel-case":{"title":"Schema JSON Structure Property Camel Case","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-json-structure-property-camel-case/","source":"spotlight","description":"Property names should be camelCase.","message":"Property is not camelCase.","given":"$.properties[*]~","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^[a-z][a-zA-Z0-9]*$"}},"tags":["format:json-structure","spec:schemas","experience:naming","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-json-structure-property-camel-case' (Schema JSON Structure Property Camel Case). Requirement: Property names should be camelCase. To fix: Ensure the targeted value matches the regular expression `^[a-z][a-zA-Z0-9]*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.properties[*]~` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-json-structure-property-require-description":{"title":"Schema JSON Structure Property Require Description","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-json-structure-property-require-description/","source":"spotlight","description":"Properties should be documented with a description.","message":"Property should have a description.","given":"$.properties[*]","severity":"info","then":{"field":"description","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:documentation"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-json-structure-property-require-description' (Schema JSON Structure Property Require Description). Requirement: Properties should be documented with a description. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-json-structure-property-require-type":{"title":"Schema JSON Structure Property Require Type","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-json-structure-property-require-type/","source":"spotlight","description":"Properties should declare a type.","message":"Property should declare a type.","given":"$.properties[*]","severity":"info","then":{"field":"type","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:data-modeling"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-json-structure-property-require-type' (Schema JSON Structure Property Require Type). Requirement: Properties should declare a type. To fix: Ensure `type` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-json-structure-root-type-object":{"title":"Schema JSON Structure Root Type Object","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-json-structure-root-type-object/","source":"spotlight","description":"The root type of a JSON Structure document is typically object.","message":"Root type should usually be object.","given":"$.type","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^object$"}},"tags":["format:json-structure","spec:document","experience:data-modeling"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-json-structure-root-type-object' (Schema JSON Structure Root Type Object). Requirement: The root type of a JSON Structure document is typically object. To fix: Ensure the targeted value matches the regular expression `^object$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-json-structure-uri":{"title":"Schema JSON Structure URI","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-json-structure-uri/","source":"spotlight","description":"$schema should be the URI of the JSON Structure meta-schema.","message":"$schema should be a URI.","given":"$.$schema","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https?://"}},"tags":["format:json-structure","spec:schemas","experience:consistency","experience:discoverability"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-json-structure-uri' (Schema JSON Structure URI). Requirement: $schema should be the URI of the JSON Structure meta-schema. To fix: Ensure the targeted value matches the regular expression `^https?://`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.$schema` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-property-require-type":{"title":"Schema Property Require Type","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-property-require-type/","source":"default","description":"The `type` property of each property should be present.","message":"type should be present","severity":"info","given":"$.properties[*]","then":{"field":"type","function":"truthy"},"tags":["format:json-structure","spec:properties","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-property-require-type' (Schema Property Require Type). Requirement: The `type` property of each property should be present. To fix: Ensure `type` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.properties[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."},"schema-require":{"title":"Schema Require","reference":"https://spotlight-rules.com/spec/rules/json-structure/schema-require/","source":"default","description":"The `$schema` property should be present.","message":"$schema should be present","severity":"info","given":"$","then":{"field":"$schema","function":"truthy"},"tags":["format:json-structure","spec:schemas","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON Structure document to satisfy the Spotlight API governance rule 'schema-require' (Schema Require). Requirement: The `$schema` property should be present. To fix: Ensure `$schema` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON Structure. Return only the complete corrected document, with no commentary."}},"json-ld":{"document-json-ld-id-iri":{"title":"Document JSON LD ID IRI","reference":"https://spotlight-rules.com/spec/rules/json-ld/document-json-ld-id-iri/","source":"spotlight","description":"@id should be an IRI (https://, urn:, did:) or a blank-node identifier.","message":"@id should be an IRI.","given":"$['@id']","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^https?://|^urn:|^did:|^_:"}},"tags":["format:json-ld","spec:document","experience:consistency","experience:discoverability"],"prompt":"You are editing a JSON-LD document to satisfy the Spotlight API governance rule 'document-json-ld-id-iri' (Document JSON LD ID IRI). Requirement: @id should be an IRI (https://, urn:, did:) or a blank-node identifier. To fix: Ensure the targeted value matches the regular expression `^https?://|^urn:|^did:|^_:`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.@id` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON-LD. Return only the complete corrected document, with no commentary."},"document-require-context":{"title":"Document Require Context","reference":"https://spotlight-rules.com/spec/rules/json-ld/document-require-context/","source":"default","description":"The `@context` property should be present.","message":"@context should be present","severity":"info","given":"$","then":{"field":"@context","function":"truthy"},"tags":["format:json-ld","spec:document","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a JSON-LD document to satisfy the Spotlight API governance rule 'document-require-context' (Document Require Context). Requirement: The `@context` property should be present. To fix: Ensure `@context` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON-LD. Return only the complete corrected document, with no commentary."},"document-require-id":{"title":"Document Require ID","reference":"https://spotlight-rules.com/spec/rules/json-ld/document-require-id/","source":"default","description":"The `@id` property should be present.","message":"@id should be present","severity":"info","given":"$","then":{"field":"@id","function":"truthy"},"tags":["format:json-ld","spec:document","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a JSON-LD document to satisfy the Spotlight API governance rule 'document-require-id' (Document Require ID). Requirement: The `@id` property should be present. To fix: Ensure `@id` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON-LD. Return only the complete corrected document, with no commentary."},"document-require-type":{"title":"Document Require Type","reference":"https://spotlight-rules.com/spec/rules/json-ld/document-require-type/","source":"default","description":"The `@type` property should be present.","message":"@type should be present","severity":"info","given":"$","then":{"field":"@type","function":"truthy"},"tags":["format:json-ld","spec:document","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a JSON-LD document to satisfy the Spotlight API governance rule 'document-require-type' (Document Require Type). Requirement: The `@type` property should be present. To fix: Ensure `@type` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON-LD. Return only the complete corrected document, with no commentary."},"schema-json-ld-context-uri-or-object":{"title":"Schema JSON LD Context URI Or Object","reference":"https://spotlight-rules.com/spec/rules/json-ld/schema-json-ld-context-uri-or-object/","source":"spotlight","description":"@context should be a URI string, an inline object, or an array of those.","message":"@context should be a URI, object, or array.","given":"$['@context']","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":["string","object","array"]}}},"tags":["format:json-ld","spec:document","experience:data-modeling","experience:consistency"],"prompt":"You are editing a JSON-LD document to satisfy the Spotlight API governance rule 'schema-json-ld-context-uri-or-object' (Schema JSON LD Context URI Or Object). Requirement: @context should be a URI string, an inline object, or an array of those. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.@context` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON-LD. Return only the complete corrected document, with no commentary."},"schema-json-ld-type-string-or-array":{"title":"Schema JSON LD Type String Or Array","reference":"https://spotlight-rules.com/spec/rules/json-ld/schema-json-ld-type-string-or-array/","source":"spotlight","description":"@type should be a string or an array of type strings.","message":"@type should be a string or array.","given":"$['@type']","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":["string","array"]}}},"tags":["format:json-ld","spec:document","experience:data-modeling"],"prompt":"You are editing a JSON-LD document to satisfy the Spotlight API governance rule 'schema-json-ld-type-string-or-array' (Schema JSON LD Type String Or Array). Requirement: @type should be a string or an array of type strings. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.@type` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid JSON-LD. Return only the complete corrected document, with no commentary."}},"mcp":{"capability-mcp-capabilities-not-empty":{"title":"Capability MCP Capabilities Not Empty","reference":"https://spotlight-rules.com/spec/rules/mcp/capability-mcp-capabilities-not-empty/","source":"spotlight","description":"capabilities should declare at least one of tools, resources, or prompts.","message":"capabilities should not be empty.","given":"$.capabilities","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"object","minProperties":1}}},"tags":["format:mcp","spec:capabilities","experience:discoverability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'capability-mcp-capabilities-not-empty' (Capability MCP Capabilities Not Empty). Requirement: capabilities should declare at least one of tools, resources, or prompts. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.capabilities` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"capability-require-prompts":{"title":"Capability Require Prompts","reference":"https://spotlight-rules.com/spec/rules/mcp/capability-require-prompts/","source":"default","description":"The `prompts` property of each capability should be present.","message":"prompts should be present","severity":"info","given":"$.capabilities","then":{"field":"prompts","function":"truthy"},"tags":["format:mcp","spec:capabilities","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'capability-require-prompts' (Capability Require Prompts). Requirement: The `prompts` property of each capability should be present. To fix: Ensure `prompts` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.capabilities` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"capability-require-resources":{"title":"Capability Require Resources","reference":"https://spotlight-rules.com/spec/rules/mcp/capability-require-resources/","source":"default","description":"The `resources` property of each capability should be present.","message":"resources should be present","severity":"info","given":"$.capabilities","then":{"field":"resources","function":"truthy"},"tags":["format:mcp","spec:capabilities","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'capability-require-resources' (Capability Require Resources). Requirement: The `resources` property of each capability should be present. To fix: Ensure `resources` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.capabilities` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"capability-require-tools":{"title":"Capability Require Tools","reference":"https://spotlight-rules.com/spec/rules/mcp/capability-require-tools/","source":"default","description":"The `tools` property of each capability should be present.","message":"tools should be present","severity":"info","given":"$.capabilities","then":{"field":"tools","function":"truthy"},"tags":["format:mcp","spec:capabilities","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'capability-require-tools' (Capability Require Tools). Requirement: The `tools` property of each capability should be present. To fix: Ensure `tools` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.capabilities` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"document-mcp-description-meaningful":{"title":"Document MCP Description Meaningful","reference":"https://spotlight-rules.com/spec/rules/mcp/document-mcp-description-meaningful/","source":"spotlight","description":"The server description should be specific (at least 40 characters) so agents can decide when to use it.","message":"MCP description should be at least 40 characters.","given":"$.description","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"string","minLength":40}}},"tags":["format:mcp","spec:document","experience:discoverability","experience:documentation"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'document-mcp-description-meaningful' (Document MCP Description Meaningful). Requirement: The server description should be specific (at least 40 characters) so agents can decide when to use it. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.description` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"document-mcp-name-kebab-case":{"title":"Document MCP Name Kebab Case","reference":"https://spotlight-rules.com/spec/rules/mcp/document-mcp-name-kebab-case/","source":"spotlight","description":"MCP server name should be lower kebab-case.","message":"MCP server name should be kebab-case.","given":"$.name","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^[a-z0-9]+(?:-[a-z0-9]+)*$"}},"tags":["format:mcp","spec:document","experience:naming","experience:consistency"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'document-mcp-name-kebab-case' (Document MCP Name Kebab Case). Requirement: MCP server name should be lower kebab-case. To fix: Ensure the targeted value matches the regular expression `^[a-z0-9]+(?:-[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"document-require-capabilities":{"title":"Document Require Capabilities","reference":"https://spotlight-rules.com/spec/rules/mcp/document-require-capabilities/","source":"default","description":"The `capabilities` property should be present.","message":"capabilities should be present","severity":"info","given":"$","then":{"field":"capabilities","function":"truthy"},"tags":["format:mcp","spec:servers","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'document-require-capabilities' (Document Require Capabilities). Requirement: The `capabilities` property should be present. To fix: Ensure `capabilities` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"document-require-description":{"title":"Document Require Description","reference":"https://spotlight-rules.com/spec/rules/mcp/document-require-description/","source":"default","description":"The `description` property should be present.","message":"description should be present","severity":"info","given":"$","then":{"field":"description","function":"truthy"},"tags":["format:mcp","spec:servers","experience:documentation","experience:data-modeling"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'document-require-description' (Document Require Description). Requirement: The `description` property should be present. To fix: Ensure `description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"document-require-instructions":{"title":"Document Require Instructions","reference":"https://spotlight-rules.com/spec/rules/mcp/document-require-instructions/","source":"default","description":"The `instructions` property should be present.","message":"instructions should be present","severity":"info","given":"$","then":{"field":"instructions","function":"truthy"},"tags":["format:mcp","spec:servers","experience:documentation","experience:usability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'document-require-instructions' (Document Require Instructions). Requirement: The `instructions` property should be present. To fix: Ensure `instructions` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"document-require-name":{"title":"Document Require Name","reference":"https://spotlight-rules.com/spec/rules/mcp/document-require-name/","source":"default","description":"The `name` property should be present.","message":"name should be present","severity":"info","given":"$","then":{"field":"name","function":"truthy"},"tags":["format:mcp","spec:servers","experience:data-modeling","experience:discoverability"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'document-require-name' (Document Require Name). Requirement: The `name` property should be present. To fix: Ensure `name` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"info-mcp-protocol-version-dated":{"title":"Info MCP Protocol Version Dated","reference":"https://spotlight-rules.com/spec/rules/mcp/info-mcp-protocol-version-dated/","source":"spotlight","description":"protocolVersion should be a dated MCP revision (YYYY-MM-DD).","message":"protocolVersion should be a dated revision (YYYY-MM-DD).","given":"$.protocolVersion","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^\\d{4}-\\d{2}-\\d{2}$"}},"tags":["format:mcp","spec:document","experience:versioning","experience:consistency"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'info-mcp-protocol-version-dated' (Info MCP Protocol Version Dated). Requirement: protocolVersion should be a dated MCP revision (YYYY-MM-DD). To fix: Ensure the targeted value matches the regular expression `^\\d{4}-\\d{2}-\\d{2}$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.protocolVersion` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"info-mcp-version-semver":{"title":"Info MCP Version Semver","reference":"https://spotlight-rules.com/spec/rules/mcp/info-mcp-version-semver/","source":"spotlight","description":"The server version should be semantic (e.g. 1.0.0).","message":"MCP version should be semantic.","given":"$.version","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^\\d+\\.\\d+\\.\\d+"}},"tags":["format:mcp","spec:document","experience:versioning"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'info-mcp-version-semver' (Info MCP Version Semver). Requirement: The server version should be semantic (e.g. 1.0.0). To fix: Ensure the targeted value matches the regular expression `^\\d+\\.\\d+\\.\\d+`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.version` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"info-require-protocol-version":{"title":"Info Require Protocol Version","reference":"https://spotlight-rules.com/spec/rules/mcp/info-require-protocol-version/","source":"default","description":"The `protocolVersion` property should be present.","message":"protocolVersion should be present","severity":"info","given":"$","then":{"field":"protocolVersion","function":"truthy"},"tags":["format:mcp","spec:servers","experience:versioning","experience:consistency"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'info-require-protocol-version' (Info Require Protocol Version). Requirement: The `protocolVersion` property should be present. To fix: Ensure `protocolVersion` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."},"info-skill-require-version":{"title":"Info Require Version","reference":"https://spotlight-rules.com/spec/rules/mcp/info-skill-require-version/","source":"default","description":"The `version` property should be present.","message":"version should be present","severity":"info","given":"$","then":{"field":"version","function":"truthy"},"tags":["format:mcp","spec:servers","experience:versioning","experience:data-modeling"],"prompt":"You are editing a MCP document to satisfy the Spotlight API governance rule 'info-skill-require-version' (Info Require Version). Requirement: The `version` property should be present. To fix: Ensure `version` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid MCP. Return only the complete corrected document, with no commentary."}},"plans":{"document-require-currency":{"title":"Document Require Currency","reference":"https://spotlight-rules.com/spec/rules/plans/document-require-currency/","source":"default","description":"The `currency` property should be present.","message":"currency should be present","severity":"info","given":"$","then":{"field":"currency","function":"truthy"},"tags":["format:plans","spec:document","experience:governance","experience:usability"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'document-require-currency' (Document Require Currency). Requirement: The `currency` property should be present. To fix: Ensure `currency` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"document-require-description":{"title":"Document Require Description","reference":"https://spotlight-rules.com/spec/rules/plans/document-require-description/","source":"default","description":"The `description` property should be present.","message":"description should be present","severity":"info","given":"$","then":{"field":"description","function":"truthy"},"tags":["format:plans","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'document-require-description' (Document Require Description). Requirement: The `description` property should be present. To fix: Ensure `description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"document-require-name":{"title":"Document Require Name","reference":"https://spotlight-rules.com/spec/rules/plans/document-require-name/","source":"default","description":"The `name` property should be present.","message":"name should be present","severity":"info","given":"$","then":{"field":"name","function":"truthy"},"tags":["format:plans","spec:document","experience:data-modeling","experience:governance"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'document-require-name' (Document Require Name). Requirement: The `name` property should be present. To fix: Ensure `name` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"document-require-plan":{"title":"Document Require Plan","reference":"https://spotlight-rules.com/spec/rules/plans/document-require-plan/","source":"default","description":"The `plans` property should be present.","message":"plans should be present","severity":"info","given":"$","then":{"field":"plans","function":"truthy"},"tags":["format:plans","spec:document","experience:data-modeling","experience:governance"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'document-require-plan' (Document Require Plan). Requirement: The `plans` property should be present. To fix: Ensure `plans` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-currency-iso4217":{"title":"Plan Currency Iso4217","reference":"https://spotlight-rules.com/spec/rules/plans/plan-currency-iso4217/","source":"spotlight","description":"currency should be a 3-letter ISO 4217 code (e.g. USD).","message":"currency should be an ISO 4217 code.","given":"$.currency","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^[A-Z]{3}$"}},"tags":["format:plans","spec:document","experience:consistency","experience:data-modeling"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-currency-iso4217' (Plan Currency Iso4217). Requirement: currency should be a 3-letter ISO 4217 code (e.g. USD). To fix: Ensure the targeted value matches the regular expression `^[A-Z]{3}$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.currency` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-features-non-empty":{"title":"Plan Features Non Empty","reference":"https://spotlight-rules.com/spec/rules/plans/plan-features-non-empty/","source":"spotlight","description":"If a plan lists features, the list should not be empty.","message":"Plan features should not be empty.","given":"$.plans[*].features","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"array","minItems":1}}},"tags":["format:plans","spec:plans","experience:documentation"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-features-non-empty' (Plan Features Non Empty). Requirement: If a plan lists features, the list should not be empty. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.plans[*].features` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-price-non-negative":{"title":"Plan Price Non Negative","reference":"https://spotlight-rules.com/spec/rules/plans/plan-price-non-negative/","source":"spotlight","description":"A plan price should be a non-negative number.","message":"Plan price should be a non-negative number.","given":"$.plans[*].price","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":["number","integer"],"minimum":0}}},"tags":["format:plans","spec:plans","experience:data-modeling"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-price-non-negative' (Plan Price Non Negative). Requirement: A plan price should be a non-negative number. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.plans[*].price` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-require-description":{"title":"Plan Require Description","reference":"https://spotlight-rules.com/spec/rules/plans/plan-require-description/","source":"default","description":"The `description` property of each plan should be present.","message":"description should be present","severity":"info","given":"$.plans[*]","then":{"field":"description","function":"truthy"},"tags":["format:plans","spec:plans","experience:documentation","experience:usability"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-require-description' (Plan Require Description). Requirement: The `description` property of each plan should be present. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.plans[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-require-features":{"title":"Plan Require Features","reference":"https://spotlight-rules.com/spec/rules/plans/plan-require-features/","source":"default","description":"The `features` property of each plan should be present.","message":"features should be present","severity":"info","given":"$.plans[*]","then":{"field":"features","function":"truthy"},"tags":["format:plans","spec:plans","experience:usability","experience:documentation"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-require-features' (Plan Require Features). Requirement: The `features` property of each plan should be present. To fix: Ensure `features` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.plans[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-require-interval":{"title":"Plan Require Interval","reference":"https://spotlight-rules.com/spec/rules/plans/plan-require-interval/","source":"spotlight","description":"Each plan should declare a billing interval (e.g. month, year).","message":"Plan should declare a billing interval.","given":"$.plans[*]","severity":"info","then":{"field":"interval","function":"truthy"},"tags":["format:plans","spec:plans","experience:consistency","experience:usability"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-require-interval' (Plan Require Interval). Requirement: Each plan should declare a billing interval (e.g. month, year). To fix: Ensure `interval` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.plans[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-require-limit":{"title":"Plan Require Limit","reference":"https://spotlight-rules.com/spec/rules/plans/plan-require-limit/","source":"default","description":"The `limits` property of each plan should be present.","message":"limits should be present","severity":"info","given":"$.plans[*]","then":{"field":"limits","function":"truthy"},"tags":["format:plans","spec:plans","experience:governance","experience:reliability"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-require-limit' (Plan Require Limit). Requirement: The `limits` property of each plan should be present. To fix: Ensure `limits` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.plans[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-require-name":{"title":"Plan Require Name","reference":"https://spotlight-rules.com/spec/rules/plans/plan-require-name/","source":"default","description":"The `name` property of each plan should be present.","message":"name should be present","severity":"info","given":"$.plans[*]","then":{"field":"name","function":"truthy"},"tags":["format:plans","spec:plans","experience:data-modeling","experience:governance"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-require-name' (Plan Require Name). Requirement: The `name` property of each plan should be present. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.plans[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."},"plan-require-price":{"title":"Plan Require Price","reference":"https://spotlight-rules.com/spec/rules/plans/plan-require-price/","source":"default","description":"The `price` property of each plan should be present.","message":"price should be present","severity":"info","given":"$.plans[*]","then":{"field":"price","function":"truthy"},"tags":["format:plans","spec:plans","experience:governance","experience:usability"],"prompt":"You are editing a Plans document to satisfy the Spotlight API governance rule 'plan-require-price' (Plan Require Price). Requirement: The `price` property of each plan should be present. To fix: Ensure `price` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.plans[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Plans. Return only the complete corrected document, with no commentary."}},"rate-limits":{"document-require-description":{"title":"Document Require Description","reference":"https://spotlight-rules.com/spec/rules/rate-limits/document-require-description/","source":"default","description":"The `description` property should be present.","message":"description should be present","severity":"info","given":"$","then":{"field":"description","function":"truthy"},"tags":["format:rate-limits","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'document-require-description' (Document Require Description). Requirement: The `description` property should be present. To fix: Ensure `description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"document-require-limit":{"title":"Document Require Limit","reference":"https://spotlight-rules.com/spec/rules/rate-limits/document-require-limit/","source":"default","description":"The `limits` property should be present.","message":"limits should be present","severity":"info","given":"$","then":{"field":"limits","function":"truthy"},"tags":["format:rate-limits","spec:document","experience:reliability","experience:data-modeling"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'document-require-limit' (Document Require Limit). Requirement: The `limits` property should be present. To fix: Ensure `limits` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"document-require-name":{"title":"Document Require Name","reference":"https://spotlight-rules.com/spec/rules/rate-limits/document-require-name/","source":"default","description":"The `name` property should be present.","message":"name should be present","severity":"info","given":"$","then":{"field":"name","function":"truthy"},"tags":["format:rate-limits","spec:document","experience:data-modeling","experience:governance"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'document-require-name' (Document Require Name). Requirement: The `name` property should be present. To fix: Ensure `name` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-max-positive":{"title":"Limit Max Positive","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-max-positive/","source":"spotlight","description":"A limit max should be a positive integer.","message":"Limit max should be a positive integer.","given":"$.limits[*].max","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"integer","minimum":1}}},"tags":["format:rate-limits","spec:limits","experience:data-modeling","experience:reliability"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-max-positive' (Limit Max Positive). Requirement: A limit max should be a positive integer. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.limits[*].max` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-require-max":{"title":"Limit Require Max","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-require-max/","source":"default","description":"The `max` property of each limit should be present.","message":"max should be present","severity":"info","given":"$.limits[*]","then":{"field":"max","function":"truthy"},"tags":["format:rate-limits","spec:limits","experience:reliability","experience:governance"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-require-max' (Limit Require Max). Requirement: The `max` property of each limit should be present. To fix: Ensure `max` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.limits[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-require-name":{"title":"Limit Require Name","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-require-name/","source":"default","description":"The `name` property of each limit should be present.","message":"name should be present","severity":"info","given":"$.limits[*]","then":{"field":"name","function":"truthy"},"tags":["format:rate-limits","spec:limits","experience:data-modeling","experience:reliability"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-require-name' (Limit Require Name). Requirement: The `name` property of each limit should be present. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.limits[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-require-scope":{"title":"Limit Require Scope","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-require-scope/","source":"default","description":"The `scope` property of each limit should be present.","message":"scope should be present","severity":"info","given":"$.limits[*]","then":{"field":"scope","function":"truthy"},"tags":["format:rate-limits","spec:limits","experience:reliability","experience:governance"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-require-scope' (Limit Require Scope). Requirement: The `scope` property of each limit should be present. To fix: Ensure `scope` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.limits[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-require-window":{"title":"Limit Require Window","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-require-window/","source":"default","description":"The `window` property of each limit should be present.","message":"window should be present","severity":"info","given":"$.limits[*]","then":{"field":"window","function":"truthy"},"tags":["format:rate-limits","spec:limits","experience:reliability","experience:governance"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-require-window' (Limit Require Window). Requirement: The `window` property of each limit should be present. To fix: Ensure `window` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.limits[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-scope-known":{"title":"Limit Scope Known","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-scope-known/","source":"spotlight","description":"A limit scope should be one of ip, user, api-key, client, or global.","message":"Limit scope should be a known value.","given":"$.limits[*].scope","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"string","enum":["ip","user","api-key","client","global"]}}},"tags":["format:rate-limits","spec:limits","experience:consistency"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-scope-known' (Limit Scope Known). Requirement: A limit scope should be one of ip, user, api-key, client, or global. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.limits[*].scope` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."},"limit-window-format":{"title":"Limit Window Format","reference":"https://spotlight-rules.com/spec/rules/rate-limits/limit-window-format/","source":"spotlight","description":"A limit window should be a duration like 60s, 1m, 1h, or 1d.","message":"Limit window should be a duration (e.g. 60s, 1h).","given":"$.limits[*].window","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^\\d+(ms|s|m|h|d)$"}},"tags":["format:rate-limits","spec:limits","experience:consistency","experience:reliability"],"prompt":"You are editing a Rate Limits document to satisfy the Spotlight API governance rule 'limit-window-format' (Limit Window Format). Requirement: A limit window should be a duration like 60s, 1m, 1h, or 1d. To fix: Ensure the targeted value matches the regular expression `^\\d+(ms|s|m|h|d)$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.limits[*].window` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Rate Limits. Return only the complete corrected document, with no commentary."}},"finops":{"cost-finops-monthly-non-negative":{"title":"Cost FinOps Monthly Non Negative","reference":"https://spotlight-rules.com/spec/rules/finops/cost-finops-monthly-non-negative/","source":"spotlight","description":"A cost monthly amount should be a non-negative number.","message":"Cost monthly should be a non-negative number.","given":"$.costs[*].monthly","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":["number","integer"],"minimum":0}}},"tags":["format:finops","spec:costs","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'cost-finops-monthly-non-negative' (Cost FinOps Monthly Non Negative). Requirement: A cost monthly amount should be a non-negative number. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.costs[*].monthly` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"cost-finops-require-monthly":{"title":"Cost FinOps Require Monthly","reference":"https://spotlight-rules.com/spec/rules/finops/cost-finops-require-monthly/","source":"default","description":"The `monthly` property of each cost should be present.","message":"monthly should be present","severity":"info","given":"$.costs[*]","then":{"field":"monthly","function":"truthy"},"tags":["format:finops","spec:costs","experience:governance","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'cost-finops-require-monthly' (Cost FinOps Require Monthly). Requirement: The `monthly` property of each cost should be present. To fix: Ensure `monthly` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.costs[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"cost-finops-require-service":{"title":"Cost FinOps Require Service","reference":"https://spotlight-rules.com/spec/rules/finops/cost-finops-require-service/","source":"default","description":"The `service` property of each cost should be present.","message":"service should be present","severity":"info","given":"$.costs[*]","then":{"field":"service","function":"truthy"},"tags":["format:finops","spec:costs","experience:governance","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'cost-finops-require-service' (Cost FinOps Require Service). Requirement: The `service` property of each cost should be present. To fix: Ensure `service` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.costs[*]` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-budget-non-negative":{"title":"Document FinOps Budget Non Negative","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-budget-non-negative/","source":"spotlight","description":"budget should be a non-negative number.","message":"budget should be a non-negative number.","given":"$.budget","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":["number","integer"],"minimum":0}}},"tags":["format:finops","spec:document","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-budget-non-negative' (Document FinOps Budget Non Negative). Requirement: budget should be a non-negative number. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.budget` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-currency-iso4217":{"title":"Document FinOps Currency Iso4217","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-currency-iso4217/","source":"spotlight","description":"currency should be a 3-letter ISO 4217 code (e.g. USD).","message":"currency should be an ISO 4217 code.","given":"$.currency","severity":"info","then":{"function":"pattern","functionOptions":{"match":"^[A-Z]{3}$"}},"tags":["format:finops","spec:document","experience:consistency","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-currency-iso4217' (Document FinOps Currency Iso4217). Requirement: currency should be a 3-letter ISO 4217 code (e.g. USD). To fix: Ensure the targeted value matches the regular expression `^[A-Z]{3}$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.currency` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-require-budget":{"title":"Document FinOps Require Budget","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-require-budget/","source":"default","description":"The `budget` property should be present.","message":"budget should be present","severity":"info","given":"$","then":{"field":"budget","function":"truthy"},"tags":["format:finops","spec:document","experience:governance","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-require-budget' (Document FinOps Require Budget). Requirement: The `budget` property should be present. To fix: Ensure `budget` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-require-cost":{"title":"Document FinOps Require Cost","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-require-cost/","source":"default","description":"The `costs` property should be present.","message":"costs should be present","severity":"info","given":"$","then":{"field":"costs","function":"truthy"},"tags":["format:finops","spec:document","experience:governance","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-require-cost' (Document FinOps Require Cost). Requirement: The `costs` property should be present. To fix: Ensure `costs` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-require-currency":{"title":"Document FinOps Require Currency","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-require-currency/","source":"default","description":"The `currency` property should be present.","message":"currency should be present","severity":"info","given":"$","then":{"field":"currency","function":"truthy"},"tags":["format:finops","spec:document","experience:governance","experience:data-modeling"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-require-currency' (Document FinOps Require Currency). Requirement: The `currency` property should be present. To fix: Ensure `currency` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-require-description":{"title":"Document FinOps Require Description","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-require-description/","source":"default","description":"The `description` property should be present.","message":"description should be present","severity":"info","given":"$","then":{"field":"description","function":"truthy"},"tags":["format:finops","spec:document","experience:documentation","experience:governance"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-require-description' (Document FinOps Require Description). Requirement: The `description` property should be present. To fix: Ensure `description` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-require-name":{"title":"Document FinOps Require Name","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-require-name/","source":"default","description":"The `name` property should be present.","message":"name should be present","severity":"info","given":"$","then":{"field":"name","function":"truthy"},"tags":["format:finops","spec:document","experience:data-modeling","experience:governance"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-require-name' (Document FinOps Require Name). Requirement: The `name` property should be present. To fix: Ensure `name` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."},"document-finops-require-period":{"title":"Document FinOps Require Period","reference":"https://spotlight-rules.com/spec/rules/finops/document-finops-require-period/","source":"spotlight","description":"A FinOps artifact should declare a period (e.g. monthly, annual) for the budget and costs.","message":"FinOps should declare a period.","given":"$","severity":"info","then":{"field":"period","function":"truthy"},"tags":["format:finops","spec:document","experience:consistency","experience:governance"],"prompt":"You are editing a FinOps document to satisfy the Spotlight API governance rule 'document-finops-require-period' (Document FinOps Require Period). Requirement: A FinOps artifact should declare a period (e.g. monthly, annual) for the budget and costs. To fix: Ensure `period` is present and non-empty at each matching location. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid FinOps. Return only the complete corrected document, with no commentary."}},"agent-skill":{"skill-require-allowed-tools":{"title":"Skill Require Allowed Tools","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-require-allowed-tools/","source":"spotlight","description":"agent-skill document should declare a `allowed-tools` property.","message":"Missing `allowed-tools`.","given":"$.frontmatter","severity":"info","then":{"field":"allowed-tools","function":"truthy"},"tags":["format:agent-skill","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-require-allowed-tools' (Require Allowed Tools). Requirement: agent-skill document should declare a `allowed-tools` property. To fix: Ensure `allowed-tools` is present and non-empty at each matching location. Guidance: Missing `allowed-tools`. This rule is evaluated at the JSONPath `$.frontmatter` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-require-metadata":{"title":"Skill Require Metadata","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-require-metadata/","source":"spotlight","description":"agent-skill document should declare a `metadata` property.","message":"Missing `metadata`.","given":"$.frontmatter","severity":"info","then":{"field":"metadata","function":"truthy"},"tags":["format:agent-skill","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-require-metadata' (Require Metadata). Requirement: agent-skill document should declare a `metadata` property. To fix: Ensure `metadata` is present and non-empty at each matching location. Guidance: Missing `metadata`. This rule is evaluated at the JSONPath `$.frontmatter` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-require-version":{"title":"Skill Require Version","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-require-version/","source":"spotlight","description":"agent-skill document should declare a `version` property.","message":"Missing `version`.","given":"$.frontmatter","severity":"info","then":{"field":"version","function":"truthy"},"tags":["format:agent-skill","spec:document","experience:governance","experience:discoverability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-require-version' (Require Version). Requirement: agent-skill document should declare a `version` property. To fix: Ensure `version` is present and non-empty at each matching location. Guidance: Missing `version`. This rule is evaluated at the JSONPath `$.frontmatter` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-allowed-tools-array":{"title":"Skill Allowed Tools Array","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-allowed-tools-array/","source":"default","description":"If a skill declares allowed-tools, it must be an array of tool names so its capability surface is explicit and auditable.","message":"allowed-tools must be an array of tool names.","severity":"info","given":"$.frontmatter['allowed-tools']","then":{"function":"schema","functionOptions":{"schema":{"type":"array","items":{"type":"string"}}}},"tags":["format:agent-skill","spec:frontmatter","experience:security","experience:governance"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-allowed-tools-array' (Skill Allowed Tools Array). Requirement: If a skill declares allowed-tools, it must be an array of tool names so its capability surface is explicit and auditable. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.frontmatter['allowed-tools']` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-body-length":{"title":"Skill Body Length","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-body-length/","source":"default","description":"Skill bodies should stay focused — very long instructions degrade agent performance. Keep the body under ~5000 words.","message":"Skill body is very long (over ~5000 words).","severity":"info","given":"$.words","then":{"function":"schema","functionOptions":{"schema":{"type":"integer","maximum":5000}}},"tags":["format:agent-skill","spec:body","experience:usability","experience:reliability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-body-length' (Skill Body Length). Requirement: Skill bodies should stay focused — very long instructions degrade agent performance. Keep the body under ~5000 words. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.words` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-body-present":{"title":"Skill Body Present","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-body-present/","source":"default","description":"A skill must have body content, not just frontmatter — the body is the instruction set the agent actually follows.","message":"A skill must have body content.","severity":"info","given":"$.words","then":{"function":"schema","functionOptions":{"schema":{"type":"integer","minimum":1}}},"tags":["format:agent-skill","spec:body","experience:documentation","experience:reliability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-body-present' (Skill Body Present). Requirement: A skill must have body content, not just frontmatter — the body is the instruction set the agent actually follows. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.words` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-description":{"title":"Skill Description","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-description/","source":"default","description":"A skill must declare a description — it is the primary signal an agent uses to decide when to invoke the skill.","message":"A skill must declare a description.","severity":"info","given":"$.frontmatter","then":{"field":"description","function":"truthy"},"tags":["format:agent-skill","spec:frontmatter","experience:discoverability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-description' (Skill Description). Requirement: A skill must declare a description — it is the primary signal an agent uses to decide when to invoke the skill. To fix: Ensure `description` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.frontmatter` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-description-length":{"title":"Skill Description Length","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-description-length/","source":"default","description":"Skill descriptions should be specific enough to drive good selection — at least 40 characters of meaningful intent.","message":"Skill description should be at least 40 characters.","severity":"info","given":"$.frontmatter.description","then":{"function":"length","functionOptions":{"min":40,"max":1024}},"tags":["format:agent-skill","spec:frontmatter","experience:discoverability","experience:usability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-description-length' (Skill Description Length). Requirement: Skill descriptions should be specific enough to drive good selection — at least 40 characters of meaningful intent. To fix: Ensure the length of the targeted value is at least 40 and at most 1024. This rule is evaluated at the JSONPath `$.frontmatter.description` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-description-single-line":{"title":"Skill Description Single Line","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-description-single-line/","source":"spotlight","description":"A skill description should be a single line (no embedded line breaks) so it renders cleanly in pickers.","message":"Skill description should be a single line.","given":"$.frontmatter.description","severity":"info","then":{"function":"pattern","functionOptions":{"notMatch":"\\n"}},"tags":["format:agent-skill","spec:frontmatter","experience:consistency","experience:usability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-description-single-line' (Skill Description Single Line). Requirement: A skill description should be a single line (no embedded line breaks) so it renders cleanly in pickers. To fix: Ensure the targeted value does NOT match the regular expression `\\n`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.frontmatter.description` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-has-examples-section":{"title":"Skill Has Examples Section","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-has-examples-section/","source":"default","description":"A skill body should show concrete examples under an Examples section so agents and humans can see how it is meant to be invoked.","message":"Skill body should have an \"Examples\" section.","severity":"info","given":"$","then":{"function":"headingPresent","functionOptions":{"name":"Examples"}},"tags":["format:agent-skill","spec:body","experience:documentation"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-has-examples-section' (Skill Has Examples Section). Requirement: A skill body should show concrete examples under an Examples section so agents and humans can see how it is meant to be invoked. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-has-usage-section":{"title":"Skill Has Usage Section","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-has-usage-section/","source":"default","description":"A skill body should document how to use it under a Usage section, so both humans and agents can see how it is meant to be invoked.","message":"Skill body should have a \"Usage\" section.","severity":"info","given":"$","then":{"function":"headingPresent","functionOptions":{"name":"Usage"}},"tags":["format:agent-skill","spec:body","experience:documentation"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-has-usage-section' (Skill Has Usage Section). Requirement: A skill body should document how to use it under a Usage section, so both humans and agents can see how it is meant to be invoked. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-license":{"title":"Skill License","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-license/","source":"default","description":"A skill should declare a license so consumers know the terms under which they can reuse and redistribute it.","message":"A skill should declare a license.","severity":"info","given":"$.frontmatter","then":{"field":"license","function":"truthy"},"tags":["format:agent-skill","spec:frontmatter","experience:governance"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-license' (Skill License). Requirement: A skill should declare a license so consumers know the terms under which they can reuse and redistribute it. To fix: Ensure `license` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.frontmatter` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-metadata-object":{"title":"Skill Metadata Object","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-metadata-object/","source":"spotlight","description":"If a skill declares metadata, it should be an object of key/value pairs.","message":"Skill metadata should be an object.","given":"$.frontmatter.metadata","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"object"}}},"tags":["format:agent-skill","spec:frontmatter","experience:data-modeling"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-metadata-object' (Skill Metadata Object). Requirement: If a skill declares metadata, it should be an object of key/value pairs. To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.frontmatter.metadata` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-name":{"title":"Skill Name","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-name/","source":"default","description":"A skill must declare a name in its frontmatter — it identifies the skill to agents and tooling.","message":"A skill must declare a name.","severity":"info","given":"$.frontmatter","then":{"field":"name","function":"truthy"},"tags":["format:agent-skill","spec:frontmatter","experience:governance","experience:discoverability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-name' (Skill Name). Requirement: A skill must declare a name in its frontmatter — it identifies the skill to agents and tooling. To fix: Ensure `name` is present and non-empty at each matching location. This rule is evaluated at the JSONPath `$.frontmatter` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-name-kebab-case":{"title":"Skill Name Kebab Case","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-name-kebab-case/","source":"default","description":"Skill name should be lower kebab-case so it matches the skill directory name and stays portable.","message":"Skill name should be lower kebab-case.","severity":"info","given":"$.frontmatter.name","then":{"function":"pattern","functionOptions":{"match":"^[a-z0-9]+(?:-[a-z0-9]+)*$"}},"tags":["format:agent-skill","spec:frontmatter","experience:naming"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-name-kebab-case' (Skill Name Kebab Case). Requirement: Skill name should be lower kebab-case so it matches the skill directory name and stays portable. To fix: Ensure the targeted value matches the regular expression `^[a-z0-9]+(?:-[a-z0-9]+)*$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.frontmatter.name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-name-max-length":{"title":"Skill Name Max Length","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-name-max-length/","source":"spotlight","description":"A skill name should be concise (64 characters or fewer).","message":"Skill name should be 64 characters or fewer.","given":"$.frontmatter.name","severity":"info","then":{"function":"schema","functionOptions":{"schema":{"type":"string","maxLength":64}}},"tags":["format:agent-skill","spec:frontmatter","experience:naming","experience:usability"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-name-max-length' (Skill Name Max Length). Requirement: A skill name should be concise (64 characters or fewer). To fix: Adjust the targeted value so it conforms to the schema this rule requires. This rule is evaluated at the JSONPath `$.frontmatter.name` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-single-title":{"title":"Skill Single Title","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-single-title/","source":"default","description":"A skill body should have at most one level-1 heading — the frontmatter name is the title, and sections should use level-2 headings.","message":"Skill body should have at most one level-1 heading.","severity":"info","given":"$","then":{"function":"headingCount","functionOptions":{"depth":1,"max":1}},"tags":["format:agent-skill","spec:body","experience:consistency"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-single-title' (Skill Single Title). Requirement: A skill body should have at most one level-1 heading — the frontmatter name is the title, and sections should use level-2 headings. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."},"skill-version-semver":{"title":"Skill Version Semver","reference":"https://spotlight-rules.com/spec/rules/agent-skill/skill-version-semver/","source":"default","description":"If a skill declares a version, it should be semantic (e.g. 1.0.0) so consumers can reason about changes between releases.","message":"Skill version should be semantic (e.g. 1.0.0).","severity":"info","given":"$.frontmatter.version","then":{"function":"pattern","functionOptions":{"match":"^\\d+\\.\\d+\\.\\d+(?:[-+][0-9A-Za-z.-]+)?$"}},"tags":["format:agent-skill","spec:frontmatter","experience:versioning"],"prompt":"You are editing an Agent Skill document to satisfy the Spotlight API governance rule 'skill-version-semver' (Skill Version Semver). Requirement: If a skill declares a version, it should be semantic (e.g. 1.0.0) so consumers can reason about changes between releases. To fix: Ensure the targeted value matches the regular expression `^\\d+\\.\\d+\\.\\d+(?:[-+][0-9A-Za-z.-]+)?$`; rewrite any value that does not. This rule is evaluated at the JSONPath `$.frontmatter.version` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid Agent Skill. Return only the complete corrected document, with no commentary."}}}
\ No newline at end of file