Amazon HealthLake · API Governance Rules
Amazon HealthLake API Rules
Spectral linting rules defining API design standards and conventions for Amazon HealthLake.
8 Rules
error 3
warn 2
info 3
Rule Categories
healthlake
Rules
error
healthlake-operation-summary
All operations must have a summary
$.paths.*[get,post,put,patch,delete]
error
healthlake-operation-id
All operations must have an operationId
$.paths.*[get,post,put,patch,delete]
warn
healthlake-operation-tags
All operations should have tags
$.paths.*[get,post,put,patch,delete]
warn
healthlake-response-200
All operations should have a 200 response
$.paths.*[get,post,put,patch,delete].responses
info
healthlake-schema-description
Schema components should have descriptions
$.components.schemas.*
info
healthlake-fhir-datastore
FHIR datastore operations should follow naming conventions
$.paths.*[get,post,put,patch,delete]
error
healthlake-hipaa-security
HIPAA-eligible service must document security requirements
$.components.securitySchemes
info
healthlake-job-operations
Job operations should have consistent naming patterns
$.paths.*[get,post,put,patch,delete][?(@property == 'operationId' && @.match('Job'))]