Ariba Sourcing · API Governance Rules
Ariba Sourcing API Rules
Spectral linting rules defining API design standards and conventions for Ariba Sourcing.
28 Rules
error 15
warn 9
info 4
Rule Categories
get
info
microcks
openapi
operation
parameter
paths
rate
request
response
schema
security
servers
Rules
error
info-title-required
API title must be defined and follow the "Ariba Sourcing - {API Name}" pattern.
$.info
warn
info-title-prefix
API title should start with "Ariba Sourcing".
$.info.title
error
info-description-required
API info must have a description.
$.info
error
info-version-required
API version must be defined.
$.info
error
openapi-version-3
APIs must use OpenAPI 3.0.x.
$
error
servers-required
Servers must be defined.
$
error
servers-https-only
All server URLs must use HTTPS.
$.servers[*].url
warn
servers-openapi-ariba-host
Production server should use openapi.ariba.com host.
$.servers[*].url
warn
paths-no-trailing-slash
Paths must not have a trailing slash.
$.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 "Ariba Sourcing".
$.paths[*][get,post,put,patch,delete].summary
error
operation-description-required
Every operation must have a description.
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId.
$.paths[*][get,post,put,patch,delete]
warn
operation-id-camel-case
operationId 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]
error
parameter-description-required
All parameters must have a description.
$.paths[*][get,post,put,patch,delete].parameters[*]
info
parameter-realm-required
SAP Ariba APIs require a realm query parameter.
$.paths[*][get,post,put,patch,delete].parameters[?(@.name == 'realm')]
warn
request-body-description-recommended
Request bodies should have a description.
$.paths[*][post,put,patch].requestBody
error
response-success-required
Every operation must have a success response.
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-recommended
Operations should define a 401 Unauthorized response.
$.paths[*][get,post,put,patch,delete].responses
warn
response-500-recommended
Operations should define a 500 Internal Server Error 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[*]
info
schema-property-description-recommended
Schema properties should have descriptions.
$.components.schemas[*].properties[*]
error
security-schemes-defined
Security schemes must be defined in components.
$.components.securitySchemes
warn
security-oauth2-token-url
OAuth2 token URL should use api.ariba.com.
$.components.securitySchemes.OAuth2.flows.clientCredentials.tokenUrl
info
rate-limits-documented
Rate limit information should be documented in the API description.
$.info.description
error
get-no-request-body
GET operations must not have a request body.
$.paths[*].get
info
microcks-operation-extension
Operations should include x-microcks-operation.
$.paths[*][get,post,put,patch,delete]