Apple Pay · API Governance Rules
Apple Pay API Rules
Spectral linting rules defining API design standards and conventions for Apple Pay.
24 Rules
error 10
warn 12
info 2
Rule Categories
external
http
info
no
operation
parameter
paths
response
schema
security
servers
Rules
warn
info-title-apple-prefix
API title should start with "Apple Pay"
$.info
error
info-version-required
API version must be specified
$.info
warn
info-description-required
API description must be present
$.info
info
info-contact-required
Contact information should be provided
$.info
warn
info-terms-of-service
Terms of service URL should be provided for payment APIs
$.info
error
servers-required
At least one server must be defined
$
error
servers-https
Server URLs must use HTTPS for payment APIs
$.servers[*]
warn
servers-description-required
Each server must have a description distinguishing production from sandbox
$.servers[*]
error
security-defined
Global security scheme must be defined for payment APIs
$
error
security-schemes-defined
Security schemes must be defined in components
$.components
warn
paths-kebab-case
Path segments must use camelCase or kebab-case
$.paths
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
error
operation-id-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
operation-success-response-required
Every operation must have a 2xx response
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-for-payment-apis
Payment APIs must define 401 Unauthorized responses
$.paths[*][post].responses
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
warn
schema-title-required
Component schemas must have a title
$.components.schemas[*]
warn
schema-description-required
Component schemas should have a description
$.components.schemas[*]
error
http-get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
no-empty-descriptions
Descriptions must not be empty
$..description
info
external-docs-encouraged
External documentation links are encouraged for payment APIs
$