From 709cabb90d6dcaf68caf67a8be0c3e17982ddfc4 Mon Sep 17 00:00:00 2001 From: Hakim Cassimally Date: Tue, 20 Feb 2024 16:48:07 +0000 Subject: [PATCH 1/2] Update config for Redocly from sync_gateway source This will update x-internal settings. via https://github.com/couchbase/docs-sync-gateway/pull/781 and discussion with @torcolvin --- .../assets/attachments/bundled-admin.yaml | 313 ++++-- .../assets/attachments/bundled-metric.yaml | 80 +- .../assets/attachments/bundled-public.yaml | 68 +- .../admin/.openapi-generator/VERSION | 2 +- .../_partials/static_restapi/admin/index.adoc | 981 ++++++++++++------ .../_partials/static_restapi/generate.sh | 6 +- .../metric/.openapi-generator/VERSION | 2 +- .../static_restapi/metric/index.adoc | 578 ++++++++++- .../public/.openapi-generator/VERSION | 2 +- .../static_restapi/public/index.adoc | 288 ++++- 10 files changed, 1810 insertions(+), 510 deletions(-) diff --git a/modules/ROOT/assets/attachments/bundled-admin.yaml b/modules/ROOT/assets/attachments/bundled-admin.yaml index bbf73cc3..a8a8ebd1 100644 --- a/modules/ROOT/assets/attachments/bundled-admin.yaml +++ b/modules/ROOT/assets/attachments/bundled-admin.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Sync Gateway description: Sync Gateway manages access and synchronization between Couchbase Lite and Couchbase Server - version: 3.1.0 + version: 3.2.0 license: name: Business Source License 1.1 (BSL) url: https://github.com/couchbase/sync_gateway/blob/master/LICENSE @@ -19,6 +19,34 @@ servers: hostname: description: The hostname to use default: localhost +tags: + - name: Authentication + description: Manage authentication + - name: Server + description: Manage server activities + - name: Database Management + description: Create and manage Sync Gateway databases + - name: Database Configuration + description: Configure Sync Gateway databases + - name: Database Security + description: Create and manage database users and roles + - name: Session + description: Manage user sessions + - name: OpenID Connect + description: Manage OpenID Connect + - name: Document + description: Create and manage documents and attachments + - name: Replication + description: Create and manage inter-Sync Gateway replications + - name: Metrics + description: Get Sync Gateway statistics + - name: Profiling + description: Generate information to help debug and fine-tune Sync Gateway + - name: Unsupported + description: Endpoints that are not supported by Sync Gateway +externalDocs: + description: Sync Gateway Quickstart | Couchbase Docs + url: https://docs.couchbase.com/sync-gateway/current/index.html paths: /{db}/_session: parameters: @@ -655,7 +683,7 @@ paths: responses: '200': description: Properties associated with a user - content: &ref_128 + content: &ref_130 application/json: schema: description: Properties associated with a user @@ -951,7 +979,7 @@ paths: responses: '200': description: Properties associated with a role - content: &ref_129 + content: &ref_131 application/json: schema: description: Properties associated with a role @@ -1131,7 +1159,7 @@ paths: **Behaviour** * *default* - In priority order, this will cause - - Deletes to always win (the delete with the logest revision history wins if both revisions are deletes) + - Deletes to always win (the delete with the longest revision history wins if both revisions are deletes) - The revision with the longest revision history to win. This means the the revision with the most changes and therefore the highest revision ID will win. * *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. @@ -1385,7 +1413,7 @@ paths: **Behaviour** * *default* - In priority order, this will cause - - Deletes to always win (the delete with the logest revision history wins if both revisions are deletes) + - Deletes to always win (the delete with the longest revision history wins if both revisions are deletes) - The revision with the longest revision history to win. This means the the revision with the most changes and therefore the highest revision ID will win. * *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. @@ -2281,7 +2309,7 @@ paths: By default, this will only be accessible to the localhost. type: string default: 127.0.0.1:4985 - metric_interface: + metrics_interface: description: |- Network interface to bind metrics API to. @@ -2435,15 +2463,18 @@ paths: max_size: description: The maximum size in MB of the log file before it gets rotated. type: integer + default: 100 max_age: - description: The maximum number of days to retain old log files. + description: The maximum number of days to retain old log files. The defaults for this value are 360 days for error, 180 days for warn, 6 days for info, 2 days for debug, and 2 days for trace logs. type: integer localtime: description: If true, it uses the computer's local time to format the backup timestamp. type: boolean - rotated_logs_size: + default: false + rotated_logs_size_limit: description: Max Size (in mb) of log files before deletion type: integer + default: 1024 readOnly: true title: Log-rotation-config collation_buffer_size: @@ -2529,7 +2560,7 @@ paths: 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. + 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 @@ -2718,6 +2749,9 @@ paths: enum: - Online - Offline + - Starting + - Stopping + - Resyncing replication_status: type: array items: @@ -4051,7 +4085,7 @@ paths: description: Force the use of views instead of GSI. type: boolean default: false - send_www_authentice_header: + send_www_authenticate_header: description: Controls whether to send a `WWW-Authenticate` header in `401 Unauthorized` HTTP responses. type: boolean default: true @@ -4143,7 +4177,7 @@ paths: default: 60 suspendable: description: |- - Set to true to allow the database to be suspended. + Set to true to allow the database to be suspended. Defaults to true when running in serverless mode otherwise defaults to false. type: boolean @@ -4167,6 +4201,34 @@ paths: type: array items: type: string + logging: + description: Per-database logging configuration. + type: object + properties: + console: + description: Console logging configuration. + type: object + properties: + log_level: + description: Log Level for the console output + type: string + enum: + - none + - error + - warn + - info + - debug + - trace + example: debug + log_keys: + description: Log Keys for the console output + type: array + items: + type: string + example: + - CRUD + - HTTP + - Query title: Database-config '404': description: Resource could not be found @@ -4634,6 +4696,12 @@ paths: description: '**Use this only when requested to do so by the Couchbase support team** This request will regenerate the sequence numbers for each document processed.' schema: type: boolean + - name: reset + in: query + description: This forces a fresh resync run instead of trying to resume the previous resync operation + schema: + type: boolean + default: false requestBody: content: application/json: @@ -5195,35 +5263,50 @@ paths: get: summary: Get a list of all the databases description: |- - This retrieves all the database's names that are in the current Sync Gateway node. + This retrieves all the databases that are in the current Sync Gateway node. If verbose, returns bucket and state information for each database, otherwise returns names only. Required Sync Gateway RBAC roles: * Sync Gateway Dev Ops + parameters: + - name: verbose + in: query + schema: + type: boolean responses: '200': description: Successfully retrieved all database names content: application/json: schema: - type: array - items: - type: string + oneOf: + - description: The names of all databases. + type: array + items: &ref_118 + type: string + - description: Description of all databases. + type: array + items: &ref_119 + 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: + description: The database state. + type: string + enum: + - Online + - Offline + - Starting + - Stopping + - Resyncing tags: - Database Management operationId: get__all_dbs - head: - summary: /_all_dbs - description: |- - Required Sync Gateway RBAC roles: - - * Sync Gateway Dev Ops - responses: - '200': - description: OK - tags: - - Database Management - operationId: head__all_dbs /{db}/_compact: parameters: - name: db @@ -5331,7 +5414,7 @@ paths: schema: description: The status returned from a compaction. type: object - properties: &ref_118 + properties: &ref_120 status: description: The status of the current operation. type: string @@ -5351,7 +5434,7 @@ paths: description: |- **Applicable to attachment compaction only** - This is the number of references there are to legacy attachments. + This is the number of references there are to legacy attachments. type: string purged_attachments: description: |- @@ -5381,7 +5464,7 @@ paths: - mark - sweep - cleanup - required: &ref_119 + required: &ref_121 - status - start_time - last_error @@ -5462,30 +5545,6 @@ paths: description: Unique server identifier. type: string example: 995618a6a6cc9ac79731bd13240e19b5 - scopes: - description: Scopes that are used by the database. - type: object - example: - scope1: - collections: - collection1: - update_seq: 123456 - collection2: - update_seq: 654321 - additionalProperties: - description: The name of the scope. - type: object - properties: - collections: - description: The set of collections within the scope. - additionalProperties: - description: The name of the collection. - type: object - properties: - update_seq: - description: The last sequence number that was committed to the collection. - type: integer - example: 123456 '404': description: Resource could not be found content: *ref_2 @@ -5658,7 +5717,7 @@ paths: 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 expiries 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. + 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 @@ -5762,7 +5821,7 @@ paths: application/javascript: schema: type: object - properties: &ref_120 + properties: &ref_122 cmdline: description: Built-in variables from the Go runtime, lists the command-line arguments type: object @@ -5852,42 +5911,72 @@ paths: 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 - process_cpu_percent_utilization: + description: The total number of goroutines. + num_idle_kv_ops: type: integer + description: The total number of idle kv 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 the [Sync Gateway Statistics Schema](./../stats-monitoring.html) for more details on the metrics collected and reported by Sync Gateway. @@ -5976,7 +6065,7 @@ paths: application/json: schema: type: object - properties: &ref_121 + properties: &ref_123 ADMIN: description: '`true` if the request is from the Admin API - otherwise omitted.' type: boolean @@ -6013,7 +6102,7 @@ paths: `true` if the sync gateway node is running in persistent config mode. type: boolean example: true - required: &ref_122 + required: &ref_124 - couchdb - vendor tags: @@ -6028,6 +6117,30 @@ paths: summary: Check if server online description: Check if the server is online by checking the status code of response. operationId: head_- + /_ping: + get: + summary: Check if API is available + description: Returns OK status if API is available. + responses: + '200': + description: Returned status + content: + text/plain: + schema: + type: string + example: OK + tags: + - Server + operationId: get__ping + head: + responses: + '200': + description: Server is available + tags: + - Server + summary: Check if API is available + description: Returns OK status if API is available. + operationId: head__ping /{keyspace}/_all_docs: parameters: - name: keyspace @@ -6602,7 +6715,7 @@ paths: schema: description: Properties of a changes feed type: object - properties: &ref_123 + properties: &ref_125 results: type: array items: @@ -7478,7 +7591,7 @@ paths: responses: '200': description: New revision created successfully - content: &ref_130 + content: &ref_132 application/json: schema: description: Properties returned when a new document revision is created @@ -8037,7 +8150,7 @@ paths: application/json: schema: type: object - properties: &ref_124 + properties: &ref_126 id_token: description: The OpenID Connect ID token type: string @@ -8276,12 +8389,12 @@ paths: responses: '200': description: Properties expected back from an OpenID Connect provider after successful authentication - content: &ref_131 + content: &ref_133 application/json: schema: description: Properties expected back from an OpenID Connect provider after successful authentication type: object - properties: &ref_125 + properties: &ref_127 access_token: type: string token_type: @@ -8438,12 +8551,12 @@ paths: schema: *ref_95 description: The OpenID Connect authentication scope. requestBody: - content: &ref_132 + content: &ref_134 application/json: schema: description: Properties passed from the OpenID Connect mock login page to the handler type: object - properties: &ref_126 + properties: &ref_128 username: type: string tokenttl: @@ -8452,7 +8565,7 @@ paths: type: string authenticated: type: string - required: &ref_127 + required: &ref_129 - username - tokenttl - identity-token-formats @@ -8517,34 +8630,6 @@ paths: tags: - Replication operationId: get_db-_blipsync -tags: - - name: Authentication - description: Manage authentication - - name: Server - description: Manage server activities - - name: Database Management - description: Create and manage Sync Gateway databases - - name: Database Configuration - description: Configure Sync Gateway databases - - name: Database Security - description: Create and manage database users and roles - - name: Session - description: Manage user sessions - - name: OpenID Connect - description: Manage OpenID Connect - - name: Document - description: Create and manage documents and attachments - - name: Replication - description: Create and manage inter-Sync Gateway replications - - name: Metrics - description: Get Sync Gateway statistics - - name: Profiling - description: Generate information to help debug and fine-tune Sync Gateway - - name: Unsupported - description: Endpoints that are not supported by Sync Gateway -externalDocs: - description: Sync Gateway Quickstart | Couchbase Docs - url: https://docs.couchbase.com/sync-gateway/current/index.html components: parameters: db: @@ -9056,11 +9141,19 @@ components: description: scope name with one or more collection names for which resync will be triggered type: object additionalProperties: *ref_117 + All DBs: + description: The names of all databases. + type: array + items: *ref_118 + All DBs Verbose: + description: Description of all databases. + type: array + items: *ref_119 Compact-status: description: The status returned from a compaction. type: object - properties: *ref_118 - required: *ref_119 + properties: *ref_120 + required: *ref_121 title: Compact-status Document: description: The configurable Sync Gateway properties of a document. @@ -9075,33 +9168,33 @@ components: title: New-revision ExpVars: type: object - properties: *ref_120 + properties: *ref_122 NodeInfo: type: object - properties: *ref_121 - required: *ref_122 + properties: *ref_123 + required: *ref_124 Changes-feed: description: Properties of a changes feed type: object - properties: *ref_123 + properties: *ref_125 Design-doc: description: Properties of a design document type: object properties: *ref_63 OIDC-callback: type: object - properties: *ref_124 + properties: *ref_126 title: OpenID Connect callback properties OIDC-token: description: Properties expected back from an OpenID Connect provider after successful authentication type: object - properties: *ref_125 + properties: *ref_127 title: OIDC-token OIDC-login-page-handler: description: Properties passed from the OpenID Connect mock login page to the handler type: object - properties: *ref_126 - required: *ref_127 + properties: *ref_128 + required: *ref_129 responses: User-session-information: description: Properties associated with a user session @@ -9120,10 +9213,10 @@ components: content: *ref_14 User: description: Properties associated with a user - content: *ref_128 + content: *ref_130 Role: description: Properties associated with a role - content: *ref_129 + content: *ref_131 Replicator-updated: description: Updated existing configuration successfully Replicator-created: @@ -9161,7 +9254,7 @@ components: content: *ref_84 New-revision: description: New revision created successfully - content: *ref_130 + content: *ref_132 OIDC-invalid-provider: description: 'The provider provided is not defined in the Sync Gateway config. If no provided was specified then there is no default provider set. ' OIDC-connection: @@ -9179,7 +9272,7 @@ components: content: *ref_97 OIDC-token: description: Properties expected back from an OpenID Connect provider after successful authentication - content: *ref_131 + content: *ref_133 OIDC-testing-redirect: description: Redirecting to Sync Gateway OpenID Connect callback URL headers: *ref_99 @@ -9196,5 +9289,5 @@ components: Profile: content: *ref_32 OIDC-login-page-handler: - content: *ref_132 + content: *ref_134 description: Properties passed from the OpenID Connect mock login page to the handler diff --git a/modules/ROOT/assets/attachments/bundled-metric.yaml b/modules/ROOT/assets/attachments/bundled-metric.yaml index 601015fb..3060fa9e 100644 --- a/modules/ROOT/assets/attachments/bundled-metric.yaml +++ b/modules/ROOT/assets/attachments/bundled-metric.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Sync Gateway description: Sync Gateway manages access and synchronization between Couchbase Lite and Couchbase Server - version: 3.1.0 + version: 3.2.0 license: name: Business Source License 1.1 (BSL) url: https://github.com/couchbase/sync_gateway/blob/master/LICENSE @@ -19,9 +19,39 @@ servers: hostname: description: The hostname to use default: localhost +tags: + - name: Prometheus + description: Endpoints for use with Prometheus +externalDocs: + description: Sync Gateway Quickstart | Couchbase Docs + url: https://docs.couchbase.com/sync-gateway/current/index.html paths: - /_metrics: + /_ping: get: + summary: Check if API is available + description: Returns OK status if API is available. + responses: + '200': + description: Returned status + content: + text/plain: + schema: + type: string + example: OK + tags: + - Server + operationId: get__ping + head: + responses: + '200': + description: Server is available + tags: + - Server + summary: Check if API is available + description: Returns OK status if API is available. + operationId: head__ping + /_metrics: + get: &ref_0 summary: Debugging/monitoring runtime stats in Prometheus Exposition format description: |- Returns Sync Gateway statistics and other runtime variables in Prometheus Exposition format. @@ -40,7 +70,9 @@ paths: type: string tags: - Prometheus - operationId: get__metrics + operationId: get_metrics + /metrics: + get: *ref_0 /_expvar: get: summary: Get all Sync Gateway statistics @@ -61,7 +93,7 @@ paths: application/javascript: schema: type: object - properties: &ref_0 + properties: &ref_1 cmdline: description: Built-in variables from the Go runtime, lists the command-line arguments type: object @@ -151,42 +183,72 @@ paths: 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 - process_cpu_percent_utilization: + description: The total number of goroutines. + num_idle_kv_ops: type: integer + description: The total number of idle kv 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 the [Sync Gateway Statistics Schema](./../stats-monitoring.html) for more details on the metrics collected and reported by Sync Gateway. @@ -262,14 +324,8 @@ paths: type: integer deprecated: true operationId: get__expvar -tags: - - name: Prometheus - description: Endpoints for use with Prometheus -externalDocs: - description: Sync Gateway Quickstart | Couchbase Docs - url: https://docs.couchbase.com/sync-gateway/current/index.html components: schemas: ExpVars: type: object - properties: *ref_0 + properties: *ref_1 diff --git a/modules/ROOT/assets/attachments/bundled-public.yaml b/modules/ROOT/assets/attachments/bundled-public.yaml index 8e0f705a..5c4c1508 100644 --- a/modules/ROOT/assets/attachments/bundled-public.yaml +++ b/modules/ROOT/assets/attachments/bundled-public.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Sync Gateway description: Sync Gateway manages access and synchronization between Couchbase Lite and Couchbase Server - version: 3.1.0 + version: 3.2.0 license: name: Business Source License 1.1 (BSL) url: https://github.com/couchbase/sync_gateway/blob/master/LICENSE @@ -19,6 +19,26 @@ servers: hostname: description: The hostname to use default: localhost +tags: + - name: Server + description: Manage server activities + - name: Database Management + description: Create and manage Sync Gateway databases + - name: Session + description: Manage user sessions + - name: Authentication + description: Manage OpenID Connect Authentication + - name: Document + description: Create and manage documents + - name: Document Attachment + description: Create and manage document attachments + - name: Replication + description: Create and manage inter-Sync Gateway replications + - name: Unsupported + description: Endpoints that are not supported by Sync Gateway +externalDocs: + description: Sync Gateway Quickstart | Couchbase Docs + url: https://docs.couchbase.com/sync-gateway/current/index.html paths: /{db}/_session: parameters: @@ -362,6 +382,30 @@ paths: summary: Check if server online description: Check if the server is online by checking the status code of response. operationId: head_- + /_ping: + get: + summary: Check if API is available + description: Returns OK status if API is available. + responses: + '200': + description: Returned status + content: + text/plain: + schema: + type: string + example: OK + tags: + - Server + operationId: get__ping + head: + responses: + '200': + description: Server is available + tags: + - Server + summary: Check if API is available + description: Returns OK status if API is available. + operationId: head__ping /{keyspace}/: parameters: - name: keyspace @@ -414,7 +458,7 @@ paths: 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 expiries 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. + 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 @@ -2881,26 +2925,6 @@ paths: tags: - Replication operationId: get_db-_blipsync -tags: - - name: Server - description: Manage server activities - - name: Database Management - description: Create and manage Sync Gateway databases - - name: Session - description: Manage user sessions - - name: Authentication - description: Manage OpenID Connect Authentication - - name: Document - description: Create and manage documents - - name: Document Attachment - description: Create and manage document attachments - - name: Replication - description: Create and manage inter-Sync Gateway replications - - name: Unsupported - description: Endpoints that are not supported by Sync Gateway -externalDocs: - description: Sync Gateway Quickstart | Couchbase Docs - url: https://docs.couchbase.com/sync-gateway/current/index.html components: parameters: db: diff --git a/modules/ROOT/pages/_partials/static_restapi/admin/.openapi-generator/VERSION b/modules/ROOT/pages/_partials/static_restapi/admin/.openapi-generator/VERSION index 4be2c727..8b23b8d4 100644 --- a/modules/ROOT/pages/_partials/static_restapi/admin/.openapi-generator/VERSION +++ b/modules/ROOT/pages/_partials/static_restapi/admin/.openapi-generator/VERSION @@ -1 +1 @@ -6.5.0 \ No newline at end of file +7.3.0 \ No newline at end of file diff --git a/modules/ROOT/pages/_partials/static_restapi/admin/index.adoc b/modules/ROOT/pages/_partials/static_restapi/admin/index.adoc index 16cd2ecc..e884059e 100644 --- a/modules/ROOT/pages/_partials/static_restapi/admin/index.adoc +++ b/modules/ROOT/pages/_partials/static_restapi/admin/index.adoc @@ -14,7 +14,7 @@ Sync Gateway manages access and synchronization between Couchbase Lite and Couch === Version information [%hardbreaks] -__Version__ : 3.1.0 +__Version__ : 3.2.0 === Host information [%hardbreaks] @@ -5158,7 +5158,6 @@ Create and manage Sync Gateway databases * xref:#+get_db-_compact+[Get the status of the most recent compact operation] * xref:#+get_db-_resync+[Get resync status] * xref:#+get_keyspace-_changes+[Get changes list] -* xref:#+head__all_dbs+[/_all_dbs] * xref:#+head_db-+[Check if database exists] * xref:#+head_keyspace-_changes+[/{db}/_changes] * xref:#+post_db-_compact+[Manage a compact operation] @@ -5386,7 +5385,7 @@ GET /_all_dbs [markdown] -- -This retrieves all the database's names that are in the current Sync Gateway node. +This retrieves all the databases that are in the current Sync Gateway node. If verbose, returns bucket and state information for each database, otherwise returns names only. Required Sync Gateway RBAC roles: @@ -5406,11 +5405,43 @@ Required Sync Gateway RBAC roles: // markup not found, no include::{specDir}paths/get__all_dbs/operation-parameters-before.adoc[opts=optional] +===== Parameters +// tag::get__all_dbs-parameters[] + + +// markup not found, no include::{specDir}paths/get__all_dbs/operation-parameters-begin.adoc[opts=optional] + + + + + + +====== Query Parameters + +[cols="2,3,1"] +|=== +|Name| Description| Schema + +a| +*verbose* + +_optional_ +a| +[markdown] +-- +-- +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +// end + +| Boolean +|=== // markup not found, no include::{specDir}paths/get__all_dbs/operation-parameters-end.adoc[opts=optional] @@ -5446,7 +5477,7 @@ Required Sync Gateway RBAC roles: | 200 a| Successfully retrieved all database names -| List +| xref:#++get__all_dbs_200_response++[+get__all_dbs_200_response+] |=== @@ -6520,143 +6551,6 @@ endif::internal-generation[] -// markup not found, no include::{specDir}paths/head__all_dbs/operation-before.adoc[opts=optional] - - -[#head__all_dbs] -==== /_all_dbs -.... -HEAD /_all_dbs -.... - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-begin.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-description-before.adoc[opts=optional] - - -[#head__all_dbs-description] -===== Description - -// tag::head__all_dbs-description[] - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-description-begin.adoc[opts=optional] - - -[markdown] --- -Required Sync Gateway RBAC roles: - -* Sync Gateway Dev Ops --- - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-description-end.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-description-after.adoc[opts=optional] - - -// end::head__all_dbs-description[] - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-parameters-before.adoc[opts=optional] - - - - - - - - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-parameters-end.adoc[opts=optional] - -// end::head__all_dbs-parameters[] - - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-parameters-after.adoc[opts=optional] - - - - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-responses-before.adoc[opts=optional] - - -[#head__all_dbs-responses] -===== Responses - -// tag::head__all_dbs-responses[] - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-responses-begin.adoc[opts=optional] - - -[cols="1,3,1"] -|=== -| HTTP Code | Description | Schema - -| 200 -a| OK -| - - -|=== - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-responses-end.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-responses-after.adoc[opts=optional] - -// end::head__all_dbs-responses[] - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-security-before.adoc[opts=optional] - - - - - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-security-after.adoc[opts=optional] - - -:leveloffset: +4 - -// markup not found, no include::{snippetDir}head__all_dbs/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}head__all_dbs/http-response.adoc[opts=optional] - -:leveloffset: -4 - - -// file not found, no * wiremock data link :_all_dbs/HEAD/HEAD.json[] - - -ifdef::internal-generation[] -===== Implementation - -// markup not found, no include::{specDir}_all_dbs/HEAD/implementation.adoc[opts=optional] - - -endif::internal-generation[] - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-end.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-after.adoc[opts=optional] - - - - // markup not found, no include::{specDir}paths/head_db-/operation-before.adoc[opts=optional] @@ -8053,6 +7947,25 @@ endif::[] | Boolean +a| +*reset* + +_optional_ +a| +[markdown] +-- +This forces a fresh resync run instead of trying to resume the previous resync operation + +-- + +[%hardbreaks] +ifeval::["false" != "null"] +*Default:* `false` +endif::[] +// end + +| Boolean + + |=== @@ -9355,7 +9268,6 @@ Indicates that roles marked as deleted should be included in the result. -- [%hardbreaks] -*Values:* `true`, `false` ifeval::["false" != "null"] *Default:* `false` endif::[] @@ -15525,8 +15437,7 @@ a| [%hardbreaks] // end -| oas_any_type_not_mapped -Map +| xref:#++PostKeyspaceRequest++[+PostKeyspaceRequest+] |=== @@ -16702,8 +16613,7 @@ ifeval::["{"doc_id":["*"]}" != "null"] endif::[] // end -| List -Map +| xref:#++PostKeyspacePurgeRequest++[+PostKeyspacePurgeRequest+] |=== @@ -16940,8 +16850,7 @@ a| [%hardbreaks] // end -| oas_any_type_not_mapped -Map +| xref:#++PostKeyspaceRequest++[+PostKeyspaceRequest+] |=== @@ -24843,9 +24752,11 @@ Manage server activities * xref:#+get_-+[Get server information] * xref:#+get__config+[Get server configuration] * xref:#+get__logging+[Get console logging settings] +* xref:#+get__ping+[Check if API is available] * xref:#+get__sgcollect_info+[Get the status of the Sync Gateway Collect Info] * xref:#+get__status+[Get the server status] * xref:#+head_-+[Check if server online] +* xref:#+head__ping+[Check if API is available] * xref:#+post__logging+[Update console logging settings] * xref:#+post__post_upgrade+[Run the post upgrade process on all databases] * xref:#+post__sgcollect_info+[Start Sync Gateway Collect Info] @@ -25483,6 +25394,145 @@ endif::internal-generation[] +// markup not found, no include::{specDir}paths/get__ping/operation-before.adoc[opts=optional] + + +[#get__ping] +==== Check if API is available +.... +GET /_ping +.... + + +// markup not found, no include::{specDir}paths/get__ping/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-before.adoc[opts=optional] + + +[#get__ping-description] +===== Description + +// tag::get__ping-description[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns OK status if API is available. +-- + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-after.adoc[opts=optional] + + +// end::get__ping-description[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-end.adoc[opts=optional] + +// end::get__ping-parameters[] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-after.adoc[opts=optional] + + +[#get__ping-produces] +===== Produces + +* text/plain + + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-before.adoc[opts=optional] + + +[#get__ping-responses] +===== Responses + +// tag::get__ping-responses[] + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Returned status +| xref:#++String++[+String+] + + +|=== + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-after.adoc[opts=optional] + +// end::get__ping-responses[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}get__ping/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}get__ping/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :_ping/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}_ping/GET/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get__ping/operation-after.adoc[opts=optional] + + + + // markup not found, no include::{specDir}paths/get__sgcollect_info/operation-before.adoc[opts=optional] @@ -25908,6 +25958,141 @@ endif::internal-generation[] +// markup not found, no include::{specDir}paths/head__ping/operation-before.adoc[opts=optional] + + +[#head__ping] +==== Check if API is available +.... +HEAD /_ping +.... + + +// markup not found, no include::{specDir}paths/head__ping/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-before.adoc[opts=optional] + + +[#head__ping-description] +===== Description + +// tag::head__ping-description[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns OK status if API is available. +-- + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-after.adoc[opts=optional] + + +// end::head__ping-description[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-end.adoc[opts=optional] + +// end::head__ping-parameters[] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-after.adoc[opts=optional] + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-before.adoc[opts=optional] + + +[#head__ping-responses] +===== Responses + +// tag::head__ping-responses[] + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Server is available +| + + +|=== + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-after.adoc[opts=optional] + +// end::head__ping-responses[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}head__ping/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}head__ping/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :_ping/HEAD/HEAD.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}_ping/HEAD/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/head__ping/operation-after.adoc[opts=optional] + + + + // markup not found, no include::{specDir}paths/post__logging/operation-before.adoc[opts=optional] @@ -31218,6 +31403,8 @@ endif::internal-generation[] :desc-Database_config_delta_sync: Delta sync configuration settings. **This is an enterprise-edition feature only** :desc-Database_config_event_handlers: These are the settings for webhooks. :desc-Database_config_local_jwt_value: The providers name. +:desc-Database_config_logging: Per-database logging configuration. +:desc-Database_config_logging_console: Console logging configuration. :desc-Database_config_oidc: Configuration for OpenID Connect authentication. :desc-Database_config_oidc_providers_value: The providers name. :desc-Database_config_roles_value: Properties associated with a role @@ -31228,8 +31415,6 @@ endif::internal-generation[] :desc-Design-doc: Properties of a design document :desc-Document: The configurable Sync Gateway properties of a document. :desc-get___200_response_vendor: Product vendor -:desc-get_db__200_response_scopes_value: The name of the scope. -:desc-get_db__200_response_scopes_value_collections_value: The name of the collection. :desc-get_db__design_ddoc_200_response: Properties of a design document :desc-get_db__design_ddoc_200_response_views_value: The name of the view. :desc-get__expvar_200_response_syncgateway: Monitoring stats @@ -31292,6 +31477,8 @@ This section describes the properties consumed and returned by this REST API. * xref:#+Database_config_event_handlers+[DatabaseConfigEventHandlers] * xref:#+Database_config_local_jwt_value+[DatabaseConfigLocalJwtValue] * xref:#+Database_config_local_jwt_value_keys_inner+[DatabaseConfigLocalJwtValueKeysInner] +* xref:#+Database_config_logging+[DatabaseConfigLogging] +* xref:#+Database_config_logging_console+[DatabaseConfigLoggingConsole] * xref:#+Database_config_oidc+[DatabaseConfigOidc] * xref:#+Database_config_oidc_providers_value+[DatabaseConfigOidcProvidersValue] * xref:#+Database_config_replications+[DatabaseConfigReplications] @@ -31312,9 +31499,9 @@ This section describes the properties consumed and returned by this REST API. * xref:#+File_logging_config+[File-logging-config] * xref:#+get___200_response+[Get200Response] * xref:#+get___200_response_vendor+[Get200ResponseVendor] +* xref:#+get__all_dbs_200_response+[GetAllDbs200Response] +* xref:#+get__all_dbs_200_response_oneOf_inner+[GetAllDbs200ResponseOneOfInner] * xref:#+get_db__200_response+[GetDb200Response] -* xref:#+get_db__200_response_scopes_value+[GetDb200ResponseScopesValue] -* xref:#+get_db__200_response_scopes_value_collections_value+[GetDb200ResponseScopesValueCollectionsValue] * xref:#+get_db__design_ddoc_200_response+[GetDbDesignDdoc200Response] * xref:#+get_db__design_ddoc_200_response_options+[GetDbDesignDdoc200ResponseOptions] * xref:#+get_db__design_ddoc_200_response_views_value+[GetDbDesignDdoc200ResponseViewsValue] @@ -31760,7 +31947,7 @@ a| *+marked_attachments+* + _optional_ a| **Applicable to attachment compaction only** -This is the number of references there are to legacy attachments. +This is the number of references there are to legacy attachments. [%hardbreaks] ifeval::["null" != "null"] @@ -32718,7 +32905,7 @@ endif::[] | Boolean -a| *+send_www_authentice_header+* + +a| *+send_www_authenticate_header+* + _optional_ a| Controls whether to send a `WWW-Authenticate` header in `401 Unauthorized` HTTP responses. @@ -32961,7 +33148,7 @@ endif::[] a| *+suspendable+* + _optional_ -a| Set to true to allow the database to be suspended. +a| Set to true to allow the database to be suspended. Defaults to true when running in serverless mode otherwise defaults to false. @@ -32994,6 +33181,24 @@ endif::[] | xref:#++Database_config_cors++[+Database_config_cors+] +a| *+logging+* + +_optional_ +a| +ifdef::desc-Database_config_logging[] +{desc-Database_config_logging} +endif::[] + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| xref:#++Database_config_logging++[+Database_config_logging+] + + |=== @@ -33645,7 +33850,7 @@ endif::[] | Boolean -a| *+send_www_authentice_header+* + +a| *+send_www_authenticate_header+* + _optional_ a| Controls whether to send a `WWW-Authenticate` header in `401 Unauthorized` HTTP responses. @@ -33888,7 +34093,7 @@ endif::[] a| *+suspendable+* + _optional_ -a| Set to true to allow the database to be suspended. +a| Set to true to allow the database to be suspended. Defaults to true when running in serverless mode otherwise defaults to false. @@ -33921,6 +34126,24 @@ endif::[] | xref:#++Database_config_cors++[+Database_config_cors+] +a| *+logging+* + +_optional_ +a| +ifdef::desc-Database_config_logging[] +{desc-Database_config_logging} +endif::[] + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| xref:#++Database_config_logging++[+Database_config_logging+] + + |=== @@ -34953,6 +35176,110 @@ endif::[] +// markup not found, no include::{specDir}definitions/Database_config_logging/definition-before.adoc[opts=optional] + + +[#Database_config_logging] +=== DatabaseConfigLogging + + +// markup not found, no include::{specDir}definitions/Database_config_logging/definition-begin.adoc[opts=optional] + + +[#fields-Database_config_logging] +[cols="1,4,1"] +|=== +| Name| Description| Schema + +a| *+console+* + +_optional_ +a| +ifdef::desc-Database_config_logging_console[] +{desc-Database_config_logging_console} +endif::[] + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| xref:#++Database_config_logging_console++[+Database_config_logging_console+] + + +|=== + + +// markup not found, no include::{specDir}definitions/Database_config_logging/definition-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}definitions/Database_config_logging/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/Database_config_logging_console/definition-before.adoc[opts=optional] + + +[#Database_config_logging_console] +=== DatabaseConfigLoggingConsole + + +// markup not found, no include::{specDir}definitions/Database_config_logging_console/definition-begin.adoc[opts=optional] + + +[#fields-Database_config_logging_console] +[cols="1,4,1"] +|=== +| Name| Description| Schema + +a| *+log_level+* + +_optional_ +a| Log Level for the console output + +[%hardbreaks] +*Values:* `none`, `error`, `warn`, `info`, `debug`, `trace` +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["debug" != "null"] +*Example:* `debug` +endif::[] +// end +| String + + +a| *+log_keys+* + +_optional_ +a| Log Keys for the console output + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["["CRUD","HTTP","Query"]" != "null"] +*Example:* `["CRUD","HTTP","Query"]` +endif::[] +// end +| String +List + + +|=== + + +// markup not found, no include::{specDir}definitions/Database_config_logging_console/definition-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}definitions/Database_config_logging_console/definition-after.adoc[opts=optional] + + + + // markup not found, no include::{specDir}definitions/Database_config_oidc/definition-before.adoc[opts=optional] @@ -36411,7 +36738,7 @@ endif::[] a| *+_exp+* + _optional_ -a| 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 expiries 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. +a| 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. @@ -36972,6 +37299,108 @@ endif::[] +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response/definition-before.adoc[opts=optional] + + +[#get__all_dbs_200_response] +=== GetAllDbs200Response + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response/definition-begin.adoc[opts=optional] + + +One of the following: + +* String +List + +* xref:#++get__all_dbs_200_response_oneOf_inner++[+get__all_dbs_200_response_oneOf_inner+] +List + + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response/definition-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response_oneOf_inner/definition-before.adoc[opts=optional] + + +[#get__all_dbs_200_response_oneOf_inner] +=== GetAllDbs200ResponseOneOfInner + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response_oneOf_inner/definition-begin.adoc[opts=optional] + + +[#fields-get__all_dbs_200_response_oneOf_inner] +[cols="1,4,1"] +|=== +| Name| Description| Schema + +a| *+db_name+* + +_optional_ +a| The name of the database. + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| String + + +a| *+bucket+* + +_optional_ +a| The Couchbase Server backing bucket for the database. + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| String + + +a| *+state+* + +_optional_ +a| The database state. + +[%hardbreaks] +*Values:* `Online`, `Offline`, `Starting`, `Stopping`, `Resyncing` +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| String + + +|=== + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response_oneOf_inner/definition-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response_oneOf_inner/definition-after.adoc[opts=optional] + + + + // markup not found, no include::{specDir}definitions/get_db__200_response/definition-before.adoc[opts=optional] @@ -37127,22 +37556,6 @@ endif::[] | String -a| *+scopes+* + -_optional_ -a| Scopes that are used by the database. - -[%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` -endif::[] -ifeval::["{"scope1":{"collections":{"collection1":{"update_seq":123456},"collection2":{"update_seq":654321}}}}" != "null"] -*Example:* `{"scope1":{"collections":{"collection1":{"update_seq":123456},"collection2":{"update_seq":654321}}}}` -endif::[] -// end -| xref:#++get_db__200_response_scopes_value++[+get_db__200_response_scopes_value+] -Map - - |=== @@ -37155,91 +37568,6 @@ Map -// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value/definition-before.adoc[opts=optional] - - -[#get_db__200_response_scopes_value] -=== GetDb200ResponseScopesValue - - -// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value/definition-begin.adoc[opts=optional] - - -[#fields-get_db__200_response_scopes_value] -[cols="1,4,1"] -|=== -| Name| Description| Schema - -a| *+collections+* + -_optional_ -a| The set of collections within the scope. - -[%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` -endif::[] -ifeval::["null" != "null"] -*Example:* `null` -endif::[] -// end -| xref:#++get_db__200_response_scopes_value_collections_value++[+get_db__200_response_scopes_value_collections_value+] -Map - - -|=== - - -// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value/definition-end.adoc[opts=optional] - - - -// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value/definition-after.adoc[opts=optional] - - - - -// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value_collections_value/definition-before.adoc[opts=optional] - - -[#get_db__200_response_scopes_value_collections_value] -=== GetDb200ResponseScopesValueCollectionsValue - - -// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value_collections_value/definition-begin.adoc[opts=optional] - - -[#fields-get_db__200_response_scopes_value_collections_value] -[cols="1,4,1"] -|=== -| Name| Description| Schema - -a| *+update_seq+* + -_optional_ -a| The last sequence number that was committed to the collection. - -[%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` -endif::[] -ifeval::["123456" != "null"] -*Example:* `123456` -endif::[] -// end -| Integer - - -|=== - - -// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value_collections_value/definition-end.adoc[opts=optional] - - - -// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value_collections_value/definition-after.adoc[opts=optional] - - - - // markup not found, no include::{specDir}definitions/get_db__design_ddoc_200_response/definition-before.adoc[opts=optional] @@ -38647,7 +38975,7 @@ endif::[] a| *+admin_net_bytes_recv+* + _optional_ -a| +a| The total number of bytes received (since node start-up) on the network interface to which the Sync Gateway api.admin_interface is bound. [%hardbreaks] ifeval::["null" != "null"] @@ -38662,7 +38990,7 @@ endif::[] a| *+admin_net_bytes_sent+* + _optional_ -a| +a| The total number of bytes sent (since node start-up) on the network interface to which the Sync Gateway api.admin_interface is bound. [%hardbreaks] ifeval::["null" != "null"] @@ -38677,7 +39005,7 @@ endif::[] a| *+error_count+* + _optional_ -a| +a| The total number of errors logged. [%hardbreaks] ifeval::["null" != "null"] @@ -38692,7 +39020,7 @@ endif::[] a| *+go_memstats_heapalloc+* + _optional_ -a| +a| 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). [%hardbreaks] ifeval::["null" != "null"] @@ -38707,7 +39035,7 @@ endif::[] a| *+go_memstats_heapidle+* + _optional_ -a| +a| 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. [%hardbreaks] ifeval::["null" != "null"] @@ -38722,7 +39050,7 @@ endif::[] a| *+go_memstats_heapinuse+* + _optional_ -a| +a| 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. [%hardbreaks] ifeval::["null" != "null"] @@ -38737,7 +39065,7 @@ endif::[] a| *+go_memstats_heapreleased+* + _optional_ -a| +a| 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. [%hardbreaks] ifeval::["null" != "null"] @@ -38752,7 +39080,7 @@ endif::[] a| *+go_memstats_pausetotalns+* + _optional_ -a| +a| 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. [%hardbreaks] ifeval::["null" != "null"] @@ -38767,7 +39095,7 @@ endif::[] a| *+go_memstats_stackinuse+* + _optional_ -a| +a| 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). [%hardbreaks] ifeval::["null" != "null"] @@ -38782,7 +39110,7 @@ endif::[] a| *+go_memstats_stacksys+* + _optional_ -a| +a| 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). [%hardbreaks] ifeval::["null" != "null"] @@ -38797,7 +39125,7 @@ endif::[] a| *+go_memstats_sys+* + _optional_ -a| +a| 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. [%hardbreaks] ifeval::["null" != "null"] @@ -38812,7 +39140,7 @@ endif::[] a| *+goroutines_high_watermark+* + _optional_ -a| +a| Peak number of go routines since process start. [%hardbreaks] ifeval::["null" != "null"] @@ -38827,7 +39155,7 @@ endif::[] a| *+num_goroutines+* + _optional_ -a| +a| The total number of goroutines. [%hardbreaks] ifeval::["null" != "null"] @@ -38840,9 +39168,9 @@ endif::[] | Integer -a| *+process_cpu_percent_utilization+* + +a| *+num_idle_kv_ops+* + _optional_ -a| +a| The total number of idle kv operations. [%hardbreaks] ifeval::["null" != "null"] @@ -38855,9 +39183,39 @@ endif::[] | Integer +a| *+process_cpu_percent_utilization+* + +_optional_ +a| 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. + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| Float (float) + + +a| *+node_cpu_percent_utilization+* + +_optional_ +a| 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. + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| Float (float) + + a| *+process_memory_resident+* + _optional_ -a| +a| The memory utilization (Resident Set Size) for the process, in bytes. [%hardbreaks] ifeval::["null" != "null"] @@ -38872,7 +39230,7 @@ endif::[] a| *+pub_net_bytes_recv+* + _optional_ -a| +a| 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 [%hardbreaks] ifeval::["null" != "null"] @@ -38887,7 +39245,7 @@ endif::[] a| *+pub_net_bytes_sent+* + _optional_ -a| +a| 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. [%hardbreaks] ifeval::["null" != "null"] @@ -38902,7 +39260,7 @@ endif::[] a| *+system_memory_total+* + _optional_ -a| +a| The total memory available on the system in bytes. [%hardbreaks] ifeval::["null" != "null"] @@ -38917,7 +39275,22 @@ endif::[] a| *+warn_count+* + _optional_ -a| +a| The total number of warnings logged. + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| Integer + + +a| *+uptime+* + +_optional_ +a| The total uptime. [%hardbreaks] ifeval::["null" != "null"] @@ -40230,8 +40603,8 @@ _optional_ a| The maximum size in MB of the log file before it gets rotated. [%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` +ifeval::["100" != "null"] +*Default:* `100` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -40242,7 +40615,7 @@ endif::[] a| *+max_age+* + _optional_ -a| The maximum number of days to retain old log files. +a| The maximum number of days to retain old log files. The defaults for this value are 360 days for error, 180 days for warn, 6 days for info, 2 days for debug, and 2 days for trace logs. [%hardbreaks] ifeval::["null" != "null"] @@ -40260,8 +40633,8 @@ _optional_ a| If true, it uses the computer's local time to format the backup timestamp. [%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` +ifeval::["false" != "null"] +*Default:* `false` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -40270,13 +40643,13 @@ endif::[] | Boolean -a| *+rotated_logs_size+* + +a| *+rotated_logs_size_limit+* + _optional_ a| Max Size (in mb) of log files before deletion [%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` +ifeval::["1024" != "null"] +*Default:* `1024` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -40317,8 +40690,8 @@ _optional_ a| The maximum size in MB of the log file before it gets rotated. [%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` +ifeval::["100" != "null"] +*Default:* `100` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -40329,7 +40702,7 @@ endif::[] a| *+max_age+* + _optional_ -a| The maximum number of days to retain old log files. +a| The maximum number of days to retain old log files. The defaults for this value are 360 days for error, 180 days for warn, 6 days for info, 2 days for debug, and 2 days for trace logs. [%hardbreaks] ifeval::["null" != "null"] @@ -40347,8 +40720,8 @@ _optional_ a| If true, it uses the computer's local time to format the backup timestamp. [%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` +ifeval::["false" != "null"] +*Default:* `false` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -40357,13 +40730,13 @@ endif::[] | Boolean -a| *+rotated_logs_size+* + +a| *+rotated_logs_size_limit+* + _optional_ a| Max Size (in mb) of log files before deletion [%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` +ifeval::["1024" != "null"] +*Default:* `1024` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -42234,7 +42607,7 @@ endif::[] a| *+_exp+* + _optional_ -a| 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 expiries 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. +a| 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. @@ -43130,7 +43503,7 @@ Changing this is an enterprise-edition only feature. **Behaviour** * *default* - In priority order, this will cause - - Deletes to always win (the delete with the logest revision history wins if both revisions are deletes) + - Deletes to always win (the delete with the longest revision history wins if both revisions are deletes) - The revision with the longest revision history to win. This means the the revision with the most changes and therefore the highest revision ID will win. * *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. @@ -43606,7 +43979,7 @@ Changing this is an enterprise-edition only feature. **Behaviour** * *default* - In priority order, this will cause - - Deletes to always win (the delete with the logest revision history wins if both revisions are deletes) + - Deletes to always win (the delete with the longest revision history wins if both revisions are deletes) - The revision with the longest revision history to win. This means the the revision with the most changes and therefore the highest revision ID will win. * *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. @@ -44517,7 +44890,7 @@ Changing this is an enterprise-edition only feature. **Behaviour** * *default* - In priority order, this will cause - - Deletes to always win (the delete with the logest revision history wins if both revisions are deletes) + - Deletes to always win (the delete with the longest revision history wins if both revisions are deletes) - The revision with the longest revision history to win. This means the the revision with the most changes and therefore the highest revision ID will win. * *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. @@ -45184,7 +45557,7 @@ endif::[] a| *+min_config_fetch_interval+* + _optional_ -a| 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. +a| 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`. @@ -45456,7 +45829,7 @@ endif::[] | String -a| *+metric_interface+* + +a| *+metrics_interface+* + _optional_ a| Network interface to bind metrics API to. @@ -46714,7 +47087,7 @@ endif::[] a| *+min_config_fetch_interval+* + _optional_ -a| 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. +a| 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`. @@ -46912,7 +47285,7 @@ _optional_ a| Whether the database is online or offline. [%hardbreaks] -*Values:* `Online`, `Offline` +*Values:* `Online`, `Offline`, `Starting`, `Stopping`, `Resyncing` ifeval::["null" != "null"] *Default:* `null` endif::[] @@ -47908,7 +48281,7 @@ Changing this is an enterprise-edition only feature. **Behaviour** * *default* - In priority order, this will cause - - Deletes to always win (the delete with the logest revision history wins if both revisions are deletes) + - Deletes to always win (the delete with the longest revision history wins if both revisions are deletes) - The revision with the longest revision history to win. This means the the revision with the most changes and therefore the highest revision ID will win. * *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. diff --git a/modules/ROOT/pages/_partials/static_restapi/generate.sh b/modules/ROOT/pages/_partials/static_restapi/generate.sh index 10432d19..01bb719a 100755 --- a/modules/ROOT/pages/_partials/static_restapi/generate.sh +++ b/modules/ROOT/pages/_partials/static_restapi/generate.sh @@ -14,12 +14,14 @@ PATH_TO_BUNDLE=${PATH_TO_BUNDLE:-${GIT_ROOT}/modules/ROOT/assets/attachments/} generate() { SPEC=$1 - redocly bundle \ - "${PATH_TO_SPECS}/${SPEC}.yaml" \ + npx '@redocly/cli' bundle \ + --config "${PATH_TO_SYNC_GATEWAY}/.redocly.yaml" \ + "${PATH_TO_SYNC_GATEWAY}/docs/api/${SPEC}.yaml" \ --dereferenced \ --output "${PATH_TO_BUNDLE}/bundled-${SPEC}.yaml" openapi-generator generate \ + --skip-validate-spec \ --generator-name asciidoc \ --input-spec "${PATH_TO_BUNDLE}/bundled-${SPEC}.yaml" \ --template-dir override/asciidoc \ diff --git a/modules/ROOT/pages/_partials/static_restapi/metric/.openapi-generator/VERSION b/modules/ROOT/pages/_partials/static_restapi/metric/.openapi-generator/VERSION index 4be2c727..8b23b8d4 100644 --- a/modules/ROOT/pages/_partials/static_restapi/metric/.openapi-generator/VERSION +++ b/modules/ROOT/pages/_partials/static_restapi/metric/.openapi-generator/VERSION @@ -1 +1 @@ -6.5.0 \ No newline at end of file +7.3.0 \ No newline at end of file diff --git a/modules/ROOT/pages/_partials/static_restapi/metric/index.adoc b/modules/ROOT/pages/_partials/static_restapi/metric/index.adoc index 03d4566e..bcea717e 100644 --- a/modules/ROOT/pages/_partials/static_restapi/metric/index.adoc +++ b/modules/ROOT/pages/_partials/static_restapi/metric/index.adoc @@ -14,7 +14,7 @@ Sync Gateway manages access and synchronization between Couchbase Lite and Couch === Version information [%hardbreaks] -__Version__ : 3.1.0 +__Version__ : 3.2.0 === Host information [%hardbreaks] @@ -32,6 +32,7 @@ The operations are grouped in the following categories. * <> * <> +* <> [#Default] @@ -199,35 +200,36 @@ Endpoints for use with Prometheus -* xref:#+get__metrics+[Debugging/monitoring runtime stats in Prometheus Exposition format] +* xref:#+get_metrics+[Debugging/monitoring runtime stats in Prometheus Exposition format] +* xref:#+get_metrics+[Debugging/monitoring runtime stats in Prometheus Exposition format] -// markup not found, no include::{specDir}paths/get__metrics/operation-before.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-before.adoc[opts=optional] -[#get__metrics] +[#get_metrics] ==== Debugging/monitoring runtime stats in Prometheus Exposition format .... GET /_metrics .... -// markup not found, no include::{specDir}paths/get__metrics/operation-begin.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-begin.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get__metrics/operation-description-before.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-description-before.adoc[opts=optional] -[#get__metrics-description] +[#get_metrics-description] ===== Description -// tag::get__metrics-description[] +// tag::get_metrics-description[] -// markup not found, no include::{specDir}paths/get__metrics/operation-description-begin.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-description-begin.adoc[opts=optional] [markdown] @@ -242,16 +244,16 @@ Required Sync Gateway RBAC roles: -- -// markup not found, no include::{specDir}paths/get__metrics/operation-description-end.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get__metrics/operation-description-after.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-description-after.adoc[opts=optional] -// end::get__metrics-description[] +// end::get_metrics-description[] -// markup not found, no include::{specDir}paths/get__metrics/operation-parameters-before.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-parameters-before.adoc[opts=optional] @@ -261,31 +263,31 @@ Required Sync Gateway RBAC roles: -// markup not found, no include::{specDir}paths/get__metrics/operation-parameters-end.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-parameters-end.adoc[opts=optional] -// end::get__metrics-parameters[] +// end::get_metrics-parameters[] -// markup not found, no include::{specDir}paths/get__metrics/operation-parameters-after.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-parameters-after.adoc[opts=optional] -[#get__metrics-produces] +[#get_metrics-produces] ===== Produces * text/plain -// markup not found, no include::{specDir}paths/get__metrics/operation-responses-before.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-before.adoc[opts=optional] -[#get__metrics-responses] +[#get_metrics-responses] ===== Responses -// tag::get__metrics-responses[] +// tag::get_metrics-responses[] -// markup not found, no include::{specDir}paths/get__metrics/operation-responses-begin.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-begin.adoc[opts=optional] [cols="1,3,1"] @@ -300,31 +302,31 @@ a| Successfully returned stats |=== -// markup not found, no include::{specDir}paths/get__metrics/operation-responses-end.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get__metrics/operation-responses-after.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-after.adoc[opts=optional] -// end::get__metrics-responses[] +// end::get_metrics-responses[] -// markup not found, no include::{specDir}paths/get__metrics/operation-security-before.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-security-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get__metrics/operation-security-after.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-security-after.adoc[opts=optional] :leveloffset: +4 -// markup not found, no include::{snippetDir}get__metrics/http-request.adoc[opts=optional] +// markup not found, no include::{snippetDir}get_metrics/http-request.adoc[opts=optional] -// markup not found, no include::{snippetDir}get__metrics/http-response.adoc[opts=optional] +// markup not found, no include::{snippetDir}get_metrics/http-response.adoc[opts=optional] :leveloffset: -4 @@ -341,10 +343,441 @@ ifdef::internal-generation[] endif::internal-generation[] -// markup not found, no include::{specDir}paths/get__metrics/operation-end.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get__metrics/operation-after.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-before.adoc[opts=optional] + + +[#get_metrics] +==== Debugging/monitoring runtime stats in Prometheus Exposition format +.... +GET /metrics +.... + + +// markup not found, no include::{specDir}paths/get_metrics/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-description-before.adoc[opts=optional] + + +[#get_metrics-description] +===== Description + +// tag::get_metrics-description[] + + +// markup not found, no include::{specDir}paths/get_metrics/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns Sync Gateway statistics and other runtime variables in Prometheus Exposition format. + +Required Sync Gateway RBAC roles: + +* Sync Gateway Architect +* Sync Gateway Dev Ops +* External Stats Reader +-- + + +// markup not found, no include::{specDir}paths/get_metrics/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get_metrics/operation-description-after.adoc[opts=optional] + + +// end::get_metrics-description[] + + +// markup not found, no include::{specDir}paths/get_metrics/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-parameters-end.adoc[opts=optional] + +// end::get_metrics-parameters[] + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-parameters-after.adoc[opts=optional] + + +[#get_metrics-produces] +===== Produces + +* text/plain + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-before.adoc[opts=optional] + + +[#get_metrics-responses] +===== Responses + +// tag::get_metrics-responses[] + +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Successfully returned stats +| xref:#++String++[+String+] + + +|=== + + +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-after.adoc[opts=optional] + +// end::get_metrics-responses[] + + +// markup not found, no include::{specDir}paths/get_metrics/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}get_metrics/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}get_metrics/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :metrics/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}metrics/GET/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/get_metrics/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get_metrics/operation-after.adoc[opts=optional] + + + +[#Server] +=== Server + + +**{toc-title}** + + +* xref:#+get__ping+[Check if API is available] +* xref:#+head__ping+[Check if API is available] + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-before.adoc[opts=optional] + + +[#get__ping] +==== Check if API is available +.... +GET /_ping +.... + + +// markup not found, no include::{specDir}paths/get__ping/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-before.adoc[opts=optional] + + +[#get__ping-description] +===== Description + +// tag::get__ping-description[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns OK status if API is available. +-- + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-after.adoc[opts=optional] + + +// end::get__ping-description[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-end.adoc[opts=optional] + +// end::get__ping-parameters[] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-after.adoc[opts=optional] + + +[#get__ping-produces] +===== Produces + +* text/plain + + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-before.adoc[opts=optional] + + +[#get__ping-responses] +===== Responses + +// tag::get__ping-responses[] + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Returned status +| xref:#++String++[+String+] + + +|=== + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-after.adoc[opts=optional] + +// end::get__ping-responses[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}get__ping/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}get__ping/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :_ping/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}_ping/GET/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get__ping/operation-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-before.adoc[opts=optional] + + +[#head__ping] +==== Check if API is available +.... +HEAD /_ping +.... + + +// markup not found, no include::{specDir}paths/head__ping/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-before.adoc[opts=optional] + + +[#head__ping-description] +===== Description + +// tag::head__ping-description[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns OK status if API is available. +-- + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-after.adoc[opts=optional] + + +// end::head__ping-description[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-end.adoc[opts=optional] + +// end::head__ping-parameters[] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-after.adoc[opts=optional] + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-before.adoc[opts=optional] + + +[#head__ping-responses] +===== Responses + +// tag::head__ping-responses[] + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Server is available +| + + +|=== + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-after.adoc[opts=optional] + +// end::head__ping-responses[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}head__ping/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}head__ping/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :_ping/HEAD/HEAD.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}_ping/HEAD/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/head__ping/operation-after.adoc[opts=optional] @@ -1151,7 +1584,7 @@ endif::[] a| *+admin_net_bytes_recv+* + _optional_ -a| +a| The total number of bytes received (since node start-up) on the network interface to which the Sync Gateway api.admin_interface is bound. [%hardbreaks] ifeval::["null" != "null"] @@ -1166,7 +1599,7 @@ endif::[] a| *+admin_net_bytes_sent+* + _optional_ -a| +a| The total number of bytes sent (since node start-up) on the network interface to which the Sync Gateway api.admin_interface is bound. [%hardbreaks] ifeval::["null" != "null"] @@ -1181,7 +1614,7 @@ endif::[] a| *+error_count+* + _optional_ -a| +a| The total number of errors logged. [%hardbreaks] ifeval::["null" != "null"] @@ -1196,7 +1629,7 @@ endif::[] a| *+go_memstats_heapalloc+* + _optional_ -a| +a| 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). [%hardbreaks] ifeval::["null" != "null"] @@ -1211,7 +1644,7 @@ endif::[] a| *+go_memstats_heapidle+* + _optional_ -a| +a| 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. [%hardbreaks] ifeval::["null" != "null"] @@ -1226,7 +1659,7 @@ endif::[] a| *+go_memstats_heapinuse+* + _optional_ -a| +a| 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. [%hardbreaks] ifeval::["null" != "null"] @@ -1241,7 +1674,7 @@ endif::[] a| *+go_memstats_heapreleased+* + _optional_ -a| +a| 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. [%hardbreaks] ifeval::["null" != "null"] @@ -1256,7 +1689,7 @@ endif::[] a| *+go_memstats_pausetotalns+* + _optional_ -a| +a| 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. [%hardbreaks] ifeval::["null" != "null"] @@ -1271,7 +1704,7 @@ endif::[] a| *+go_memstats_stackinuse+* + _optional_ -a| +a| 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). [%hardbreaks] ifeval::["null" != "null"] @@ -1286,7 +1719,7 @@ endif::[] a| *+go_memstats_stacksys+* + _optional_ -a| +a| 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). [%hardbreaks] ifeval::["null" != "null"] @@ -1301,7 +1734,7 @@ endif::[] a| *+go_memstats_sys+* + _optional_ -a| +a| 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. [%hardbreaks] ifeval::["null" != "null"] @@ -1316,7 +1749,7 @@ endif::[] a| *+goroutines_high_watermark+* + _optional_ -a| +a| Peak number of go routines since process start. [%hardbreaks] ifeval::["null" != "null"] @@ -1331,7 +1764,7 @@ endif::[] a| *+num_goroutines+* + _optional_ -a| +a| The total number of goroutines. [%hardbreaks] ifeval::["null" != "null"] @@ -1344,9 +1777,9 @@ endif::[] | Integer -a| *+process_cpu_percent_utilization+* + +a| *+num_idle_kv_ops+* + _optional_ -a| +a| The total number of idle kv operations. [%hardbreaks] ifeval::["null" != "null"] @@ -1359,9 +1792,39 @@ endif::[] | Integer +a| *+process_cpu_percent_utilization+* + +_optional_ +a| 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. + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| Float (float) + + +a| *+node_cpu_percent_utilization+* + +_optional_ +a| 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. + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| Float (float) + + a| *+process_memory_resident+* + _optional_ -a| +a| The memory utilization (Resident Set Size) for the process, in bytes. [%hardbreaks] ifeval::["null" != "null"] @@ -1376,7 +1839,7 @@ endif::[] a| *+pub_net_bytes_recv+* + _optional_ -a| +a| 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 [%hardbreaks] ifeval::["null" != "null"] @@ -1391,7 +1854,7 @@ endif::[] a| *+pub_net_bytes_sent+* + _optional_ -a| +a| 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. [%hardbreaks] ifeval::["null" != "null"] @@ -1406,7 +1869,7 @@ endif::[] a| *+system_memory_total+* + _optional_ -a| +a| The total memory available on the system in bytes. [%hardbreaks] ifeval::["null" != "null"] @@ -1421,7 +1884,22 @@ endif::[] a| *+warn_count+* + _optional_ -a| +a| The total number of warnings logged. + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| Integer + + +a| *+uptime+* + +_optional_ +a| The total uptime. [%hardbreaks] ifeval::["null" != "null"] diff --git a/modules/ROOT/pages/_partials/static_restapi/public/.openapi-generator/VERSION b/modules/ROOT/pages/_partials/static_restapi/public/.openapi-generator/VERSION index 4be2c727..8b23b8d4 100644 --- a/modules/ROOT/pages/_partials/static_restapi/public/.openapi-generator/VERSION +++ b/modules/ROOT/pages/_partials/static_restapi/public/.openapi-generator/VERSION @@ -1 +1 @@ -6.5.0 \ No newline at end of file +7.3.0 \ No newline at end of file diff --git a/modules/ROOT/pages/_partials/static_restapi/public/index.adoc b/modules/ROOT/pages/_partials/static_restapi/public/index.adoc index dc66276e..7d840bcd 100644 --- a/modules/ROOT/pages/_partials/static_restapi/public/index.adoc +++ b/modules/ROOT/pages/_partials/static_restapi/public/index.adoc @@ -14,7 +14,7 @@ Sync Gateway manages access and synchronization between Couchbase Lite and Couch === Version information [%hardbreaks] -__Version__ : 3.1.0 +__Version__ : 3.2.0 === Host information [%hardbreaks] @@ -7198,8 +7198,7 @@ a| [%hardbreaks] // end -| oas_any_type_not_mapped -Map +| xref:#++PostKeyspaceRequest++[+PostKeyspaceRequest+] |=== @@ -8377,8 +8376,7 @@ a| [%hardbreaks] // end -| oas_any_type_not_mapped -Map +| xref:#++PostKeyspaceRequest++[+PostKeyspaceRequest+] |=== @@ -10230,7 +10228,9 @@ Manage server activities * xref:#+get_-+[Get server information] +* xref:#+get__ping+[Check if API is available] * xref:#+head_-+[Check if server online] +* xref:#+head__ping+[Check if API is available] @@ -10374,6 +10374,145 @@ endif::internal-generation[] +// markup not found, no include::{specDir}paths/get__ping/operation-before.adoc[opts=optional] + + +[#get__ping] +==== Check if API is available +.... +GET /_ping +.... + + +// markup not found, no include::{specDir}paths/get__ping/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-before.adoc[opts=optional] + + +[#get__ping-description] +===== Description + +// tag::get__ping-description[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns OK status if API is available. +-- + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-after.adoc[opts=optional] + + +// end::get__ping-description[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-end.adoc[opts=optional] + +// end::get__ping-parameters[] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-after.adoc[opts=optional] + + +[#get__ping-produces] +===== Produces + +* text/plain + + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-before.adoc[opts=optional] + + +[#get__ping-responses] +===== Responses + +// tag::get__ping-responses[] + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Returned status +| xref:#++String++[+String+] + + +|=== + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-after.adoc[opts=optional] + +// end::get__ping-responses[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}get__ping/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}get__ping/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :_ping/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}_ping/GET/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get__ping/operation-after.adoc[opts=optional] + + + + // markup not found, no include::{specDir}paths/head_-/operation-before.adoc[opts=optional] @@ -10508,6 +10647,141 @@ endif::internal-generation[] + +// markup not found, no include::{specDir}paths/head__ping/operation-before.adoc[opts=optional] + + +[#head__ping] +==== Check if API is available +.... +HEAD /_ping +.... + + +// markup not found, no include::{specDir}paths/head__ping/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-before.adoc[opts=optional] + + +[#head__ping-description] +===== Description + +// tag::head__ping-description[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns OK status if API is available. +-- + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-after.adoc[opts=optional] + + +// end::head__ping-description[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-end.adoc[opts=optional] + +// end::head__ping-parameters[] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-after.adoc[opts=optional] + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-before.adoc[opts=optional] + + +[#head__ping-responses] +===== Responses + +// tag::head__ping-responses[] + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Server is available +| + + +|=== + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-after.adoc[opts=optional] + +// end::head__ping-responses[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}head__ping/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}head__ping/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :_ping/HEAD/HEAD.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}_ping/HEAD/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/head__ping/operation-after.adoc[opts=optional] + + + [#Session] === Session @@ -12883,7 +13157,7 @@ endif::[] a| *+_exp+* + _optional_ -a| 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 expiries 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. +a| 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. @@ -16279,7 +16553,7 @@ endif::[] a| *+_exp+* + _optional_ -a| 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 expiries 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. +a| 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. From 6d30c73278ced7cffa3aaa129fc185a0905f4e51 Mon Sep 17 00:00:00 2001 From: Hakim Cassimally Date: Tue, 20 Feb 2024 17:10:55 +0000 Subject: [PATCH 2/2] Update from release/3.1.3 --- .../assets/attachments/bundled-admin.yaml | 244 +++++-------- .../assets/attachments/bundled-metric.yaml | 34 +- .../assets/attachments/bundled-public.yaml | 4 +- .../_partials/static_restapi/admin/index.adoc | 334 +++++++++--------- .../static_restapi/metric/index.adoc | 87 ++--- .../static_restapi/public/index.adoc | 6 +- 6 files changed, 276 insertions(+), 433 deletions(-) diff --git a/modules/ROOT/assets/attachments/bundled-admin.yaml b/modules/ROOT/assets/attachments/bundled-admin.yaml index a8a8ebd1..77d55d46 100644 --- a/modules/ROOT/assets/attachments/bundled-admin.yaml +++ b/modules/ROOT/assets/attachments/bundled-admin.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Sync Gateway description: Sync Gateway manages access and synchronization between Couchbase Lite and Couchbase Server - version: 3.2.0 + version: 3.1.0 license: name: Business Source License 1.1 (BSL) url: https://github.com/couchbase/sync_gateway/blob/master/LICENSE @@ -683,7 +683,7 @@ paths: responses: '200': description: Properties associated with a user - content: &ref_130 + content: &ref_129 application/json: schema: description: Properties associated with a user @@ -979,7 +979,7 @@ paths: responses: '200': description: Properties associated with a role - content: &ref_131 + content: &ref_130 application/json: schema: description: Properties associated with a role @@ -1159,7 +1159,7 @@ paths: **Behaviour** * *default* - In priority order, this will cause - - Deletes to always win (the delete with the longest revision history wins if both revisions are deletes) + - Deletes to always win (the delete with the logest revision history wins if both revisions are deletes) - The revision with the longest revision history to win. This means the the revision with the most changes and therefore the highest revision ID will win. * *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. @@ -1413,7 +1413,7 @@ paths: **Behaviour** * *default* - In priority order, this will cause - - Deletes to always win (the delete with the longest revision history wins if both revisions are deletes) + - Deletes to always win (the delete with the logest revision history wins if both revisions are deletes) - The revision with the longest revision history to win. This means the the revision with the most changes and therefore the highest revision ID will win. * *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. @@ -2247,7 +2247,7 @@ paths: application/json: schema: type: object - properties: &ref_111 + properties: &ref_36 bootstrap: description: Configuration settings for interacting with Couchbase Server. type: object @@ -2309,7 +2309,7 @@ paths: By default, this will only be accessible to the localhost. type: string default: 127.0.0.1:4985 - metrics_interface: + metric_interface: description: |- Network interface to bind metrics API to. @@ -2428,7 +2428,7 @@ paths: readOnly: true console: type: object - properties: &ref_36 + properties: &ref_110 log_level: description: Log Level for the console output type: string @@ -2463,18 +2463,15 @@ paths: max_size: description: The maximum size in MB of the log file before it gets rotated. type: integer - default: 100 max_age: - description: The maximum number of days to retain old log files. The defaults for this value are 360 days for error, 180 days for warn, 6 days for info, 2 days for debug, and 2 days for trace logs. + description: The maximum number of days to retain old log files. type: integer localtime: description: If true, it uses the computer's local time to format the backup timestamp. type: boolean - default: false - rotated_logs_size_limit: + rotated_logs_size: description: Max Size (in mb) of log files before deletion type: integer - default: 1024 readOnly: true title: Log-rotation-config collation_buffer_size: @@ -2542,9 +2539,6 @@ paths: type: integer maximum: 9 minimum: 0 - max_concurrent_replications: - description: Maximum number of concurrent replication connections allowed. If set to 0 this limit will be ignored. - type: integer readOnly: true unsupported: description: Settings that are not officially supported. It is highly recommended these are **not** used. @@ -2553,14 +2547,14 @@ paths: serverless: description: Configuration for when SG is running in serverless mode type: object - properties: &ref_110 + properties: &ref_111 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. + 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 @@ -2651,58 +2645,8 @@ paths: application/json: schema: type: object - properties: &ref_112 - logging: - description: The configuration settings for modifying Sync Gateway logging. - 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: - type: object - properties: *ref_36 - title: Console-logging-config - error: - type: object - properties: *ref_34 - title: File-logging-config - warn: - type: object - properties: *ref_34 - title: File-logging-config - info: - type: object - properties: *ref_34 - title: File-logging-config - debug: - type: object - properties: *ref_34 - title: File-logging-config - trace: - type: object - properties: *ref_34 - title: File-logging-config - stats: - type: object - properties: *ref_34 - title: File-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 + properties: *ref_36 + title: Startup-config responses: '200': description: Successfully set runtime options @@ -2728,7 +2672,7 @@ paths: application/json: schema: type: object - properties: &ref_113 + properties: &ref_112 databases: description: Contains a map of all the databases in the node along with their status. type: object @@ -3523,7 +3467,7 @@ paths: x-additionalPropertiesName: scopename description: Scope-specific configuration. type: object - properties: &ref_115 + properties: &ref_114 collections: description: An object keyed by collection name containing config for the specific collection. type: object @@ -3531,7 +3475,7 @@ paths: x-additionalPropertiesName: collectionname description: Collection-specific configuration. type: object - properties: &ref_114 + properties: &ref_113 sync: description: The Javascript function that newly created documents in this collection are ran through. type: string @@ -3713,7 +3657,7 @@ paths: enable_star_channel: description: Used to control whether Sync Gateway should use the all documents (*) channel. type: boolean - default: true + default: false max_length: description: The maximum number of entries to maintain in the cache per channel. type: integer @@ -4085,7 +4029,7 @@ paths: description: Force the use of views instead of GSI. type: boolean default: false - send_www_authenticate_header: + send_www_authentice_header: description: Controls whether to send a `WWW-Authenticate` header in `401 Unauthorized` HTTP responses. type: boolean default: true @@ -4177,7 +4121,7 @@ paths: default: 60 suspendable: description: |- - Set to true to allow the database to be suspended. + Set to true to allow the database to be suspended. Defaults to true when running in serverless mode otherwise defaults to false. type: boolean @@ -4711,10 +4655,10 @@ paths: scopes: description: This controls for which collections resync will run type: object - additionalProperties: &ref_117 + additionalProperties: &ref_116 description: List of collection names type: array - items: &ref_116 + items: &ref_115 type: string regenerate_sequences: description: This can be used as an alternative to query param `regenerate_sequences`. If either query param or this is set to true, then the request will regenerate the sequence numbers for each document processed. @@ -5282,11 +5226,11 @@ paths: oneOf: - description: The names of all databases. type: array - items: &ref_118 + items: &ref_117 type: string - description: Description of all databases. type: array - items: &ref_119 + items: &ref_118 type: object properties: db_name: @@ -5414,7 +5358,7 @@ paths: schema: description: The status returned from a compaction. type: object - properties: &ref_120 + properties: &ref_119 status: description: The status of the current operation. type: string @@ -5434,7 +5378,7 @@ paths: description: |- **Applicable to attachment compaction only** - This is the number of references there are to legacy attachments. + This is the number of references there are to legacy attachments. type: string purged_attachments: description: |- @@ -5464,7 +5408,7 @@ paths: - mark - sweep - cleanup - required: &ref_121 + required: &ref_120 - status - start_time - last_error @@ -5545,6 +5489,30 @@ paths: description: Unique server identifier. type: string example: 995618a6a6cc9ac79731bd13240e19b5 + scopes: + description: Scopes that are used by the database. + type: object + example: + scope1: + collections: + collection1: + update_seq: 123456 + collection2: + update_seq: 654321 + additionalProperties: + description: The name of the scope. + type: object + properties: + collections: + description: The set of collections within the scope. + additionalProperties: + description: The name of the collection. + type: object + properties: + update_seq: + description: The last sequence number that was committed to the collection. + type: integer + example: 123456 '404': description: Resource could not be found content: *ref_2 @@ -5717,7 +5685,7 @@ paths: 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. + 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 expiries 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 @@ -5821,7 +5789,7 @@ paths: application/javascript: schema: type: object - properties: &ref_122 + properties: &ref_121 cmdline: description: Built-in variables from the Go runtime, lists the command-line arguments type: object @@ -5911,72 +5879,42 @@ paths: 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. 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. + type: integer 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 the [Sync Gateway Statistics Schema](./../stats-monitoring.html) for more details on the metrics collected and reported by Sync Gateway. @@ -6065,7 +6003,7 @@ paths: application/json: schema: type: object - properties: &ref_123 + properties: &ref_122 ADMIN: description: '`true` if the request is from the Admin API - otherwise omitted.' type: boolean @@ -6102,7 +6040,7 @@ paths: `true` if the sync gateway node is running in persistent config mode. type: boolean example: true - required: &ref_124 + required: &ref_123 - couchdb - vendor tags: @@ -6715,7 +6653,7 @@ paths: schema: description: Properties of a changes feed type: object - properties: &ref_125 + properties: &ref_124 results: type: array items: @@ -7591,7 +7529,7 @@ paths: responses: '200': description: New revision created successfully - content: &ref_132 + content: &ref_131 application/json: schema: description: Properties returned when a new document revision is created @@ -8150,7 +8088,7 @@ paths: application/json: schema: type: object - properties: &ref_126 + properties: &ref_125 id_token: description: The OpenID Connect ID token type: string @@ -8389,12 +8327,12 @@ paths: responses: '200': description: Properties expected back from an OpenID Connect provider after successful authentication - content: &ref_133 + content: &ref_132 application/json: schema: description: Properties expected back from an OpenID Connect provider after successful authentication type: object - properties: &ref_127 + properties: &ref_126 access_token: type: string token_type: @@ -8551,12 +8489,12 @@ paths: schema: *ref_95 description: The OpenID Connect authentication scope. requestBody: - content: &ref_134 + content: &ref_133 application/json: schema: description: Properties passed from the OpenID Connect mock login page to the handler type: object - properties: &ref_128 + properties: &ref_127 username: type: string tokenttl: @@ -8565,7 +8503,7 @@ paths: type: string authenticated: type: string - required: &ref_129 + required: &ref_128 - username - tokenttl - identity-token-formats @@ -9081,7 +9019,7 @@ components: title: Log-rotation-config Console-logging-config: type: object - properties: *ref_36 + properties: *ref_110 title: Console-logging-config File-logging-config: type: object @@ -9090,7 +9028,7 @@ components: Serverless: description: Configuration for when SG is running in serverless mode type: object - properties: *ref_110 + properties: *ref_111 CredentialsConfig: description: The configuration for the credentials set. type: object @@ -9098,25 +9036,21 @@ components: title: Credentials config Startup-config: type: object - properties: *ref_111 + properties: *ref_36 title: Startup-config - Runtime-config: - type: object - properties: *ref_112 - title: Runtime-config Status: type: object - properties: *ref_113 + properties: *ref_112 title: Status CollectionConfig: description: Collection-specific configuration. type: object - properties: *ref_114 + properties: *ref_113 title: Collection config Scopes: description: Scope-specific configuration. type: object - properties: *ref_115 + properties: *ref_114 title: Scopes Event-config: type: object @@ -9136,24 +9070,24 @@ components: CollectionNames: description: List of collection names type: array - items: *ref_116 + items: *ref_115 ResyncScopesMap: description: scope name with one or more collection names for which resync will be triggered type: object - additionalProperties: *ref_117 + additionalProperties: *ref_116 All DBs: description: The names of all databases. type: array - items: *ref_118 + items: *ref_117 All DBs Verbose: description: Description of all databases. type: array - items: *ref_119 + items: *ref_118 Compact-status: description: The status returned from a compaction. type: object - properties: *ref_120 - required: *ref_121 + properties: *ref_119 + required: *ref_120 title: Compact-status Document: description: The configurable Sync Gateway properties of a document. @@ -9168,33 +9102,33 @@ components: title: New-revision ExpVars: type: object - properties: *ref_122 + properties: *ref_121 NodeInfo: type: object - properties: *ref_123 - required: *ref_124 + properties: *ref_122 + required: *ref_123 Changes-feed: description: Properties of a changes feed type: object - properties: *ref_125 + properties: *ref_124 Design-doc: description: Properties of a design document type: object properties: *ref_63 OIDC-callback: type: object - properties: *ref_126 + properties: *ref_125 title: OpenID Connect callback properties OIDC-token: description: Properties expected back from an OpenID Connect provider after successful authentication type: object - properties: *ref_127 + properties: *ref_126 title: OIDC-token OIDC-login-page-handler: description: Properties passed from the OpenID Connect mock login page to the handler type: object - properties: *ref_128 - required: *ref_129 + properties: *ref_127 + required: *ref_128 responses: User-session-information: description: Properties associated with a user session @@ -9213,10 +9147,10 @@ components: content: *ref_14 User: description: Properties associated with a user - content: *ref_130 + content: *ref_129 Role: description: Properties associated with a role - content: *ref_131 + content: *ref_130 Replicator-updated: description: Updated existing configuration successfully Replicator-created: @@ -9254,7 +9188,7 @@ components: content: *ref_84 New-revision: description: New revision created successfully - content: *ref_132 + content: *ref_131 OIDC-invalid-provider: description: 'The provider provided is not defined in the Sync Gateway config. If no provided was specified then there is no default provider set. ' OIDC-connection: @@ -9272,7 +9206,7 @@ components: content: *ref_97 OIDC-token: description: Properties expected back from an OpenID Connect provider after successful authentication - content: *ref_133 + content: *ref_132 OIDC-testing-redirect: description: Redirecting to Sync Gateway OpenID Connect callback URL headers: *ref_99 @@ -9289,5 +9223,5 @@ components: Profile: content: *ref_32 OIDC-login-page-handler: - content: *ref_134 + content: *ref_133 description: Properties passed from the OpenID Connect mock login page to the handler diff --git a/modules/ROOT/assets/attachments/bundled-metric.yaml b/modules/ROOT/assets/attachments/bundled-metric.yaml index 3060fa9e..71474f0b 100644 --- a/modules/ROOT/assets/attachments/bundled-metric.yaml +++ b/modules/ROOT/assets/attachments/bundled-metric.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Sync Gateway description: Sync Gateway manages access and synchronization between Couchbase Lite and Couchbase Server - version: 3.2.0 + version: 3.1.0 license: name: Business Source License 1.1 (BSL) url: https://github.com/couchbase/sync_gateway/blob/master/LICENSE @@ -183,72 +183,42 @@ paths: 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. 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. + type: integer 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 the [Sync Gateway Statistics Schema](./../stats-monitoring.html) for more details on the metrics collected and reported by Sync Gateway. diff --git a/modules/ROOT/assets/attachments/bundled-public.yaml b/modules/ROOT/assets/attachments/bundled-public.yaml index 5c4c1508..269aa6e0 100644 --- a/modules/ROOT/assets/attachments/bundled-public.yaml +++ b/modules/ROOT/assets/attachments/bundled-public.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: Sync Gateway description: Sync Gateway manages access and synchronization between Couchbase Lite and Couchbase Server - version: 3.2.0 + version: 3.1.0 license: name: Business Source License 1.1 (BSL) url: https://github.com/couchbase/sync_gateway/blob/master/LICENSE @@ -458,7 +458,7 @@ paths: 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. + 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 expiries 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 diff --git a/modules/ROOT/pages/_partials/static_restapi/admin/index.adoc b/modules/ROOT/pages/_partials/static_restapi/admin/index.adoc index e884059e..e1b4176b 100644 --- a/modules/ROOT/pages/_partials/static_restapi/admin/index.adoc +++ b/modules/ROOT/pages/_partials/static_restapi/admin/index.adoc @@ -14,7 +14,7 @@ Sync Gateway manages access and synchronization between Couchbase Lite and Couch === Version information [%hardbreaks] -__Version__ : 3.2.0 +__Version__ : 3.1.0 === Host information [%hardbreaks] @@ -26763,7 +26763,7 @@ a| [%hardbreaks] // end -| xref:#++RuntimeConfig++[+RuntimeConfig+] +| xref:#++StartupConfig++[+StartupConfig+] |=== @@ -31415,6 +31415,8 @@ endif::internal-generation[] :desc-Design-doc: Properties of a design document :desc-Document: The configurable Sync Gateway properties of a document. :desc-get___200_response_vendor: Product vendor +:desc-get_db__200_response_scopes_value: The name of the scope. +:desc-get_db__200_response_scopes_value_collections_value: The name of the collection. :desc-get_db__design_ddoc_200_response: Properties of a design document :desc-get_db__design_ddoc_200_response_views_value: The name of the view. :desc-get__expvar_200_response_syncgateway: Monitoring stats @@ -31502,6 +31504,8 @@ This section describes the properties consumed and returned by this REST API. * xref:#+get__all_dbs_200_response+[GetAllDbs200Response] * xref:#+get__all_dbs_200_response_oneOf_inner+[GetAllDbs200ResponseOneOfInner] * xref:#+get_db__200_response+[GetDb200Response] +* xref:#+get_db__200_response_scopes_value+[GetDb200ResponseScopesValue] +* xref:#+get_db__200_response_scopes_value_collections_value+[GetDb200ResponseScopesValueCollectionsValue] * xref:#+get_db__design_ddoc_200_response+[GetDbDesignDdoc200Response] * xref:#+get_db__design_ddoc_200_response_options+[GetDbDesignDdoc200ResponseOptions] * xref:#+get_db__design_ddoc_200_response_views_value+[GetDbDesignDdoc200ResponseViewsValue] @@ -31580,7 +31584,6 @@ This section describes the properties consumed and returned by this REST API. * xref:#+Retrieved-replication+[Replication] * xref:#+Role+[Role] * xref:#+Role_1+[Role] -* xref:#+Runtime_config+[Runtime-config] * xref:#+Scopes+[Scopes] * xref:#+Serverless+[Serverless] * xref:#+Startup_config+[Startup-config] @@ -31947,7 +31950,7 @@ a| *+marked_attachments+* + _optional_ a| **Applicable to attachment compaction only** -This is the number of references there are to legacy attachments. +This is the number of references there are to legacy attachments. [%hardbreaks] ifeval::["null" != "null"] @@ -32905,7 +32908,7 @@ endif::[] | Boolean -a| *+send_www_authenticate_header+* + +a| *+send_www_authentice_header+* + _optional_ a| Controls whether to send a `WWW-Authenticate` header in `401 Unauthorized` HTTP responses. @@ -33148,7 +33151,7 @@ endif::[] a| *+suspendable+* + _optional_ -a| Set to true to allow the database to be suspended. +a| Set to true to allow the database to be suspended. Defaults to true when running in serverless mode otherwise defaults to false. @@ -33850,7 +33853,7 @@ endif::[] | Boolean -a| *+send_www_authenticate_header+* + +a| *+send_www_authentice_header+* + _optional_ a| Controls whether to send a `WWW-Authenticate` header in `401 Unauthorized` HTTP responses. @@ -34093,7 +34096,7 @@ endif::[] a| *+suspendable+* + _optional_ -a| Set to true to allow the database to be suspended. +a| Set to true to allow the database to be suspended. Defaults to true when running in serverless mode otherwise defaults to false. @@ -34456,8 +34459,8 @@ _optional_ a| Used to control whether Sync Gateway should use the all documents (*) channel. [%hardbreaks] -ifeval::["true" != "null"] -*Default:* `true` +ifeval::["false" != "null"] +*Default:* `false` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -36738,7 +36741,7 @@ endif::[] a| *+_exp+* + _optional_ -a| 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. +a| 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 expiries 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. @@ -37556,6 +37559,22 @@ endif::[] | String +a| *+scopes+* + +_optional_ +a| Scopes that are used by the database. + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["{"scope1":{"collections":{"collection1":{"update_seq":123456},"collection2":{"update_seq":654321}}}}" != "null"] +*Example:* `{"scope1":{"collections":{"collection1":{"update_seq":123456},"collection2":{"update_seq":654321}}}}` +endif::[] +// end +| xref:#++get_db__200_response_scopes_value++[+get_db__200_response_scopes_value+] +Map + + |=== @@ -37568,6 +37587,91 @@ endif::[] +// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value/definition-before.adoc[opts=optional] + + +[#get_db__200_response_scopes_value] +=== GetDb200ResponseScopesValue + + +// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value/definition-begin.adoc[opts=optional] + + +[#fields-get_db__200_response_scopes_value] +[cols="1,4,1"] +|=== +| Name| Description| Schema + +a| *+collections+* + +_optional_ +a| The set of collections within the scope. + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| xref:#++get_db__200_response_scopes_value_collections_value++[+get_db__200_response_scopes_value_collections_value+] +Map + + +|=== + + +// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value/definition-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value_collections_value/definition-before.adoc[opts=optional] + + +[#get_db__200_response_scopes_value_collections_value] +=== GetDb200ResponseScopesValueCollectionsValue + + +// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value_collections_value/definition-begin.adoc[opts=optional] + + +[#fields-get_db__200_response_scopes_value_collections_value] +[cols="1,4,1"] +|=== +| Name| Description| Schema + +a| *+update_seq+* + +_optional_ +a| The last sequence number that was committed to the collection. + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["123456" != "null"] +*Example:* `123456` +endif::[] +// end +| Integer + + +|=== + + +// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value_collections_value/definition-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}definitions/get_db__200_response_scopes_value_collections_value/definition-after.adoc[opts=optional] + + + + // markup not found, no include::{specDir}definitions/get_db__design_ddoc_200_response/definition-before.adoc[opts=optional] @@ -38975,7 +39079,7 @@ endif::[] a| *+admin_net_bytes_recv+* + _optional_ -a| The total number of bytes received (since node start-up) on the network interface to which the Sync Gateway api.admin_interface is bound. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -38990,7 +39094,7 @@ endif::[] a| *+admin_net_bytes_sent+* + _optional_ -a| The total number of bytes sent (since node start-up) on the network interface to which the Sync Gateway api.admin_interface is bound. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39005,7 +39109,7 @@ endif::[] a| *+error_count+* + _optional_ -a| The total number of errors logged. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39020,7 +39124,7 @@ endif::[] a| *+go_memstats_heapalloc+* + _optional_ -a| 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). +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39035,7 +39139,7 @@ endif::[] a| *+go_memstats_heapidle+* + _optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39050,7 +39154,7 @@ endif::[] a| *+go_memstats_heapinuse+* + _optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39065,7 +39169,7 @@ endif::[] a| *+go_memstats_heapreleased+* + _optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39080,7 +39184,7 @@ endif::[] a| *+go_memstats_pausetotalns+* + _optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39095,7 +39199,7 @@ endif::[] a| *+go_memstats_stackinuse+* + _optional_ -a| 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). +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39110,7 +39214,7 @@ endif::[] a| *+go_memstats_stacksys+* + _optional_ -a| 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). +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39125,7 +39229,7 @@ endif::[] a| *+go_memstats_sys+* + _optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39140,7 +39244,7 @@ endif::[] a| *+goroutines_high_watermark+* + _optional_ -a| Peak number of go routines since process start. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39155,22 +39259,7 @@ endif::[] a| *+num_goroutines+* + _optional_ -a| The total number of goroutines. - -[%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` -endif::[] -ifeval::["null" != "null"] -*Example:* `null` -endif::[] -// end -| Integer - - -a| *+num_idle_kv_ops+* + -_optional_ -a| The total number of idle kv operations. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39185,22 +39274,7 @@ endif::[] a| *+process_cpu_percent_utilization+* + _optional_ -a| 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. - -[%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` -endif::[] -ifeval::["null" != "null"] -*Example:* `null` -endif::[] -// end -| Float (float) - - -a| *+node_cpu_percent_utilization+* + -_optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39210,12 +39284,12 @@ ifeval::["null" != "null"] *Example:* `null` endif::[] // end -| Float (float) +| Integer a| *+process_memory_resident+* + _optional_ -a| The memory utilization (Resident Set Size) for the process, in bytes. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39230,7 +39304,7 @@ endif::[] a| *+pub_net_bytes_recv+* + _optional_ -a| 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 +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39245,7 +39319,7 @@ endif::[] a| *+pub_net_bytes_sent+* + _optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39260,7 +39334,7 @@ endif::[] a| *+system_memory_total+* + _optional_ -a| The total memory available on the system in bytes. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -39275,22 +39349,7 @@ endif::[] a| *+warn_count+* + _optional_ -a| The total number of warnings logged. - -[%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` -endif::[] -ifeval::["null" != "null"] -*Example:* `null` -endif::[] -// end -| Integer - - -a| *+uptime+* + -_optional_ -a| The total uptime. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -40603,8 +40662,8 @@ _optional_ a| The maximum size in MB of the log file before it gets rotated. [%hardbreaks] -ifeval::["100" != "null"] -*Default:* `100` +ifeval::["null" != "null"] +*Default:* `null` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -40615,7 +40674,7 @@ endif::[] a| *+max_age+* + _optional_ -a| The maximum number of days to retain old log files. The defaults for this value are 360 days for error, 180 days for warn, 6 days for info, 2 days for debug, and 2 days for trace logs. +a| The maximum number of days to retain old log files. [%hardbreaks] ifeval::["null" != "null"] @@ -40633,8 +40692,8 @@ _optional_ a| If true, it uses the computer's local time to format the backup timestamp. [%hardbreaks] -ifeval::["false" != "null"] -*Default:* `false` +ifeval::["null" != "null"] +*Default:* `null` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -40643,13 +40702,13 @@ endif::[] | Boolean -a| *+rotated_logs_size_limit+* + +a| *+rotated_logs_size+* + _optional_ a| Max Size (in mb) of log files before deletion [%hardbreaks] -ifeval::["1024" != "null"] -*Default:* `1024` +ifeval::["null" != "null"] +*Default:* `null` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -40690,8 +40749,8 @@ _optional_ a| The maximum size in MB of the log file before it gets rotated. [%hardbreaks] -ifeval::["100" != "null"] -*Default:* `100` +ifeval::["null" != "null"] +*Default:* `null` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -40702,7 +40761,7 @@ endif::[] a| *+max_age+* + _optional_ -a| The maximum number of days to retain old log files. The defaults for this value are 360 days for error, 180 days for warn, 6 days for info, 2 days for debug, and 2 days for trace logs. +a| The maximum number of days to retain old log files. [%hardbreaks] ifeval::["null" != "null"] @@ -40720,8 +40779,8 @@ _optional_ a| If true, it uses the computer's local time to format the backup timestamp. [%hardbreaks] -ifeval::["false" != "null"] -*Default:* `false` +ifeval::["null" != "null"] +*Default:* `null` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -40730,13 +40789,13 @@ endif::[] | Boolean -a| *+rotated_logs_size_limit+* + +a| *+rotated_logs_size+* + _optional_ a| Max Size (in mb) of log files before deletion [%hardbreaks] -ifeval::["1024" != "null"] -*Default:* `1024` +ifeval::["null" != "null"] +*Default:* `null` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -42607,7 +42666,7 @@ endif::[] a| *+_exp+* + _optional_ -a| 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. +a| 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 expiries 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. @@ -43503,7 +43562,7 @@ Changing this is an enterprise-edition only feature. **Behaviour** * *default* - In priority order, this will cause - - Deletes to always win (the delete with the longest revision history wins if both revisions are deletes) + - Deletes to always win (the delete with the logest revision history wins if both revisions are deletes) - The revision with the longest revision history to win. This means the the revision with the most changes and therefore the highest revision ID will win. * *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. @@ -43979,7 +44038,7 @@ Changing this is an enterprise-edition only feature. **Behaviour** * *default* - In priority order, this will cause - - Deletes to always win (the delete with the longest revision history wins if both revisions are deletes) + - Deletes to always win (the delete with the logest revision history wins if both revisions are deletes) - The revision with the longest revision history to win. This means the the revision with the most changes and therefore the highest revision ID will win. * *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. @@ -44890,7 +44949,7 @@ Changing this is an enterprise-edition only feature. **Behaviour** * *default* - In priority order, this will cause - - Deletes to always win (the delete with the longest revision history wins if both revisions are deletes) + - Deletes to always win (the delete with the logest revision history wins if both revisions are deletes) - The revision with the longest revision history to win. This means the the revision with the most changes and therefore the highest revision ID will win. * *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. @@ -45422,66 +45481,6 @@ Map -// markup not found, no include::{specDir}definitions/Runtime_config/definition-before.adoc[opts=optional] - - -[#Runtime_config] -=== Runtime-config - - -// markup not found, no include::{specDir}definitions/Runtime_config/definition-begin.adoc[opts=optional] - - -[#fields-Runtime_config] -[cols="1,4,1"] -|=== -| Name| Description| Schema - -a| *+logging+* + -_optional_ -a| -ifdef::desc-Startup_config_logging[] -{desc-Startup_config_logging} -endif::[] - -[%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` -endif::[] -ifeval::["null" != "null"] -*Example:* `null` -endif::[] -// end -| xref:#++Startup_config_logging++[+Startup_config_logging+] - - -a| *+max_concurrent_replications+* + -_optional_ -a| Maximum number of concurrent replication connections allowed. If set to 0 this limit will be ignored. - -[%hardbreaks] -ifeval::["0" != "null"] -*Default:* `0` -endif::[] -ifeval::["null" != "null"] -*Example:* `null` -endif::[] -// end -| Integer - - -|=== - - -// markup not found, no include::{specDir}definitions/Runtime_config/definition-end.adoc[opts=optional] - - - -// markup not found, no include::{specDir}definitions/Runtime_config/definition-after.adoc[opts=optional] - - - - // markup not found, no include::{specDir}definitions/Scopes/definition-before.adoc[opts=optional] @@ -45557,7 +45556,7 @@ endif::[] a| *+min_config_fetch_interval+* + _optional_ -a| 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. +a| 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`. @@ -45829,7 +45828,7 @@ endif::[] | String -a| *+metrics_interface+* + +a| *+metric_interface+* + _optional_ a| Network interface to bind metrics API to. @@ -46876,21 +46875,6 @@ endif::[] | Integer -a| *+max_concurrent_replications+* + -_optional_ -a| Maximum number of concurrent replication connections allowed. If set to 0 this limit will be ignored. - -[%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` -endif::[] -ifeval::["null" != "null"] -*Example:* `null` -endif::[] -// end -| Integer - - |=== @@ -47087,7 +47071,7 @@ endif::[] a| *+min_config_fetch_interval+* + _optional_ -a| 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. +a| 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`. @@ -48281,7 +48265,7 @@ Changing this is an enterprise-edition only feature. **Behaviour** * *default* - In priority order, this will cause - - Deletes to always win (the delete with the longest revision history wins if both revisions are deletes) + - Deletes to always win (the delete with the logest revision history wins if both revisions are deletes) - The revision with the longest revision history to win. This means the the revision with the most changes and therefore the highest revision ID will win. * *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. diff --git a/modules/ROOT/pages/_partials/static_restapi/metric/index.adoc b/modules/ROOT/pages/_partials/static_restapi/metric/index.adoc index bcea717e..dc94ef9c 100644 --- a/modules/ROOT/pages/_partials/static_restapi/metric/index.adoc +++ b/modules/ROOT/pages/_partials/static_restapi/metric/index.adoc @@ -14,7 +14,7 @@ Sync Gateway manages access and synchronization between Couchbase Lite and Couch === Version information [%hardbreaks] -__Version__ : 3.2.0 +__Version__ : 3.1.0 === Host information [%hardbreaks] @@ -1584,7 +1584,7 @@ endif::[] a| *+admin_net_bytes_recv+* + _optional_ -a| The total number of bytes received (since node start-up) on the network interface to which the Sync Gateway api.admin_interface is bound. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1599,7 +1599,7 @@ endif::[] a| *+admin_net_bytes_sent+* + _optional_ -a| The total number of bytes sent (since node start-up) on the network interface to which the Sync Gateway api.admin_interface is bound. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1614,7 +1614,7 @@ endif::[] a| *+error_count+* + _optional_ -a| The total number of errors logged. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1629,7 +1629,7 @@ endif::[] a| *+go_memstats_heapalloc+* + _optional_ -a| 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). +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1644,7 +1644,7 @@ endif::[] a| *+go_memstats_heapidle+* + _optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1659,7 +1659,7 @@ endif::[] a| *+go_memstats_heapinuse+* + _optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1674,7 +1674,7 @@ endif::[] a| *+go_memstats_heapreleased+* + _optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1689,7 +1689,7 @@ endif::[] a| *+go_memstats_pausetotalns+* + _optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1704,7 +1704,7 @@ endif::[] a| *+go_memstats_stackinuse+* + _optional_ -a| 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). +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1719,7 +1719,7 @@ endif::[] a| *+go_memstats_stacksys+* + _optional_ -a| 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). +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1734,7 +1734,7 @@ endif::[] a| *+go_memstats_sys+* + _optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1749,7 +1749,7 @@ endif::[] a| *+goroutines_high_watermark+* + _optional_ -a| Peak number of go routines since process start. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1764,22 +1764,7 @@ endif::[] a| *+num_goroutines+* + _optional_ -a| The total number of goroutines. - -[%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` -endif::[] -ifeval::["null" != "null"] -*Example:* `null` -endif::[] -// end -| Integer - - -a| *+num_idle_kv_ops+* + -_optional_ -a| The total number of idle kv operations. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1794,22 +1779,7 @@ endif::[] a| *+process_cpu_percent_utilization+* + _optional_ -a| 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. - -[%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` -endif::[] -ifeval::["null" != "null"] -*Example:* `null` -endif::[] -// end -| Float (float) - - -a| *+node_cpu_percent_utilization+* + -_optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1819,12 +1789,12 @@ ifeval::["null" != "null"] *Example:* `null` endif::[] // end -| Float (float) +| Integer a| *+process_memory_resident+* + _optional_ -a| The memory utilization (Resident Set Size) for the process, in bytes. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1839,7 +1809,7 @@ endif::[] a| *+pub_net_bytes_recv+* + _optional_ -a| 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 +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1854,7 +1824,7 @@ endif::[] a| *+pub_net_bytes_sent+* + _optional_ -a| 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. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1869,7 +1839,7 @@ endif::[] a| *+system_memory_total+* + _optional_ -a| The total memory available on the system in bytes. +a| [%hardbreaks] ifeval::["null" != "null"] @@ -1884,22 +1854,7 @@ endif::[] a| *+warn_count+* + _optional_ -a| The total number of warnings logged. - -[%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` -endif::[] -ifeval::["null" != "null"] -*Example:* `null` -endif::[] -// end -| Integer - - -a| *+uptime+* + -_optional_ -a| The total uptime. +a| [%hardbreaks] ifeval::["null" != "null"] diff --git a/modules/ROOT/pages/_partials/static_restapi/public/index.adoc b/modules/ROOT/pages/_partials/static_restapi/public/index.adoc index 7d840bcd..211e8b5f 100644 --- a/modules/ROOT/pages/_partials/static_restapi/public/index.adoc +++ b/modules/ROOT/pages/_partials/static_restapi/public/index.adoc @@ -14,7 +14,7 @@ Sync Gateway manages access and synchronization between Couchbase Lite and Couch === Version information [%hardbreaks] -__Version__ : 3.2.0 +__Version__ : 3.1.0 === Host information [%hardbreaks] @@ -13157,7 +13157,7 @@ endif::[] a| *+_exp+* + _optional_ -a| 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. +a| 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 expiries 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. @@ -16553,7 +16553,7 @@ endif::[] a| *+_exp+* + _optional_ -a| 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. +a| 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 expiries 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.