Amazon Firewall Manager · API Governance Rules
Amazon Firewall Manager API Rules
Spectral linting rules defining API design standards and conventions for Amazon Firewall Manager.
25 Rules
error 8
warn 14
info 3
Rule Categories
fms
Rules
warn
fms-info-contact
API must include contact information
$.info
error
fms-info-description
API must have a description
$.info
error
fms-server-https
All server URLs must use HTTPS
$.servers[*].url
error
fms-operation-summary
Operations must have a summary
$.paths[*][get,post,put,patch,delete]
warn
fms-operation-description
Operations should have a description
$.paths[*][get,post,put,patch,delete]
error
fms-operation-tags
Operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
error
fms-operation-id
Operations must have operationId
$.paths[*][get,post,put,patch,delete]
warn
fms-operation-id-camel-case
operationId should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
warn
fms-response-200
GET and POST operations should define 200 response
$.paths[*][get,post]
warn
fms-response-400
Operations should define 400 response
$.paths[*][get,post,put,patch,delete]
warn
fms-response-500
Operations should define 500 response
$.paths[*][get,post,put,patch,delete]
warn
fms-response-404
Operations accessing resources by ID should define 404
$.paths[*~'\{[^}]+\}'][get,put,patch,delete].responses
error
fms-parameter-description
Parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
error
fms-path-param-required
Path parameters must be marked as required
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='path')]
warn
fms-schema-description
Schema components should have descriptions
$.components.schemas[*]
warn
fms-tags-title-case
Operation tags should use Title Case
$.paths[*][*].tags[*]
warn
fms-list-operation-prefix
Collection GET operationIds should start with 'list'
$.paths[*~'[^}]$'].get.operationId
error
fms-put-policy-request
PUT policy requests should define a request body
$.paths[*].post.requestBody
warn
fms-policy-remediation-documented
Policies should document RemediationEnabled field in schema
$.components.schemas.Policy.properties
warn
fms-security-service-type-enum
SecurityServicePolicyData Type should define allowed enum values
$.components.schemas.SecurityServicePolicyData.properties.Type
warn
fms-delete-operation
DELETE operations should have a description
$.paths[*].delete
info
fms-admin-account-documented
Admin account endpoint should be documented
$.paths
info
fms-compliance-endpoint-documented
Compliance endpoint should be documented
$.paths
info
fms-resource-set-documented
Resource set endpoint should be documented
$.paths
warn
fms-schema-properties-defined
Object schemas should define properties
$.components.schemas[?(@.type=='object')]