Amazon OpenSearch Service API · API Governance Rules
Amazon OpenSearch Service API API Rules
Spectral linting rules defining API design standards and conventions for Amazon OpenSearch Service API.
21 Rules
error 10
warn 10
info 1
Rule Categories
get
info
openapi
operation
parameter
paths
response
schema
security
server
servers
Rules
warn
info-title-format
API title should start with "Amazon OpenSearch Service API"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
Info object must have a version
$.info
warn
openapi-version-3
OpenAPI version should be 3.x
$.openapi
error
servers-required
Servers must be defined
$
error
server-https-required
Server URLs must use HTTPS
$.servers[*].url
warn
paths-kebab-case
Path segments should use kebab-case
$.paths[*]~
warn
paths-no-trailing-slash
Paths should not have a trailing slash
$.paths[*]~
error
operation-summary-required
Operations must have a summary
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-summary-company-prefix
Operation summaries should start with "Amazon OpenSearch Service API"
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Operations must have a description
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-id-required
Operations must have an operationId
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-id-camel-case
OperationIds should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
warn
operation-tags-required
Operations must have at least one tag
$.paths[*][get,post,put,patch,delete,head,options]
warn
parameter-description-required
Parameters must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Operations must have a success response (2xx)
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Response objects must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-type-required
Schemas should define a type
$.components.schemas[*]
error
security-scheme-defined
Security schemes must be defined in components
$.components
error
get-no-request-body
GET operations should not have a request body
$.paths[*].get
info
operation-examples-encouraged
Operations should include examples
$.paths[*][get,post,put,patch,delete].responses[*].content[*]