Bancomat · API Governance Rules

Bancomat API Rules

Spectral linting rules defining API design standards and conventions for Bancomat.

10 Rules error 5 warn 5
View Rules File View on GitHub

Rule Categories

bancomat

Rules

error
bancomat-info-title-required
API title must be present.
$.info
warn
bancomat-info-description-required
API description must be present.
$.info
error
bancomat-info-version-required
API version must be present.
$.info
error
bancomat-operation-id-required
All operations must have an operationId.
$.paths[*][get,post,put,patch,delete]
warn
bancomat-operation-summary-required
All operations must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
bancomat-payment-status-response
Payment endpoints must return a status field.
$.components.schemas.Payment.properties
error
bancomat-security-required
All BANCOMAT APIs must define security schemes.
$
error
bancomat-response-200-required
GET operations must define a 200 response.
$.paths[*].get.responses
warn
bancomat-error-response-schema
Error responses must include a schema.
$.paths[*][*].responses[4XX].content[*]
warn
bancomat-schema-description-required
All named schemas must have a description.
$.components.schemas[*]