Appium · API Governance Rules
Appium API Rules
Spectral linting rules defining API design standards and conventions for Appium.
27 Rules
error 10
warn 15
info 2
Rule Categories
http
info
microcks
no
openapi
operation
parameter
paths
request
response
schema
servers
Rules
error
info-title-required
Info title must be present and follow "Appium ..." pattern
$.info
warn
info-description-required
Info description must be present and have minimum length
$.info
error
info-version-required
API version must be specified
$.info
warn
info-license-required
License information must be present (Appium is Apache 2.0)
$.info
error
openapi-version-3
OpenAPI version must be 3.0.x
$
error
servers-required
At least one server must be defined
$
warn
servers-description-required
Each server must have a description
$.servers[*]
warn
paths-kebab-case
Path segments must use kebab-case (lowercase, hyphens)
$.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-appium-prefix
Operation summary must start with "Appium"
$.paths[*][get,post,put,patch,delete]
warn
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 must use camelCase
$.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
parameter-schema-required
Every parameter must have a schema
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
request-body-json-content
Request bodies should use application/json content type
$.paths[*][post,put,patch].requestBody.content
error
operation-success-response-required
Every operation must have a 2xx response defined
$.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-description-required
Top-level schemas should have a description
$.components.schemas[*]
warn
schema-title-required
Component schemas must have a title
$.components.schemas[*]
info
schema-properties-snake-case
Schema property names should use camelCase or snake_case consistently
$.components.schemas[*].properties
error
http-get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
http-delete-no-request-body
DELETE operations should not have a request body
$.paths[*].delete
warn
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
microcks-operation-extension
Operations should include x-microcks-operation extension for mock server compatibility
$.paths[*][get,post,put,patch,delete]