AmTrust Financial Services · API Governance Rules

AmTrust Financial Services API Rules

Spectral linting rules defining API design standards and conventions for AmTrust Financial Services.

10 Rules error 7 warn 3
View Rules File View on GitHub

Rule Categories

info operation parameter response schema security servers

Rules

warn
info-title-amtrust
API title must include AmTrust Financial Services
$.info.title
error
info-description-required
Info must have a description
$.info
error
servers-https-only
All servers must use HTTPS
$.servers[*].url
error
operation-summary-required
All operations must have summaries
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-required
All operations must have operationIds
$.paths[*][get,post,put,patch,delete]
error
operation-tags-required
All operations must have tags
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
All parameters must have descriptions
$.paths[*][*].parameters[*]
error
response-success-required
All operations must have success responses
$.paths[*][get,post,put,patch,delete].responses
error
security-schemes-defined
Security schemes must be defined
$.components
warn
schema-properties-typed
Schema properties should have explicit types
$.components.schemas[*].properties[*]

Spectral Ruleset

Raw ↑ 
extends: "spectral:oas"
rules:
  info-title-amtrust:
    description: API title must include AmTrust Financial Services
    severity: warn
    given: "$.info.title"
    then:
      function: pattern
      functionOptions:
        match: "^AmTrust"

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

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

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

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

  operation-tags-required:
    description: All operations must have tags
    severity: error
    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[*][*].parameters[*]"
    then:
      field: description
      function: truthy

  response-success-required:
    description: All operations must have success responses
    severity: error
    given: "$.paths[*][get,post,put,patch,delete].responses"
    then:
      function: schema
      functionOptions:
        schema:
          anyOf:
            - required: ['200']
            - required: ['201']
            - required: ['204']

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

  schema-properties-typed:
    description: Schema properties should have explicit types
    severity: warn
    given: "$.components.schemas[*].properties[*]"
    then:
      field: type
      function: truthy