Skip to content

Commit 2d6213f

Browse files
ElliotFrancisHunterbbrks
authored andcommitted
Update schemas.yaml (#7165)
* 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
1 parent 9326dbd commit 2d6213f

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/api/components/schemas.yaml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -673,15 +673,15 @@ Retrieved-replication:
673673
description: |-
674674
This defines what conflict resolution policy Sync Gateway should use to apply when resolving conflicting revisions.
675675
676-
Changing this is an enterprise-edition only feature.
676+
Changing this is an Enterprise Edition only feature.
677677
678678
**Behaviour**
679679
* *default* - In priority order, this will cause
680680
- Deletes to always win (the delete with the longest revision history wins if both revisions are deletes)
681681
- 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.
682682
* *localWins* - This will result in local revisions always being the winner in any conflict.
683683
* *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.
685685
686686
687687
Note: replications created prior to Sync Gateway 2.8 will default to `default`.
@@ -693,7 +693,7 @@ Retrieved-replication:
693693
- localWins
694694
- custom
695695
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"
697697
type: string
698698
default: none
699699
purge_on_removal:
@@ -711,7 +711,7 @@ Retrieved-replication:
711711
712712
Replications created prior to Sync Gateway 2.8 must have delta-sync disabled.
713713
714-
Enabling this is an enterprise-edition only feature.
714+
Enabling this is an Enterprise Edition only feature.
715715
type: boolean
716716
default: false
717717
max_backoff_time:
@@ -776,7 +776,7 @@ Retrieved-replication:
776776
type: boolean
777777
default: false
778778
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.
780780
type: integer
781781
default: 200
782782
run_as:
@@ -901,15 +901,15 @@ Replication:
901901
description: |-
902902
This defines what conflict resolution policy Sync Gateway should use to apply when resolving conflicting revisions.
903903
904-
Changing this is an enterprise-edition only feature.
904+
Changing this is an Enterprise Edition only feature.
905905
906906
**Behaviour**
907907
* *default* - In priority order, this will cause
908908
- Deletes to always win (the delete with the longest revision history wins if both revisions are deletes)
909909
- 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.
910910
* *localWins* - This will result in local revisions always being the winner in any conflict.
911911
* *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.
913913
914914
915915
Note: replications created prior to Sync Gateway 2.8 will default to `default`.
@@ -921,7 +921,7 @@ Replication:
921921
- localWins
922922
- custom
923923
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"
925925
type: string
926926
default: none
927927
purge_on_removal:
@@ -939,7 +939,7 @@ Replication:
939939
940940
Replications created prior to Sync Gateway 2.8 must have delta-sync disabled.
941941
942-
Enabling this is an enterprise-edition only feature.
942+
Enabling this is an Enterprise Edition only feature.
943943
type: boolean
944944
default: false
945945
max_backoff_time:
@@ -1004,7 +1004,7 @@ Replication:
10041004
type: boolean
10051005
default: false
10061006
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.
10081008
type: integer
10091009
default: 200
10101010
run_as:
@@ -1240,13 +1240,13 @@ Database:
12401240
description: |-
12411241
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.
12421242
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`.
12441244
12451245
This can also be set to the string `continuous` which maps to true.
12461246
type: boolean
12471247
import_partitions:
12481248
description: |-
1249-
** This is an enterprise-edition feature only**
1249+
** This is an Enterprise Edition feature only**
12501250
12511251
This is how many import partitions should be used for import sharding.
12521252
@@ -1308,7 +1308,7 @@ Database:
13081308
description: |-
13091309
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.
13101310
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**
13121312
type: integer
13131313
default: 0
13141314
shard_count:
@@ -1737,14 +1737,14 @@ Database:
17371737
description: |-
17381738
Delta sync configuration settings.
17391739
1740-
**This is an enterprise-edition feature only**
1740+
**This is an Enterprise Edition feature only**
17411741
type: object
17421742
properties:
17431743
enabled:
17441744
description: |-
17451745
Whether delta sync is enabled.
17461746
1747-
**This is an enterprise-edition feature only**
1747+
**This is an Enterprise Edition feature only**
17481748
type: boolean
17491749
default: false
17501750
rev_max_age_seconds:
@@ -2257,7 +2257,7 @@ Startup-config:
22572257
description: |-
22582258
Whether to enable the DP permissions check feature of admin auth.
22592259
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.
22612261
type: boolean
22622262
server_read_timeout:
22632263
description: |-

0 commit comments

Comments
 (0)