Amazon Forecast · API Governance Rules
Amazon Forecast API Rules
Spectral linting rules defining API design standards and conventions for Amazon Forecast.
25 Rules
error 7
warn 15
info 3
Rule Categories
forecast
Rules
warn
forecast-info-contact
API must include contact information
$.info
error
forecast-info-description
API must have a description
$.info
error
forecast-server-https
Server URLs must use HTTPS
$.servers[*].url
error
forecast-operation-summary
Operations must have a summary
$.paths[*][get,post,put,patch,delete]
warn
forecast-operation-description
Operations should have a description
$.paths[*][get,post,put,patch,delete]
error
forecast-operation-tags
Operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
error
forecast-operation-id
Operations must have operationId
$.paths[*][get,post,put,patch,delete]
warn
forecast-operation-id-camel-case
operationId should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
warn
forecast-response-200
POST operations should define 200 response
$.paths[*][post]
warn
forecast-response-400
Operations should define 400 response
$.paths[*][get,post,put,patch,delete]
warn
forecast-response-500
Operations should define 500 response
$.paths[*][get,post,put,patch,delete]
error
forecast-parameter-description
Parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
forecast-schema-description
Schema components should have descriptions
$.components.schemas[*]
warn
forecast-tags-title-case
Operation tags should use Title Case
$.paths[*][*].tags[*]
warn
forecast-list-operation-prefix
Collection GET operationIds should start with 'list'
$.paths[*~'[^}]$'].get.operationId
warn
forecast-create-post-prefix
POST operationIds should start with 'create'
$.paths[*].post.operationId
warn
forecast-dataset-domain-documented
Dataset schema should define Domain enum values
$.components.schemas.Dataset.properties.Domain
warn
forecast-predictor-horizon-documented
Predictor schema should include ForecastHorizon
$.components.schemas.Predictor.properties
warn
forecast-schema-properties-defined
Object schemas should define properties
$.components.schemas[?(@.type=='object')]
error
forecast-request-body-content
POST request bodies must define content
$.paths[*].post.requestBody
info
forecast-arn-fields-consistent
ARN fields should follow consistent naming (ResourceArn pattern)
$.components.schemas[*].properties[*~'Arn$']
info
forecast-forecast-types-array
ForecastTypes should be an array of quantile strings
$.components.schemas.Forecast.properties.ForecastTypes
info
forecast-status-field-documented
Resources should document Status field
$.components.schemas[*].properties.Status
warn
forecast-tag-schema-documented
Tag schema should be defined
$.components.schemas
warn
forecast-export-job-destination
Export job request should require Destination
$.components.schemas.CreateForecastExportJobRequest.required