ArcBest · API Governance Rules

ArcBest API Rules

Spectral linting rules defining API design standards and conventions for ArcBest.

18 Rules error 11 warn 6 info 1
View Rules File View on GitHub

Rule Categories

delete get info openapi operation parameter response schema security servers

Rules

error
info-title-arcbest-prefix
API title must start with "ArcBest"
$.info
warn
info-description-required
API must have a description
$.info
error
info-version-required
API must specify a version
$.info
error
openapi-version-3
Use OpenAPI 3.0.x
$
error
servers-defined
Server URLs must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*]
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]
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 "ArcBest"
$.paths[*][get,post,put,delete,patch]
error
operation-tags-required
All operations must have at least one tag
$.paths[*][get,post,put,delete,patch]
warn
parameter-description-required
All parameters must have a description
$.paths[*][*].parameters[*]
error
response-success-required
All operations must define a success response
$.paths[*][get,post,put,delete,patch].responses
warn
response-401-secured
All secured endpoints should document 401 responses
$.paths[*][get,post,put,delete,patch].responses
warn
schema-type-defined
Schema properties should define a type
$.components.schemas[*].properties[*]
error
security-schemes-defined
Security schemes must be defined
$.components
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
info
delete-returns-204
DELETE operations should return 204
$.paths[*].delete.responses

Spectral Ruleset

Raw ↑ 
rules:
  info-title-arcbest-prefix:
    description: API title must start with "ArcBest"
    severity: error
    given: "$.info"
    then:
      field: title
      function: pattern
      functionOptions:
        match: "^ArcBest"
  info-description-required:
    description: API must have a description
    severity: warn
    given: "$.info"
    then:
      field: description
      function: truthy
  info-version-required:
    description: API must specify a version
    severity: error
    given: "$.info"
    then:
      field: version
      function: truthy
  openapi-version-3:
    description: Use OpenAPI 3.0.x
    severity: error
    given: "$"
    then:
      field: openapi
      function: pattern
      functionOptions:
        match: "^3\\.0\\."
  servers-defined:
    description: Server URLs must be defined
    severity: error
    given: "$"
    then:
      field: servers
      function: truthy
  servers-https:
    description: Server URLs must use HTTPS
    severity: error
    given: "$.servers[*]"
    then:
      field: url
      function: pattern
      functionOptions:
        match: "^https://"
  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]"
    then:
      field: operationId
      function: pattern
      functionOptions:
        match: "^[a-z][a-zA-Z0-9]*$"
  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 "ArcBest"
    severity: warn
    given: "$.paths[*][get,post,put,delete,patch]"
    then:
      field: summary
      function: pattern
      functionOptions:
        match: "^ArcBest"
  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
  parameter-description-required:
    description: All parameters must have a description
    severity: warn
    given: "$.paths[*][*].parameters[*]"
    then:
      field: description
      function: truthy
  response-success-required:
    description: All operations must define a success response
    severity: error
    given: "$.paths[*][get,post,put,delete,patch].responses"
    then:
      function: truthy
  response-401-secured:
    description: All secured endpoints should document 401 responses
    severity: warn
    given: "$.paths[*][get,post,put,delete,patch].responses"
    then:
      field: "401"
      function: truthy
  schema-type-defined:
    description: Schema properties should define a type
    severity: warn
    given: "$.components.schemas[*].properties[*]"
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          anyOf:
            - required: [type]
            - required: [$ref]
  security-schemes-defined:
    description: Security schemes must be defined
    severity: error
    given: "$.components"
    then:
      field: securitySchemes
      function: truthy
  get-no-request-body:
    description: GET operations must not have a request body
    severity: error
    given: "$.paths[*].get"
    then:
      field: requestBody
      function: falsy
  delete-returns-204:
    description: DELETE operations should return 204
    severity: info
    given: "$.paths[*].delete.responses"
    then:
      field: "204"
      function: truthy