Adobe Premiere Pro · API Governance Rules
Adobe Premiere Pro API Rules
Spectral linting rules defining API design standards and conventions for Adobe Premiere Pro.
27 Rules
error 16
warn 11
Rule Categories
delete
get
info
no
openapi
operation
parameter
paths
request
response
schema
security
servers
Rules
warn
info-title-adobe-prefix
API title must start with "Adobe"
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must declare a version
$.info
warn
info-contact-required
API info should include contact details
$.info
error
openapi-version-3
Must use OpenAPI 3.x
$
error
servers-defined
API must define servers
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
warn
paths-no-trailing-slash
Paths must not end with trailing slash
$.paths[*]~
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-adobe-prefix
Summaries should start with "Adobe Premiere"
$.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-camelcase
operationId should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
error
parameter-description-required
Parameters must have descriptions
$.paths[*][*].parameters[*]
error
parameter-schema-required
Parameters must have schemas
$.paths[*][*].parameters[*]
warn
request-body-description
Request bodies should have descriptions
$.paths[*][post,put,patch].requestBody
error
response-success-required
Operations must define 2xx responses
$.paths[*][get,post,put,patch,delete]
error
response-description-required
Responses must have descriptions
$.paths[*][*].responses[*]
warn
response-error-401
Operations should define 401 error response
$.paths[*][get,post,put,patch,delete].responses
warn
schema-description
Component schemas should have descriptions
$.components.schemas[*]
warn
schema-type-defined
Schemas should define a type
$.components.schemas[*]
error
security-schemes-defined
API must define security schemes
$.components
warn
security-global-defined
API should define global security
$
error
get-no-request-body
GET must not have request body
$.paths[*].get
warn
delete-no-request-body
DELETE should not have request body
$.paths[*].delete
error
no-empty-descriptions
Descriptions must not be empty
$..description