# authorship: generated by API Evangelist tooling. Stamped 2026-08-18
# on the file's own generator header (roadmap#64). An unmarked file is
# NOT assumed to be ours -- absence of evidence was never stamped.
x-method: generated
# amazon-lookout-for-metrics — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
# - servers-https-only: 50% of servers already https (warn)
# - path-params-casing: camel @ 100% (n=3)
# - query-params-casing: pascal @ 94% (n=17)
# - operationid-casing: pascal @ 100% (n=30)
# - schema-names-casing: pascal @ 100% (n=236)
# - schema-properties-casing: pascal @ 98% (n=335)
# - security: global (root) — NOT emitting operation-security-required
# - error-schema-defined: ErrorMessage
# - merge: kept 24 existing, added 5 measured, upgraded 0
# - added: query-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, error-schema-defined
extends:
- spectral:oas
rules:
info-title-required:
description: Info title must be present and start with "Amazon Lookout for Metrics"
severity: error
given: $.info
then:
field: title
function: truthy
info-description-required:
description: Info description must be present
severity: warn
given: $.info
then:
field: description
function: truthy
info-version-required:
description: API version must be defined
severity: error
given: $.info
then:
field: version
function: truthy
openapi-version:
description: Must use OpenAPI 3.0.x
severity: error
given: $
then:
field: openapi
function: pattern
functionOptions:
match: ^3\.0\.
servers-required:
description: Servers must be defined
severity: error
given: $
then:
field: servers
function: truthy
servers-https:
description: Server URLs should use HTTPS
severity: warn
given: $.servers[*]
then:
field: url
function: pattern
functionOptions:
match: ^https://
operation-operationId-required:
description: Every operation must have an operationId
severity: error
given: $.paths[*][get,post,put,patch,delete]
then:
field: operationId
function: truthy
operation-summary-required:
description: Every operation must have a summary
severity: warn
given: $.paths[*][get,post,put,patch,delete]
then:
field: summary
function: truthy
operation-summary-prefix:
description: Operation summaries should start with "Amazon Lookout for Metrics"
severity: info
given: $.paths[*][get,post,put,patch,delete].summary
then:
function: pattern
functionOptions:
match: ^Amazon Lookout for Metrics
operation-description-required:
description: Every operation should have a description
severity: warn
given: $.paths[*][get,post,put,patch,delete]
then:
field: description
function: truthy
operation-tags-required:
description: Every operation must have at least one tag
severity: warn
given: $.paths[*][get,post,put,patch,delete]
then:
field: tags
function: truthy
paths-kebab-case:
description: Path segments should use PascalCase (AWS convention for action-based paths)
severity: info
given: $.paths
then:
field: '@key'
function: pattern
functionOptions:
match: ^/[A-Za-z][A-Za-z0-9]*$
parameter-description-required:
description: All parameters must have descriptions
severity: warn
given: $.paths[*][get,post,put,patch,delete].parameters[*]
then:
field: description
function: truthy
response-success-required:
description: Operations must have at least one 2xx response
severity: error
given: $.paths[*][post]
then:
field: responses
function: schema
functionOptions:
schema:
type: object
minProperties: 1
response-description-required:
description: All responses must have a description
severity: warn
given: $.paths[*][get,post,put,patch,delete].responses[*]
then:
field: description
function: truthy
response-error-401:
description: Operations should document 401 Unauthorized responses
severity: info
given: $.paths[*][post]
then:
field: responses
function: schema
functionOptions:
schema:
type: object
schema-description:
description: Top-level schemas in components should have descriptions
severity: info
given: $.components.schemas[*]
then:
field: description
function: truthy
schema-property-type:
description: Schema properties should define a type
severity: warn
given: $.components.schemas[*].properties[*]
then:
field: type
function: truthy
security-schemes-required:
description: Security schemes must be defined
severity: error
given: $.components
then:
field: securitySchemes
function: truthy
security-aws-sigv4:
description: AWS Signature Version 4 security should be documented
severity: warn
given: $.components.securitySchemes
then:
function: truthy
http-get-no-body:
description: GET operations should not have request bodies
severity: error
given: $.paths[*].get
then:
field: requestBody
function: falsy
http-delete-no-body:
description: DELETE operations should not have request bodies
severity: warn
given: $.paths[*].delete
then:
field: requestBody
function: falsy
no-empty-descriptions:
description: Descriptions should not be empty strings
severity: warn
given: $..description
then:
function: pattern
functionOptions:
match: .+
examples-encouraged:
description: Schema properties should include examples
severity: info
given: $.components.schemas[*].properties[*]
then:
field: example
function: truthy
query-params-casing:
description: Query parameters should be PascalCase (the dominant convention in this API).
severity: warn
given: $.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
then:
field: name
function: casing
functionOptions:
type: pascal
operationid-casing:
description: Operation IDs should be PascalCase (the dominant convention in this API).
severity: warn
given: $.paths[*][get,post,put,patch,delete].operationId
then:
function: casing
functionOptions:
type: pascal
schema-names-casing:
description: Component schema names should be PascalCase (the dominant convention in this API).
severity: warn
given: $.components.schemas
then:
field: '@key'
function: pattern
functionOptions:
match: ^[A-Z][A-Za-z0-9]*$
schema-properties-casing:
description: Schema properties should be PascalCase (the dominant convention in this API).
severity: warn
given: $.components.schemas[*].properties
then:
field: '@key'
function: pattern
functionOptions:
match: ^[A-Z][A-Za-z0-9]*$
error-schema-defined:
description: A shared error schema (ErrorMessage) should be defined for error payloads.
severity: warn
given: $.components.schemas
then:
field: ErrorMessage
function: truthy