Amazon Mechanical Turk · API Governance Rules

Amazon Mechanical Turk API Rules

Spectral linting rules defining API design standards and conventions for Amazon Mechanical Turk.

18 Rules error 7 warn 7 info 4
View Rules File View on GitHub

Rule Categories

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

Rules

error
info-title-required
Info title must be present
$.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 Mechanical Turk"
$.paths[*][get,post,put,patch,delete].summary
warn
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
warn
response-description-required
All responses must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
info
schema-description
Top-level schemas should have descriptions
$.components.schemas[*]
error
security-schemes-required
Security schemes must be defined
$.components
error
http-get-no-body
GET operations should not have request bodies
$.paths[*].get
warn
no-empty-descriptions
Descriptions should not be empty strings
$..description
info
paths-kebab-case
Path segments should use kebab-case
$.paths
info
examples-encouraged
Schema properties should include examples
$.components.schemas[*].properties[*]

Spectral Ruleset

Raw ↑ 
rules:
  info-title-required:
    description: Info title must be present
    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 Mechanical Turk"
    severity: info
    given: "$.paths[*][get,post,put,patch,delete].summary"
    then:
      function: pattern
      functionOptions:
        match: "^Amazon Mechanical Turk"
  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
  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-description-required:
    description: All responses must have a description
    severity: warn
    given: "$.paths[*][get,post,put,patch,delete].responses[*]"
    then:
      field: description
      function: truthy
  schema-description:
    description: Top-level schemas should have descriptions
    severity: info
    given: "$.components.schemas[*]"
    then:
      field: description
      function: truthy
  security-schemes-required:
    description: Security schemes must be defined
    severity: error
    given: "$.components"
    then:
      field: securitySchemes
      function: truthy
  http-get-no-body:
    description: GET operations should not have request bodies
    severity: error
    given: "$.paths[*].get"
    then:
      field: requestBody
      function: falsy
  no-empty-descriptions:
    description: Descriptions should not be empty strings
    severity: warn
    given: "$..description"
    then:
      function: pattern
      functionOptions:
        match: ".+"
  paths-kebab-case:
    description: Path segments should use kebab-case
    severity: info
    given: "$.paths"
    then:
      field: "@key"
      function: pattern
      functionOptions:
        match: "^(/[a-z0-9{}_.\\-]+)+$"
  examples-encouraged:
    description: Schema properties should include examples
    severity: info
    given: "$.components.schemas[*].properties[*]"
    then:
      field: example
      function: truthy