Oracle Integration · API Governance Rules
Oracle Integration API Rules
Spectral linting rules defining API design standards and conventions for Oracle Integration.
36 Rules
error 19
warn 11
info 6
Rule Categories
delete
examples
get
info
microcks
no
openapi
operation
parameter
paths
request
response
schema
security
servers
tag
Rules
error
info-title-must-start-with-oracle
Info title must start with "Oracle Integration".
$.info.title
error
info-description-required
Info description is required and must be at least 50 characters.
$.info
error
info-version-required
Info version is required.
$.info
warn
info-contact-required
Info contact information is required.
$.info
warn
info-license-required
Info license information is required.
$.info
error
openapi-version-3
OpenAPI version must be 3.0.x.
$.openapi
error
servers-defined
At least one server must be defined.
$
error
servers-https-required
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-description-required
Each server must have a description.
$.servers[*]
info
paths-kebab-case
Path segments should use kebab-case or camelCase consistently.
$.paths
error
paths-no-trailing-slash
Paths must not have a trailing slash.
$.paths
error
paths-no-query-strings
Paths must not contain query strings.
$.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 "Oracle Integration".
$.paths[*][get,post,put,patch,delete].summary
warn
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]
warn
operation-operationid-camelcase
Operation IDs should 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]
info
tag-description-required
Global tags should have descriptions.
$.tags[*]
warn
tag-title-case
Tag names should use Title Case.
$.tags[*].name
warn
parameter-description-required
Every parameter must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
error
parameter-schema-required
Every parameter must have a schema with a type.
$.paths[*][get,post,put,patch,delete].parameters[*]
info
request-body-json-content
Request bodies should use application/json content type.
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must have a 2xx success response.
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-recommended
Operations should include a 401 Unauthorized response.
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Every response must have a description.
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-properties-camelcase
Schema property names should use camelCase.
$.components.schemas[*].properties
error
schema-type-defined
Schemas must have a type defined.
$.components.schemas[*]
info
schema-description-recommended
Top-level schemas should have descriptions.
$.components.schemas[*].properties[*]
error
security-global-defined
Global security must be defined.
$
error
security-schemes-defined
Security schemes must be defined in components.
$.components
error
get-no-request-body
GET operations should not have a request body.
$.paths[*].get
warn
delete-no-request-body
DELETE operations should not have a request body.
$.paths[*].delete
error
no-empty-descriptions
Descriptions must not be empty strings.
$.paths[*][get,post,put,patch,delete].description
info
examples-encouraged
Schema properties should include example values.
$.components.schemas[*].properties[*]
info
microcks-extension-recommended
Operations should include x-microcks-operation for mock server compatibility.
$.paths[*][get,post,put,patch,delete]