# Copyright 2022-Present Couchbase, Inc.
#
# Use of this software is governed by the Business Source License included
# in the file licenses/BSL-Couchbase.txt.  As of the Change Date specified
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

openapi: 3.0.3
info:
  title: Sync Gateway
  description: Sync Gateway manages access and synchronization between Couchbase Lite and Couchbase Server
  version: '4.2'
  license:
    name: Business Source License 1.1 (BSL)
    url: 'https://github.com/couchbase/sync_gateway/blob/master/LICENSE'
servers:
  - url: '{protocol}://{hostname}:4987'
    description: Diagnostic API
    variables:
      protocol:
        description: The protocol to use (HTTP or HTTPS)
        default: http
        enum:
          - http
          - https
      hostname:
        description: The hostname to use
        default: localhost
paths:
  /_ping:
    $ref: ./paths/common/_ping.yaml
  '/{keyspace}/{docid}/_all_channels':
    $ref: './paths/diagnostic/keyspace-docid-_all_channels.yaml'
  '/{keyspace}/_sync':
    $ref: './paths/diagnostic/keyspace-sync.yaml'
  '/{keyspace}/_import_filter':
    $ref: './paths/diagnostic/keyspace-import_filter.yaml'
  '/{db}/_user/{name}/_all_channels':
    $ref: './paths/diagnostic/db-_user-name-_all_channels.yaml'
  '/{keyspace}/_user/{name}':
    $ref: './paths/diagnostic/keyspace-_user-name.yaml'
externalDocs:
  description: Sync Gateway Quickstart | Couchbase Docs
  url: 'https://docs.couchbase.com/sync-gateway/current/index.html'