Adobe · API Governance Rules
Adobe API Rules
Spectral linting rules defining API design standards and conventions for Adobe.
18 Rules
error 8
warn 9
info 1
Rule Categories
error
info
no
operation
operationid
path
response
schema
security
servers
Rules
error
info-title-required
Info title must be present
$.info
error
info-description-required
Info description must be present
$.info
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-summary-required
Every operation must have a summary
$.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
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
error
no-empty-descriptions
Descriptions must not be empty
$..description
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-expected-domain
Server URLs should be on the adobe.io domain.
$.servers[*].url
warn
path-params-casing
Path parameters should be camelCase (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
operationid-casing
Operation IDs should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
info
schema-properties-casing
Schema properties should be camelCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
security-schemes-defined
Security schemes should be defined in components.
$.components
warn
error-schema-defined
A shared error schema (ErrorResponse) should be defined for error payloads.
$.components.schemas
warn
operation-documents-400
Operations should document a 400 response (documented on 86% of this API's operations).
$.paths[*][get,post,put,patch,delete].responses
warn
operation-documents-401
Operations should document a 401 response (documented on 91% of this API's operations).
$.paths[*][get,post,put,patch,delete].responses
warn
operation-documents-429
Operations should document a 429 response (documented on 86% of this API's operations).
$.paths[*][get,post,put,patch,delete].responses
Spectral Ruleset
# adobe — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
# - servers-https-only: 100% of servers already https (error)
# - servers-expected-domain: 2/2 servers on adobe.io
# - path-params-casing: camel @ 100% (n=4)
# - operationid-casing: camel @ 100% (n=22)
# - schema-names-casing: pascal @ 100% (n=25)
# - schema-properties-casing: camel @ 84% (n=61)
# - security: global (root) — NOT emitting operation-security-required
# - error-schema-defined: ErrorResponse
# - operation-documents-400: 86% adherence
# - operation-documents-401: 91% adherence
# - operation-documents-429: 86% adherence
# - merge: kept 7 existing, added 11 measured, upgraded 0
# - added: servers-https-only, servers-expected-domain, path-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, security-schemes-defined, error-schema-defined, operation-documents-400, operation-documents-401, operation-documents-429
extends:
- spectral:oas
rules:
info-title-required:
description: Info title must be present
severity: error
given: $.info
then:
field: title
function: truthy
info-description-required:
description: Info description must be present
severity: error
given: $.info
then:
field: description
function: truthy
operation-operationid-required:
description: Every operation must have an operationId
severity: error
given: $.paths[*][get,post,put,patch,delete]
then:
field: operationId
function: truthy
operation-summary-required:
description: Every operation must have a summary
severity: error
given: $.paths[*][get,post,put,patch,delete]
then:
field: summary
function: truthy
operation-tags-required:
description: Every operation must have tags
severity: error
given: $.paths[*][get,post,put,patch,delete]
then:
field: tags
function: truthy
response-description-required:
description: Every response must have a description
severity: error
given: $.paths[*][get,post,put,patch,delete].responses[*]
then:
field: description
function: truthy
no-empty-descriptions:
description: Descriptions must not be empty
severity: error
given: $..description
then:
function: truthy
servers-https-only:
description: Server URLs must use HTTPS.
severity: error
given: $.servers[*].url
then:
function: pattern
functionOptions:
match: ^https://
servers-expected-domain:
description: Server URLs should be on the adobe.io domain.
severity: warn
given: $.servers[*].url
then:
function: pattern
functionOptions:
match: adobe\.io
path-params-casing:
description: Path parameters should be camelCase (the dominant convention in this API).
severity: warn
given: $.paths[*].parameters[?(@.in=='path')].name
then:
function: pattern
functionOptions:
match: ^[a-z][A-Za-z0-9]*$
operationid-casing:
description: Operation IDs should be camelCase (the dominant convention in this API).
severity: warn
given: $.paths[*][get,post,put,patch,delete].operationId
then:
function: pattern
functionOptions:
match: ^[a-z][A-Za-z0-9]*$
schema-names-casing:
description: Component schema names should be PascalCase (the dominant convention in this API).
severity: warn
given: $.components.schemas
then:
field: '@key'
function: pattern
functionOptions:
match: ^[A-Z][A-Za-z0-9]*$
schema-properties-casing:
description: Schema properties should be camelCase (the dominant convention in this API).
severity: info
given: $.components.schemas[*].properties
then:
field: '@key'
function: pattern
functionOptions:
match: ^[a-z][A-Za-z0-9]*$
security-schemes-defined:
description: Security schemes should be defined in components.
severity: warn
given: $.components
then:
field: securitySchemes
function: truthy
error-schema-defined:
description: A shared error schema (ErrorResponse) should be defined for error payloads.
severity: warn
given: $.components.schemas
then:
field: ErrorResponse
function: truthy
operation-documents-400:
description: Operations should document a 400 response (documented on 86% of this API's operations).
severity: warn
given: $.paths[*][get,post,put,patch,delete].responses
then:
field: '400'
function: truthy
operation-documents-401:
description: Operations should document a 401 response (documented on 91% of this API's operations).
severity: warn
given: $.paths[*][get,post,put,patch,delete].responses
then:
field: '401'
function: truthy
operation-documents-429:
description: Operations should document a 429 response (documented on 86% of this API's operations).
severity: warn
given: $.paths[*][get,post,put,patch,delete].responses
then:
field: '429'
function: truthy