Amazon FSx · API Governance Rules
Amazon FSx API Rules
Spectral linting rules defining API design standards and conventions for Amazon FSx.
26 Rules
error 7
warn 16
info 3
Rule Categories
fsx
Rules
warn
fsx-info-contact
API must include contact information
$.info
error
fsx-info-description
API must have a description
$.info
error
fsx-server-https
Server URLs must use HTTPS
$.servers[*].url
error
fsx-operation-summary
Operations must have a summary
$.paths[*][get,post,put,patch,delete]
warn
fsx-operation-description
Operations should have a description
$.paths[*][get,post,put,patch,delete]
error
fsx-operation-tags
Operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
error
fsx-operation-id
Operations must have operationId
$.paths[*][get,post,put,patch,delete]
warn
fsx-operation-id-camel-case
operationId should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
warn
fsx-response-200
POST operations should define 200 response
$.paths[*][post]
warn
fsx-response-400
Operations should define 400 response
$.paths[*][get,post,put,patch,delete]
warn
fsx-response-500
Operations should define 500 response
$.paths[*][get,post,put,patch,delete]
warn
fsx-schema-description
Schema components should have descriptions
$.components.schemas[*]
warn
fsx-tags-title-case
Operation tags should use Title Case
$.paths[*][*].tags[*]
warn
fsx-filesystem-type-documented
FileSystem schema should define FileSystemType field
$.components.schemas.FileSystem.properties
info
fsx-lifecycle-enum
FileSystem lifecycle should define enum values
$.components.schemas.FileSystem.properties.Lifecycle
info
fsx-backup-type-enum
Backup type should define enum values
$.components.schemas.Backup.properties.Type
error
fsx-parameter-description
Parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
error
fsx-path-param-required
Path parameters must be required
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='path')]
warn
fsx-schema-properties
Object schemas should define properties
$.components.schemas[?(@.type=='object')]
warn
fsx-request-body-json
POST request bodies should define application/json content
$.paths[*].post.requestBody.content
warn
fsx-create-prefix
POST creation operationIds should start with 'create'
$.paths[*].post.operationId
warn
fsx-delete-operation
DELETE operations should have a description
$.paths[*].delete
warn
fsx-storage-capacity-documented
FileSystem schema should document StorageCapacity
$.components.schemas.FileSystem.properties
info
fsx-resource-arn-consistent
Resource ARN field should be named ResourceARN
$.components.schemas[*].properties.ResourceARN
warn
fsx-tag-schema-required
Tag schema must require Key field
$.components.schemas.Tag.required
warn
fsx-svm-filesystem-required
StorageVirtualMachine must reference FileSystemId
$.components.schemas.StorageVirtualMachine.required