# 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-secrets-manager — 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: 100% of servers already https (error)
# - servers-expected-domain: 1/1 servers on amazonaws.com
# - operationid-casing: pascal @ 100% (n=12)
# - schema-names-casing: pascal @ 100% (n=26)
# - schema-properties-casing: pascal @ 92% (n=119)
# - merge: kept 20 existing, added 3 measured, upgraded 0
# - added: servers-expected-domain, schema-names-casing, schema-properties-casing
extends:
- spectral:oas
rules:
info-title-required:
description: Info title must be present
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: Info version must be present
severity: error
given: $.info
then:
field: version
function: truthy
openapi-version-3:
description: Must use OpenAPI 3.x
severity: error
given: $
then:
field: openapi
function: pattern
functionOptions:
match: ^3\.
servers-required:
description: Servers must be defined
severity: error
given: $
then:
field: servers
function: truthy
servers-https-only:
description: Server URLs must use HTTPS
severity: error
given: $.servers[*]
then:
field: url
function: pattern
functionOptions:
match: ^https://
operation-summary-required:
description: Every operation must have a summary
severity: error
given: $.paths[*][get,post,put,patch,delete]
then:
field: summary
function: truthy
operation-summary-prefix:
description: Operation summaries must start with "Amazon Secrets Manager"
severity: warn
given: $.paths[*][get,post,put,patch,delete].summary
then:
function: pattern
functionOptions:
match: ^Amazon Secrets Manager
operation-description-required:
description: Every operation must have a description
severity: warn
given: $.paths[*][get,post,put,patch,delete]
then:
field: description
function: truthy
operation-id-required:
description: Every operation must have an operationId
severity: error
given: $.paths[*][get,post,put,patch,delete]
then:
field: operationId
function: truthy
operation-id-pascal-case:
description: operationId must use PascalCase
severity: warn
given: $.paths[*][get,post,put,patch,delete].operationId
then:
function: pattern
functionOptions:
match: ^[A-Z][a-zA-Z0-9]*$
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
parameter-description-required:
description: Every parameter must have a description
severity: warn
given: $.paths[*][get,post,put,patch,delete].parameters[*]
then:
field: description
function: truthy
response-success-required:
description: Every operation must have a 200 response
severity: error
given: $.paths[*][get,post,put,patch,delete].responses
then:
function: schema
functionOptions:
schema:
anyOf:
- required:
- '200'
- required:
- '201'
- required:
- '204'
response-description-required:
description: Every response must have a description
severity: warn
given: $.paths[*][get,post,put,patch,delete].responses[*]
then:
field: description
function: truthy
schema-type-required:
description: Schema properties should have a type defined
severity: warn
given: $.components.schemas[*].properties[*]
then:
field: type
function: truthy
security-schemes-defined:
description: Security schemes should be defined in components
severity: warn
given: $
then:
field: components.securitySchemes
function: truthy
get-no-request-body:
description: GET operations must not have a request body
severity: error
given: $.paths[*].get
then:
field: requestBody
function: falsy
no-empty-descriptions:
description: Descriptions must not be empty strings
severity: warn
given: $..description
then:
function: pattern
functionOptions:
match: .+
microcks-operation-present:
description: Operations should have x-microcks-operation for mock support
severity: info
given: $.paths[*][get,post,put,patch,delete]
then:
field: x-microcks-operation
function: truthy
servers-expected-domain:
description: Server URLs should be on the amazonaws.com domain.
severity: warn
given: $.servers[*].url
then:
function: pattern
functionOptions:
match: amazonaws\.com
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: casing
functionOptions:
type: pascal
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]*$