Archrock · API Governance Rules
Archrock API Rules
Spectral linting rules defining API design standards and conventions for Archrock.
12 Rules
error 7
warn 5
Rule Categories
archrock
Rules
error
archrock-quarterly-year-required
Quarterly financials must include year
$.components.schemas.QuarterlyFinancials.properties
error
archrock-fleet-utilization-rate
Fleet statistics must include utilization rate
$.components.schemas.FleetStatistics.properties
error
archrock-equipment-status-enum
Equipment status must be a valid enum value
$.components.schemas.Equipment.properties.status
error
archrock-sec-filing-type-enum
SEC filing type must be a valid enum value
$.components.schemas.SecFiling.properties.type
warn
archrock-list-responses-have-total
List responses must include a total count
$.components.schemas[*List].properties
warn
archrock-list-responses-have-limit
List responses must include a limit field
$.components.schemas[*List].properties
warn
archrock-operations-have-tags
All API operations must have tags
$.paths[*][get,post,put,patch,delete]
error
archrock-operations-have-summary
All API operations must have a summary
$.paths[*][get,post,put,patch,delete]
error
archrock-operations-have-operation-id
All API operations must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
archrock-api-key-security
API must use API key security scheme
$.components.securitySchemes
warn
archrock-info-contact-required
API info must include contact information
$.info
error
archrock-servers-defined
API must define at least one server
$