Apple Keynote · API Governance Rules
Apple Keynote API Rules
Spectral linting rules defining API design standards and conventions for Apple Keynote.
22 Rules
error 9
warn 13
Rule Categories
http
info
no
openapi
operation
parameter
paths
response
schema
servers
Rules
error
info-title-required
API info title must be present
$.info
warn
info-title-apple-prefix
API title should start with "Apple Keynote"
$.info
error
info-version-required
API version must be specified
$.info
warn
info-description-required
API description must be present with minimum length
$.info
error
openapi-version-3
OpenAPI version must be 3.0.x
$
error
servers-required
At least one server must be defined
$
warn
servers-https
Server URLs must use HTTPS
$.servers[*]
warn
paths-kebab-case
Path segments must use kebab-case
$.paths
warn
paths-no-trailing-slash
Paths must not end with a trailing slash
$.paths
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-apple-prefix
Operation summary must start with "Apple Keynote"
$.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 must use camelCase
$.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 tags
$.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
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 strings
$..description