Amazon Detective · API Governance Rules

Amazon Detective API Rules

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

39 Rules error 18 warn 12 info 9
View Rules File View on GitHub

Rule Categories

delete external get info no openapi operation operations parameter paths post request response schema security servers tag tags

Rules

warn
info-title-prefix
API title should start with "Amazon Detective"
$.info.title
error
info-description-required
API must have a description of at least 50 characters
$.info
error
info-version-required
API must have a version
$.info
warn
info-contact-required
API info should include contact information
$.info
warn
info-license-required
API info should include license information
$.info
error
openapi-version-3
Must use OpenAPI 3.x
$
error
servers-defined
At least one server must be defined
$
error
servers-https-only
All server URLs must use HTTPS
$.servers[*].url
warn
servers-description-required
Each server should have a description
$.servers[*]
info
paths-kebab-case
Path segments should use kebab-case or camelCase (AWS Detective uses camelCase in some paths)
$.paths
error
paths-no-trailing-slash
Paths must not end with a trailing slash
$.paths
error
operation-summary-required
All operations must have a summary
$.paths[*][get,post,put,delete,patch]
warn
operation-summary-prefix
Operation summaries should start with "Amazon Detective"
$.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-id-required
All operations must have an operationId
$.paths[*][get,post,put,delete,patch]
warn
operation-id-camel-case
OperationIds should use camelCase
$.paths[*][get,post,put,delete,patch].operationId
error
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,delete,patch]
warn
tags-global-defined
Global tags array should be defined
$
info
tag-description-required
Global tags should have descriptions
$.tags[*]
error
parameter-description-required
All parameters must have a description
$.paths[*][get,post,put,delete,patch].parameters[*]
error
parameter-schema-required
All parameters must have a schema
$.paths[*][get,post,put,delete,patch].parameters[*]
info
request-body-description
Request bodies should have a description
$.paths[*][post,put,patch].requestBody
warn
request-body-json-content
Request bodies should use application/json content type
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Operations must have at least one 2xx response
$.paths[*][get,post,put,delete,patch].responses
error
response-description-required
All responses must have a description
$.paths[*][get,post,put,delete,patch].responses[*]
info
response-error-400
Operations should include a 400 error response
$.paths[*][post,put,patch].responses
warn
response-error-500
Operations should include a 500 error response
$.paths[*][get,post,put,delete,patch].responses
warn
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
warn
schema-type-required
Schemas should have a type defined
$.components.schemas[*]
info
schema-property-pascal-case
Amazon Detective schema properties use PascalCase naming
$.components.schemas[*].properties
error
security-global-defined
Global security must be defined
$
error
security-schemes-defined
Security schemes must be defined in components
$.components
warn
security-scheme-description
Security schemes should have descriptions
$.components.securitySchemes[*]
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
info
delete-no-request-body-unless-needed
DELETE operations typically should not have a request body
$.paths[*].delete
info
post-should-have-request-body
POST operations should have a request body
$.paths[*].post
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
operations-microcks-extension
Operations should have x-microcks-operation for mock support
$.paths[*][get,post,put,delete,patch]
info
external-docs-encouraged
API should reference external documentation
$

Spectral Ruleset

