extends: ["spectral:oas"]
documentationUrl: https://docs.couchbase.com/sync-gateway/current/rest-api.html
rules:
  couchbase-sg-info-title:
    description: API title must mention Sync Gateway.
    given: "$.info.title"
    severity: error
    then:
      function: pattern
      functionOptions:
        match: "Sync Gateway"
  couchbase-sg-public-port:
    description: Public Sync Gateway servers must reference port 4984.
    given: "$.servers[*].url"
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: "4984"
  couchbase-sg-operation-id:
    description: Every operation must define an operationId.
    given: "$.paths.*.*"
    severity: error
    then:
      field: operationId
      function: truthy
  couchbase-sg-operation-tags:
    description: Every operation must define at least one tag.
    given: "$.paths.*.*"
    severity: error
    then:
      field: tags
      function: truthy