Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions modules/ROOT/assets/attachments/rest-api-admin.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -696,16 +696,14 @@ paths:
- 'Database Configuration'
summary: Update Database Configuration
description: |+
Use this endpoint to update the configuration of an existing Sync Gatewat database.
Use this endpoint to update the configuration of an existing Sync Gateway database.

Provide the database name in the URL path.
Provide the required database configuration settings as a JSON object in the request body.
You only need to provide those settings you wish to change.

By default the updated database is brought online immediately, **unless** you include `"offline": true` in the configuration.

`See: {rest-api-admin--xref}` for further information on this.

*Sync Gateway Roles Required (CBS 7.0.2 Developer Preview):*

-- Sync Gateway Architect
Expand Down Expand Up @@ -1728,7 +1726,7 @@ paths:

Taking a database offline that is in the progress of coming online will take the database offline after it comes online.

For more information about taking a database offline and bringing it back online, see [this guide](../database-offline.html).
For more information about taking a database offline and bringing it back online, see [this guide](database-offline.html).


*Sync Gateway Roles Required (CBS 7.0.2 Developer Preview):*
Expand Down Expand Up @@ -1759,7 +1757,7 @@ paths:
- Making a database available for Couchbase Mobile clients at a specific time.
- Making databases on several Sync Gateway instances available at the same time.

For more information about taking a database offline and bringing it back online, see [this guide](../database-offline.html).
For more information about taking a database offline and bringing it back online, see [this guide](database-offline.html).

*Sync Gateway Roles Required (CBS 7.0.2 Developer Preview):*

Expand Down Expand Up @@ -3403,7 +3401,7 @@ definitions:
description: |+
This property defines the maximum depth to which a document's revision tree can grow; its value governs the point at which to prune a document's revision tree.

The default and minimum values of `revs_limit` are dependent on whether [allow_conflicts](config-properties.html#databases-this_db-allow_conflicts) is set True or False -- see the *Default and Minimum Values* table below.
The default and minimum values of `revs_limit` are dependent on whether [allow_conflicts](configuration-schema-database.html#database-allow_conflicts) is set True or False -- see the *Default and Minimum Values* table below.

The process to remove obsolete revisions is called pruning and runs automatically every time a revision is added. Although fundamentally the same, the pruning algorithm works slightly differently between Sync Gateway and Couchbase Lite. On Sync Gateway, the pruning algorithm is applied to the shortest, non-tombstoned branch in the revision tree.

Expand Down Expand Up @@ -3436,8 +3434,8 @@ definitions:
- `revs_limit` minimum = 20

See also:
- Sync Gateway purge endpoint [/{db}/_purge](admin-rest-api.html#/document/post__db___purge).
- Sync Gateway [document TTLs](admin-rest-api.html#/document/put__db___doc_).
- Sync Gateway purge endpoint [/{db}/_purge](rest-api-admin.html#/Document/post__db___purge).
- Sync Gateway [document TTLs](rest-api-admin.html#/document/put__db___doc_).

minimum -- see Default and Minimum Values table in description

Expand Down Expand Up @@ -3492,7 +3490,8 @@ definitions:

You can configure Sync Gateway to log information about event handling, by including either the log key ```Event``` or ```Events+``` in the `Log` property in your Sync Gateway configuration file. `Events+` is more verbose.

See also: {webhooks--xref}
See also:
[Webhook](webhooks.html)..

properties:
document_changed:
Expand Down Expand Up @@ -5039,7 +5038,7 @@ definitions:
per_db:
type: array
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.
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.

The statistics for each {$db_name} database are grouped into:

Expand Down