Alpha Vantage · API Governance Rules
Alpha Vantage API Rules
Spectral linting rules defining API design standards and conventions for Alpha Vantage.
15 Rules
error 8
warn 6
info 1
Rule Categories
alpha
Rules
warn
alpha-vantage-operation-summary-prefix
All operation summaries must start with "Alpha Vantage"
$.paths[*][*].summary
error
alpha-vantage-operation-tags
All operations must have at least one tag
$.paths[*][*]
error
alpha-vantage-operation-id
All operations must have an operationId
$.paths[*][*]
warn
alpha-vantage-operation-description
All operations must have a description
$.paths[*][*]
error
alpha-vantage-apikey-param
All operations must have the apikey parameter
$.paths[*][get].parameters[*]
error
alpha-vantage-function-param
All query operations must have the function parameter
$.paths[/query][get].parameters[?(@.name == 'function')]
warn
alpha-vantage-function-enum
The function parameter must have an enum of allowed values
$.paths[/query][get].parameters[?(@.name == 'function')].schema
error
alpha-vantage-apikey-security-scheme
API must define the ApiKey security scheme
$.components.securitySchemes
error
alpha-vantage-apikey-in-query
ApiKey must be passed as a query parameter
$.components.securitySchemes.ApiKey
warn
alpha-vantage-schema-title
All schemas must have a title
$.components.schemas[*]
warn
alpha-vantage-schema-description
All schemas must have a description
$.components.schemas[*]
warn
alpha-vantage-property-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]
error
alpha-vantage-200-response
All operations must document a 200 success response
$.paths[*][*].responses
info
alpha-vantage-microcks-operation
All operations should have x-microcks-operation extension
$.paths[*][*]
error
alpha-vantage-server-https
API server must use HTTPS
$.servers[*].url