Amazon Lookout for Equipment · API Governance Rules

Amazon Lookout for Equipment API Rules

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

16 Rules error 9 warn 7
View Rules File View on GitHub

Rule Categories

info openapi operation parameter paths schema security servers

Rules

warn
info-title-format
API title must start with "Amazon Lookout for Equipment"
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
error
openapi-version
Must use OpenAPI 3.x
$
error
servers-required
Servers must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-prefix
Summaries must start with "Amazon Lookout for Equipment"
$.paths[*][get,post,put,delete,patch].summary
error
operation-description-required
All operations must have a description
$.paths[*][get,post,put,delete,patch]
error
operation-operationid-required
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-tags-required
All operations must have tags
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][*].parameters[*]
error
security-schemes-required
Security schemes must be defined
$.components
warn
security-global-required
Global security must be defined
$
warn
paths-kebab-case
Path segments should use kebab-case
$.paths
warn
schema-description-required
Schema components should have descriptions
$.components.schemas[*]

Spectral Ruleset

Raw ↑ 
rules:

  info-title-format:
    description: API title must start with "Amazon Lookout for Equipment"
    severity: warn
    given: "$.info.title"
    then:
      function: pattern
      functionOptions:
        match: "^Amazon Lookout for Equipment"

  info-description-required:
    description: API must have a description
    severity: error
    given: "$.info"
    then:
      field: description
      function: truthy

  info-version-required:
    description: API must have a version
    severity: error
    given: "$.info"
    then:
      field: version
      function: truthy

  openapi-version:
    description: Must use OpenAPI 3.x
    severity: error
    given: "$"
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: "^3\\."

  servers-required:
    description: Servers must be defined
    severity: error
    given: "$"
    then:
      field: servers
      function: truthy

  servers-https:
    description: Server URLs must use HTTPS
    severity: error
    given: "$.servers[*].url"
    then:
      function: pattern
      functionOptions:
        match: "^https://"

  operation-summary-required:
    description: All operations must have a summary
    severity: error
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: summary
      function: truthy

  operation-summary-prefix:
    description: Summaries must start with "Amazon Lookout for Equipment"
    severity: warn
    given: "$.paths[*][get,post,put,delete,patch].summary"
    then:
      function: pattern
      functionOptions:
        match: "^Amazon Lookout for Equipment"

  operation-description-required:
    description: All operations must have a description
    severity: error
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: description
      function: truthy

  operation-operationid-required:
    description: All operations must have an operationId
    severity: error
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: operationId
      function: truthy

  operation-tags-required:
    description: All operations must have tags
    severity: warn
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: tags
      function: truthy

  parameter-description-required:
    description: All parameters must have descriptions
    severity: warn
    given: "$.paths[*][*].parameters[*]"
    then:
      field: description
      function: truthy

  security-schemes-required:
    description: Security schemes must be defined
    severity: error
    given: "$.components"
    then:
      field: securitySchemes
      function: truthy

  security-global-required:
    description: Global security must be defined
    severity: warn
    given: "$"
    then:
      field: security
      function: truthy

  paths-kebab-case:
    description: Path segments should use kebab-case
    severity: warn
    given: "$.paths"
    then:
      function: pattern
      functionOptions:
        match: "^(/[a-zA-Z0-9{}/-]+)+$"

  schema-description-required:
    description: Schema components should have descriptions
    severity: warn
    given: "$.components.schemas[*]"
    then:
      field: description
      function: truthy