Allianz Future Cloud Platform · API Governance Rules
Allianz Future Cloud Platform API Rules
Spectral linting rules defining API design standards and conventions for Allianz Future Cloud Platform.
24 Rules
error 15
warn 6
info 3
Rule Categories
async
get
info
openapi
operation
parameter
paths
response
schema
security
servers
tags
Rules
warn
info-title-allianz-prefix
API title must start with "Allianz"
$.info.title
error
info-description-required
API info must have a description
$.info
error
info-version-required
API info must define a version
$.info
error
openapi-version-3
Specs must use OpenAPI 3.x
$.openapi
error
servers-defined
At least one server must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
warn
paths-kebab-case
Path segments must use kebab-case
$.paths
info
paths-versioned
API paths should be prefixed with /api or contain versioning
$.paths
error
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-allianz-prefix
Summaries must start with "Allianz Future Cloud Platform"
$.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-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-id-camel-case
operationId must use camelCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
tags-defined
Global tags array should be defined
$
error
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Every operation must define a success response
$.paths[*][get,post,put,patch,delete]
warn
response-401-required
Operations should define a 401 response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
All responses must have descriptions
$.paths[*][get,post,put,patch,delete].responses[*]
error
security-schemes-defined
Security schemes must be defined
$.components
error
get-no-request-body
GET operations must not have request bodies
$.paths[*].get
info
schema-properties-described
Schema properties should have descriptions
$.components.schemas[*].properties[*]
info
async-operations-return-202
Async operations should return 202 Accepted
$.paths[*].post.operationId