schemas.yaml

# 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.

ExpVars:
  type: object
  properties:
    cmdline:
      description: 'Built-in variables from the Go runtime, lists the command-line arguments'
      type: object
    memstats:
      description: Dumps a large amount of information about the memory heap and garbage collector
      type: object
    cb:
      description: Variables reported by the Couchbase SDK (go_couchbase package)
      type: object
    mc:
      description: Variables reported by the low-level memcached API (gomemcached package)
      type: object
    syncGateway_changeCache:
      type: object
      properties:
        maxPending:
          description: Max number of sequences waiting on a missing earlier sequence number
          type: object
        lag-tap-0000ms:
          description: Histogram of delay from doc save till it shows up in Tap feed
          type: object
        lag-queue-0000ms:
          description: Histogram of delay from Tap feed till doc is posted to changes feed
          type: object
        lag-total-0000ms:
          description: Histogram of total delay from doc save till posted to changes feed
          type: object
        outOfOrder:
          description: Number of out-of-order sequences posted
          type: object
        view_queries:
          description: Number of queries to channels view
          type: object
    syncGateway_db:
      type: object
      properties:
        channelChangesFeeds:
          description: 'Number of calls to db.changesFeed, i.e. generating a changes feed for a single channel.'
          type: object
        channelLogAdds:
          description: Number of entries added to channel logs
          type: object
        channelLogAppends:
          description: Number of times entries were written to channel logs using an APPEND operation
          type: object
        channelLogCacheHits:
          description: Number of requests for channel-logs that were fulfilled from the in-memory cache
          type: object
        channelLogRewrites:
          description: Number of times entries were written to channel logs using a SET operation (rewriting the entire log)
          type: object
        channelLogRewriteCollisions:
          description: Number of collisions while attempting to rewrite channel logs using SET
          type: object
        document_gets:
          description: Number of times a document was read from the database
          type: object
        revisionCache_adds:
          description: Number of revisions added to the revision cache
          type: object
        revisionCache_hits:
          description: Number of times a revision-cache lookup succeeded
          type: object
        revisionCache_misses:
          description: Number of times a revision-cache lookup failed
          type: object
        revs_added:
          description: Number of revisions added to the database (including deletions)
          type: object
        sequence_gets:
          description: Number of times the database's lastSequence was read
          type: object
        sequence_reserves:
          description: Number of times the database's lastSequence was incremented
          type: object
    syncgateway:
      description: Monitoring stats
      type: object
      properties:
        global:
          description: Global Sync Gateway stats
          type: object
          properties:
            resource_utilization:
              description: Resource utilization stats
              type: object
              properties:
                admin_net_bytes_recv:
                  type: integer
                  description: "The total number of bytes received (since node start-up) on the network interface to which the Sync Gateway api.admin_interface is bound."
                admin_net_bytes_sent:
                  type: integer
                  description: "The total number of bytes sent (since node start-up) on the network interface to which the Sync Gateway api.admin_interface is bound."
                error_count:
                  type: integer
                  description: "The total number of errors logged."
                go_memstats_heapalloc:
                  type: integer
                  description: "HeapAlloc is bytes of allocated heap objects. Allocated heap objects include all reachable objects, as well as unreachable objects that the garbage collector has not yet freed. Specifically, HeapAlloc increases as heap objects are allocated and decreases as the heap is swept and unreachable objects are freed. Sweeping occurs incrementally between GC cycles, so these two processes occur simultaneously, and as a result HeapAlloc tends to change smoothly (in contrast with the sawtooth that is typical of stop-the-world garbage collectors)."
                go_memstats_heapidle:
                  type: integer
                  description: "HeapIdle is bytes in idle (unused) spans. Idle spans have no objects in them. These spans could be (and may already have been) returned to the OS, or they can be reused for heap allocations, or they can be reused as stack memory. HeapIdle minus HeapReleased estimates the amount of memory that could be returned to the OS, but is being retained by the runtime so it can grow the heap without requesting more memory from the OS. If this difference is significantly larger than the heap size, it indicates there was a recent transient spike in live heap size."
                go_memstats_heapinuse:
                  type: integer
                  description: "HeapInuse is bytes in in-use spans. In-use spans have at least one object in them. These spans an only be used for other objects of roughly the same size. HeapInuse minus HeapAlloc estimates the amount of memory that has been dedicated to particular size classes, but is not currently being used. This is an upper bound on fragmentation, but in general this memory can be reused efficiently."
                go_memstats_heapreleased:
                  type: integer
                  description: "HeapReleased is bytes of physical memory returned to the OS. This counts heap memory from idle spans that was returned to the OS and has not yet been reacquired for the heap."
                go_memstats_pausetotalns:
                  type: integer
                  description: "PauseTotalNs is the cumulative nanoseconds in GC stop-the-world pauses since the program started. During a stop-the-world pause, all goroutines are paused and only the garbage collector can run."
                go_memstats_stackinuse:
                  type: integer
                  description: "StackInuse is bytes in stack spans. In-use stack spans have at least one stack in them. These spans can only be used for other stacks of the same size. There is no StackIdle because unused stack spans are returned to the heap (and hence counted toward HeapIdle)."
                go_memstats_stacksys:
                  type: integer
                  description: "StackSys is bytes of stack memory obtained from the OS. StackSys is StackInuse, plus any memory obtained directly from the OS for OS thread stacks (which should be minimal)."
                go_memstats_sys:
                  type: integer
                  description: "Sys is the total bytes of memory obtained from the OS. Sys is the sum of the XSys fields below. Sys measures the virtual address space reserved by the Go runtime for the heap, stacks, and other internal data structures. It's likely that not all of the virtual address space is backed by physical memory at any given moment, though in general it all was at some point."
                goroutines_high_watermark:
                  type: integer
                  description: "Peak number of go routines since process start."
                num_goroutines:
                  type: integer
                  description: "The total number of goroutines."
                num_idle_kv_ops:
                  type: integer
                  description: "The total number of idle kv operations."
                num_idle_query_ops:
                  type: integer
                  description: "The total number of idle query operations."
                process_cpu_percent_utilization:
                  type: number
                  format: float
                  description: "The CPU utilization as percentage value * 10. The extra 10 multiplier is a mistake left for backwards compatibility. Please consider using node_cpu_percent_utilization as of version 3.2. The CPU usage calculation is performed based on user and system CPU time, but it does not include components such as iowait. The derivation means that the values of process_cpu_percent_utilization and %Cpu, returned when running the top command, will differ."
                node_cpu_percent_utilization:
                  type: number
                  format: float
                  description: "The node CPU utilization as percentage value, since the last time this stat was called. The CPU usage calculation is performed based on user and system CPU time, but it does not include components such as iowait."
                process_memory_resident:
                  type: integer
                  description: "The memory utilization (Resident Set Size) for the process, in bytes."
                pub_net_bytes_recv:
                  type: integer
                  description: "The total number of bytes received (since node start-up) on the network interface to which the Sync Gateway api.public_interface is bound. By default, that is the number of bytes received on 127.0.0.1:4984 since node start-up"
                pub_net_bytes_sent:
                  type: integer
                  description: "The total number of bytes sent (since node start-up) on the network interface to which Sync Gateway api.public_interface is bound. By default, that is the number of bytes sent on 127.0.0.1:4984 since node start-up."
                system_memory_total:
                  type: integer
                  description: "The total memory available on the system in bytes."
                warn_count:
                  type: integer
                  description: "The total number of warnings logged."
                uptime:
                  type: integer
                  description: "The total uptime."
        per_db:
          description: |-
            This array contains stats for all databases declared in the config file — see [View Statistics and Metrics](stats-monitoring.html) for more details on the metrics collected and reported by Sync Gateway.

            The statistics for each database are grouped into:
            - cache related statistics
            - collections statistics
            - cbl_replication_push
            - cbl_replication_pull
            - database_related_statistics
            - delta_sync
            - gsi_views
            - security_related_statistics
            - shared_bucket_import
            - per_replication statistics for each `replication_id`
          type: array
          items:
            type: object
            properties:
              cache:
                type: object
              database:
                type: object
              per_replication:
                type: object
              collections:
                type: object
              security:
                type: object
        per_replication:
          description: |-
            An array of stats for each replication declared in the config file
            **Deprecated @ 2.8**: used only by inter-sync-gateway replications version 1.
          type: array
          items:
            type: object
            description: Stats for a given replication_id
            properties:
              $replication_id:
                type: object
                properties:
                  sgr_active:
                    description: |-
                      Whether the replication is active at this time.
                      **Deprecated @ 2.8**: used only by inter-sync-gateway replications version 1.
                    type: boolean
                  sgr_docs_checked_sent:
                    description: |-
                      The total number of documents checked for changes since replication started.
                      This represents the number of potential change notifications pushed by Sync Gateway.
                      **Constraints**
                        This is not necessarily the number of documents pushed, as a given target might already have the change.
                        Used by versions 1 and 2.
                    type: integer
                  sgr_num_attachments_transferred:
                    description: |-
                      The total number of attachments transferred since replication started.
                      **Deprecated @ 2.8**: used only by inter-sync-gateway replications version 1.
                    type: integer
                  sgr_num_attachment_bytes_transferred:
                    description: |-
                      The total number of attachment bytes transferred since replication started.
                      **Deprecated @ 2.8**: used only by inter-sync-gateway replications version 1.
                    type: integer
                  sgr_num_docs_failed_to_push:
                    description: |-
                      The total number of documents that failed to be pushed since replication started.
                      Used by versions 1 and 2.
                    type: integer
                  sgr_num_docs_pushed:
                    description: |-
                      The total number of documents that were pushed since replication started.
                      Used by versions 1 and 2.
                    type: integer
          deprecated: true
User:
  description: Properties associated with a user
  type: object
  properties:
    name:
      description: |-
        The name of the user.

        User names can only have alphanumeric ASCII characters and underscores.
      type: string
    password:
      description: |-
        The password of the user.

        Mandatory. unless `allow_empty_password` is `true` in the database configs.
      type: string
    admin_channels:
      description: |-
        A list of channels to explicitly grant to the user for the default collection.
        See `collection_access` for channels in named collections.
      type: array
      items:
        type: string
    all_channels:
      description: |-
        All the channels that the user has been granted access to for the default collection.
        See `collection_access` for channels in named collections.

        Access could have been granted through the sync function, roles, or explicitly on the user under the `admin_channels` property.
      type: array
      items:
        type: string
      readOnly: true
    $ref: '#/CollectionAccessConfig'
    email:
      description: The email address of the user.
      type: string
    disabled:
      description: 'If true, the user will not be able to login to the account as it is disabled.'
      type: boolean
      default: false
    admin_roles:
      description: A list of roles to explicitly grant to the user.
      type: array
      items:
        type: string
    roles:
      description: |-
        All the roles that the user has been granted access to.

        Access could have been granted through the sync function, roles_claim, or explicitly on the user under the `admin_roles` property.
      type: array
      items:
        type: string
      readOnly: true
    jwt_roles:
      description: The roles that the user has been added to through roles_claim.
      type: array
      items:
        type: string
      readOnly: true
    jwt_channels:
      description: The channels that the user has been granted access to through channels_claim for the default collection.
      type: array
      items:
        type: string
      readOnly: true
    jwt_issuer:
      description: The issuer of the last JSON Web Token that the user last used to sign in.
      type: string
      readOnly: true
    jwt_last_updated:
      description: The last time that the user's JWT roles/channels were updated.
      type: string
      format: date-time
      readOnly: true
  title: User
CollectionAccessConfig:
  collection_access:
    description: A set of access grants by scope and collection for a specific collection.
    type: object
    additionalProperties:
      maxProperties: 1
      description: An object keyed by scope, containing a set of collections.
      type: object
      x-additionalPropertiesName: scopename
      additionalProperties:
        description: An object keyed by collection name, defines access collections in this scope.
        type: object
        x-additionalPropertiesName: collectionname
        properties:
          admin_channels:
            description: A list of channels to explicitly grant to the user in this collection.
            type: array
            items:
              type: string
          all_channels:
            description: |-
              All the channels that the user has been granted access to in this collection.

              Access could have been granted through the sync function, roles, or explicitly on the user under the `admin_channels` property.
            type: array
            items:
              type: string
            readOnly: true
          jwt_channels:
            description: The channels that the user has been granted access to through channels_claim for this collection.
            type: array
            items:
              type: string
            readOnly: true
          jwt_last_updated:
            description: The last time that the user's JWT channels were updated for this collection.
            type: string
            format: date-time
            readOnly: true
Role:
  description: Properties associated with a role
  type: object
  properties:
    name:
      description: |-
        The name of the role.

        Role names can only have alphanumeric ASCII characters and underscores.
      type: string
    admin_channels:
      description: |-
        A list of channels to explicitly grant to the role for the default collection.
        See `collection_access` for channels in named collections.
      type: array
      items:
        type: string
    all_channels:
      description: |-
        All the channels that the role has been granted access to for the default collection.

        These channels could have been assigned by the Sync function or using the `admin_channels` property.
      type: array
      items:
        type: string
      readOnly: true
    $ref: '#/CollectionAccessConfig'
  title: Role
User-session-information:
  type: object
  properties:
    authentication_handlers:
      description: The ways authentication can be established to authenticate as a user. Used for CouchDB compatibility. Always contains "default" and "cookie".
      type: array
      enum:
        - ["default", "cookie"]
      default: ["default", "cookie"]
    ok:
      description: Used for CouchDB compatibility. Always true.
      type: boolean
      enum:
        - true
    userCtx:
      type: object
      properties:
        channels:
          description: A map of the channels in the default collection that the user is in along with the sequence number the user was granted access. This does not include inherited channels through roles.
          type: object
          additionalProperties:
            x-additionalPropertiesName: channelName
            type: number
            minimum: 1
            description: The sequence number the user was granted access.
            title: sequence number
          example:
            "!": 1
            "channelA": 2
        name:
          description: The name of the user.
          type: string
          minLength: 1
      required:
        - channels
        - name
  required:
    - authentication_handlers
    - ok
    - userCtx
  title: User Session Information
