Alloy Automation · API Governance Rules
Alloy Automation API Rules
Spectral linting rules defining API design standards and conventions for Alloy Automation.
16 Rules
error 4
warn 7
info 5
Rule Categories
alloy
Rules
warn
alloy-operation-summary-prefix
All operation summaries must start with "Alloy"
$.paths[*][*].summary
error
alloy-operation-tags
All operations must have at least one tag
$.paths[*][*]
error
alloy-operation-id
All operations must have an operationId
$.paths[*][*]
warn
alloy-operation-description
All operations must have a description
$.paths[*][*]
error
alloy-error-response-401
All operations must document 401 Unauthorized response
$.paths[*][*].responses
error
alloy-api-key-security
API must use bearer API key security
$.components.securitySchemes
info
alloy-api-version-header
API version should be specified in server URL or via x-api-version header
$.servers[0].url
warn
alloy-schema-title
All schemas must have a title
$.components.schemas[*]
warn
alloy-schema-description
All schemas must have a description
$.components.schemas[*]
warn
alloy-property-description
All schema properties must have a description
$.components.schemas[*].properties[*]
info
alloy-property-example
Schema properties should have examples
$.components.schemas[*].properties[*]
info
alloy-microcks-operation
All operations should have x-microcks-operation extension
$.paths[*][*]
info
alloy-user-id-pattern
User ID fields should follow usr_ prefix pattern
$.components.schemas[*].properties.userId.example
warn
alloy-post-201-or-200
POST operations should return 201 (created) or 200
$.paths[*].post.responses
warn
alloy-error-response-schema
Error responses must reference ErrorResponse schema
$.paths[*][*].responses[4XX,5XX].content.application/json.schema.$ref
info
alloy-connector-id-kebab-case
Connector IDs should use kebab-case
$.components.schemas[*].properties.connectorId.example