Apache Jena · API Governance Rules
Apache Jena API Rules
Spectral linting rules defining API design standards and conventions for Apache Jena.
15 Rules
error 8
warn 4
info 3
Rule Categories
info
no
openapi
operation
parameter
paths
response
schema
servers
sparql
Rules
warn
info-title-prefix
Info title should start with Apache Jena
$.info
error
info-version-required
Info must have a version
$.info
error
openapi-version
Must use OpenAPI 3.x
$
error
servers-defined
Servers must be defined
$
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
error
response-description-required
Responses must have descriptions
$.paths[*][get,post,put,patch,delete].responses[*]
error
response-2xx-required
Every operation must have a 2xx response
$.paths[*][get,post,put,patch,delete].responses
warn
response-400-sparql
SPARQL endpoints should document 400 for invalid queries
$.paths[*].post.responses
info
sparql-media-types
SPARQL query endpoints should support sparql-results+json
$.paths[*].get.responses.200.content
warn
no-empty-descriptions
Descriptions must not be empty
$..description
info
schema-description-required
Component schemas should have descriptions
$.components.schemas[*]
warn
parameter-description-required
Parameters should have descriptions
$.paths[*][get,post].parameters[*]
info
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths