Avaloq · API Governance Rules
Avaloq API Rules
Spectral linting rules defining API design standards and conventions for Avaloq.
25 Rules
error 9
warn 15
info 1
Rule Categories
avaloq
Rules
error
avaloq-info-title-required
Avaloq APIs must have a title in the info object.
$.info
error
avaloq-info-version-required
Avaloq APIs must define a version.
$.info
warn
avaloq-info-description-required
Avaloq APIs must have a description.
$.info
warn
avaloq-info-contact-required
Avaloq APIs must include contact information.
$.info
error
avaloq-servers-required
Avaloq APIs must define at least one server.
$
error
avaloq-server-url-https
Avaloq server URLs must use HTTPS.
$.servers[*]
warn
avaloq-paths-kebab-case
Avaloq path segments must use kebab-case.
$.paths
error
avaloq-operation-summary-required
All Avaloq operations must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
avaloq-operation-description-required
All Avaloq operations must have a description.
$.paths[*][get,post,put,patch,delete]
error
avaloq-operation-id-required
All Avaloq operations must have an operationId.
$.paths[*][get,post,put,patch,delete]
warn
avaloq-operation-tags-required
All Avaloq operations must have at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
avaloq-parameters-description-required
All Avaloq parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
avaloq-request-body-description
Avaloq request bodies must have a description.
$.paths[*][post,put,patch].requestBody
error
avaloq-response-200-required
Avaloq GET operations must have a 200 response.
$.paths[*].get.responses
warn
avaloq-response-400-required
Avaloq operations must document 400 errors.
$.paths[*][get,post,put,patch,delete].responses
warn
avaloq-response-401-required
Avaloq operations must document 401 unauthorized.
$.paths[*][get,post,put,patch,delete].responses
warn
avaloq-schema-properties-described
Avaloq schema properties must have descriptions.
$.components.schemas[*].properties[*]
warn
avaloq-schema-type-required
Avaloq schema properties must have a type.
$.components.schemas[*].properties[*]
error
avaloq-security-defined
Avaloq APIs must define security schemes.
$.components
warn
avaloq-bearer-auth-required
Avaloq APIs must use Bearer/JWT authentication.
$.components.securitySchemes[*]
error
avaloq-get-no-request-body
Avaloq GET operations must not have a request body.
$.paths[*].get
warn
avaloq-delete-no-request-body
Avaloq DELETE operations must not have a request body.
$.paths[*].delete
warn
avaloq-post-returns-201
Avaloq POST creation operations should return 201.
$.paths[*].post.responses
info
avaloq-schema-example-provided
Avaloq schemas should have examples.
$.components.schemas[*]
warn
avaloq-response-content-type
Avaloq API responses must specify content type.
$.paths[*][get,post,put,patch].responses[*]