Air Quality Programmatic APIs · API Governance Rules
Air Quality Programmatic APIs API Rules
Spectral linting rules defining API design standards and conventions for Air Quality Programmatic APIs.
10 Rules
error 5
warn 5
Rule Categories
info
operation
parameter
response
servers
token
Rules
warn
info-title-aqicn
API title should start with "Air Quality" or "AQICN"
$.info.title
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation should have tags
$.paths[*][get,post,put,patch,delete]
warn
token-parameter-required
API token query parameter should be documented on all operations
$.paths[*][get,post,put,patch,delete].parameters[?(@.name == 'token')]
error
response-200-required
Operations must define a 200 response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
All responses must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
parameter-description-required
All parameters should have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
error
servers-defined
Servers must be defined
$
warn
servers-https
Server URLs should use HTTPS
$.servers[*].url