Skip to content

Commit ff08ca5

Browse files
authored
CBG-4865: Update database schema for API Docs (#7765)
1 parent 964f0f0 commit ff08ca5

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

docs/api/components/schemas.yaml

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -994,9 +994,11 @@ Database:
994994
type: string
995995
cache:
996996
type: object
997+
x-requirePropertiesSorted: true
997998
properties:
998999
channel_cache:
9991000
description: The channel cache config settings.
1001+
x-requirePropertiesSorted: true
10001002
type: object
10011003
properties:
10021004
compact_high_watermark_pct:
@@ -1017,10 +1019,6 @@ Database:
10171019
When the cache size, determined by `max_number` returns to a value lower than the percentage of it set here, the cache eviction process is stopped.
10181020
type: integer
10191021
default: 60
1020-
enable_star_channel:
1021-
description: Used to control whether Sync Gateway should use the all documents (*) channel.
1022-
type: boolean
1023-
default: true
10241022
expiry_seconds:
10251023
description: The amount of time (in seconds) to keep entries in the cache beyond the minimum retained.
10261024
type: integer
@@ -1049,6 +1047,13 @@ Database:
10491047
description: The minimum number of entries to maintain in the cache per channel.
10501048
type: integer
10511049
default: 50
1050+
enable_star_channel:
1051+
description: |-
1052+
Since Sync Gateway 4.0, this option no longer has an effect, the star channel is always enabled.
1053+
If this value is set to false, a database can only exist in the offline state until this configuration is modified.
1054+
type: boolean
1055+
default: true
1056+
deprecated: true
10521057
query_limit:
10531058
description: |-
10541059
**Deprecated in favour of the database setting `query_pagination_limit`**
@@ -1742,12 +1747,16 @@ Database:
17421747
type: integer
17431748
default: 75
17441749
allow_conflicts:
1745-
description: This controls whether to allow conflicting document revisions. This option is going to be removed from sync gateway, and conflicts will not be allowed.
1750+
description: |-
1751+
Since Sync Gateway 4.0, this option has no effect.
1752+
If this option is set to true on an existing database, the database must be modified to remove this parameter in order allow the database to come online. Otherwise, the database will be in the offline state.
17461753
type: boolean
17471754
default: false
17481755
deprecated: true
17491756
enable_shared_bucket_access:
1750-
description: Whether to use extended attributes to store Sync Gateway document (`_sync`) metadata.
1757+
description: |-
1758+
Since Sync Gateway 4.0, this option has no effect.
1759+
If this option is set to true on an existing database, the database must be modified to remove this parameter in order allow the database to come online. Otherwise, the database will be in the offline state.
17511760
type: boolean
17521761
default: true
17531762
deprecated: true

0 commit comments

Comments
 (0)