Bancontact · API Governance Rules
Bancontact API Rules
Spectral linting rules defining API design standards and conventions for Bancontact.
12 Rules
error 5
warn 6
info 1
Rule Categories
bancontact
Rules
error
bancontact-info-title-required
API title must be present.
$.info
warn
bancontact-info-description-required
API description must be present.
$.info
error
bancontact-info-version-required
API version must be present.
$.info
error
bancontact-operation-id-required
All operations must have an operationId.
$.paths[*][get,post,put,patch,delete]
warn
bancontact-operation-summary-required
All operations must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
bancontact-payment-status-field
Payment response schemas must include a status field.
$.components.schemas.Payment.properties
error
bancontact-payment-amount-required
Payment request schemas must include amount.
$.components.schemas.PaymentRequest.properties
error
bancontact-security-required
All Bancontact APIs must define security schemes.
$
info
bancontact-webhook-callback
Payment operations should document webhook callbacks.
$.paths[*].post
warn
bancontact-response-201-for-post
POST operations should return 201 on resource creation.
$.paths[*].post.responses
warn
bancontact-error-response-schema
Error responses must include a schema.
$.paths[*][*].responses[4XX].content[*]
warn
bancontact-schema-description-required
All named schemas must have a description.
$.components.schemas[*]