Amazon Fraud Detector · API Governance Rules
Amazon Fraud Detector API Rules
Spectral linting rules defining API design standards and conventions for Amazon Fraud Detector.
25 Rules
error 7
warn 16
info 2
Rule Categories
fraud
Rules
warn
fraud-detector-info-contact
API must include contact information
$.info
error
fraud-detector-info-description
API must have a description
$.info
error
fraud-detector-server-https
Server URLs must use HTTPS
$.servers[*].url
error
fraud-detector-operation-summary
Operations must have a summary
$.paths[*][get,post,put,patch,delete]
warn
fraud-detector-operation-description
Operations should have a description
$.paths[*][get,post,put,patch,delete]
error
fraud-detector-operation-tags
Operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
error
fraud-detector-operation-id
Operations must have operationId
$.paths[*][get,post,put,patch,delete]
warn
fraud-detector-response-200
POST operations should define 200 response
$.paths[*][post]
warn
fraud-detector-response-400
Operations should define 400 response
$.paths[*][get,post,put,patch,delete]
warn
fraud-detector-response-500
Operations should define 500 response
$.paths[*][get,post,put,patch,delete]
warn
fraud-detector-schema-description
Schema components should have descriptions
$.components.schemas[*]
warn
fraud-detector-tags-title-case
Operation tags should use Title Case
$.paths[*][*].tags[*]
warn
fraud-detector-detector-event-type
Detector schema must reference eventTypeName
$.components.schemas.Detector.required
warn
fraud-detector-model-type-enum
Model type should define allowed enum values
$.components.schemas.Model.properties.modelType
warn
fraud-detector-rule-outcomes
Rule schema must include outcomes
$.components.schemas.Rule.required
warn
fraud-detector-prediction-entities
Event prediction request must include entities
$.components.schemas.GetEventPredictionRequest.required
error
fraud-detector-parameter-description
Parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
error
fraud-detector-path-param-required
Path parameters must be required
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='path')]
warn
fraud-detector-schema-properties
Object schemas should define properties
$.components.schemas[?(@.type=='object')]
info
fraud-detector-arn-fields
ARN fields should be consistently named 'arn'
$.components.schemas[*].properties.arn
warn
fraud-detector-event-type-labels
Event type schema must include labels field
$.components.schemas.EventType.required
info
fraud-detector-rule-language-enum
Rule language should define DETECTORPL enum
$.components.schemas.Rule.properties.language
warn
fraud-detector-request-body-json
Request bodies should define application/json content
$.paths[*][put,post].requestBody.content
warn
fraud-detector-tag-key-required
Tag schema must require key field
$.components.schemas.Tag.required
warn
fraud-detector-delete-not-found
DELETE operations should define 404 response
$.paths[*].delete.responses