Cribl · API Governance Rules

Cribl API Rules

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

5 Rules error 5
View Rules File View on GitHub

Rule Categories

cribl

Rules

error
cribl-search-info-contact
API info object should reference Cribl support contact.
$.info.contact
error
cribl-search-bearer-auth
API must declare bearerAuth security scheme.
$.components.securitySchemes
error
cribl-search-job-paths
Search API must define search job paths.
$.paths
error
cribl-search-operation-id
All operations must define an operationId.
$.paths.*.*
error
cribl-search-tags
All operations must define tags.
$.paths.*.*

Spectral Ruleset

Raw ↑ 
extends: ["spectral:oas"]
documentationUrl: https://docs.cribl.io/search/
rules:
  cribl-search-info-contact:
    description: API info object should reference Cribl support contact.
    given: "$.info.contact"
    severity: error
    then:
      field: url
      function: pattern
      functionOptions:
        match: "cribl"
  cribl-search-bearer-auth:
    description: API must declare bearerAuth security scheme.
    given: "$.components.securitySchemes"
    severity: error
    then:
      field: bearerAuth
      function: truthy
  cribl-search-job-paths:
    description: Search API must define search job paths.
    given: "$.paths"
    severity: error
    then:
      function: schema
      functionOptions:
        schema:
          type: object
          required:
            - /search/jobs
  cribl-search-operation-id:
    description: All operations must define an operationId.
    given: "$.paths.*.*"
    severity: error
    then:
      field: operationId
      function: truthy
  cribl-search-tags:
    description: All operations must define tags.
    given: "$.paths.*.*"
    severity: error
    then:
      field: tags
      function: truthy