Amazon Audit Manager · API Governance Rules
Amazon Audit Manager API Rules
Spectral linting rules defining API design standards and conventions for Amazon Audit Manager.
23 Rules
error 11
warn 11
info 1
Rule Categories
audit
no
path
query
schema
security
servers
Rules
warn
audit-manager-operation-id-camel-case
All operationIds must be camelCase
$.paths[*][*].operationId
warn
audit-manager-summary-prefix
All operation summaries must start with Amazon Audit Manager
$.paths[*][*].summary
warn
audit-manager-has-tags
All operations must have tags
$.paths[*][*]
error
audit-manager-response-200
All operations must have a 200 response
$.paths[*][*].responses
error
audit-manager-assessment-name-required
CreateAssessmentRequest must require name
$.components.schemas.CreateAssessmentRequest
error
audit-manager-assessment-status-enum
AssessmentMetadata Status must use valid enum values
$.components.schemas.AssessmentMetadata.properties.status
error
audit-manager-assessment-report-status-enum
AssessmentReport status must use valid enum values
$.components.schemas.AssessmentReport.properties.status
error
audit-manager-framework-type-enum
Framework type must use valid enum values
$.components.schemas.Framework.properties.type
error
audit-manager-control-type-enum
Control type must use valid enum values
$.components.schemas.Control.properties.type
error
audit-manager-role-type-enum
Role roleType must use valid enum values
$.components.schemas.Role.properties.roleType
error
audit-manager-destination-type-enum
AssessmentReportsDestination type must use valid enum values
$.components.schemas.AssessmentReportsDestination.properties.destinationType
error
audit-manager-security-sigv4
API must use sigv4 security scheme
$.security[*]
warn
audit-manager-server-url-fixed
Server URL must be fixed without variables
$.servers[*]
warn
audit-manager-example-microcks-default
All examples must have x-microcks-default set to true
$.paths[*][*].responses[*].content[*].examples.default
error
audit-manager-delegation-status-enum
Delegation status must use valid enum values
$.components.schemas.Delegation.properties.status
error
servers-https-only
Server URLs must use HTTPS.
$.servers[*].url
warn
servers-expected-domain
Server URLs should be on the amazonaws.com domain.
$.servers[*].url
warn
path-params-casing
Path parameters should be camelCase (the dominant convention in this API).
$.paths[*].parameters[?(@.in=='path')].name
warn
query-params-casing
Query parameters should be camelCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
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
no-empty-descriptions
Descriptions must not be empty strings.
$..description