Raw ↑ 
rules:
  # INFO / METADATA
  info-title-prefix:
    description: API title should start with "Amazon Detective"
    severity: warn
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: "^Amazon Detective"

  info-description-required:
    description: API must have a description of at least 50 characters
    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

  info-contact-required:
    description: API info should include contact information
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy

  info-license-required:
    description: API info should include license information
    severity: warn
    given: $.info
    then:
      field: license
      function: truthy

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

  # SERVERS
  servers-defined:
    description: At least one server must be defined
    severity: error
    given: $
    then:
      field: servers
      function: truthy

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

  servers-description-required:
    description: Each server should have a description
    severity: warn
    given: $.servers[*]
    then:
      field: description
      function: truthy

  # PATHS — NAMING CONVENTIONS
  paths-kebab-case:
    description: Path segments should use kebab-case or camelCase (AWS Detective uses camelCase in some paths)
    severity: info
    given: $.paths
    then:
      function: pattern
      functionOptions:
        match: "^(/[a-z][a-zA-Z0-9/-]*)+$"

  paths-no-trailing-slash:
    description: Paths must not end with a trailing slash
    severity: error
    given: $.paths
    then:
      function: pattern
      functionOptions:
        notMatch: "/$"

  # OPERATIONS
  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: Operation summaries should start with "Amazon Detective"
    severity: warn
    given: $.paths[*][get,post,put,delete,patch].summary
    then:
      function: pattern
      functionOptions:
        match: "^Amazon Detective"

  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-id-required:
    description: All operations must have an operationId
    severity: error
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: operationId
      function: truthy

  operation-id-camel-case:
    description: OperationIds should use camelCase
    severity: warn
    given: $.paths[*][get,post,put,delete,patch].operationId
    then:
      function: pattern
      functionOptions:
        match: "^[a-z][a-zA-Z0-9]*$"

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

  # TAGS
  tags-global-defined:
    description: Global tags array should be defined
    severity: warn
    given: $
    then:
      field: tags
      function: truthy

  tag-description-required:
    description: Global tags should have descriptions
    severity: info
    given: $.tags[*]
    then:
      field: description
      function: truthy

  # PARAMETERS
  parameter-description-required:
    description: All parameters must have a description
    severity: error
    given: $.paths[*][get,post,put,delete,patch].parameters[*]
    then:
      field: description
      function: truthy

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

  # REQUEST BODIES
  request-body-description:
    description: Request bodies should have a description
    severity: info
    given: $.paths[*][post,put,patch].requestBody
    then:
      field: description
      function: truthy

  request-body-json-content:
    description: Request bodies should use application/json content type
    severity: warn
    given: $.paths[*][post,put,patch].requestBody.content
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          minProperties: 1

  # RESPONSES
  response-success-required:
    description: Operations must have at least one 2xx response
    severity: error
    given: $.paths[*][get,post,put,delete,patch].responses
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          anyOf:
            - required: ['200']
            - required: ['201']
            - required: ['204']

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

  response-error-400:
    description: Operations should include a 400 error response
    severity: info
    given: $.paths[*][post,put,patch].responses
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          required: ['400']

  response-error-500:
    description: Operations should include a 500 error response
    severity: warn
    given: $.paths[*][get,post,put,delete,patch].responses
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          required: ['500']

  # SCHEMAS — PROPERTY NAMING
  schema-description-required:
    description: Top-level schemas should have descriptions
    severity: warn
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy

  schema-type-required:
    description: Schemas should have a type defined
    severity: warn
    given: $.components.schemas[*]
    then:
      field: type
      function: truthy

  schema-property-pascal-case:
    description: Amazon Detective schema properties use PascalCase naming
    severity: info
    given: $.components.schemas[*].properties
    then:
      function: schema
      functionOptions:
        schema:
          type: object

  # SECURITY
  security-global-defined:
    description: Global security must be defined
    severity: error
    given: $
    then:
      field: security
      function: truthy

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

  security-scheme-description:
    description: Security schemes should have descriptions
    severity: warn
    given: $.components.securitySchemes[*]
    then:
      field: description
      function: truthy

  # HTTP METHOD CONVENTIONS
  get-no-request-body:
    description: GET operations must not have a request body
    severity: error
    given: $.paths[*].get
    then:
      field: requestBody
      function: falsy

  delete-no-request-body-unless-needed:
    description: DELETE operations typically should not have a request body
    severity: info
    given: $.paths[*].delete
    then:
      field: requestBody
      function: falsy

  post-should-have-request-body:
    description: POST operations should have a request body
    severity: info
    given: $.paths[*].post
    then:
      field: requestBody
      function: truthy

  # GENERAL QUALITY
  no-empty-descriptions:
    description: Descriptions must not be empty strings
    severity: error
    given: $..description
    then:
      function: truthy

  operations-microcks-extension:
    description: Operations should have x-microcks-operation for mock support
    severity: info
    given: $.paths[*][get,post,put,delete,patch]
    then:
      field: x-microcks-operation
      function: truthy

  external-docs-encouraged:
    description: API should reference external documentation
    severity: info
    given: $
    then:
      field: externalDocs
      function: truthy