You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update schemas.yaml
Correcting the wording from `enterprise-edition` to `Enterprise Edition` as that is the documentation standard.
* DOC-12574: Change format to Enterprise Edition and Community Edition
Copy file name to clipboardExpand all lines: docs/api/components/schemas.yaml
+16-16Lines changed: 16 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -673,15 +673,15 @@ Retrieved-replication:
673
673
description: |-
674
674
This defines what conflict resolution policy Sync Gateway should use to apply when resolving conflicting revisions.
675
675
676
-
Changing this is an enterprise-edition only feature.
676
+
Changing this is an Enterprise Edition only feature.
677
677
678
678
**Behaviour**
679
679
* *default* - In priority order, this will cause
680
680
- Deletes to always win (the delete with the longest revision history wins if both revisions are deletes)
681
681
- 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.
682
682
* *localWins* - This will result in local revisions always being the winner in any conflict.
683
683
* *remoteWins* - This will result in remote revisions always being the winner in any conflict.
684
-
* *custom* - This will result in conflicts going through your own custom conflict resolver. You must provide this logic as a Javascript function in the `custom_conflict_resolver` parameter. This is an enterprise-edition only feature.
684
+
* *custom* - This will result in conflicts going through your own custom conflict resolver. You must provide this logic as a Javascript function in the `custom_conflict_resolver` parameter. This is an Enterprise Edition only feature.
685
685
686
686
687
687
Note: replications created prior to Sync Gateway 2.8 will default to `default`.
@@ -693,7 +693,7 @@ Retrieved-replication:
693
693
- localWins
694
694
- custom
695
695
custom_conflict_resolver:
696
-
description: "This specifies the Javascript function to use to resolve conflicts between conflicting revisions.\n \nThis **must** be used when `conflict_resolution_type=custom`. This property will be ignored when `conflict_resolution_type` is not `custom`.\n\nThe Javascript function to provide this property should be in backticks (like the sync function). The function takes 1 parameter which is a struct that represents the conflict. This struct has 2 properties:\n* `LocalDocument` - The local document. This contains the document ID under the `_id` key.\n* `RemoteDocument` - The remote document\nThe function should return the new documents body. This can be the winning revision (for example, `return conflict.LocalDocument`), a new body, or `nil` to resolve as a delete.\n\nExample:\n```\n\"custom_conflict_resolver\":\\`\n\tfunction(conflict) {\n\t\tconsole.log(\"Doc ID: \"+conflict.LocalDocument._id);\n\t\tconsole.log(\"Full remote doc: \"+JSON.stringify(conflict.RemoteDocument));\n\t\treturn conflict.RemoteDocument;\n\t}\n\\`\n```\n\nUsing complex `custom_conflict_resolver` functions can noticeably degrade performance. Use a built-in resolver whenever possible.\n\nThis is an enterprise-edition only feature.\n"
696
+
description: "This specifies the Javascript function to use to resolve conflicts between conflicting revisions.\n \nThis **must** be used when `conflict_resolution_type=custom`. This property will be ignored when `conflict_resolution_type` is not `custom`.\n\nThe Javascript function to provide this property should be in backticks (like the sync function). The function takes 1 parameter which is a struct that represents the conflict. This struct has 2 properties:\n* `LocalDocument` - The local document. This contains the document ID under the `_id` key.\n* `RemoteDocument` - The remote document\nThe function should return the new documents body. This can be the winning revision (for example, `return conflict.LocalDocument`), a new body, or `nil` to resolve as a delete.\n\nExample:\n```\n\"custom_conflict_resolver\":\\`\n\tfunction(conflict) {\n\t\tconsole.log(\"Doc ID: \"+conflict.LocalDocument._id);\n\t\tconsole.log(\"Full remote doc: \"+JSON.stringify(conflict.RemoteDocument));\n\t\treturn conflict.RemoteDocument;\n\t}\n\\`\n```\n\nUsing complex `custom_conflict_resolver` functions can noticeably degrade performance. Use a built-in resolver whenever possible.\n\nThis is an Enterprise Edition only feature.\n"
697
697
type: string
698
698
default: none
699
699
purge_on_removal:
@@ -711,7 +711,7 @@ Retrieved-replication:
711
711
712
712
Replications created prior to Sync Gateway 2.8 must have delta-sync disabled.
713
713
714
-
Enabling this is an enterprise-edition only feature.
714
+
Enabling this is an Enterprise Edition only feature.
715
715
type: boolean
716
716
default: false
717
717
max_backoff_time:
@@ -776,7 +776,7 @@ Retrieved-replication:
776
776
type: boolean
777
777
default: false
778
778
batch_size:
779
-
description: The amount of changes to be sent in one batch of replications. Changing this is an enterprise-edition only feature.
779
+
description: The amount of changes to be sent in one batch of replications. Changing this is an Enterprise Edition only feature.
780
780
type: integer
781
781
default: 200
782
782
run_as:
@@ -901,15 +901,15 @@ Replication:
901
901
description: |-
902
902
This defines what conflict resolution policy Sync Gateway should use to apply when resolving conflicting revisions.
903
903
904
-
Changing this is an enterprise-edition only feature.
904
+
Changing this is an Enterprise Edition only feature.
905
905
906
906
**Behaviour**
907
907
* *default* - In priority order, this will cause
908
908
- Deletes to always win (the delete with the longest revision history wins if both revisions are deletes)
909
909
- 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.
910
910
* *localWins* - This will result in local revisions always being the winner in any conflict.
911
911
* *remoteWins* - This will result in remote revisions always being the winner in any conflict.
912
-
* *custom* - This will result in conflicts going through your own custom conflict resolver. You must provide this logic as a Javascript function in the `custom_conflict_resolver` parameter. This is an enterprise-edition only feature.
912
+
* *custom* - This will result in conflicts going through your own custom conflict resolver. You must provide this logic as a Javascript function in the `custom_conflict_resolver` parameter. This is an Enterprise Edition only feature.
913
913
914
914
915
915
Note: replications created prior to Sync Gateway 2.8 will default to `default`.
@@ -921,7 +921,7 @@ Replication:
921
921
- localWins
922
922
- custom
923
923
custom_conflict_resolver:
924
-
description: "This specifies the Javascript function to use to resolve conflicts between conflicting revisions.\n \nThis **must** be used when `conflict_resolution_type=custom`. This property will be ignored when `conflict_resolution_type` is not `custom`.\n\nThe Javascript function to provide this property should be in backticks (like the sync function). The function takes 1 parameter which is a struct that represents the conflict. This struct has 2 properties:\n* `LocalDocument` - The local document. This contains the document ID under the `_id` key.\n* `RemoteDocument` - The remote document\nThe function should return the new documents body. This can be the winning revision (for example, `return conflict.LocalDocument`), a new body, or `nil` to resolve as a delete.\n\nExample:\n```\n\"custom_conflict_resolver\":\\`\n\tfunction(conflict) {\n\t\tconsole.log(\"Doc ID: \"+conflict.LocalDocument._id);\n\t\tconsole.log(\"Full remote doc: \"+JSON.stringify(conflict.RemoteDocument));\n\t\treturn conflict.RemoteDocument;\n\t}\n\\`\n```\n\nUsing complex `custom_conflict_resolver` functions can noticeably degrade performance. Use a built-in resolver whenever possible.\n\nThis is an enterprise-edition only feature.\n"
924
+
description: "This specifies the Javascript function to use to resolve conflicts between conflicting revisions.\n \nThis **must** be used when `conflict_resolution_type=custom`. This property will be ignored when `conflict_resolution_type` is not `custom`.\n\nThe Javascript function to provide this property should be in backticks (like the sync function). The function takes 1 parameter which is a struct that represents the conflict. This struct has 2 properties:\n* `LocalDocument` - The local document. This contains the document ID under the `_id` key.\n* `RemoteDocument` - The remote document\nThe function should return the new documents body. This can be the winning revision (for example, `return conflict.LocalDocument`), a new body, or `nil` to resolve as a delete.\n\nExample:\n```\n\"custom_conflict_resolver\":\\`\n\tfunction(conflict) {\n\t\tconsole.log(\"Doc ID: \"+conflict.LocalDocument._id);\n\t\tconsole.log(\"Full remote doc: \"+JSON.stringify(conflict.RemoteDocument));\n\t\treturn conflict.RemoteDocument;\n\t}\n\\`\n```\n\nUsing complex `custom_conflict_resolver` functions can noticeably degrade performance. Use a built-in resolver whenever possible.\n\nThis is an Enterprise Edition only feature.\n"
925
925
type: string
926
926
default: none
927
927
purge_on_removal:
@@ -939,7 +939,7 @@ Replication:
939
939
940
940
Replications created prior to Sync Gateway 2.8 must have delta-sync disabled.
941
941
942
-
Enabling this is an enterprise-edition only feature.
942
+
Enabling this is an Enterprise Edition only feature.
943
943
type: boolean
944
944
default: false
945
945
max_backoff_time:
@@ -1004,7 +1004,7 @@ Replication:
1004
1004
type: boolean
1005
1005
default: false
1006
1006
batch_size:
1007
-
description: The amount of changes to be sent in one batch of replications. Changing this is an enterprise-edition only feature.
1007
+
description: The amount of changes to be sent in one batch of replications. Changing this is an Enterprise Edition only feature.
1008
1008
type: integer
1009
1009
default: 200
1010
1010
run_as:
@@ -1240,13 +1240,13 @@ Database:
1240
1240
description: |-
1241
1241
If true, documents will be imported in to Sync Gateway from the bucket when requested. Documents will be ran through the set `import_filter` if any is set.
1242
1242
1243
-
The default value depends on the edition of Sync Gateway being used. If the edition is the community-edition, then this will default to `false` or else in the enterprise-edition, it will default to `true`.
1243
+
The default value depends on the edition of Sync Gateway being used. If the edition is the Community Edition, then this will default to `false` or else in the Enterprise Edition, it will default to `true`.
1244
1244
1245
1245
This can also be set to the string `continuous` which maps to true.
1246
1246
type: boolean
1247
1247
import_partitions:
1248
1248
description: |-
1249
-
** This is an enterprise-edition feature only**
1249
+
** This is an Enterprise Edition feature only**
1250
1250
1251
1251
This is how many import partitions should be used for import sharding.
1252
1252
@@ -1308,7 +1308,7 @@ Database:
1308
1308
description: |-
1309
1309
The maximum amount of memory the revision cache should take up in MB, setting to 0 will disable any eviction based on memory at rev cache.
1310
1310
When set this memory limit will work in in hand with revision cache size parameter. So you will potentially get eviction at revision cache both based off memory footprint and number of items in the cache.
1311
-
**This is an enterprise-edition feature only**
1311
+
**This is an Enterprise Edition feature only**
1312
1312
type: integer
1313
1313
default: 0
1314
1314
shard_count:
@@ -1737,14 +1737,14 @@ Database:
1737
1737
description: |-
1738
1738
Delta sync configuration settings.
1739
1739
1740
-
**This is an enterprise-edition feature only**
1740
+
**This is an Enterprise Edition feature only**
1741
1741
type: object
1742
1742
properties:
1743
1743
enabled:
1744
1744
description: |-
1745
1745
Whether delta sync is enabled.
1746
1746
1747
-
**This is an enterprise-edition feature only**
1747
+
**This is an Enterprise Edition feature only**
1748
1748
type: boolean
1749
1749
default: false
1750
1750
rev_max_age_seconds:
@@ -2257,7 +2257,7 @@ Startup-config:
2257
2257
description: |-
2258
2258
Whether to enable the DP permissions check feature of admin auth.
2259
2259
2260
-
Defaults to `true` if using enterprise-edition or `false` if using community-edition.
2260
+
Defaults to `true` if using Enterprise Edition or `false` if using Community Edition.
0 commit comments