GitLab · API Governance Rules
GitLab API Rules
Spectral linting rules defining API design standards and conventions for GitLab.
24 Rules
error 15
warn 6
info 3
Rule Categories
get
info
no
openapi
operation
parameter
paths
request
response
schema
security
servers
tags
Rules
error
info-title-required
API title must be present.
$.info
warn
info-title-format
Title should start with "GitLab".
$.info.title
error
info-description-required
API description must be present.
$.info
error
info-version-required
API version must be specified.
$.info
error
openapi-version-3
OpenAPI version must be 3.0.x.
$
error
servers-defined
At least one server must be defined.
$
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
error
paths-no-trailing-slash
Paths must not have trailing slashes.
$.paths
info
paths-snake-case
Path segments should use snake_case (GitLab convention).
$.paths
error
operation-description-required
Every operation must 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-operationid-unique
Operation IDs must be unique.
$
warn
operation-tags-required
Every operation must have at least one tag.
$.paths[*][get,post,put,patch,delete]
info
tags-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[*]
warn
parameter-snake-case
Parameter names should use snake_case (GitLab convention).
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
request-body-json
Request bodies should use application/json.
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must define a success 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-names-pascalcase
Schema names should use PascalCase.
$.components.schemas
info
schema-properties-snake-case
Schema properties should use snake_case (GitLab convention).
$.components.schemas[*].properties
warn
security-schemes-defined
Security schemes should be defined.
$.components
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
error
no-empty-descriptions
Descriptions must not be empty.
$..description