Amazon Fault Injection Simulator · API Governance Rules

Amazon Fault Injection Simulator API Rules

Spectral linting rules defining API design standards and conventions for Amazon Fault Injection Simulator.

28 Rules error 10 warn 16 info 2
View Rules File View on GitHub

Rule Categories

client info no operation path paths response schema security servers tag tags

Rules

error
info-title-required
API must have a title
$.info
warn
info-title-aws-fis-prefix
Title must start with AWS Fault Injection Simulator
$.info.title
error
info-description-required
API must have a description
$.info
error
info-version-required
API must have a version
$.info
error
servers-required
API must define servers
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
error
operation-operationid-required
Operations must have operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-operationid-camelcase
operationId must use camelCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-summary-required
Operations must have summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-aws-fis-prefix
Summaries must start with AWS Fault Injection Simulator
$.paths[*][get,post,put,patch,delete].summary
warn
operation-description-required
Operations must have description
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Operations must have tags
$.paths[*][get,post,put,patch,delete]
info
operation-microcks-extension
Operations should have x-microcks-operation
$.paths[*][get,post,put,patch,delete]
warn
paths-kebab-case
Path segments should use kebab-case
$.paths
error
response-success-required
Operations must have a success response
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Responses must have descriptions
$.paths[*][*].responses[*]
warn
response-error-400
Mutating operations should document 400
$.paths[*][post,put,patch].responses
warn
response-error-404
Operations on specific resources should document 404
$.paths[*][get,patch,delete].responses
warn
response-error-500
Operations should document 500
$.paths[*][*].responses
warn
schema-description-required
Component schemas must have descriptions
$.components.schemas[*]
warn
schema-type-defined
Schema properties should define type
$.components.schemas[*].properties[*]
error
security-schemes-defined
Security schemes must be defined
$.components
warn
security-global-defined
Global security must be defined
$
warn
path-parameters-described
Path parameters should have descriptions
$.paths[*][*].parameters[*][?(@.in=="path")]
warn
no-empty-descriptions
Descriptions must not be empty
$..description
warn
tags-defined
Global tags must be defined
$
warn
tag-description-required
Each tag must have a description
$.tags[*]
info
client-token-in-create
Create operations should include clientToken for idempotency
$.paths[*][post].requestBody.content

Spectral Ruleset

Raw ↑ 
rules:
  info-title-required:
    description: API must have a title
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  info-title-aws-fis-prefix:
    description: Title must start with AWS Fault Injection Simulator
    severity: warn
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: ^AWS Fault Injection Simulator
  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
  servers-required:
    description: API must define servers
    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-operationid-required:
    description: Operations must have operationId
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: operationId
      function: truthy
  operation-operationid-camelcase:
    description: operationId must use camelCase
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: casing
      functionOptions:
        type: camel
  operation-summary-required:
    description: Operations must have summary
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: summary
      function: truthy
  operation-summary-aws-fis-prefix:
    description: Summaries must start with AWS Fault Injection Simulator
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].summary
    then:
      function: pattern
      functionOptions:
        match: ^AWS Fault Injection Simulator
  operation-description-required:
    description: Operations must have description
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: description
      function: truthy
  operation-tags-required:
    description: Operations must have tags
    severity: warn
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: tags
      function: truthy
  operation-microcks-extension:
    description: Operations should have x-microcks-operation
    severity: info
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: x-microcks-operation
      function: truthy
  paths-kebab-case:
    description: Path segments should use kebab-case
    severity: warn
    given: $.paths
    then:
      function: truthy
  response-success-required:
    description: Operations must have a success response
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      function: truthy
  response-description-required:
    description: Responses must have descriptions
    severity: error
    given: $.paths[*][*].responses[*]
    then:
      field: description
      function: truthy
  response-error-400:
    description: Mutating operations should document 400
    severity: warn
    given: $.paths[*][post,put,patch].responses
    then:
      field: '400'
      function: truthy
  response-error-404:
    description: Operations on specific resources should document 404
    severity: warn
    given: $.paths[*][get,patch,delete].responses
    then:
      field: '404'
      function: truthy
  response-error-500:
    description: Operations should document 500
    severity: warn
    given: $.paths[*][*].responses
    then:
      field: '500'
      function: truthy
  schema-description-required:
    description: Component schemas must have descriptions
    severity: warn
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy
  schema-type-defined:
    description: Schema properties should define type
    severity: warn
    given: $.components.schemas[*].properties[*]
    then:
      field: type
      function: truthy
  security-schemes-defined:
    description: Security schemes must be defined
    severity: error
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  security-global-defined:
    description: Global security must be defined
    severity: warn
    given: $
    then:
      field: security
      function: truthy
  path-parameters-described:
    description: Path parameters should have descriptions
    severity: warn
    given: $.paths[*][*].parameters[*][?(@.in=="path")]
    then:
      field: description
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty
    severity: warn
    given: $..description
    then:
      function: truthy
  tags-defined:
    description: Global tags must be defined
    severity: warn
    given: $
    then:
      field: tags
      function: truthy
  tag-description-required:
    description: Each tag must have a description
    severity: warn
    given: $.tags[*]
    then:
      field: description
      function: truthy
  client-token-in-create:
    description: Create operations should include clientToken for idempotency
    severity: info
    given: $.paths[*][post].requestBody.content
    then:
      function: truthy