Oracle Cloud Infrastructure · API Governance Rules
Oracle Cloud Infrastructure API Rules
Spectral linting rules defining API design standards and conventions for Oracle Cloud Infrastructure.
25 Rules
error 14
warn 8
info 3
Rule Categories
delete
get
info
microcks
no
openapi
operation
parameter
paths
response
schema
security
server
servers
Rules
error
info-title-format
Info title must start with "Oracle Cloud"
$.info.title
error
info-description-required
Info description is required
$.info
error
info-version-required
API version is required
$.info
error
openapi-version
OpenAPI version must be 3.0.x
$
error
servers-defined
Servers array must be defined
$
error
server-https
Server URLs must use HTTPS
$.servers[*].url
info
paths-kebab-case
Path segments should use camelCase (OCI convention)
$.paths
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,delete,patch]
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 "Oracle Cloud"
$.paths[*][get,post,put,delete,patch].summary
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,delete,patch]
warn
operation-operationid-camel-case
OperationId should use camelCase
$.paths[*][get,post,put,delete,patch].operationId
warn
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,delete,patch].parameters[*]
error
parameter-schema-required
Every parameter must have a schema
$.paths[*][get,post,put,delete,patch].parameters[*]
error
response-success-required
Operations must define at least one success response (2xx)
$.paths[*][get,post,put,delete,patch].responses
warn
response-description-required
Every response must have a description
$.paths[*][get,post,put,delete,patch].responses[*]
info
schema-properties-camel-case
Schema property names should use camelCase (OCI convention)
$.components.schemas[*].properties
warn
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
error
security-global-defined
Global security must be defined
$
error
security-schemes-defined
Security schemes must be defined
$.components
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
error
no-empty-descriptions
Descriptions must not be empty
$..description
info
microcks-operation-extension
Operations should include x-microcks-operation extension
$.paths[*][get,post,put,delete,patch]