Harness · API Governance Rules

Harness API Rules

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

8 Rules error 4 warn 3 info 1
View Rules File View on GitHub

Rule Categories

info operation parameter response schema security

Rules

warn
info-title-prefix
Info title should start with "Harness"
$.info
error
operation-operationId-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
error
operation-summary-required
Every operation must have a summary starting with "Harness"
$.paths[*][get,post,put,patch,delete]
warn
operation-tags-required
Every operation must have tags
$.paths[*][get,post,put,patch,delete]
warn
parameter-description-required
Every parameter must have a description
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Operations must have success responses
$.paths[*][get,post,put,patch,delete].responses
error
security-global-defined
Global security must be defined
$
info
schema-properties-description
Schema properties should have descriptions
$.components.schemas[*].properties[*]

Spectral Ruleset

harness-spectral-rules.yml Raw ↑ 
rules:
  info-title-prefix:
    description: Info title should start with "Harness"
    given: $.info
    severity: warn
    then:
      field: title
      function: pattern
      functionOptions:
        match: "^Harness"

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

  operation-summary-required:
    description: Every operation must have a summary starting with "Harness"
    given: "$.paths[*][get,post,put,patch,delete]"
    severity: error
    then:
      field: summary
      function: truthy

  operation-tags-required:
    description: Every operation must have tags
    given: "$.paths[*][get,post,put,patch,delete]"
    severity: warn
    then:
      field: tags
      function: truthy

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

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

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

  schema-properties-description:
    description: Schema properties should have descriptions
    given: "$.components.schemas[*].properties[*]"
    severity: info
    then:
      field: description
      function: truthy