Adyen · API Governance Rules
Adyen API Rules
Spectral linting rules defining API design standards and conventions for Adyen.
32 Rules
error 12
warn 14
info 6
Rule Categories
delete
get
info
microcks
no
openapi
operation
parameter
paths
request
response
schema
security
servers
Rules
error
info-title-required
API info must have a title.
$.info
warn
info-description-required
API info must have a description.
$.info
error
info-version-required
API info must have a version.
$.info
warn
openapi-version-3
APIs should use OpenAPI 3.x specification.
$
error
servers-defined
At least one server must be defined.
$
error
servers-https-only
All server URLs must use HTTPS.
$.servers[*]
info
servers-description-required
Each server should have a description.
$.servers[*]
warn
paths-no-trailing-slash
Path must not have a trailing slash.
$.paths[*]~
error
paths-no-query-string
Path must not contain a query string.
$.paths[*]~
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-summary-adyen-prefix
Operation summaries should start with "Adyen".
$.paths[*][get,post,put,patch,delete,head,options].summary
warn
operation-description-required
Every operation should have a description.
$.paths[*][get,post,put,patch,delete,head,options]
error
operation-id-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete,head,options]
warn
operation-id-camel-case
operationId should use camelCase.
$.paths[*][get,post,put,patch,delete,head,options].operationId
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete,head,options]
warn
parameter-description-required
Every parameter must have a description.
$.paths[*][get,post,put,patch,delete,head,options].parameters[*]
error
parameter-schema-required
Every parameter must have a schema.
$.paths[*][get,post,put,patch,delete,head,options].parameters[*]
warn
parameter-api-key-in-header
API keys should be passed in headers, not query parameters.
$.components.securitySchemes[?(@.type=='apiKey')]
info
request-body-description
Request body should have a description.
$.paths[*][post,put,patch].requestBody
warn
request-body-content-json
Request body should support application/json content type.
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must have at least one 2xx response.
$.paths[*][get,post,put,patch,delete]
error
response-description-required
Every response must have a description.
$.paths[*][get,post,put,patch,delete].responses[*]
info
response-401-defined
Operations with authentication should define a 401 response.
$.paths[*][get,post,put,patch,delete].responses
info
schema-description-required
Top-level schemas should have a description.
$.components.schemas[*]
warn
schema-type-defined
Schema properties should define a type.
$.components.schemas[*].properties[*]
error
security-schemes-defined
Security schemes must be defined in components.
$.components
info
security-scheme-description
Security schemes should have a description.
$.components.securitySchemes[*]
warn
security-api-key-header-name
Adyen API key header should be named X-API-Key.
$.components.securitySchemes[?(@.type=='apiKey')]
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body.
$.paths[*].delete
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..[description]
info
microcks-operation-present
Each operation should have x-microcks-operation for mock server support.
$.paths[*][get,post,put,patch,delete]