Apache CouchDB · API Governance Rules
Apache CouchDB API Rules
Spectral linting rules defining API design standards and conventions for Apache CouchDB.
28 Rules
error 11
warn 15
info 2
Rule Categories
delete
examples
get
info
no
openapi
operation
parameter
paths
request
response
schema
security
servers
tag
Rules
error
info-title-required
OpenAPI info title must be present
$.info
warn
info-description-required
OpenAPI info must have a description
$.info
error
info-version-required
OpenAPI info must include a version
$.info
warn
openapi-version-3
All specs must use OpenAPI 3.0.x
$
error
servers-required
At least one server must be defined
$
warn
servers-https
Production servers should use HTTPS
$.servers[*]
warn
paths-kebab-case
Path segments should use kebab-case (lowercase, hyphens allowed)
$.paths[*]~
warn
paths-no-trailing-slash
Paths must not have a trailing slash
$.paths[*]~
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-operationid-camel-case
operationId should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
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 "Apache CouchDB"
$.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-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
tag-global-defined
All tags used in operations should be defined globally
$
warn
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[*]
warn
request-body-content-type
Request bodies should use application/json content type
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must have at least one 2xx response
$.paths[*][get,post,put,patch,delete].responses
warn
response-404-for-get
GET operations on resource paths should include a 404 response
$.paths[*].get.responses
error
response-description-required
All responses must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
info
schema-property-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
warn
schema-type-defined
Top-level schemas should have a type defined
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined if security is declared
$
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body
$.paths[*].delete
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
examples-encouraged
Schema properties are encouraged to have examples
$.components.schemas[*].properties[*]