OIDC-callback:
  type: object
  properties:
    id_token:
      description: The OpenID Connect ID token
      type: string
    refresh_token:
      description: The OpenID Connect ID refresh token
      type: string
    session_id:
      description: The Sync Gateway session token
      type: string
    name:
      description: The Sync Gateway user
      type: string
    access_token:
      description: The OpenID Connect access token
      type: string
    token_type:
      description: The OpenID Connect ID token type
      type: string
    expires_in:
      description: The time until the id_token expires (TTL).
      type: number
  title: OpenID Connect callback properties
OIDC-token:
  description: Properties expected back from an OpenID Connect provider after successful authentication
  type: object
  properties:
    access_token:
      type: string
    token_type:
      type: string
    refresh_token:
      type: string
    expires_in:
      type: string
    id_token:
      type: string
  title: OIDC-token
OIDC-login-page-handler:
  description: Properties passed from the OpenID Connect mock login page to the handler
  type: object
  properties:
    username:
      type: string
    tokenttl:
      type: string
    identity-token-formats:
      type: string
    authenticated:
      type: string
  required:
    - username
    - tokenttl
    - identity-token-formats
    - authenticated
Document:
  description: |-
    A Sync Gateway document. The document body is a JSON object whose top-level fields are the application's own data; Sync Gateway metadata is inlined into the same object using reserved `_`-prefixed field names (`_id`, `_rev`, `_exp`, etc.) listed below. Any top-level field that does not start with `_` is treated as user data and stored verbatim, and field values can be any valid JSON (including nested objects and arrays).
  type: object
  additionalProperties:
    x-additionalPropertiesName: propertyname
    description: A user-defined field belonging to the document body. Any JSON value is permitted. Field names beginning with `_` are reserved for Sync Gateway metadata.
  properties:
    _id:
      description: The ID of the document.
      type: string
    _rev:
      description: |-
        The ancestor Revision Tree ID of the document, used by Sync Gateway as an optimistic concurrency control (OCC) value to detect conflicts when updating an existing document; omit this field when creating a new document. The value is typically taken from the `_rev` returned by a prior `GET` of the document, or from the `ETag` response header.

        For single-document upserts ([PUT /{keyspace}/{docid}](#operation/put_keyspace-docid)), the `rev` query parameter and the `If-Match` request header are alternative OCC sources for the same document; for bulk upserts ([POST /{keyspace}/_bulk_docs](#operation/post_keyspace-_bulk_docs)), per-document OCC must be supplied in the doc body via this field or `_cv`. Clients may supply more than one OCC source as long as same-type values match exactly; mismatched values return HTTP 400. Precedence when multiple are present: `rev` query parameter, then `If-Match` header, then body `_cv`, then body `_rev`.
      type: string
    _cv:
      description: |-
        The ancestor Current Version (CV) ID of the document, used by Sync Gateway as an optimistic concurrency control (OCC) value to detect conflicts when updating an existing document; omit this field when creating a new document. The value is typically taken from the `_cv` returned by a prior `GET` of the document, or from the `ETag` response header.

        Unlike the `rev` query parameter and `If-Match` header (which autodetect Revision Tree IDs vs Current Version IDs), this field must hold a CV. As with `_rev`, this can be supplied alongside other OCC sources as long as same-type values match exactly. See `_rev` for the full precedence order.
      type: string
    _exp:
      description: |-
        Expiry time after which the document will be purged. The expiration time is set and managed on the Couchbase Server document. The value can be specified in two ways; in ISO-8601 format, for example the 6th of July 2022 at 17:00 in the BST timezone would be `2016-07-06T17:00:00+01:00`; it can also be specified as a numeric Couchbase Server expiry value. Couchbase Server expiry values are specified as Unix time, and if the desired TTL is below 30 days then it can also represent an interval in seconds from the current time (for example, a value of 5 will remove the document 5 seconds after it is written to Couchbase Server). The document expiration time is returned in the response of `GET /{db}/{doc} ` when `show_exp=true` is included in the query.

        As with the existing explicit purge mechanism, this applies only to the local database; it has nothing to do with replication. This expiration time is not propagated when the document is replicated. The purge of the document does not cause it to be deleted on any other database.
      type: string
    _deleted:
      description: 'Whether the document is a tombstone or not. If true, it is a tombstone.'
      type: boolean
    _revisions:
      description: |-
        Encoded revision history for the document. This field is used by legacy 1.x REST replication protocol clients and CouchDB-style API callers to transmit ancestry alongside a revision. Most upsert/create requests should omit this field and rely on `_rev` alone.
      type: object
      properties:
        start:
          description: Prefix number for the latest revision.
          type: number
        ids:
          description: 'Array of valid Revision Tree IDs, in reverse order (latest first).'
          type: array
          items:
            type: string
    _attachments:
      description: |-
        Binary attachments associated with the document, keyed by attachment name. Each entry describes a single attachment and its inline base64 data. Attachments are stored separately from the document body but travel with the document during replication.
      type: object
      additionalProperties:
        x-additionalPropertiesName: attachmentname
        description: The name of the attachment.
        type: object
        properties:
          content_type:
            description: Content type of the attachment.
            type: string
          data:
            description: The data in the attachment in base64.
            type: string
New-revision:
  description: Properties returned when a new document revision is created
  type: object
  properties:
    id:
      description: The ID of the document.
      type: string
    ok:
      description: Whether the request completed successfully.
      type: boolean
    rev:
      description: The Revision Tree ID of the document.
      type: string
    cv:
      description: The CV of the document.
      type: string
  required:
    - id
    - ok
    - rev
  title: New-revision
Changes-feed:
  description: Properties of a changes feed
  type: object
  properties:
    results:
      type: array
      items:
        type: object
        properties:
          seq:
            description: The change sequence number.
            type: number
          id:
            description: The document ID the change happened on.
            type: string
          changes:
            description: List of document leafs with each leaf containing only a `rev` or `cv` field.
            type: array
            items:
              oneOf:
                - type: object
                  properties:
                    rev:
                      description: The Revision Tree ID associated with the change. This may be returned even when the `version_type` preference is set to `cv` if this document was an old revision written prior to upgrading to SG 4.0+
                      type: string
                  title: Revision Tree ID
                - type: object
                  properties:
                    cv:
                      description: The Current Version associated with the change. This value requires the `version_type` preference set to `cv` and this document revision being written through SG 4.0+
                      type: string
                  title: Current Version
            uniqueItems: true
      uniqueItems: true
    last_seq:
      description: The last change sequence number.
      type: string
Design-doc:
  description: Properties of a design document
  type: object
  properties:
    language:
      type: string
    views:
      type: object
      additionalProperties:
        x-additionalPropertiesName: viewname
        description: The name of the view.
        type: object
        properties:
          map:
            type: string
          reduce:
            type: string
    options:
      type: object
      properties:
        local_seq:
          type: string
        include_design:
          type: string
        raw:
          type: string
        index_xattr_on_deleted_docs:
          type: string
HTTP-Error:
  type: object
  properties:
    error:
      description: The error name.
      type: string
    reason:
      description: The error description.
      type: string
  required:
    - error
    - reason
  title: HTTP-Error
ISGRReplicationState:
  description: This is the state that the replicator is in or that trying to transition in to.
  type: string
  enum:
    - running
    - stopped
    - resetting
    - error
    - starting
    - reconnecting
  x-enumDescriptions:
    running: Currently running replication.
    stopped: Not running replication.
    resetting: The replication is resetting its state.
    error: The replication is stopped due to an error.
    starting: The replication is starting up.
    reconnecting: The replication is reconnecting to the remote database.
  title: Replication Status
Retrieved-replication:
  description: Properties of a replication
  allOf:
    - type: object
      properties:
        replication_id:
          description: |-
            This is the ID of the replication.
          type: string
    - $ref: '#/Replication'
    - type: object
      properties:
        assigned_node:
          description: The unique ID of the node assigned to the replication.
          type: string
        target_state:
          $ref: '#/ISGRReplicationState'
        cluster_uuid:
          description: The cluster unique identifier.
          type: string
  title: Replication
Replication:
  description: Properties of a replication
  type: object
  x-requirePropertiesSorted: true
  properties:
    adhoc:
      description: |-
        Set to true to run the replication as an adhoc replication instead of a persistent one.

        This means that the replication will only last the period of the replication until the status is changed to `stopped` and then it will be removed automatically. It will also be removed if Sync Gateway restarts or if removed due to user action.
      type: boolean
      default: false
    batch_size:
      description: The amount of changes to be sent in one batch of replications. Changing this is an Enterprise Edition only feature.
      type: integer
      default: 200
    collections_enabled:
      description: |-
        If true, the replicator will run with collections, and will replicate all collections, unless otherwise limited by `collections_local`.

        If false, the replicator will only replicate the default collection.
      type: boolean
      default: false
    collections_local:
      description: |-
        Limits the set of collections replicated to those listed in this array.

        The replication will use all collections defined on the database if this list is empty.
      type: array
      items:
        type: string
      example: ["scope1.collection1", "scope1.collection3", "scope1.collection6"]
      default: []
    collections_remote:
      description: |-
        Remaps the local collection name to the one specified in this array when replicating with the remote.

        If only a subset of collections need remapping, elements in this array can be specified as `null` to preserve the local collection name.

        The same index is used for both `collections_remote` and `collections_local`, and both arrays must be the same length.
      type: array
      items:
        type: string
        nullable: true
      example: ["scope1.collectionA", null, "scope1.collectionF"]
      default: []
    conflict_resolution_type:
      description: |-
        This defines what conflict resolution policy Sync Gateway should use to apply when resolving conflicting revisions.

        Changing this is an Enterprise Edition only feature.
      type: string
      default: default
      enum:
        - default
        - remoteWins
        - localWins
        - custom
      x-enumDescriptions:
        default: |-
          This will use:
            - Timestamp based conflict resolution (often referred to as "last write wins", or LWW). Which uses a document timestamp from most recent document revisions to compare.
            - The revision with the most recent timestamp wins.
            - If replicating a document that was last updated/written pre upgrade to SG 4.x, the default policy for versions < 4.x will be used.
        localWins: This will result in local revisions always being the winner in any conflict.
        remoteWins: This will result in remote revisions always being the winner in any conflict.
        custom: This will result in conflicts going through your own custom conflict resolver. You must provide this logic as a Javascript function in the `custom_conflict_resolver` parameter.
    continuous:
      description: |-
        If true, changes will be immediately synced when they happen. This is known as a continuous replication.

        If false, all changes will be synced until they have been processed. The replication will then cease and not process any future changes (unless started again by the user). This is known as a one-shot replication.
      type: boolean
      default: false
    custom_conflict_resolver:
      description: |-
        This specifies the Javascript function to use to resolve conflicts between conflicting revisions.

        This **must** be used when `conflict_resolution_type=custom`. This property will be ignored when `conflict_resolution_type` is not `custom`.

        The Javascript function to provide this property should be in backticks (like the sync function). The function takes 1 parameter which is a struct that represents the conflict. This struct has 2 properties:
          * `LocalDocument` - The local document. This contains the document ID under the `_id` key.
          * `RemoteDocument` - The remote document
        The function should return the new document's body. This can be the winning revision (for example, `return conflict.LocalDocument`), a new body, or `nil` to resolve as a delete.

        Example:

        ```javascript
        function(conflict) {
          console.log("Doc ID: "+conflict.LocalDocument._id);
          console.log("Full remote doc: "+JSON.stringify(conflict.RemoteDocument));
          return conflict.RemoteDocument;
        }
        ```

        Using complex `custom_conflict_resolver` functions can noticeably degrade performance. Use a built-in resolver whenever possible.

        If a document merge is being done, the `_rev` and `_cv` properties should not be included in the returned document body as Sync Gateway will generate new values for these.

        This is an Enterprise Edition only feature.
      type: string
      default: ""
    direction:
      description: |-
        This specifies which direction the replication will be replicating with the `remote` replicator.
      type: string
      enum:
        - push
        - pull
        - pushAndPull
      x-enumDescriptions:
        pull: changes are pulled from the remote database
        push: changes are pushed to the remote database
        pushAndPull: changes are both push-to and pulled-from the remote database
    enable_delta_sync:
      description: |-
        This will turn on delta-sync for the replication. In order to enable delta-sync for a replication, the database level setting `delta_sync.enabled` must also be set to true.

        Using delta-sync is an Enterprise Edition only feature.
      type: boolean
      default: false
    filter:
      description: |-
        This defines whether to filter documents.
      type: string
      enum:
        - sync_gateway/bychannel
        - ""
      x-enumDescriptions:
        "": Do not filter any documents.
        sync_gateway/bychannel: |-
          If set, a pull replication will be limited to a specific set of channels specified by the `query_param.channels` property.
    initial_state:
      description: |-
        This is what state to start the replication in when creating a new replication.

        This allows you to control if the replication starts in a `stopped` start or `running` state.

        Replications prior to Sync Gateway 2.8 will run in the default state `running`.
      type: string
      default: running
      enum:
        - running
        - stopped
      x-enumDescriptions:
        running: The replication will immediately start running.
        stopped: The replication configuration will be created but the replication will not start running until the user explicitly starts it.
    max_backoff_time:
      description: |-
        Specifies the maximum time-period (in minutes) that Sync Gateway will attempt to reconnect to a lost or unreachable remote.

        When a disconnection happens, Sync Gateway will do an exponential backoff up to this specified value. When this value is met, it will attempt to reconnect indefinitely every `max_backoff_time` minutes.

        If this is set to 0, Sync Gateway will do the normal exponential backoff after the disconnect happens but then attempting 10 minutes and stop the replication.

        Note: this defaults to 5 minutes for replications created prior to Sync Gateway 2.8.
      type: integer
      default: 5
    purge_on_removal:
      description: |-
        Specifies whether to purge a document if the remote user loses access to all of the channels on the document when attempting to pull it from the remote.

        If false, documents will not be replicated and not be purged when the user loses access.
      type: boolean
      default: false
    query_params:
      description: |-
        This is a set of key/value pairs used in the query string of the replication.

        If `filters=sync_gateway/bychannel` then this can be used to set the channels to filter by in a pull replication. To do this, set the `channels` key to a string array of the channels to filter by. For example:
        ```json
        "filter":"sync_gateway/bychannel",
        "query_params": {
          "channels":["chanUser1"]
        },
        ```
      type: array
      items:
        type: string
    remote:
      description: |-
        This is the endpoint of the database for the remote Sync Gateway that is the subject of this replication's `push`, `pull`, or `pushAndPull` action.
        Typically this would include the URI, port, and database name. For example, `https://localhost:4985/db`.
      type: string
    remote_password:
      description: |-
        The password to use to authenticate with the remote. This password will be redacted in the replication config.
      type: string
    remote_username:
      description: |-
        The username to use to authenticate with the remote.
      type: string
    replication_id:
      description: |-
        This is the ID of the replication.

        When creating a new replication using a POST request, this will be set to a random UUID if not explicitly set.

        When the replication ID is specified in the URL, this must be set to the same replication ID if specifying it at all.
      type: string
      maximum: 160
    run_as:
      description: This is used if you want to specify a user to run the replication as. This means that the replication will only be able to replicate what the user  access to what the user has access to.
      type: string
    password:
      description: |-
        **This has been deprecated in favour of `remote_password`.**

        This is the password to use to authenticate with the remote. This password will be redacted in the replication config.
      type: string
      deprecated: true
    username:
      description: |-
        **This has been deprecated in favour of `remote_username`.**

        This is the username to use to authenticate with the remote.
      type: string
      deprecated: true
  required:
    - direction
  title: User configurable replication properties
All-replications:
  description: Contains all the replication IDs with their corresponding replication configurations
  type: object
  properties:
    replication_id:
      $ref: '#/Retrieved-replication'
  title: All replications
Replication-status:
  type: object
  properties:
    replication_id:
      description: The ID of the replication.
      type: string
    config:
      $ref: '#/Replication'
    status:
      $ref: '#/ISGRReplicationState'
    error_message:
      description: The error message of the replication if an error has occurred.
      type: string
    docs_read:
      description: The number of documents that have been read (fetched) from the source database.
      type: integer
    docs_checked_pull:
      type: integer
    docs_purged:
      description: The number of documents that have been purged.
      type: integer
    rejected_by_local:
      description: The number of documents that were received by the local but did not get replicated due to getting rejected by the sync function on the local.
      type: integer
    last_seq_pull:
      description: The last changes sequence number that was pulled from the remote.
      type: string
    deltas_recv:
      description: The number of deltas that have been received from the remote.
      type: integer
    deltas_requested:
      type: integer
    docs_written:
      description: The number of documents that have been wrote (pushed) to the target database.
      type: integer
    docs_checked_push:
      type: integer
    doc_write_failures:
      description: The number of documents that have failed to be wrote (pushed) to the target database. There will be no attempt to try to push these docs again.
      type: integer
    doc_write_conflicts:
      description: The number of documents that had a conflict.
      type: integer
    rejected_by_remote:
      description: The number of documents that were received by the remote but did not get replicated due to getting rejected by the sync function on the remote.
      type: integer
    last_seq_push:
      description: The last changes sequence number that was pushed to the remote.
      type: string
    deltas_sent:
      description: 'The number of deltas that have been sent to the remote. '
      type: integer
  required:
    - replication_id
  title: Replication-status
Scopes:
  description: Scope-specific configuration.
  type: object
  properties:
    collections:
      description: An object keyed by collection name containing config for the specific collection.
      type: object
      additionalProperties:
        x-additionalPropertiesName: collectionname
        $ref: '#/CollectionConfig'
  title: Scopes
CollectionConfig:
  description: Collection-specific configuration.
  type: object
  properties:
    sync:
      description: The Javascript function that newly created documents in this collection are ran through.
      type: string
      example: 'function(doc){channel("collection name");}'
    import_filter:
      description: |-
        This is the function that all imported documents in this collection are ran through in order to filter out what to import and what not to import. This allows you to control what is made available to Couchbase Mobile clients. If it is not set, then no documents are filtered when imported.

        `import_docs` in the database config must be true to make this field applicable.
      type: string
      example: 'function(doc) { if (doc.type != ''mobile'') { return false; } return true; }'
  title: Collection config
CredentialsConfig:
  description: The configuration for the credentials set.
  type: object
  properties:
    username:
      description: Username for authenticating to the bucket
      type: string
    password:
      description: Password for authenticating to the bucket. This value is always redacted.
      type: string
    x509_cert_path:
      description: Cert path (public key) for X.509 bucket auth
      type: string
    x509_key_path:
      description: Key path (private key) for X.509 bucket auth
      type: string
  title: Credentials config
Database:
  description: The properties of a database configuration.
  type: object
  x-requirePropertiesSorted: true
  properties:
    allow_empty_password:
      description: This controls whether users that are created can have an empty password or not.
      type: boolean
      default: false
    bucket:
      description: The Couchbase Server backing bucket for the database.
      type: string
      default: The database name
    bucket_op_timeout_ms:
      description: 'This is the amount of milliseconds should pass before a bucket operation times out. An error will be returned if the bucket operation times out saying: `operation timed out`.'
      type: number
    cacertpath:
      description: The root CA cert path for X.509 bucket authentication.
      type: string
    cache:
      type: object
      x-requirePropertiesSorted: true
      properties:
        channel_cache:
          description: The channel cache config settings.
          x-requirePropertiesSorted: true
          type: object
          properties:
            compact_high_watermark_pct:
              description: |-
                The trigger value for starting the channel cache eviction process.

                Specify this as a percentage which will be the percentage used on `max_number).

                When the cache size, determined by `max_number`, reaches the high watermark, the eviction process iterates through the cache, removing inactive channels.
              type: integer
              default: 80
            compact_low_watermark_pct:
              description: |-
                The trigger value for stopping the channel cache eviction process.

                Specify this as a percentage which will be the percentage used on `max_number).

                When the cache size, determined by `max_number` returns to a value lower than the percentage of it set here, the cache eviction process is stopped.
              type: integer
              default: 60
            expiry_seconds:
              description: The amount of time (in seconds) to keep entries in the cache beyond the minimum retained.
              type: integer
              default: 60
            max_length:
              description: The maximum number of entries to maintain in the cache per channel.
              type: integer
              default: 500
            max_num_pending:
              description: The maximum number of pending sequences before skipping sequences.
              type: integer
              default: 10000
            max_number:
              description: The maximum number of channel caches which can exist at any one point.
              type: integer
              default: 50000
            max_wait_pending:
              description: The maximum time (in milliseconds) for waiting for a pending sequence before skipping it.
              type: number
              default: 5000
            max_wait_skipped:
              description: The maximum amount of time (in milliseconds) to wait for a skipped sequence before abandoning it.
              type: number
              default: 3600000
            min_length:
              description: The minimum number of entries to maintain in the cache per channel.
              type: integer
              default: 50
            enable_star_channel:
              description: |-
                Since Sync Gateway 4.0, this option no longer has an effect, the star channel is always enabled.
                If this value is set to false, a database can only exist in the offline state until this configuration is modified.
              type: boolean
              default: true
              deprecated: true
            query_limit:
              description: |-
                **Deprecated in favour of the database setting `query_pagination_limit`**

                The limit used for channel queries.
              type: integer
              default: 5000
              deprecated: true
        rev_cache:
          description: The revision cache config settings.
          type: object
          properties:
            max_memory_count_mb:
              description: |-
                The maximum amount of memory the revision cache should take up in MB, setting to 0 will disable any eviction based on memory at rev cache.
                There is a minimum value of 50 (50MB) for this config option.
                When set this memory limit will work in in hand with revision cache size parameter. So you will potentially get eviction at revision cache both based off memory footprint and number of items in the cache.
                **This is an Enterprise Edition feature only**
              type: integer
              default: 0
            shard_count:
              description: The number of shards the revision cache should be split into.
              type: integer
              default: 16
            size:
              description: |-
                The maximum number of revisions that can be stored in the revision cache.
                Note when running with greater than 1 shard count we add 10% capacity overall to avoid early eviction when some shards fill up before others, so
                you may find that the capacity stat (revision_cache_num_items) will climb to the defined rev cache size + 10%.
              type: integer
              default: 5000
            insert_on_write:
              description: |-
                Whether to insert revisions into the revision cache when documents are written to the database.
                If false, only revisions read from the database will be cached.
              type: boolean
              default: false
        channel_cache_expiry:
          description: |-
            **Deprecated, please use the database setting `cache.channel_cache.expiry_seconds` instead**

            The time (seconds) to keep entries in cache beyond the minimum retained.
          type: integer
          deprecated: true
        channel_cache_max_length:
          description: |-
            **Deprecated, please use the database setting `cache.channel_cache.max_length` instead**

            The maximum number of entries maintained in cache per channel.
          type: number
          deprecated: true
        channel_cache_min_length:
          description: |-
            **Deprecated, please use the database setting `cache.channel_cache.min_length` instead**

            The minimum number of entries maintained in cache per channel.
          type: integer
          deprecated: true
        enable_star_channel:
          description: |-
            **Deprecated, please use the database setting `cache.channel_cache.enable_star_channel` instead**

            Used to control whether Sync Gateway should use the all documents (*) channel.
          type: boolean
          deprecated: true
        max_num_pending:
          description: |-
            **Deprecated, please use the database setting `cache.channel_cache.max_num_pending` instead**

            The max number of pending sequences before skipping.
          type: integer
          deprecated: true
        max_wait_pending:
          description: |-
            **Deprecated, please use the database setting `cache.channel_cache.max_wait_pending` instead**

            The maximum time (in milliseconds) for waiting for a pending sequence before skipping it.
          type: number
          deprecated: true
        max_wait_skipped:
          description: |-
            **Deprecated, please use the database setting `cache.channel_cache.max_wait_skipped` instead**

            The maximum time (in milliseconds) for waiting for pending sequences before skipping.
          type: number
          deprecated: true
    certpath:
      description: The cert path (public key) for X.509 bucket auth.
      type: string
    changes_request_plus:
      type: boolean
      default: false
      description: |-
        Sets the default value of `request_plus` for one-shot/non-continuous changes feeds, which when true, ensures all valid documents written prior to the request being issued are included in the response. Setting this option at the database level is required to ensure Couchbase Lite utilizes this changes feed mode.

        This also sets the default value of query param `request_plus` for [GET /{keyspace}/_changes](#operation/get_keyspace-_changes) or `request_plus` for [POST /{keyspace}/_changes](#operation/post_keyspace-_changes).
    client_partition_window_secs:
      description: |-
        How long (in seconds) clients can remain offline for without losing replication metadata.

        Defaults to 30 days (in seconds)
      type: integer
      default: 2592000
    compact_interval_days:
      description: |-
        The interval between scheduled tombstone compaction runs (in days). This can be a floating point number.

        If set to 0, compaction will not run automatically.
      type: number
      default: 1
    cors:
      allOf:
        - $ref: "#/CORS"
        - type: object
          description: CORS configuration for this database; if present, overrides server's config.
    delta_sync:
      description: |-
        Delta sync configuration settings.

        **This is an Enterprise Edition feature only**
      type: object
      properties:
        enabled:
          description: |-
            Whether delta sync is enabled.

            **This is an Enterprise Edition feature only**
          type: boolean
          default: false
        rev_max_age_seconds:
          description: |-
            The number of seconds deltas for old revisions are available for.

            This defaults to 24 hours (in seconds).
          type: number
          default: 86400
    disable_password_auth:
      description: Whether to disable username/password authentication and only allow OIDC and guest access.
      type: boolean
      default: false
    disable_public_all_docs:
      description: |-
        This controls whether the [GET /{keyspace}/_all_docs](#operation/get_keyspace-_all_docs) REST API endpoint is publicly accessible or not.
        Disabling this endpoint is recommended for larger datasets or production workloads.
        [GET /{keyspace}/_changes](#operation/get_keyspace-_changes) or [POST /{keyspace}/_bulk_get](#operation/post_keyspace-_bulk_get) have more efficient implementations and should be used instead.

        If set to `true`, the endpoint will not be publicly accessible, and will only be available on the Admin API.
        Setting this to `false`, or leaving it as the default value is deprecated, and may default to `true` in a future release.
      type: boolean
      default: false
    event_handlers:
      description: These are the settings for webhooks.
      type: object
      properties:
        db_state_changed:
          $ref: '#/Event-config'
        document_changed:
          allOf:
            - $ref: '#/Event-config'
            - type: object
              properties:
                options:
                  description: Options for the document changed event.
                  type: object
                  properties:
                    winning_rev_only:
                      description: If true, only the winning revision of the document will be sent to the webhook.
                      type: boolean
                      default: false
        max_processes:
          description: The maximum amount of concurrent event handling independent functions that can be running at the same time.
          type: string
        wait_for_process:
          description: The maximum amount of time (in milliseconds) to wait when the even queue is full.
          type: string
    guest:
      $ref: '#/User'
    import_backup_old_rev:
      description: This controls whether import should attempt to create a temporary backup of the previous revision body (if available) when the document is modified in the bucket.
      type: boolean
      default: false
    import_docs:
      description: |-
        If true, documents will be imported in to Sync Gateway from the bucket in the background. Documents will be ran through the set `import_filter` if any is set.

        The default value depends on the edition of Sync Gateway being used. If the edition is the Community Edition, then this will default to `false` or else in the Enterprise Edition, it will default to `true`. This value requires `enable_shared_bucket_access=true`.

        This can also be set to the string `continuous` which maps to true.
      type: boolean
    import_filter:
      description: |-
        This is the function that all imported documents in the default scope and collection are ran through in order to filter out what to import and what not to import. This allows you to control what is made available to Couchbase Mobile clients. If it is not set, then no documents are filtered when imported.

        `import_docs` must be true to make this field applicable.

        If `scopes` parameter is set, this is ignored.
      type: string
      example: 'function(doc) { if (doc.type != ''mobile'') { return false; } return true; }'
    import_partitions:
      description: |-
        ** This is an Enterprise Edition feature only**

        This is how many import partitions should be used for import sharding.

        Partitions are distributed among all Sync Gateway nodes participating in import processing (`import_docs=true`), and each process a subset of the server's vbuckets.

        Each partition is processed by an independent function that runs simultaneously to others, so `import_partitions` can be used to tune concurrency based on the number of Sync Gateway nodes, and the number of cores per node.
      type: number
      default: 16
      minimum: 1
      maximum: 1024
    index:
      description: "Global Secondary Index Settings"
      properties:
        num_partitions:
          $ref: '#/NumIndexPartitions'
        num_replicas:
          description: This is the number of Global Secondary Indexes (GSI) to use for core indexes.
          type: number
          default: 1
    javascript_timeout_secs:
      description: The maximum number of seconds the sync, import filter, and custom conflict resolver JavaScript functions are allowed to run for before timing out. Set to 0 to allow the JS functions to run uncapped.
      type: number
      default: 60
    keypath:
      description: The key path (private key) for X.509 bucket auth
      type: string
    kv_tls_port:
      description: The Memcached TLS port.
      type: integer
      default: 11207
    local_doc_expiry_secs:
      description: The number of seconds before a `_local` document should expire.
      type: integer
      default: 7776000
    local_jwt:
      description: Configuration for Local JWT authentication.
      type: object
      additionalProperties:
        x-additionalPropertiesName: providername
        description: The providers name.
        type: object
        required: ['issuer', 'client_id', 'algorithms', 'keys']
        properties:
          algorithms:
            description: The JWT signing algorithms to accept for authentication.
            type: array
            items:
              type: string
          channels_claim:
            description: |-
              If set, the value(s) of the given JSON Web Token claim will be added to the user's channels.

              The value of this claim must be either a string or an array of strings, any other type will result in an error.
            type: string
          client_id:
            description: The value to match against the "aud" claim of JWTs. Set to an empty string to disable audience validation.
            type: string
          disable_session:
            description: Disable Sync Gateway session creation on successful JWT authentication.
            type: boolean
          issuer:
            description: The value to match against the "iss" claim of JWTs.
            type: string
          keys:
            description: The JSON Web Keys to use to validate JWTs.
            type: array
            items:
              type: object
              properties:
                alg:
                  type: string
                  description: The algorithm intended for use with the key.
                crv:
                  type: string
                  description: For Elliptic Curve keys, the name of the curve to use.
                  enum: ['P-256', 'P-384', 'P-521']
                e:
                  type: string
                  description: For RSA keys, the exponent of the public key, as a Base64urlUInt-encoded value.
                kid:
                  type: string
                  description: The Key ID, used to identify the key to use.
                kty:
                  type: string
                  description: The cryptographic algorithm family used with the key, such as "RSA" or "EC"
                  enum: ['RSA', 'EC']
                n:
                  type: string
                  description: For RSA keys, the modulus value of the key, as a Base64urlUInt-encoded value.
                use:
                  type: string
                  description: The intended use of the public key. Only 'sig' is accepted.
                  enum: ['sig']
                x:
                  type: string
                  description: For Elliptic Curve keys, the X coordinate of the point, as a base64url string.
                y:
                  type: string
                  description: For Elliptic Curve keys, the Y coordinate of the point, as a base64url string.
          register:
            description: If to register a new Sync Gateway user account when a user logs in with a JWT.
            type: boolean
          roles_claim:
            description: |-
              If set, the value(s) of the given JSON Web Token claim will be added to the user's roles.

              The value of this claim must be either a string or an array of strings, any other type will result in an error.
            type: string
          user_prefix:
            description: This is the username prefix for all users created through this provider.
            type: string
          username_claim:
            description: |-
              Allows a different OpenID Connect field to be specified instead of the Subject (`sub`).

              The field name to use can be specified here.
            type: string
    logging:
      description: Per-database logging configuration.
      type: object
      properties:
        audit:
          description: Audit logging configuration.
          type: object
          properties:
            disabled_roles:
              description: List of roles for which audit logging is disabled. Either cbs or sgw.
              type: array
              items:
                type: object
                properties:
                  domain:
                    description: >
                      The domain of the role for which audit logging is disabled.
                    enum: [cbs, sgw]
                    x-enumDescription:
                      cbs: Couchbase Server RBAC
                      sgw: Sync Gateway Role
                    type: string
                  name:
                    description: The name of the role for which audit logging is disabled.
                    type: string
            disabled_users:
              description: List of users for which audit logging is disabled.
              type: array
              items:
                type: object
                properties:
                  domain:
                    description: >
                      The domain of the user for which audit logging is disabled.
                    type: string
                    enum: [cbs, sgw]
                    x-enumDescription:
                      cbs: Couchbase Server User
                      sgw: Sync Gateway User
                  name:
                    description: The name of the user for which audit logging is disabled.
                    type: string
            enabled:
              description: Whether audit logging is enabled.
              type: boolean
              default: false
            enabled_events:
              description: List of enabled audit events for this database.
              type: array
              items:
                type: number
              example: [1234, 5678]
        console:
          description: Console logging configuration.
          type: object
          properties:
            log_keys:
              description: Log Keys for the console output
              type: array
              items:
                type: string
              example: ["CRUD", "HTTP", "Query"]
            log_level:
              description: Log Level for the console output
              type: string
              enum:
                - none
                - error
                - warn
                - info
                - debug
                - trace
              example: debug
    max_concurrent_query_ops:
      description: The maximum amount of query operations that can be running at any one point.
      type: integer
      default: 1000
    name:
      description: The name of the database.
      type: string
    offline:
      description: Start the database in an offline state.
      type: boolean
      default: false
    oidc:
      description: Configuration for OpenID Connect authentication.
      type: object
      properties:
        default_provider:
          description: The default provider to use when the provider is not specified in the client.
          type: string
        providers:
          description: List of OpenID Connect issuers.
          type: object
          additionalProperties:
            x-additionalPropertiesName: providername
            description: The providers name.
            type: object
            properties:
              InsecureSkipVerify:
                description: 'Determines whether the TLS certificate verification should be disabled for this provider. '
                type: boolean
                default: false
              IsDefault:
                description: Indicates if this is the default OpenID Connect provider.
                type: boolean
              Name:
                description: The name of the OpenID Connect Provider.
                type: string
              allow_unsigned_provider_tokens:
                description: Allows users accept unsigned tokens from providers.
                type: boolean
              callback_url:
                description: |-
                  The URL that the OpenID Connect will redirect to after authentication.

                  If not provided, a callback URL will be generated.
                type: string
              channels_claim:
                description: |-
                  If set, the value(s) of the given OpenID Connect authentication token claim will be added to the user's channels.

                  The value of this claim must be either a string or an array of strings, any other type will result in an error.
                type: string
              client_id:
                description: The OpenID Connect provider client ID.
                type: string
              disable_callback_state:
                description: |-
                  Controls whether to maintain state between the auth request and callback endpoints (`/_oidc` and `/_oidc_callback`).

                  **This is not recommended as it would cause OpenID Connect authentication to be vulnerable to Cross-Site Request Forgery (CSRF, XSRF).**
                type: boolean
                default: false
              disable_cfg_validation:
                description: This bypasses the configuration validation based on the OpenID Connect specifications. This may be required for some OpenID providers that don't strictly adhere to the specifications.
                type: boolean
                default: false
              disable_session:
                description: Disable Sync Gateway session creation on successful OpenID Connect authentication.
                type: boolean
              discovery_url:
                description: The non-standard discovery endpoint.
                type: string
              include_access:
                description: 'This is whether the `_oidc_callback` response should include the OpenID Connect access token and associated fields (such as `token_type`, and `expires_in`).'
                type: boolean
              issuer:
                description: The URL for the OpenID Connect issuer.
                type: string
              register:
                description: If to register a new Sync Gateway user account when a user logs in with OpenID Connect.
                type: boolean
              roles_claim:
                description: |-
                  If set, the value(s) of the given OpenID Connect authentication token claim will be added to the user's roles.

                  The value of this claim must be either a string or an array of strings, any other type will result in an error.
                type: string
              scope:
                description: The scope sent for the OpenID Connect request.
                type: array
                items:
                  type: string
              user_prefix:
                description: This is the username prefix for all users created through this provider.
                type: string
              username_claim:
                description: |-
                  Allows a different OpenID Connect field to be specified instead of the Subject (`sub`).

                  The field name to use can be specified here.
                type: string
              validation_key:
                description: The OpenID Connect provider client secret.
                type: string
    old_rev_expiry_seconds:
      description: The number of seconds before old revisions are removed from the Couchbase Server bucket.
      type: number
      default: 300
    password:
      description: The password for authenticating to the server.
      type: string
    query_pagination_limit:
      description: The query limit to be used during pagination of large queries.
      type: integer
      default: 5000
    replications:
      type: object
      properties:
        replication_id:
          $ref: '#/Replication'
    revs_limit:
      description: |-
        The maximum depth a document's revision tree can grow to.
      type: number
      default: 50
      minimum: 0
    roles:
      additionalProperties:
        x-additionalPropertiesName: rolename
        $ref: '#/Role'
    scopes:
      description: An object keyed by scope name containing config for the specific collection.
      type: object
      additionalProperties:
        x-additionalPropertiesName: scopename
        $ref: '#/Scopes'
      maxProperties: 1
      example:
        scopename:
          collections:
            collectionname1:
              sync: 'function(doc){channel("collection name");}'
              import_filter: 'function(doc) { if (doc.type != ''mobile'') { return false; } return true; }'
            collectionname2:
              sync: 'function(doc){channel("collection name");}'
              import_filter: 'function(doc) { if (doc.type != ''mobile'') { return false; } return true; }'
    send_www_authenticate_header:
      description: Controls whether to send a `WWW-Authenticate` header in `401 Unauthorized` HTTP responses.
      type: boolean
      default: true
    serve_insecure_attachment_types:
      description: |
        If set, always serve attachments with the `Content-Type` header set to the type of the attachment.

        When serving an attachment, usually the `Content-Type` header is set to the type of the attachment but the `Content-Disposition` response header will be set instead if the content type is vulnerable to a phishing attack, causing the browser to download the file instead of display it. This option will override that behaviour and always set the `Content-Type` header.
      type: boolean
      default: false
    server:
      description: 'This is the Couchbase Server address or addresses that the database connect to. '
      type: string
    session_cookie_http_only:
      description: Make all session cookies for the database set the `HttpOnly` flag so they are inaccessible to JavaScript.
      type: boolean
      default: false
    session_cookie_name:
      description: This can be used to define a custom per-database session cookie name.
      type: string
    session_cookie_secure:
      description: |-
        Override the session cookie `secure` flag. If set, the cookie will have the `secure` flag.

        This will default to `true` if startup config `api.https.tls_cert_path` is set otherwise it will default to `false`.
      type: boolean
    sgreplicate_enabled:
      description: Whether the node should accept assign replications (`true`) or not (`false`).
      type: boolean
      default: true
    sgreplicate_websocket_heartbeat_secs:
      description: Use a custom heartbeat interval (in seconds) for websocket ping frames.
      type: integer
      default: 300
    slow_query_warning_threshold:
      description: 'The amount of milliseconds a N1QL query should run before logging a warning. '
      type: number
      default: 500
    store_legacy_revtree_data:
      description: |-
        Controls whether Sync Gateway stores additional legacy revision tree pointer data to support 3.x/early 4.x clients that still use RevTree IDs (for example when used as delta sources).

        Disable this when you are confident all clients use newer CV-based revisions and no longer require legacy RevTree ID lookups.
      type: boolean
      default: true
    suspendable:
      description: |-
        Set to true to allow the database to be suspended.

        Defaults to true when running in serverless mode otherwise defaults to false.
      type: boolean
      default: false
    sync:
      description: |-
        The Javascript function that newly created documents are ran through for the default scope and collection.

        If `scopes` parameter is set, this is ignored.
      type: string
      default: 'function(doc){channel(doc.channels);}'
    unsupported:
      description: These are unsupported options and therefore it is not recommended to use them.
      type: object
      properties:
        api_endpoints:
          type: object
          properties:
            enable_couchbase_bucket_flush:
              description: |-
                **Setting for test purposes only**

                Whether Couchbase buckets can be flushed via Admin REST API.
              type: boolean
        dcp_read_buffer:
          description: Set the dcp feed to use a different read buffer size.
          type: number
        force_api_forbidden_errors:
          description: Force REST API errors to return forbidden
          type: boolean
        guest_read_only:
          description: Restrict GUEST document access to read-only.
          type: boolean
        kv_buffer:
          description: Set the kv pool to use a different buffer size.
          type: number
        oidc_test_provider:
          type: object
          properties:
            enabled:
              description: Whether the `oidc_test_provider` endpoints should be exposed on the public API.
              type: boolean
        oidc_tls_skip_verify:
          description: Enable self-signed certificates for OIDC testing.
          type: boolean
        remote_config_tls_skip_verify:
          description: Enable self-signed certificates for external JavaScript load.
          type: boolean
        resync_partitions:
          description: |-
            Number of partitions to use for distributed DCP resync. If not set, defaults to the import partitions value.
          type: integer
          minimum: 1
          maximum: 1024
        same_site_cookie:
          description: |-
            Override the session cookie SameSite behavior. By default, a session cookie will have SameSite:None if CORS is enabled, and will have no SameSite attribute if CORS is not enabled.  Setting this property to`Default` will omit the SameSite attribute from the cookie.
          type: string
          enum:
            - "Default"
            - "Lax"
            - "None"
            - "Strict"
        sgr_tls_skip_verify:
          description: Enable self-signed certificates for SG-replicate testing.
          type: boolean
        user_views:
          type: object
          properties:
            enabled:
              description: Whether pass-through view query is supported through public API.
              type: boolean
        warning_thresholds:
          type: object
          properties:
            access_and_role_grants_per_doc:
              description: The number of access and role grants per document to be used as a threshold for grant count warnings.
              type: number
            channel_name_size:
              description: The number of channel name characters to be used as a threshold for channel name warnings.
              type: number
            channels_per_doc:
              description: The number of channels per document to be used as a threshold for the channel count warnings.
              type: number
            channels_per_user:
              description: The number of channels per user to be used as a threshold for channel count warnings.
              type: number
            xattr_size_bytes:
              description: The number of bytes to be used as a threshold for xattr size limit warnings.
              type: number
    use_views:
      description: Force the use of views instead of GSI.
      type: boolean
      default: false
    user_xattr_key:
      description: |-
        The key to use for the user xattr that will be accessible from the sync function. If empty, the feature will be disabled.

        This is an Enterprise Edition feature only.
      type: string
      maximum: 15
    username:
      description: The username for authenticating to the server.
      type: string
    users:
      additionalProperties:
        x-additionalPropertiesName: username
        $ref: '#/User'
    view_query_timeout_secs:
      description: The number of seconds before a view query should timeout.
      type: integer
      default: 75
    allow_conflicts:
      description: |-
        Since Sync Gateway 4.0, this option has no effect.
        If this option is set to true on an existing database, the database must be modified to remove this parameter in order allow the database to come online. Otherwise, the database will be in the offline state.
      type: boolean
      default: false
      deprecated: true
    enable_shared_bucket_access:
      description: |-
        Since Sync Gateway 4.0, this option has no effect.
        If this option is set to true on an existing database, the database must be modified to remove this parameter in order allow the database to come online. Otherwise, the database will be in the offline state.
      type: boolean
      default: true
      deprecated: true
    feed_type:
      description: The type of feed to use to communicate with Couchbase Server. This will use DCP regardless of specification.
      type: string
      default: DCP
      enum:
        - DCP
      deprecated: true
    num_index_replicas:
      description: |-
        **Deprecated, please use the database setting `index.num_replicas` instead**
      deprecated: true
      type: number
      default: 1
    pool:
      description: This field is unsupported and ignored.
      type: string
      default: default
      deprecated: true
    rev_cache_size:
      description: |-
        **Deprecated, please use the database setting `cache.rev_cache.size` instead**

        The maximum number of revisions to store in the revision cache.
      type: number
      deprecated: true
  title: Database-config
Disabled-users-and-roles:
  type: object
  properties:
    disabled_users:
      description: List of users for which audit logging is disabled.
      type: array
      items:
        type: object
        properties:
          domain:
            description: The domain of the user for which audit logging is disabled. Either cbs or sgw.
            type: string
          name:
            description: The name of the user for which audit logging is disabled.
            type: string
    disabled_roles:
      description: List of roles for which audit logging is disabled. Either cbs or sgw.
      type: array
      items:
        type: object
        properties:
          domain:
            description: The domain of the role for which audit logging is disabled.
            type: string
          name:
            description: The name of the role for which audit logging is disabled.
            type: string
Database-audit:
  title: Simple
  description: A map of audit events and whether they are enabled or not.
  properties:
    enabled:
      type: boolean
    events:
      type: object
      additionalProperties:
        x-additionalPropertiesName: audit_id
        description: The audit event ID and whether it is enabled or not.
        type: boolean
    disabled_users:
      description: List of users for which audit logging is disabled.
      type: array
      items:
        type: object
        properties:
          domain:
            description: >
              The domain of the role for which audit logging is disabled.
            enum: [cbs, sgw]
            x-enumDescription:
              cbs: Couchbase Server User
              sgw: Sync Gateway User
            type: string
          name:
            description: The name of the user for which audit logging is disabled.
            type: string
    disabled_roles:
      description: List of roles for which audit logging is disabled. Either cbs or sgw.
      type: array
      items:
        type: object
        properties:
          domain:
            description: >
              The domain of the role for which audit logging is disabled.
            enum: [cbs, sgw]
            x-enumDescription:
              cbs: Couchbase Server RBAC
              sgw: Sync Gateway Role
            type: string
          name:
            description: The name of the role for which audit logging is disabled.
            type: string
Database-audit-verbose:
  title: Verbose
  description: A map of detailed audit events.
  properties:
    enabled:
      type: boolean
    events:
      type: object
      additionalProperties:
        x-additionalPropertiesName: audit_id
        description: The audit event ID and whether it is enabled or not.
        $ref: '#/AuditEventVerbose'
    disabled_users:
      description: List of users for which audit logging is disabled.
      type: array
      items:
        type: object
        properties:
          domain:
            description: >
              The domain of the role for which audit logging is disabled.
            enum: [cbs, sgw]
            x-enumDescription:
              cbs: Couchbase Server User
              sgw: Sync Gateway User
            type: string
          name:
            description: The name of the user for which audit logging is disabled.
            type: string
    disabled_roles:
      description: List of roles for which audit logging is disabled. Either cbs or sgw.
      type: array
      items:
        type: object
        properties:
          domain:
            description: >
              The domain of the role for which audit logging is disabled.
            enum: [cbs, sgw]
            x-enumDescription:
              cbs: Couchbase Server RBAC
              sgw: Sync Gateway Role
            type: string
          name:
            description: The name of the role for which audit logging is disabled.
            type: string
AuditEventVerbose:
  title: audit-event-verbose
  description: Detailed information about an audit event.
  type: object
  properties:
    name:
      type: string
      description: "The name of the audit event."
      readOnly: true
    description:
      type: string
      description: "The description of the audit event."
      readOnly: true
    enabled:
      type: boolean
      description: "Whether this audit event is currently enabled or not."
    filterable:
      type: boolean
      description: "Whether this audit event can be disabled. Some audit events are always on."
      readOnly: true
Event-config:
  type: object
  properties:
    handler:
      description: The handler type.
      type: string
      enum:
        - webhook
    url:
      description: The URL of the webhook.
      type: string
    filter:
      description: The Javascript function to use to filter the webhook events.
      type: string
    timeout:
      description: The amount of time (in seconds) to attempt connect to the webhook before giving up.
      type: number
  title: Event-config
Resync-status:
  description: The status of a resync operation
  type: object
  properties:
    status:
      description: The status of the current operation.
      type: string
      enum:
        - running
        - completed
        - stopping
        - stopped
        - error
    start_time:
      description: The ISO-8601 date and time the resync operation was started.
      type: string
    last_error:
      description: The last error that occurred in the resync operation (if any).
      type: string
    docs_changed:
      description: The amount of documents that have been changed as a result of the resync operation.
      type: integer
    docs_processed:
      description: The amount of docs that have been processed so far in the resync operation.
      type: integer
    collections_processing:
      description: The collections that the resync operation is running on.
      allOf:
        - $ref: '#/ResyncScopesMap'
  required:
    - status
    - start_time
    - last_error
    - docs_changed
    - docs_processed
  title: Resync-status
Attachment-Migration-status:
  description: The status of a attachment migration operation
  type: object
  properties:
    status:
      description: The status of the current attachment migration operation.
      type: string
      enum:
        - running
        - completed
        - stopping
        - stopped
        - error
    start_time:
      description: The ISO-8601 date and time the attachment migration operation was started.
      type: string
    last_error:
      description: The last error that occurred in the attachment migration operation (if any).
      type: string
    migration_id:
      description: The UUID given to the attachment migration operation.
      type: string
    docs_changed:
      description: The amount of documents that have had attachment metadata migrated as a result of attachment migration operation.
      type: integer
    docs_processed:
      description: The amount of docs that have been processed through the attachment migration operation.
      type: integer
    docs_failed:
      description: The amount of docs that have failed to be processed through the attachment migration operation.
      type: integer
  required:
    - status
    - start_time
    - last_error
    - docs_changed
    - docs_processed
  title: Attachment-Migration-status
Compact-status:
  description: The status returned from a compaction.
  type: object
  properties:
    status:
      description: The status of the current operation.
      type: string
    start_time:
      description: The ISO-8601 date and time the compact operation was started.
      type: string
    last_error:
      description: The last error that occurred in the compact operation (if any).
      type: string
    docs_purged:
      description: |-
        **Applicable to tombstone compaction only**

        This is the amount of documents that have been purged so far.
      type: string
    marked_attachments:
      description: |-
        **Applicable to attachment compaction only**

        This is the number of references there are to legacy attachments.
      type: string
    purged_attachments:
      description: |-
        **Applicable to attachment compaction only**

        This is the amount of attachments that have been purged so far.
      type: string
    compact_id:
      description: |-
        **Applicable to attachment compaction only**

        This is the ID of the compaction.
      type: string
    phase:
      description: |-
        **Applicable to attachment compaction only**

        This indicates the current phase of running attachment compact processes.

        For failed processes, this indicates the phase at which a compact_id restart will commence (where relevant).
      type: string
    dry_run:
      description: |
        **Applicable to attachment compaction only**
      type: string
      enum:
        - mark
        - sweep
        - cleanup
  required:
    - status
    - start_time
    - last_error
  title: Compact-status
Serverless:
  description: Configuration for when SG is running in serverless mode
  type: object
  properties:
    enabled:
      description: Run SG in to serverless mode
      type: boolean
      readOnly: true
    min_config_fetch_interval:
      description: |-
        How long database configs should be kept for in Sync Gateway before refreshing. Set to 0 to fetch configs everytime. This is used for requested databases that SG does not know about.

        This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
      type: string
      default: 1s
Startup-config:
  type: object
  x-requirePropertiesSorted: true
  properties:
    api:
      description: Configuration settings for modifying how the REST API is interacted with.
      type: object
      properties:
        admin_interface:
          description: |-
            Network interface to bind admin API to.

            By default, this will only be accessible to the localhost.
          type: string
          default: '127.0.0.1:4985'
        admin_interface_authentication:
          description: Whether the admin API requires authentication
          type: boolean
          default: true
        compress_responses:
          description: 'If false, disables compression of HTTP responses'
          type: boolean
          default: true
        cors:
          allOf:
            - type: object
              description: CORS configuration for all databases
            - $ref: "#/CORS"
        enable_advanced_auth_dp:
          description: |-
            Whether to enable the DP permissions check feature of admin auth.

            Defaults to `true` if using Enterprise Edition or `false` if using Community Edition.
          type: boolean
        hide_product_version:
          description: Whether product versions removed from Server headers and REST API responses
          type: boolean
        https:
          type: object
          properties:
            tls_cert_path:
              description: The TLS cert file to use for the REST APIs
              type: string
            tls_key_path:
              description: The TLS key file to use for the REST APIs
              type: string
            tls_minimum_version:
              description: The minimum allowable TLS version for the REST APIs
              type: string
              default: tlsv1.2
        idle_timeout:
          description: |-
            The maximum amount of time to wait for the next request when keep-alives are enabled.

            This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
          type: string
          default: 90s
        max_connections:
          description: Max of incoming HTTP connections to accept
          type: number
          default: 0
        metrics_interface:
          description: |-
            Network interface to bind metrics API to.

            By default, this will only be accessible to the localhost.
          type: string
          default: '127.0.0.1:4986'
        metrics_interface_authentication:
          description: Whether the metrics API requires authentication
          type: boolean
          default: true
        profile_interface:
          description: Network interface to bind profiling API to
          type: string
        public_interface:
          description: Network interface to bind public API to
          type: string
          default: ':4984'
        read_header_timeout:
          description: |-
            The amount of time allowed to read request headers.

            This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
          type: string
          default: 5s
        server_read_timeout:
          description: |-
            Maximum duration before timing out read of the HTTP(S) request.

            This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
          type: string
        server_write_timeout:
          description: |-
            Maximum duration before timing out write of the HTTP(S) response.

            This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
          type: string
        pretty:
          description: Pretty-print JSON responses. This property is deprecated.
          type: boolean
          deprecated: true
      readOnly: true
    auth:
      type: object
      properties:
        bcrypt_cost:
          description: Cost to use for bcrypt password hashes
          type: integer
          default: 10
          maximum: 31
          minimum: 10
      readOnly: true
    bootstrap:
      description: Configuration settings for interacting with Couchbase Server.
      type: object
      properties:
        ca_cert_path:
          description: Root CA cert path for TLS connection
          type: string
        config_update_frequency:
          description: |-
            How often to poll Couchbase Server for new config changes.

            This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
          type: string
          default: 10s
        node_heartbeat_expiry:
          description: |-
            How long since a node's last heartbeat before its cluster compat registry entry is pruned. Minimum is 2x the configured `config_update_frequency`.

            This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
          type: string
          default: 60s
        group_id:
          description: The config group ID to use when discovering databases. Allows for non-homogenous configuration.
          type: string
          default: default
        password:
          description: Password for authenticating to server
          type: string
        server:
          description: |
            Couchbase Server connection string/URL for bootstrap configuration.
            The connection string should only reference Couchbase Server Data (KV) nodes.
            Using other node types (Query, Index, Analytics, or Search nodes) is not supported.
            **Connection String Format**
            Sync Gateway supports the ability to resolve DNS SRV records for alternate hostnames, or specifying multiple hostnames explicitly. See the [Couchbase Go SDK documentation on DNS SRV records](https://docs.couchbase.com/go-sdk/current/howtos/managing-connections.html#using-dns-srv-records) for more details.
            Sync Gateway supports both the couchbases:// for TLS and couchbase:// schemes for insecure connection.
            The supported schemes match that of the Couchbase Server SDKs.
            **Examples of valid server values:**
            - `couchbases://nodeA.example.com`
            - `couchbase://nodeA.example.com`
            - `couchbases://nodeA.example.com,nodeB.example.com`
            - `couchbase://nodeA.example.com,nodeB.example.com`
            - `couchbases://nodeA.example.com:1234,nodeB.example.com:1234`
            - `couchbase://nodeA.example.com:1234,nodeB.example.com:1234`
            - `couchbases://127.0.0.1`
            - `couchbase://127.0.0.1`
            On startup, Sync Gateway will try all hostnames until it is able
            to connect successfully.
            **Port Information**
            When using the couchbase:// or couchbases:// schemes, the port is not required as Sync Gateway will use the default Couchbase Server client-to-node ports (11210 for couchbase:// and 11207 for couchbases://). See the [Couchbase Server ports documentation](https://docs.couchbase.com/server/current/install/install-ports.html#ports-listed-by-communication-path) for more details.
            **Alternate Addresses**
            If your Couchbase Server cluster is running in a containerized, port mapped, or otherwise NATd environment like Docker or Kubernetes, Sync Gateway might need more information to connect to the cluster. In many cases the client is able to automatically select the correct set of addresses.
            If the detection heuristic fails in your environment, it is possible to override this behavior by adding a network parameter to the connection string.
            The network parameter can be:
            - `external`: Force the use alternate addresses of Couchbase Server. Used when Sync Gateway should not share network used by Couchbase Server internally.
            - `default`: Do not allow use of alternate addresses of Couchbase Server. Used when Sync Gateway and Couchbase Server are on the same network.
            Example: `"server": "couchbases://my-cbs-server?network=default"`
            Will force the connection to ignore any alternative external addresses configured
            on the Couchbase Server node.
            **Lost Connections**
            If the connection to Couchbase Server is lost during normal operations, Sync Gateway
            will automatically re-connect to another node in the cluster.
          type: string
        server_tls_skip_verify:
          description: Allow empty server CA Cert Path without attempting to use system root pool
          type: boolean
          default: false
        use_system_metadata_collection:
          description: If true, Sync Gateway uses the `_system._mobile` metadata collection and triggers a one-time migration of any metadata in the default collection.
          type: boolean
          default: false
        use_tls_server:
          description: Enforces a secure or non-secure server scheme
          type: boolean
          default: true
        username:
          description: Username for authenticating to server.
          type: string
        x509_cert_path:
          description: Cert path (public key) for X.509 bucket auth
          type: string
        x509_key_path:
          description: Key path (private key) for X.509 bucket auth
          type: string
      readOnly: true
      required:
        - server
        - username
        - password
    bucket_credentials:
      description: 'A map of bucket names to credentials, that can be used instead of the bootstrap ones.'
      type: object
      additionalProperties:
        x-additionalPropertiesName: bucketname
        $ref: '#/CredentialsConfig'
      readOnly: true
    database_credentials:
      description: 'A map of database name to credentials, that can be used instead of the bootstrap ones.'
      type: object
      additionalProperties:
        x-additionalPropertiesName: databasename
        $ref: '#/CredentialsConfig'
      readOnly: true
    heap_profile_collection_threshold:
      description: Threshold in bytes for automatic collection of heap profiles. If not specified, defaults to 85% of the lesser of cgroup or system memory.
      readOnly: true
      type: integer
    heap_profile_disable_collection:
      description: Disables automatic heap profile collection.
      default: false
      type: boolean
      readOnly: true
    logging:
      description: The configuration settings for modifying Sync Gateway logging.
      type: object
      allOf:
        - $ref: '#/Logging-config'
    max_file_descriptors:
      description: Max of open file descriptors (RLIMIT_NOFILE)
      type: number
      default: 5000
      minimum: 0
      readOnly: true
    replicator:
      type: object
      properties:
        blip_compression:
          description: BLIP data compression level (0-9)
          type: integer
          maximum: 9
          minimum: 0
        max_concurrent_changes_batches:
          description: Maximum number of changes batches to process concurrently per replication (1-5)"
          type: integer
          default: 2
          minimum: 1
          maximum: 5
        max_concurrent_replications:
          description: Maximum number of concurrent replication connections allowed. If set to 0 this limit will be ignored.
          type: integer
        max_concurrent_revs:
          description: Maximum number of revs to process concurrently per replication (5-200)
          type: integer
          default: 5
          minimum: 5
          maximum: 200
        max_heartbeat:
          description: |-
            Max heartbeat value for `_changes` request.

            This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
          type: string
      readOnly: true
    unsupported:
      description: Settings that are not officially supported. It is highly recommended these are **not** used.
      type: object
      properties:
        allow_dbconfig_env_vars:
          description: Can be set to false to skip environment variable expansion in database configs
          type: boolean
          default: true
        diagnostic_interface:
          description: |-
            Network interface to bind diagnotic API to.

            By default, this API will not be run unless this string is specified.
          type: string
          default: ""
        http2:
          type: object
          properties:
            enabled:
              description: Whether HTTP2 support is enabled
              type: boolean
              default: false
        serverless:
          $ref: '#/Serverless'
        stats_log_frequency:
          description: |-
            How often should stats be written to stats logs.

            This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
          type: string
          default: 1m
        use_stdlib_json:
          description: Bypass the jsoniter package and use Go's stdlib instead
          type: boolean
          default: false
        use_xattr_config:
          description: Store database configurations in system xattrs
          type: boolean
          default: false
        use_gocb_fast_fail_retry:
          description: When true, gocb cluster/bucket readiness checks and index lookups (on both the bootstrap and per-database connections) fail on the first error instead of retrying. When false, they use the best-effort retry strategy, retrying until their timeout when Couchbase Server is unavailable or failing over.
          type: boolean
          default: false
      readOnly: true
    couchbase_keepalive_interval:
      description: TCP keep-alive interval between SG and Couchbase server. This is unused.
      type: integer
      deprecated: true
      readOnly: true
  title: Startup-config
Runtime-config:
  type: object
  properties:
    logging:
      allOf:
        - $ref: "#/Logging-config"
    max_concurrent_replications:
      description: Maximum number of concurrent replication connections allowed. If set to 0 this limit will be ignored.
      type: integer
      default: 0
  title: Runtime-config
Logging-config:
  type: object
  properties:
    log_file_path:
      description: Absolute or relative path on the filesystem to the log file directory. A relative path is from the directory that contains the Sync Gateway executable file.
      type: string
      readOnly: true
    redaction_level:
      description: Redaction level to apply to log output.
      type: string
      default: partial
      enum:
        - none
        - partial
        - full
        - unset
      readOnly: true
    console:
      allOf:
        - $ref: '#/Console-logging-config'
    error:
      type: object
      description: Error logging configuration.
      properties:
        enabled:
          description: Toggle for this log output
          type: boolean
          default: true
        rotation:
          type: object
          readOnly: true
          properties:
            max_size:
              description: The maximum size in MB of the log file before it gets rotated.
              type: integer
              default: 100
            localtime:
              description: 'If true, it uses the computer''s local time to format the backup timestamp.'
              type: boolean
              default: false
            rotated_logs_size_limit:
              description: Max Size (in mb) of log files before deletion
              type: integer
              default: 1024
            rotation_interval:
              description: |-
                If set, the interval at which log files are rotated, even if max_size is not reached.

                This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
              type: string
              default: ""
            max_age:
              description: The maximum number of days to retain old log files.
              default: 360
              type: integer
        collation_buffer_size:
          description: The size of the log collation buffer.
          default: 0
          type: integer
          readOnly: true
    warn:
      type: object
      description: Warning logging configuration.
      properties:
        enabled:
          description: Toggle for this log output
          type: boolean
          default: true
        rotation:
          type: object
          readOnly: true
          properties:
            max_size:
              description: The maximum size in MB of the log file before it gets rotated.
              type: integer
              default: 100
            localtime:
              description: 'If true, it uses the computer''s local time to format the backup timestamp.'
              type: boolean
              default: false
            rotated_logs_size_limit:
              description: Max Size (in mb) of log files before deletion
              type: integer
              default: 1024
            rotation_interval:
              description: |-
                If set, the interval at which log files are rotated, even if max_size is not reached.

                This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
              type: string
              default: ""
            max_age:
              description: The maximum number of days to retain old log files.
              default: 180
              type: integer
        collation_buffer_size:
          description: The size of the log collation buffer
          default: 0
          type: integer
          readOnly: true
    info:
      type: object
      description: Info logging configuration.
      properties:
        enabled:
          description: Toggle for this log output
          type: boolean
          default: true
        rotation:
          type: object
          readOnly: true
          properties:
            max_size:
              description: The maximum size in MB of the log file before it gets rotated.
              type: integer
              default: 100
            localtime:
              description: 'If true, it uses the computer''s local time to format the backup timestamp.'
              type: boolean
              default: false
            rotated_logs_size_limit:
              description: Max Size (in mb) of log files before deletion
              type: integer
              default: 1024
            rotation_interval:
              description: |-
                If set, the interval at which log files are rotated, even if max_size is not reached.

                This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
              type: string
              default: ""
            max_age:
              description: The maximum number of days to retain old log files.
              default: 6
              type: integer
        collation_buffer_size:
          description: The size of the log collation buffer
          default: 0
          type: integer
          readOnly: true
    debug:
      type: object
      description: Debug logging configuration.
      properties:
        enabled:
          description: Toggle for this log output
          type: boolean
          default: false
        rotation:
          type: object
          readOnly: true
          properties:
            max_size:
              description: The maximum size in MB of the log file before it gets rotated.
              type: integer
              default: 100
            localtime:
              description: 'If true, it uses the computer''s local time to format the backup timestamp.'
              type: boolean
              default: false
            rotated_logs_size_limit:
              description: Max Size (in mb) of log files before deletion
              type: integer
              default: 1024
            rotation_interval:
              description: |-
                If set, the interval at which log files are rotated, even if max_size is not reached.

                This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
              type: string
              default: ""
            max_age:
              description: The maximum number of days to retain old log files.
              default: 2
              type: integer
        collation_buffer_size:
          description: The size of the log collation buffer
          default: 1000
          type: integer
          readOnly: true
    trace:
      type: object
      description: Trace logging configuration.
      properties:
        enabled:
          description: Toggle for this log output
          type: boolean
          default: false
        rotation:
          type: object
          readOnly: true
          properties:
            max_size:
              description: The maximum size in MB of the log file before it gets rotated.
              type: integer
              default: 100
            localtime:
              description: 'If true, it uses the computer''s local time to format the backup timestamp.'
              type: boolean
              default: false
            rotated_logs_size_limit:
              description: Max Size (in mb) of log files before deletion
              type: integer
              default: 1024
            rotation_interval:
              description: |-
                If set, the interval at which log files are rotated, even if max_size is not reached.

                This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
              type: string
              default: ""
            max_age:
              description: The maximum number of days to retain old log files.
              default: 2
              type: integer
        collation_buffer_size:
          description: The size of the log collation buffer
          default: 1000
          type: integer
          readOnly: true
    stats:
      type: object
      description: Trace logging configuration.
      properties:
        enabled:
          description: Toggle for this log output
          type: boolean
          default: true
        rotation:
          type: object
          readOnly: true
          properties:
            max_size:
              description: The maximum size in MB of the log file before it gets rotated.
              type: integer
              default: 100
            localtime:
              description: 'If true, it uses the computer''s local time to format the backup timestamp.'
              type: boolean
              default: false
            rotated_logs_size_limit:
              description: Max Size (in mb) of log files before deletion
              type: integer
              default: 1024
            rotation_interval:
              description: |-
                If set, the interval at which log files are rotated, even if max_size is not reached.

                This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
              type: string
              default: ""
            max_age:
              description: The maximum number of days to retain old log files.
              default: 6
              type: integer
        collation_buffer_size:
          description: The size of the log collation buffer
          default: 0
          type: integer
          readOnly: true
    audit:
      $ref: '#/Audit-logging-config'
File-logging-config-base:
  type: object
  properties:
    enabled:
      description: Toggle for this log output
      type: boolean
      default: false
  title: File-logging-config
Audit-logging-config:
  type: object
  title: "Audit logging config"
  properties:
    enabled:
      description: Toggle for this log output
      type: boolean
      default: false
    rotation:
      type: object
      readOnly: true
      properties:
        max_size:
          description: The maximum size in MB of the log file before it gets rotated.
          type: integer
          default: 100
        localtime:
          description: 'If true, it uses the computer''s local time to format the backup timestamp.'
          type: boolean
          default: false
        rotated_logs_size_limit:
          description: Max Size (in mb) of log files before deletion
          type: integer
          default: 1024
        rotation_interval:
          description: |-
            If set, the interval at which log files are rotated, even if max_size is not reached.

            This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
          type: string
          default: ""
        max_age:
          description: The maximum number of days to retain old log files.
          default: 6
          type: integer
    audit_log_file_path:
      description: The path to write audit log files to
      type: string
      readOnly: true
    enabled_events:
      description: List of enabled global audit events.
      type: array
      items:
        type: number
      example: [1234, 5678]
      readOnly: true
Console-logging-keys-level:
  type: object
  properties:
    log_level:
      description: Log Level for the console output
      type: string
      default: info
      enum:
        - none
        - error
        - warn
        - info
        - debug
        - trace
    log_keys:
      description: Log Keys for the console output
      type: array
      items:
        type: string
        enum:
          - "*"
          - "Admin"
          - "Access"
          - "Auth"
          - "Bucket"
          - "Cache"
          - "Changes"
          - "SGCluster"
          - "Config"
          - "CRUD"
          - "DCP"
          - "Diagnostic"
          - "Events"
          - "gocb"
          - "HTTP"
          - "HTTP+"
          - "Import"
          - "Javascript"
          - "Migrate"
          - "Query"
          - "Replicate"
          - "Sync"
          - "SyncMsg"
          - "WS"
          - "WSFrame"
        x-enumDescriptions:
          "*": "This wildcard log key, enables all log keys."
          "Access": "Anytime an access() call is made in the sync function."
          "Admin": "Admin processes in Sync Gateway."
          "Auth": "Authentication."
          "Bucket": "Sync Gateway interactions with the bucket."
          "CRUD": "CRUD operations."
          "Cache": Interactions with Sync Gateway’s in-memory channel cache.
          "Changes": "Processing of /{keyspace}/_changes requests and pull replications"
          "Config": "Server or database configuration."
          "DCP": "Updates made by Sync Gateway to documents."
          "Diagnostic": "Operations used by dry run endpoints."
          "Events": "Event processing (webhooks)."
          "HTTP": "All requests made to the Sync Gateway REST APIs."
          "HTTP+": "Additional information about HTTP requests (response times, status codes)."
          "Import": "This log key can be useful to troubleshoot why a given document was not successfully imported."
          "Javascript": "All logging from Javascript. This includes: sync function, import filters, webhook filter function, and custom inter-Sync Gateway replication conflict resolvers."
          "Migrate": "Logs messages that show when old inline document metadata is upgraded to xattrs."
          "Query": "Query is used for Sync Gateway code related to N1QL queries"
          "Replicate": "Log messages related to Inter-Sync Gateway replications. This is not used for replications initiated by Couchbase Lite."
          "SGCluster": "Log messages related to coordination of Sync Gateways for sharded import and Inter-Sync Gateway Replication."
          "Sync": "Activity which relates to synchronization between Couchbase Lite and Sync Gateway"
          "SyncMsg": "Additional logging on top of `Sync` key."
          "WS": "Websocket replication log messages."
          "WSFrame": "Additional logging on top of `WS` key."
          "gocb": "All logging emitted by the gocb SDK"
      example: ["CRUD", "HTTP", "Query"]
Console-logging-config:
  title: Configuration for console logging.
  allOf:
    - $ref: '#/Console-logging-keys-level'
    - type: object
      properties:
        color_enabled:
          description: Log with color for the console output
          type: boolean
          default: false
          readOnly: true
        file_output:
          description: 'Override the default stderr output, and write to the file specified instead'
          type: string
          readOnly: true
        enabled:
          description: Toggle for this log output
          type: boolean
          default: false
          readOnly: true
        rotation:
          type: object
          readOnly: true
          title: Log-rotation-config
          properties:
            max_size:
              description: The maximum size in MB of the log file before it gets rotated.
              type: integer
              default: 100
            localtime:
              description: 'If true, it uses the computer''s local time to format the backup timestamp.'
              type: boolean
              default: false
            rotated_logs_size_limit:
              description: Max Size (in mb) of log files before deletion
              type: integer
              default: 1024
            rotation_interval:
              description: |-
                If set, the interval at which log files are rotated, even if max_size is not reached.

                This is a duration and therefore can be provided with units "h", "m", "s", "ms", "us", and "ns". For example, 5 hours, 20 minutes, and 30 seconds would be `5h20m30s`.
              type: string
              default: ""
            max_age:
              description: The maximum number of days to retain old log files. By default, there is no rotation, max_age=0.
              default: 0
              type: integer
        collation_buffer_size:
          description: The size of the log collation buffer. The default is 10 if the output is stderr, or 1000 if to a file.
          type: integer
          default: 10
          readOnly: true
Log-update-enabled:
  type: object
  properties:
    enabled:
      description: 'If set, this log level will be outputted.'
      type: boolean
  title: Log-update-enabled
DeprecatedLogKeyMap:
  description: A map of log keys and whether they are enabled or not.
  type: object
  example:
    HTTP: true
    CRUD: false
    Changes: true
  additionalProperties:
    description: The log key and whether it is enabled or not.
    type: boolean
Vendor:
  description: Product vendor
  type: object
  properties:
    name:
      description: Product name
      type: string
      example: Couchbase Sync Gateway
    version:
      description: |-
        API version.
        Omitted if `api.hide_product_version=true`
      type: string
      example: "3.1"
  required:
    - name
  title: Vendor
Status:
  type: object
  properties:
    databases:
      description: Contains a map of all the databases in the node along with their status.
      type: object
      additionalProperties:
        x-additionalPropertiesName: dbname
        description: The name of the database.
        type: object
        properties:
          seq:
            description: The latest sequence number in the database.
            type: number
            minimum: 0
          server_uuid:
            description: The server unique identifier.
            type: string
          require_resync:
            description: Indicates whether the database requires resync before it can be brought online.
            type: boolean
          state:
            allOf: # use allOf to prevent DatabaseState from showing as the type in the display
              - $ref: '#/DatabaseState'
          replication_status:
            type: array
            items:
              $ref: '#/Replication-status'
          cluster:
            type: object
            properties:
              cluster_uuid:
                description: The cluster unique identifier.
                type: string
              replication:
                description: Map of replication configs defined for the cluster.
                type: object
                properties:
                  replication_id:
                    $ref: '#/Retrieved-replication'
              nodes:
                description: Map of all Sync Gateway nodes in the cluster.
                type: object
                properties:
                  node_uuid:
                    description: The nodes unique identifier.
                    type: object
                    properties:
                      uuid:
                        description: The nodes unique identifier.
                        type: string
                      host:
                        description: The nodes host name.
                        type: string
    version:
      description: |-
        The product version including the build number and edition (ie. `EE` or `CE`).

        Blank if `api.hide_product_version=true` in the startup configuration.
      type: string
    vendor:
      allOf:
        - $ref: '#/Vendor'
    runtime:
      description: |-
        Runtime environment information for this Sync Gateway node. Includes Go runtime
        settings and container memory limits.
      type: object
      properties:
        go_memlimit_bytes:
          description: |-
            The effective Go memory limit (`GOMEMLIMIT`) in bytes. This is the soft memory
            limit that the Go garbage collector targets. A value of `9223372036854775807`
            (`math.MaxInt64`) indicates no limit is set.
          type: integer
          format: int64
          example: 1073741824
        go_maxprocs:
          description: The effective number of OS threads (`GOMAXPROCS`) that can execute Go code simultaneously.
          type: integer
          minimum: 1
          example: 4
        cgroup_memory_limit_bytes:
          description: |-
            The cgroup memory hard limit in bytes, as reported by the container runtime
            (cgroupv2 `memory.max` or cgroupv1 `memory.limit_in_bytes`). Only present when
            running inside a cgroup with a memory limit configured.
          type: integer
          format: uint64
          example: 2147483648
    node_uid:
      description: |-
        Stable identifier for this Sync Gateway node, derived deterministically from host
        fingerprint.
      type: string
    cluster_compat_version:
      description: |-
        The minimum cluster compatibility version (`"major.minor"`) across all nodes in the
        cluster. Omitted if `api.hide_product_version=true`, or when no version has been
        computed yet (e.g. first startup before nodes have registered).
      type: string
      example: '4.1'
  title: Status
NodeInfo:
  type: object
  properties:
    ADMIN:
      description: '`true` if the request is from the Admin API - otherwise omitted.'
      type: boolean
      example: true
    couchdb:
      description: CouchDB welcome
      type: string
      example: Welcome
    vendor:
      allOf:
        - $ref: '#/Vendor'
    version:
      description: |-
        Product version, including the build number and edition (i.e. `EE` or `CE`)
        Omitted if `api.hide_product_version=true`
      type: string
      example: Couchbase Sync Gateway/3.1.0(1;a765231) EE
    persistent_config:
      description: |-
        Indication for whether sync gateway is running in persistent config mode or legacy config mode.
        `true` if the sync gateway node is running in persistent config mode.
      type: boolean
      example: true
    node_uid:
      description: |-
        Stable identifier for this Sync Gateway node, derived deterministically from host
        fingerprint.
      type: string
    cluster_compat_version:
      description: |-
        The minimum cluster compatibility version (`"major.minor"`) across all nodes in the
        cluster.
      type: string
      example: '4.1'
  required:
    - couchdb
    - vendor
ResyncScopesMap:
  description: 'scope name with one or more collection names for which resync will be triggered'
  type: object
  additionalProperties:
    allOf:
      - $ref: '#/CollectionNames'
  example: {"scopeName": ["collection1", "collection2"]}
CollectionNames:
  description: 'List of collection names'
  type: array
  items:
    type: string
  example: ["collection1", "collection2"]
"All DBs":
  title: Simple
  description: "The names of all databases."
  type: array
  items:
    type: string
  example: ["db1", "db2"] # example required to work around https://github.com/Redocly/redoc/issues/2676
"All DBs Verbose":
  title: Verbose
  description: "Description of all databases."
  type: array
  example: # example required to work around https://github.com/Redocly/redoc/issues/2676
    - db_name: "db1"
      bucket: "bucket1"
      state: "Online"
      require_resync: false
      init_in_progress: false
    - db_name: "db2"
      bucket: "bucket2"
      state: "Starting"
      require_resync: true
      init_in_progress: true
    - db_name: "db3"
      bucket: "bucket3"
      state: "Offline"
      require_resync: true
      init_in_progress: true
      database_error:
        error_message: "Error connecting to bucket"
        error_code: 1
  items:
    type: object
    properties:
      db_name:
        type: string
        description: The name of the database.
      bucket:
        type: string
        description: The Couchbase Server backing bucket for the database.
      state:
        allOf: # use allOf to prevent DatabaseState from showing as the type in the display
          - $ref: '#/DatabaseState'
      require_resync:
        description: Indicates whether the database requires resync before it can be brought online.
        type: boolean
        example: true
      init_in_progress:
        description: Indicates whether database initialization is in progress.
        type: boolean
        example: true
      database_error:
        description: Error that occurred during database startup, if any.
        allOf:
          - $ref: '#/DatabaseError'
"DatabaseError":
  description: An error that occurred during database startup.
  type: object
  properties:
    error_message:
      description: A human-readable description of the error.
      type: string
      example: "Error connecting to bucket"
    error_code:
      description: A numeric code identifying the type of error.
      type: integer
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
      x-enumDescriptions:
        1: "Error connecting to bucket"
        2: "Collection(s) not available"
        3: "Error initializing sync info"
        4: "Error initializing database indexes"
        5: "Error creating database context"
        6: "Error with fetching SGR cluster definition"
        7: "Error creating replication during database init"
        8: "Error attempting to start online process"
        9: "Allow conflicts is set to true"
        10: "Enable star channel is set to false"
        11: "Bucket has metadata from a newer Sync Gateway cluster compat version"
      example: 1
all_user_channels:
  description: |-
    All user channels split by how they were assigned to the user and by keyspace.
  type: object
  properties:
    all_channels:
      description: |-
        All channels that the user has access to.
      type: object
      properties:
        keyspace:
          type: object
          properties:
            channel:
              $ref: '#/channelEntry'
channelEntry:
  description: Channel name
  type: object
  properties:
    entries:
      type: array
      description: Start sequence to end sequence. If the channel is currently granted, the end sequence will be zero.
    updated_at:
      type: integer
      description: Unix timestamp of last update
doc_access_spans:
  description: |-
    Grant history entries for a user, showing which documents the user had access to, through which channels and for which sequence spans.
  type: object
  properties:
    doc_id:
      description: |-
        Document names.
      type: object
      properties:
        channel:
          description: Channel name
          type: object
          properties:
            entries:
              type: array
              description: Start sequence to end sequence. If the channel is currently granted, the end sequence will be zero.
DatabaseState:
  description: The state of the database.
  type: string
  enum:
    - Online
    - Offline
    - Starting
    - Stopping
    - Resyncing
  x-enumDescriptions:
    Online: The database is online and available for use.
    Offline: The database is offline, resync and other offline only endpoints are allowed.
    Starting: The database is in the process of going online.
    Stopping: The database is no longer accepting connections and is being taken offline or deleted.
    Resyncing: The database is offline and performing a resync operation.
NumIndexPartitions:
  description: |-
    The number of partitions to use for the large indexes created by Sync Gateway. It is not recommended to set this unless you require additional horizontal scalability for individual indexes and have appropriately scaled your Query nodes to handle the increased query parallelism. If set, the recommended number is 8 and does not need to be directly related to the number of your Query nodes. Ensure documentation is read to understand the performance tradeoffs and instructions for migration if you have previously run with only one partition. See [/{db}/_index_init](#operation/post_db-_index_init) for more information.

    If not specified or 1, all indexes will be non partitioned.
  type: number
  default: 1
  title: Number of Index Partitions
IndexSettings:
  type: object
  description: Settings for Global Secondary Indexes (GSI).
  properties:
    create_separate_principal_indexes:
      description: |-
        Whether to create separate indexes for users and roles instead of a single larger syncDocs index.

        The separate principal indexes are smaller and used automatically for new database deployments. To remove the syncDocs index, wait for this to complete, restart all Sync Gateway instances and run  [POST /_post_upgrade](#operation/post__post_upgrade).
      type: boolean
      default: false
    num_partitions:
      $ref: '#/NumIndexPartitions'
IndexInitStatus:
  description: The status of an asynchronous indexes initialization operation.
  type: object
  properties:
    status:
      description: The status of the current operation.
      type: string
      enum:
        - completed
        - error
        - running
        - stopped
        - stopping
      x-enumDescriptions:
        running: Indexes are being created.
        completed: All indexes were created.
        error: The index initialization operation has failed.
        stopped: The index initialization operation has been stopped. These indexes may still exist on Couchbase Server.
        stopping: The index initialization operation is in the process of being stopped.
    start_time:
      description: The ISO-8601 date and time the index initialization operation was started.
      type: string
    last_error:
      description: The last error that occurred in the index initialization operation (if any).
      type: string
    index_status:
      description: 'scope name with one or more collection names and the status of their index creation'
      type: object
      additionalProperties:
        x-additionalPropertiesName: scopename
        description: An object keyed by scope, containing a set of collections and the status of their index creation.
        type: object
        additionalProperties:
          x-additionalPropertiesName: collectionname
          type: string
          enum:
            - "queued"
            - "in progress"
            - "ready"
            - "error"
          x-enumDescriptions:
            "queued": Indexes are queued for creation.
            "in progress": Indexes are being created.
            "ready": All indexes were created.
            "error": The index creation operation has failed.
    settings:
      allOf:
        - $ref: '#/IndexSettings'
  required:
    - status
    - start_time
    - last_error
    - index_status
  title: IndexInitStatus
CORS:
  type: object
  properties:
    headers:
      description: |-
        List of allowed headers. These headers will be added the `Access-Control-Allow-Headers` response to a valid CORS request.

        A recommended minimum set of values should be `["Accept-Encoding", "Authorization", "Content-Type", "If-Match"]`.
      type: array
      items:
        type: string
      example:
        - Accept-Encoding
        - Authorization
        - Content-Type
        - If-Match
    login_origin:
      description: |-
        List of allowed origins to apply to public `/{db}/_session` API.

        To use cors on `/{db}/_session`, the domain must be present in both `login_origin` and `origin`.

        If configured, `Authorization` must be included in headers.
      type: array
      items:
        type: string
      example: ["https://example.com"]
    max_age:
      description: Value for `Access-Control-Maximum-Age`. Uses 0 by default.
      type: integer
      default: 0
    origin:
      description: |-
        List of allowed origins for the public API. The request `Origin` header is checked against these values. If successful the `Origin` header is returned in the HTTP response header as `Access-Control-Allow-Origin`.
      type: array
      items:
        type: string
      example: ["https://example.com"]
  title: Cors Configuration
ClusterCompatVersion:
  description: |-
    A Sync Gateway cluster compatibility version, represented as a `"major.minor"` string (e.g. `"4.1"`).

    This is the minimum version across all nodes in the cluster and is used to gate new metadata formats
    until all nodes have been upgraded.
  type: string
  nullable: true
  example: '4.1'
  title: Cluster Compatibility Version
ClusterCompatVersionState:
  type: object
  description: |-
    Cluster compatibility version state.

    Without a freeze, `cluster_compat_version` is the minimum version across all live nodes
    in the cluster, and advances automatically as nodes are upgraded.

    A freeze pins `cluster_compat_version` to the value captured at the time of the freeze,
    preventing it from advancing as nodes upgrade. This preserves the option to roll a node
    back to the prior major/minor before committing to the upgrade.

    The presence of `frozen_cluster_compat_version` indicates that a frozen version is currently set;
    its absence indicates no version has been frozen.
  properties:
    cluster_compat_version:
      allOf:
        - $ref: '#/ClusterCompatVersion'
      description: |-
        The currently-reported cluster compatibility version. Equal to
        `frozen_cluster_compat_version` when a freeze is set, otherwise the minimum across
        all live nodes. Omitted if no version has been computed yet (e.g. immediately after
        startup, before any node has registered).
    nodes:
      type: object
      description: |-
        Per-node cluster compatibility versions, keyed by node UID. Includes every node
        currently registered in any tracked bucket registry.
      additionalProperties:
        x-additionalPropertiesName: nodeUID
        $ref: '#/ClusterCompatVersion'
    pre_ccv_aware_nodes:
      type: object
      description: |-
        Pre-CCV-aware Sync Gateway peers observed via side-channels (cbgt NodeDefs for
        sharded import, SGRCluster.Nodes for ISGR), keyed by pre-CCV-aware peer UUID. Each
        peer's value is its observed cluster compatibility version (major.minor) — the
        observer parses the side-channel's full build version and stores major.minor
        only, since CCV decisions don't depend on higher precision. When the side-channel
        didn't carry a version, a conservative pre-SGNode-Version fallback (4.0) is
        substituted at observation time. Peers below the cluster's HWM are reported here
        for operator visibility but do not roll cluster_compat_version back below HWM —
        that case represents an unsupported downgrade. Omitted when no pre-CCV-aware peers
        are currently observed.
      additionalProperties:
        x-additionalPropertiesName: nodeUUID
        $ref: '#/ClusterCompatVersion'
    frozen_cluster_compat_version:
      allOf:
        - $ref: '#/ClusterCompatVersion'
      description: |-
        The cluster compatibility version captured at the time of the most recent freeze.
        Omitted when no freeze is set.
  title: Cluster Compatibility Version State
DiagnosticFunctionException:
  description: The exception thrown during evaluation (if any).
  type: string
DiagnosticFunctionLogging:
  description: Logging emitted during evaluation.
  type: object
  properties:
    errors:
      description: Error messages logged during evaluation.
      type: array
      items:
        type: string
        example: This is an error message produced by console.error("oops").
    info:
      description: Info messages logged during evaluation.
      type: array
      items:
        type: string
        example: This is an info message produced by console.log("test").

ClusterInfo:
  type: object
  description: |-
    Cluster information returned by `/_cluster_info`. Per-node version data is exposed via
    each bucket's `registry.nodes`; aggregated cluster compatibility is available from `/_status`.
  properties:
    legacy_config:
      description: Indicates if the server is using legacy (non persistent) configuration.
      type: boolean
    buckets:
      description: Map of bucket names to bucket information.
      type: object
      additionalProperties:
        x-additionalPropertiesName: bucketname
        $ref: '#/BucketInfo'

BucketInfo:
  type: object
  properties:
    registry:
      $ref: '#/GatewayRegistry'
    enable_cross_cluster_versioning:
      description: Indicates if cross-cluster versioning is enabled for this bucket.
      type: boolean

GatewayRegistry:
  type: object
  properties:
    version:
      type: string
      description: Registry version. This is not the Sync Gateway version number.
    config_groups:
      type: object
      description: Map of config groups, keyed by config group ID
      additionalProperties:
        x-additionalPropertiesName: configgroupid
        $ref: '#/RegistryConfigGroup'
    sg_version:
      type: string
      description: |-
        Latest full Sync Gateway build version that wrote to the registry. Diagnostic-only —
        cluster compatibility / downgrade decisions key off `cluster_compat_version_hwm`.
    cluster_compat_version_hwm:
      allOf:
        - $ref: '#/ClusterCompatVersion'
      description: |-
        High-water mark of the cluster compatibility version observed on this bucket. Ratchets
        up only — once raised, it never decreases. A Sync Gateway node refuses to serve a
        database on this bucket when this value is greater than its own compat version, blocking
        downgrades from a higher major.minor that may have written forward-incompatible metadata.
        Omitted on registries written by older Sync Gateway versions.
    updated_at:
      type: string
      format: date-time
      description: Time the registry was last updated
    created_at:
      type: string
      format: date-time
      description: Time the registry was created
    nodes:
      description: |-
        Map of node UID to that node's version registration. Populated by Sync Gateway nodes
        that have a database loaded on this bucket; used to compute the cluster compatibility
        version. Omitted on registries written by older Sync Gateway versions that did not
        track per-node versions.
      type: object
      additionalProperties:
        x-additionalPropertiesName: nodeUID
        $ref: '#/RegistryNode'
    frozen_cluster_compat_version:
      allOf:
        - $ref: '#/RegistryFrozenClusterCompatVersion'
      description: |-
        Cluster compatibility version freeze record. When present, the
        cluster compatibility version reported by this Sync Gateway is capped at
        `frozen_cluster_compat_version.version` until the freeze is cleared via
        `POST /_cluster_compat_version/unfreeze`.
    pre_ccv_aware_nodes:
      description: |-
        Map of pre-CCV-aware peer UUID to that peer's pre-CCV-aware-node entry. Records pre-CCV-aware
        Sync Gateway peers detected via side-channel registries (cbgt `NODE_DEFS_KNOWN` for
        sharded import, `SGRCluster.Nodes` for inter-SG replication). Unlike `nodes`, entries
        here are written by an observing CCV-aware peer rather than by the pre-CCV-aware peer
        itself. Entries age out via the heartbeat-expiry prune on each registry write. Omitted
        when no pre-CCV-aware peers are currently recorded.
      type: object
      additionalProperties:
        x-additionalPropertiesName: nodeUUID
        $ref: '#/RegistryPreCCVAwareNode'

RegistryNode:
  type: object
  description: A single Sync Gateway node's version registration in a bucket registry.
  properties:
    version:
      allOf:
        - $ref: '#/ClusterCompatVersion'
      description: The cluster compatibility version reported by this node.
    heartbeat_at:
      type: string
      format: date-time
      description: Time of the node's last heartbeat write to this registry.

RegistryPreCCVAwareNode:
  type: object
  description: |-
    An observation of a pre-CCV-aware Sync Gateway peer recorded by a CCV-aware peer. Written
    by the observer (not the pre-CCV-aware peer), keyed in `pre_ccv_aware_nodes` by the pre-CCV-aware peer's
    UUID. The observer collapses the peer's side-channel build version to major.minor at write
    time; when the side-channel observation didn't carry a version, a conservative
    pre-SGNode-Version fallback (4.0) is substituted. Entries below the bucket's
    `cluster_compat_version_hwm` are reported here for operator visibility but do not pull
    reported cluster_compat_version back below HWM.
  properties:
    version:
      allOf:
        - $ref: '#/ClusterCompatVersion'
      description: |-
        The pre-CCV-aware peer's cluster compatibility version (major.minor). Reflects either the
        parsed side-channel build version or the conservative fallback when none was carried.
    last_observed_at:
      type: string
      format: date-time
      description: |-
        Time at which the observation was last refreshed by an observer. Entries whose
        `last_observed_at` is older than the configured heartbeat expiry are pruned on the
        next registry write.
  required:
    - version
    - last_observed_at

RegistryFrozenClusterCompatVersion:
  type: object
  description: |-
    A cluster compatibility version freeze record stored in a bucket registry. Set by
    `POST /_cluster_compat_version/freeze` and cleared by
    `POST /_cluster_compat_version/unfreeze`. Cluster-wide freeze state is the aggregate of
    these records across all bucket registries.
  properties:
    version:
      allOf:
        - $ref: '#/ClusterCompatVersion'
      description: |-
        The cluster compatibility version captured at the time of the freeze.
    frozen_at:
      type: string
      format: date-time
      description: Time at which the freeze was set.
  required:
    - version
    - frozen_at

RegistryConfigGroup:
  type: object
  properties:
    databases:
      type: object
      description: Map of databases in this config group.
      additionalProperties:
        x-additionalPropertiesName: dbname
        $ref: '#/RegistryDatabase'

RegistryDatabase:
  type: object
  properties:
    scopes:
      $ref: '#/RegistryScopes'
    version:
      type: string
      description: Revision ID for a database configuration, used for ETag validation.
    previous_version:
      $ref: '#/RegistryDatabaseVersion'
    metadata_id:
      type: string
      description: Metadata ID.
    uuid:
      type: string
      description: Database UUID.

RegistryDatabaseVersion:
  type: object
  properties:
    scopes:
      $ref: '#/RegistryScopes'
    version:
      type: string
      description: Revision ID for a database configuration, used for ETag validation.

RegistryScopes:
  type: object
  description: Map of scope names to registry scope information.
  additionalProperties:
    x-additionalPropertiesName: scopename
    $ref: '#/RegistryScope'

RegistryScope:
  type: object
  properties:
    collections:
      description: List of collections in this scope.
      type: array
      items:
        type: string

UserHistory:
  description: User history containing various history types organized by scope and collection.
  type: object
  properties:
    channels:
      description: Channel history organized by scope and collection.
      type: object
      additionalProperties:
        description: An object keyed by scope name.
        type: object
        x-additionalPropertiesName: scopename
        additionalProperties:
          description: An array of channel names for the collection.
          type: array
          x-additionalPropertiesName: collectionname
          items:
            type: string
  title: UserHistory