trello · API Governance Rules
trello API Rules
Spectral linting rules defining API design standards and conventions for trello.
20 Rules
error 4
warn 14
info 2
Rule Categories
no
operation
path
query
schema
servers
trello
Rules
warn
trello-operation-id-camel-case
Operation IDs must use camelCase
$.paths[*][*].operationId
warn
trello-summary-title-case
Operation summaries must use Title Case
$.paths[*][*].summary
error
trello-security-defined
All operations must define security requirements
$.paths[*][get,post,put,patch,delete]
error
trello-response-200-get
All GET operations must define a 200 response
$.paths[*].get
warn
trello-tag-defined
All operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
info
trello-api-key-auth
Trello uses API key and token query parameter authentication
$.components.securitySchemes
warn
trello-path-kebab-case
API paths should use kebab-case
$.paths[*]~
warn
trello-response-400-defined
Operations with request bodies should define a 400 response
$.paths[*][post,put,patch]
warn
trello-delete-response
DELETE operations should return 200 or 204
$.paths[*].delete
warn
trello-post-request-body
POST operations that create resources should define a request body
$.paths[*].post
error
trello-no-query-strings-in-path
Query string parameters must not appear in path definitions
$.paths[*]~
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-expected-domain
Server URLs should be on the trello.com 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
info
schema-properties-casing
Schema properties should be snake_case (the dominant convention in this API).
$.components.schemas[*].properties
warn
operation-documents-401
Operations should document a 401 response (documented on 100% of this API's operations).
$.paths[*][get,post,put,patch,delete].responses
warn
operation-documents-404
Operations should document a 404 response (documented on 88% of this API's operations).
$.paths[*][get,post,put,patch,delete].responses
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description