Abortion Policy API · API Governance Rules
Abortion Policy API API Rules
Spectral linting rules defining API design standards and conventions for Abortion Policy API.
32 Rules
error 16
warn 15
info 1
Rule Categories
delete
examples
get
info
no
openapi
operation
parameter
paths
response
schema
security
server
servers
tag
tags
Rules
error
info-title-required
API info must have a title.
$.info
warn
info-title-format
API title should follow the "Abortion Policy API ..." naming pattern.
$.info.title
error
info-description-required
API info must have a description.
$.info
error
info-version-required
API info must have a version.
$.info
error
openapi-version
API must use OpenAPI 3.x.
$
error
servers-required
At least one server must be defined.
$
error
server-https-required
All server URLs must use HTTPS.
$.servers[*].url
warn
server-description-required
Each server should have a description.
$.servers[*]
warn
paths-kebab-case
Path segments should use kebab-case or underscore_case.
$.paths
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries should start with "Abortion Policy API".
$.paths[*][get,post,put,patch,delete].summary
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]
warn
operation-operationid-camelcase
OperationIds must use camelCase.
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
warn
tags-array-defined
Global tags array should be defined.
$
warn
tag-description-required
Each global tag should have a description.
$.tags[*]
warn
tag-name-title-case
Tag names should use Title Case.
$.tags[*].name
error
parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
error
parameter-schema-required
All parameters must have a schema.
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Every operation must have at least one 2xx response.
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-required
Every authenticated operation should have a 401 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
schema-property-description
Top-level schemas should have descriptions.
$.components.schemas[*]
warn
schema-type-defined
All schemas should have a type defined.
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined in components.
$.components
warn
security-scheme-description
Security schemes should have descriptions.
$.components.securitySchemes[*]
warn
operation-security-defined
Every operation should have security defined.
$.paths[*][get,post,put,patch,delete]
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
warn
delete-no-request-body
DELETE operations must not have a request body.
$.paths[*].delete
error
no-empty-descriptions
Descriptions must not be empty strings.
$..description
info
examples-encouraged
Operations should have examples for better developer experience.
$.paths[*][get,post,put,patch,delete].responses[*].content[*]