Home
Amazon Cloud WAN
Amazon Cloud WAN API Rules
Amazon Cloud WAN API Rules
Spectral linting rules defining API design standards and conventions for Amazon Cloud WAN.
23 Rules
error 12
warn 10
info 1
Generated by API Evangelist
Written by API Evangelist tooling for Amazon Cloud WAN's APIs. It is a starting point, not a ruleset Amazon Cloud WAN publishes or enforces.
Rule Categories
get
info
microcks
no
operation
parameter
response
schema
security
servers
Rules
error
info-title-prefix
API title must start with "Amazon Cloud WAN"
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
API must have a version
$.info
error
servers-required
API must define at least one server
$
error
servers-https-only
All server URLs must use HTTPS
$.servers[*].url
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-operationId-pascal-case
operationId must use PascalCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries must start with "Amazon Cloud WAN"
$.paths[*][get,post,put,patch,delete].summary
error
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-description-required
All response codes must have descriptions
$.paths[*][get,post,put,patch,delete].responses[*]
warn
response-500-required
Operations should document 500 internal server error
$.paths[*][get,post,put,patch,delete].responses
warn
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
warn
security-schemes-defined
Security schemes must be defined
$.components
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty
$..description
info
microcks-operation-present
Operations should have x-microcks-operation extension
$.paths[*][get,post,put,patch,delete]
warn
servers-expected-domain
Server URLs should be on the amazonaws.com domain.
$.servers[*].url
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
warn
schema-properties-casing
Schema properties should be PascalCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
operation-documents-400
Operations should document a 400 response (documented on 100% of this API's operations).
$.paths[*][get,post,put,patch,delete].responses
Spectral Ruleset
# 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-cloud-wan — 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=4)
# - schema-names-casing: pascal @ 100% (n=9)
# - schema-properties-casing: pascal @ 100% (n=18)
# - security: global (root) — NOT emitting operation-security-required
# - operation-documents-400: 100% adherence
# - operation-documents-500: 100% adherence
# - pagination params observed: ['maxResults', 'nextToken']
# - merge: kept 19 existing, added 4 measured, upgraded 0
# - added: servers-expected-domain, schema-names-casing, schema-properties-casing, operation-documents-400
extends:
- spectral:oas
rules:
info-title-prefix:
description: API title must start with "Amazon Cloud WAN"
severity: error
given: $.info.title
then:
function: pattern
functionOptions:
match: ^Amazon Cloud WAN
info-description-required:
description: Info object must have a description
severity: error
given: $.info
then:
field: description
function: truthy
info-version-required:
description: API must have a version
severity: error
given: $.info
then:
field: version
function: truthy
servers-required:
description: API must define at least one server
severity: error
given: $
then:
field: servers
function: truthy
servers-https-only:
description: All server URLs must use HTTPS
severity: error
given: $.servers[*].url
then:
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-operationId-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-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 Cloud WAN"
severity: warn
given: $.paths[*][get,post,put,patch,delete].summary
then:
function: pattern
functionOptions:
match: ^Amazon Cloud WAN
operation-description-required:
description: Every operation must have a description
severity: error
given: $.paths[*][get,post,put,patch,delete]
then:
field: description
function: truthy
operation-tags-required:
description: Every operation must have tags
severity: error
given: $.paths[*][get,post,put,patch,delete]
then:
field: tags
function: truthy
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-description-required:
description: All response codes must have descriptions
severity: error
given: $.paths[*][get,post,put,patch,delete].responses[*]
then:
field: description
function: truthy
response-500-required:
description: Operations should document 500 internal server error
severity: warn
given: $.paths[*][get,post,put,patch,delete].responses
then:
field: '500'
function: truthy
schema-description-required:
description: Top-level schemas should have descriptions
severity: warn
given: $.components.schemas[*]
then:
field: description
function: truthy
security-schemes-defined:
description: Security schemes must be defined
severity: warn
given: $.components
then:
field: 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
severity: error
given: $..description
then:
function: truthy
microcks-operation-present:
description: Operations should have x-microcks-operation extension
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: casing
functionOptions:
type: pascal
operation-documents-400:
description: Operations should document a 400 response (documented on 100% of this API's operations).
severity: warn
given: $.paths[*][get,post,put,patch,delete].responses
then:
field: '400'
function: truthy
Every ruleset here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for spectral rules
4 MCP tools reach this
find_rulesBrowse and filter every ruleset in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This ruleset
curl "https://apis.io/api/v1/rules/amazon-cloud-wan-spectral-rules"
All spectral rules
curl "https://apis.io/api/v1/rules?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms .
A second provider on the same verified email joins the account you already have.