Vehicle Databases API Rules
Spectral linting rules defining API design standards and conventions for Vehicle Databases.
27 Rules
error 10
warn 15
info 2
Rule Categories
get
info
no
openapi
operation
parameter
path
paths
query
response
schema
security
servers
Rules
error
info-title-required
Info title must be defined.
$.info
warn
info-description-required
Info description must be non-empty.
$.info
error
info-version-required
API version must be defined.
$.info
error
openapi-version-3
Must use OpenAPI 3.x.
$
error
servers-defined
At least one server must be defined.
$
error
servers-https
Server URLs must use HTTPS.
$.servers[*].url
warn
paths-kebab-case
Path segments should use kebab-case.
$.paths[*]~
error
operation-summary-required
Every operation must have a summary.
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-prefix
Operation summaries must start with "Vehicle Databases".
$.paths[*][get,post,put,delete,patch].summary
warn
operation-description-required
Every operation must have a description.
$.paths[*][get,post,put,delete,patch]
error
operation-operationid-required
Every operation must have an operationId.
$.paths[*][get,post,put,delete,patch]
warn
operation-operationid-camelcase
operationId must use camelCase.
$.paths[*][get,post,put,delete,patch].operationId
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
All parameters must have a description.
$..parameters[*]
error
response-success-required
Every operation must have a 2xx response.
$.paths[*][get,post,put,delete,patch].responses
warn
response-404-defined
Operations with path parameters should define 404 responses.
$.paths[*][get].responses
warn
schema-description-required
Component schemas must have descriptions.
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined.
$.components
info
security-apikey-header
API key authentication should use header placement (X-API-Key).
$.components.securitySchemes[?(@.type == 'apiKey')]
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
warn
no-empty-descriptions
Descriptions must not be empty.
$..description
warn
servers-expected-domain
Server URLs should be on the vehicledatabases.com domain.
$.servers[*].url
warn
path-params-casing
Path parameters should be camelCase (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-404
Operations should document a 404 response (documented on 100% of this API's operations).
$.paths[*][get,post,put,patch,delete].responses
Spectral Ruleset
# vehicle-databases — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
# - servers-https-only: 100% of servers already https (error)
# - servers-expected-domain: 1/1 servers on vehicledatabases.com
# - path-params-casing: camel @ 80% (n=5)
# - query-params-casing: snake @ 86% (n=7)
# - operationid-casing: camel @ 100% (n=6)
# - schema-names-casing: pascal @ 90% (n=10)
# - schema-properties-casing: snake @ 61% (n=54)
# - security: global (root) — NOT emitting operation-security-required
# - operation-documents-404: 100% adherence
# - merge: kept 21 existing, added 6 measured, upgraded 0
# - added: servers-expected-domain, path-params-casing, query-params-casing, schema-names-casing, schema-properties-casing, operation-documents-404
extends:
- spectral:oas
rules:
info-title-required:
description: Info title must be defined.
severity: error
given: $.info
then:
field: title
function: truthy
info-description-required:
description: Info description must be non-empty.
severity: warn
given: $.info
then:
field: description
function: truthy
info-version-required:
description: API version must be defined.
severity: error
given: $.info
then:
field: version
function: truthy
openapi-version-3:
description: Must use OpenAPI 3.x.
severity: error
given: $
then:
field: openapi
function: pattern
functionOptions:
match: ^3\.
servers-defined:
description: At least one server must be defined.
severity: error
given: $
then:
field: servers
function: truthy
servers-https:
description: Server URLs must use HTTPS.
severity: error
given: $.servers[*].url
then:
function: pattern
functionOptions:
match: ^https://
paths-kebab-case:
description: Path segments should use kebab-case.
severity: warn
given: $.paths[*]~
then:
function: pattern
functionOptions:
match: ^(/[a-z0-9{}_/-]+)+$
operation-summary-required:
description: Every operation must have a summary.
severity: error
given: $.paths[*][get,post,put,delete,patch]
then:
field: summary
function: truthy
operation-summary-prefix:
description: Operation summaries must start with "Vehicle Databases".
severity: warn
given: $.paths[*][get,post,put,delete,patch].summary
then:
function: pattern
functionOptions:
match: '^Vehicle Databases '
operation-description-required:
description: Every operation must have a description.
severity: warn
given: $.paths[*][get,post,put,delete,patch]
then:
field: description
function: truthy
operation-operationid-required:
description: Every operation must have an operationId.
severity: error
given: $.paths[*][get,post,put,delete,patch]
then:
field: operationId
function: truthy
operation-operationid-camelcase:
description: operationId must use camelCase.
severity: warn
given: $.paths[*][get,post,put,delete,patch].operationId
then:
function: pattern
functionOptions:
match: ^[a-z][a-zA-Z0-9]+$
operation-tags-required:
description: Every operation must have at least one tag.
severity: warn
given: $.paths[*][get,post,put,delete,patch]
then:
field: tags
function: truthy
parameter-description-required:
description: All parameters must have a description.
severity: warn
given: $..parameters[*]
then:
field: description
function: truthy
response-success-required:
description: Every operation must have a 2xx response.
severity: error
given: $.paths[*][get,post,put,delete,patch].responses
then:
function: schema
functionOptions:
schema:
type: object
anyOf:
- required:
- '200'
- required:
- '201'
response-404-defined:
description: Operations with path parameters should define 404 responses.
severity: warn
given: $.paths[*][get].responses
then:
function: schema
functionOptions:
schema:
type: object
required:
- '404'
schema-description-required:
description: Component schemas must have descriptions.
severity: warn
given: $.components.schemas[*]
then:
field: description
function: truthy
security-schemes-defined:
description: Security schemes must be defined.
severity: error
given: $.components
then:
field: securitySchemes
function: truthy
security-apikey-header:
description: API key authentication should use header placement (X-API-Key).
severity: info
given: $.components.securitySchemes[?(@.type == 'apiKey')]
then:
field: in
function: pattern
functionOptions:
match: ^header$
get-no-request-body:
description: GET operations must not have a request body.
severity: error
given: $.paths[*].get
then:
field: requestBody
function: falsy
no-empty-descriptions:
description: Descriptions must not be empty.
severity: warn
given: $..description
then:
function: pattern
functionOptions:
match: .+
servers-expected-domain:
description: Server URLs should be on the vehicledatabases.com domain.
severity: warn
given: $.servers[*].url
then:
function: pattern
functionOptions:
match: vehicledatabases\.com
path-params-casing:
description: Path parameters should be camelCase (the dominant convention in this API).
severity: warn
given: $.paths[*].parameters[?(@.in=='path')].name
then:
function: casing
functionOptions:
type: camel
query-params-casing:
description: Query parameters should be snake_case (the dominant convention in this API).
severity: warn
given: $.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
then:
field: name
function: casing
functionOptions:
type: snake
schema-names-casing:
description: Component schema names should be PascalCase (the dominant convention in this API).
severity: warn
given: $.components.schemas
then:
field: '@key'
function: pattern
functionOptions:
match: ^[A-Z][A-Za-z0-9]*$
schema-properties-casing:
description: Schema properties should be snake_case (the dominant convention in this API).
severity: info
given: $.components.schemas[*].properties
then:
field: '@key'
function: casing
functionOptions:
type: snake
operation-documents-404:
description: Operations should document a 404 response (documented on 100% of this API's operations).
severity: warn
given: $.paths[*][get,post,put,patch,delete].responses
then:
field: '404'
function: truthy