Taxi - Describe How Your APIs and Data Relate · API Governance Rules
Taxi - Describe How Your APIs and Data Relate API Rules
Spectral linting rules defining API design standards and conventions for Taxi - Describe How Your APIs and Data Relate.
16 Rules
error 3
warn 13
Rule Categories
error
no
path
query
schema
servers
taxi
Rules
warn
taxi-operation-ids-camel-case
Operation IDs must use camelCase
$.paths[*][*].operationId
warn
taxi-path-kebab-case
Path segments must use kebab-case
$.paths[*]~
error
taxi-operation-summary-exists
All operations must have a summary
$.paths[*][get,post,put,patch,delete]
warn
taxi-operation-description-exists
All operations must have a description
$.paths[*][get,post,put,patch,delete]
error
taxi-response-200-exists
All operations must define a 200 response
$.paths[*][get,post,put,patch,delete].responses
warn
taxi-tags-title-case
Tags must use Title Case
$.tags[*].name
warn
taxi-info-license
API must include license information (open source)
$.info
warn
taxi-schema-descriptions
Component schemas must have descriptions
$.components.schemas[*]
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-expected-domain
Server URLs should be on the taxilang.org domain.
$.servers[*].url
warn
path-params-casing
Path parameters should be snake_case (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
query-params-casing
Query parameters should be snake_case (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
warn
schema-properties-casing
Schema properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
error-schema-defined
A shared error schema (Error) should be defined for error payloads.
$.components.schemas
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description