Amazon Lookout for Metrics · API Governance Rules

Amazon Lookout for Metrics API Rules

Spectral linting rules defining API design standards and conventions for Amazon Lookout for Metrics.

29 Rules error 8 warn 16 info 5
View Rules File View on GitHub

Rule Categories

error examples http info no openapi operation operationid parameter paths query response schema security servers

Rules

error
info-title-required
Info title must be present and start with "Amazon Lookout for Metrics"
$.info
warn
info-description-required
Info description must be present
$.info
error
info-version-required
API version must be defined
$.info
error
openapi-version
Must use OpenAPI 3.0.x
$
error
servers-required
Servers must be defined
$
warn
servers-https
Server URLs should use HTTPS
$.servers[*]
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
info
operation-summary-prefix
Operation summaries should start with "Amazon Lookout for Metrics"
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Every operation should have a description
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
info
paths-kebab-case
Path segments should use PascalCase (AWS convention for action-based paths)
$.paths
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Operations must have at least one 2xx response
$.paths[*][post]
warn
response-description-required
All responses must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
info
response-error-401
Operations should document 401 Unauthorized responses
$.paths[*][post]
info
schema-description
Top-level schemas in components should have descriptions
$.components.schemas[*]
warn
schema-property-type
Schema properties should define a type
$.components.schemas[*].properties[*]
error
security-schemes-required
Security schemes must be defined
$.components
warn
security-aws-sigv4
AWS Signature Version 4 security should be documented
$.components.securitySchemes
error
http-get-no-body
GET operations should not have request bodies
$.paths[*].get
warn
http-delete-no-body
DELETE operations should not have request bodies
$.paths[*].delete
warn
no-empty-descriptions
Descriptions should not be empty strings
$..description
info
examples-encouraged
Schema properties should include examples
$.components.schemas[*].properties[*]
warn
query-params-casing
Query parameters should be PascalCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
warn
operationid-casing
Operation IDs should be PascalCase (the dominant convention in this API).
$.paths[*][get,post,put,patch,delete].operationId
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
warn
schema-properties-casing
Schema properties should be PascalCase (the dominant convention in this API).
$.components.schemas[*].properties
warn
error-schema-defined
A shared error schema (ErrorMessage) should be defined for error payloads.
$.components.schemas

Spectral Ruleset

Raw ↑ 
# amazon-lookout-for-metrics — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
#   - servers-https-only: 50% of servers already https (warn)
#   - path-params-casing: camel @ 100% (n=3)
#   - query-params-casing: pascal @ 94% (n=17)
#   - operationid-casing: pascal @ 100% (n=30)
#   - schema-names-casing: pascal @ 100% (n=236)
#   - schema-properties-casing: pascal @ 98% (n=335)
#   - security: global (root) — NOT emitting operation-security-required
#   - error-schema-defined: ErrorMessage
#   - merge: kept 24 existing, added 5 measured, upgraded 0
#   - added: query-params-casing, operationid-casing, schema-names-casing, schema-properties-casing, error-schema-defined
extends:
  - spectral:oas
rules:
  info-title-required:
    description: Info title must be present and start with "Amazon Lookout for Metrics"
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  info-description-required:
    description: Info description must be present
    severity: warn
    given: $.info
    then:
      field: description
      function: truthy
  info-version-required:
    description: API version must be defined
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  openapi-version:
    description: Must use OpenAPI 3.0.x
    severity: error
    given: $
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: ^3\.0\.
  servers-required:
    description: Servers must be defined
    severity: error
    given: $
    then:
      field: servers
      function: truthy
  servers-https:
    description: Server URLs should use HTTPS
    severity: warn
    given: $.servers[*]
    then:
      field: url
      function: pattern
      functionOptions:
        match: ^https://
  operation-operationId-required:
    description: Every operation must have an operationId
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: operationId
      function: truthy
  operation-summary-required:
    description: Every operation must have a summary
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: summary
      function: truthy
  operation-summary-prefix:
    description: Operation summaries should start with "Amazon Lookout for Metrics"
    severity: info
    given: $.paths[*][get,post,put,patch,delete].summary
    then:
      function: pattern
      functionOptions:
        match: ^Amazon Lookout for Metrics
  operation-description-required:
    description: Every operation should have a description
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: description
      function: truthy
  operation-tags-required:
    description: Every operation must have at least one tag
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: tags
      function: truthy
  paths-kebab-case:
    description: Path segments should use PascalCase (AWS convention for action-based paths)
    severity: info
    given: $.paths
    then:
      field: '@key'
      function: pattern
      functionOptions:
        match: ^/[A-Za-z][A-Za-z0-9]*$
  parameter-description-required:
    description: All parameters must have descriptions
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].parameters[*]
    then:
      field: description
      function: truthy
  response-success-required:
    description: Operations must have at least one 2xx response
    severity: error
    given: $.paths[*][post]
    then:
      field: responses
      function: schema
      functionOptions:
        schema:
          type: object
          minProperties: 1
  response-description-required:
    description: All responses must have a description
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].responses[*]
    then:
      field: description
      function: truthy
  response-error-401:
    description: Operations should document 401 Unauthorized responses
    severity: info
    given: $.paths[*][post]
    then:
      field: responses
      function: schema
      functionOptions:
        schema:
          type: object
  schema-description:
    description: Top-level schemas in components should have descriptions
    severity: info
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy
  schema-property-type:
    description: Schema properties should define a type
    severity: warn
    given: $.components.schemas[*].properties[*]
    then:
      field: type
      function: truthy
  security-schemes-required:
    description: Security schemes must be defined
    severity: error
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  security-aws-sigv4:
    description: AWS Signature Version 4 security should be documented
    severity: warn
    given: $.components.securitySchemes
    then:
      function: truthy
  http-get-no-body:
    description: GET operations should not have request bodies
    severity: error
    given: $.paths[*].get
    then:
      field: requestBody
      function: falsy
  http-delete-no-body:
    description: DELETE operations should not have request bodies
    severity: warn
    given: $.paths[*].delete
    then:
      field: requestBody
      function: falsy
  no-empty-descriptions:
    description: Descriptions should not be empty strings
    severity: warn
    given: $..description
    then:
      function: pattern
      functionOptions:
        match: .+
  examples-encouraged:
    description: Schema properties should include examples
    severity: info
    given: $.components.schemas[*].properties[*]
    then:
      field: example
      function: truthy
  query-params-casing:
    description: Query parameters should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].parameters[?(@.in=='query')]
    then:
      field: name
      function: casing
      functionOptions:
        type: pascal
  operationid-casing:
    description: Operation IDs should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: casing
      functionOptions:
        type: pascal
  schema-names-casing:
    description: Component schema names should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas
    then:
      field: '@key'
      function: pattern
      functionOptions:
        match: ^[A-Z][A-Za-z0-9]*$
  schema-properties-casing:
    description: Schema properties should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: pattern
      functionOptions:
        match: ^[A-Z][A-Za-z0-9]*$
  error-schema-defined:
    description: A shared error schema (ErrorMessage) should be defined for error payloads.
    severity: warn
    given: $.components.schemas
    then:
      field: ErrorMessage
      function: truthy