Basetrip · API Governance Rules
Basetrip API Rules
Spectral linting rules defining API design standards and conventions for Basetrip.
15 Rules
error 6
warn 9
Rule Categories
basetrip
Rules
error
basetrip-api-key-required
All operations must require X-API-Key header authentication.
$.paths.*.*.security
error
basetrip-operation-id-required
All operations must have an operationId.
$.paths.*.*
warn
basetrip-operation-id-camel-case
Operation IDs must use camelCase.
$.paths.*.*.operationId
error
basetrip-summary-required
All operations must have a summary.
$.paths.*.*
warn
basetrip-summary-title-case
Operation summaries must use Title Case.
$.paths.*.*.summary
error
basetrip-tags-required
All operations must be tagged.
$.paths.*.*
warn
basetrip-description-required
All operations must have a description.
$.paths.*.*
error
basetrip-200-response-required
All GET operations must have a 200 response.
$.paths.*.get.responses
warn
basetrip-401-response-defined
Operations should document 401 Unauthorized responses.
$.paths.*.get.responses
warn
basetrip-404-response-defined
Operations on parameterized paths should document 404 responses.
$.paths[*~/*{id}*].*.responses
warn
basetrip-path-kebab-case
Path segments must use kebab-case.
$.paths[*]~
warn
basetrip-schema-description-required
All schema properties should have descriptions.
$.components.schemas.*.properties.*
warn
basetrip-response-schema-ref
Responses should reference schemas using $ref rather than inline definitions.
$.paths.*.*.responses.*.content.application/json.schema
warn
basetrip-info-contact-required
API info must include contact details.
$.info
error
basetrip-server-url-https
Server URLs must use HTTPS.
$.servers.*.url