2020 Police Brutality · API Governance Rules
2020 Police Brutality API Rules
Spectral linting rules defining API design standards and conventions for 2020 Police Brutality.
19 Rules
error 10
warn 7
info 2
Rule Categories
get
info
no
openapi
operation
response
schema
servers
tags
Rules
error
info-title-required
API info title must be present.
$.info
warn
info-description-required
API info description must be present and meaningful.
$.info
error
info-version-required
API version must be defined.
$.info
warn
info-license-required
Open data APIs should include a license.
$.info
error
openapi-version-3
Must use OpenAPI 3.0.x.
$
error
servers-must-be-defined
Servers array must be defined.
$
warn
servers-description-required
Each server should have a description.
$.servers[*]
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
operation-description-required
Every operation should have a description.
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
error
response-success-required
Every operation must define at least one 2xx response.
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Every response must have a description.
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-description-required
Component schemas should have descriptions.
$.components.schemas[*]
warn
schema-type-required
Schemas should define a type.
$.components.schemas[*]
info
schema-properties-described
Schema properties should have descriptions.
$.components.schemas[*].properties[*]
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
warn
no-empty-descriptions
Descriptions must not be empty strings.
$..description
info
tags-defined
Global tags array should be defined for documentation.
$