Amazon FreeRTOS · API Governance Rules
Amazon FreeRTOS API Rules
Spectral linting rules defining API design standards and conventions for Amazon FreeRTOS.
25 Rules
error 7
warn 16
info 2
Rule Categories
freertos
Rules
warn
freertos-info-contact
API must include contact information
$.info
error
freertos-info-description
API must have a description
$.info
error
freertos-server-https
Server URLs must use HTTPS
$.servers[*].url
error
freertos-operation-summary
Operations must have a summary
$.paths[*][get,post,put,patch,delete]
warn
freertos-operation-description
Operations should have a description
$.paths[*][get,post,put,patch,delete]
error
freertos-operation-tags
Operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
error
freertos-operation-id
Operations must have operationId
$.paths[*][get,post,put,patch,delete]
warn
freertos-operation-id-camel-case
operationId should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
warn
freertos-response-200
POST operations should define 200 response
$.paths[*][post]
warn
freertos-response-400
Operations should define 400 response
$.paths[*][get,post,put,patch,delete]
warn
freertos-response-500
Operations should define 500 response
$.paths[*][get,post,put,patch,delete]
warn
freertos-response-404
Resource-by-ID operations should define 404
$.paths[*~'\{[^}]+\}'][get,put,patch,delete].responses
info
freertos-delete-204
DELETE operations should return 204
$.paths[*].delete
error
freertos-parameter-description
Parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
error
freertos-path-param-required
Path parameters must be required
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='path')]
warn
freertos-schema-description
Schema components should have descriptions
$.components.schemas[*]
warn
freertos-tags-title-case
Operation tags should use Title Case
$.paths[*][*].tags[*]
warn
freertos-ota-targets-required
OTA update schema must require targets
$.components.schemas.OtaUpdate.required
warn
freertos-ota-status-enum
OTA update status should define enum values
$.components.schemas.OtaUpdate.properties.otaUpdateStatus
warn
freertos-sw-config-hardware-platform
Software configuration must document hardware platform
$.components.schemas.SoftwareConfiguration.required
warn
freertos-create-prefix
POST creation operationIds should start with 'create'
$.paths[*].post.operationId
warn
freertos-list-prefix
Collection GET operationIds should start with 'list'
$.paths[*~'[^}]$'].get.operationId
warn
freertos-schema-properties
Object schemas should define properties
$.components.schemas[?(@.type=='object')]
warn
freertos-request-body-json
POST/PUT request bodies should define application/json
$.paths[*][post,put].requestBody.content
info
freertos-ota-protocols-documented
OTA update create request should document protocols
$.components.schemas.CreateOtaUpdateRequest.properties