Amazon HealthOmics · API Governance Rules
Amazon HealthOmics API Rules
Spectral linting rules defining API design standards and conventions for Amazon HealthOmics.
8 Rules
error 3
warn 2
info 3
Rule Categories
healthomics
Rules
error
healthomics-operation-summary
All operations must have a summary
$.paths.*[get,post,put,patch,delete]
error
healthomics-operation-id
All operations must have an operationId
$.paths.*[get,post,put,patch,delete]
warn
healthomics-operation-tags
All operations should have tags
$.paths.*[get,post,put,patch,delete]
warn
healthomics-response-200
All operations should have a 200 response
$.paths.*[get,post,put,patch,delete].responses
info
healthomics-schema-description
Schema components should have descriptions
$.components.schemas.*
info
healthomics-workflow-operations
Workflow operations should follow consistent naming
$.paths.*[get,post,put,patch,delete]
info
healthomics-store-naming
Store operations should reference appropriate schemas
$.paths.*[get,post,put,patch,delete][?(@property == 'operationId' && @.match('Store'))]
error
healthomics-security
HealthOmics must document security requirements
$.components.securitySchemes