Ariba Guided Buying · API Governance Rules
Ariba Guided Buying API Rules
Spectral linting rules defining API design standards and conventions for Ariba Guided Buying.
34 Rules
error 16
warn 15
info 3
Rule Categories
delete
get
info
microcks
openapi
operation
parameter
paths
request
response
schema
security
servers
Rules
error
info-title-required
API title must be defined and follow the "Ariba Guided Buying - {API Name}" pattern.
$.info
warn
info-title-prefix
API title should start with "Ariba Guided Buying".
$.info.title
error
info-description-required
API info must have a description.
$.info
error
info-version-required
API version must be defined.
$.info
warn
info-contact-required
API info should include contact information.
$.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-kebab-case
Path segments must use kebab-case.
$.paths[*]~
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 Guided Buying".
$.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[*]
error
parameter-schema-required
All parameters must have a schema.
$.paths[*][get,post,put,patch,delete].parameters[*]
info
parameter-realm-naming
Realm parameter should be named "realm" (SAP Ariba convention).
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
request-body-description-required
Request bodies should have a description.
$.paths[*][post,put,patch].requestBody
warn
request-body-json-content
Request bodies should define application/json content.
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must have a 200 or 201 success response.
$.paths[*][get,post,put,patch,delete].responses
warn
response-400-recommended
Operations should define a 400 Bad Request 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[*]
warn
schema-type-defined
Component schemas should define a type.
$.components.schemas[*]
error
security-schemes-defined
Security schemes must be defined in components.
$.components.securitySchemes
warn
security-oauth2-ariba
SAP Ariba APIs should use OAuth 2.0 with api.ariba.com token URL.
$.components.securitySchemes.OAuth2.flows.clientCredentials.tokenUrl
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
info
microcks-operation-extension
Operations should include x-microcks-operation for mock server configuration.
$.paths[*][get,post,put,patch,delete]