Conversation
Redocly previews |
There was a problem hiding this comment.
Pull Request Overview
This PR updates database schema documentation for API specifications, focusing on clarifying the status of deprecated configuration options.
- Updated descriptions for deprecated configuration options to reflect current behavior
- Added deprecation marking for
enable_star_channelproperty - Clarified that certain options are no longer configurable and have fixed values
docs/api/components/schemas.yaml
Outdated
| default: 60 | ||
| enable_star_channel: | ||
| description: Used to control whether Sync Gateway should use the all documents (*) channel. | ||
| description: Used to control whether Sync Gateway should use the all documents (*) channel. This is not configurable and the value is set to `true`. |
There was a problem hiding this comment.
[nitpick] The description is confusing as it says the option 'is used to control' something but then states it's 'not configurable'. Consider rephrasing to: 'Controls whether Sync Gateway uses the all documents (*) channel. This option is deprecated and always set to true.' to better align with the deprecated status.
| description: Used to control whether Sync Gateway should use the all documents (*) channel. This is not configurable and the value is set to `true`. | |
| description: Controls whether Sync Gateway uses the all documents (*) channel. This option is deprecated and always set to `true`. |
docs/api/components/schemas.yaml
Outdated
| default: 75 | ||
| allow_conflicts: | ||
| 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. | ||
| description: This controls whether to allow conflicting document revisions. This option is removed from sync gateway, and conflicts will not be allowed. |
There was a problem hiding this comment.
The description contains inconsistent capitalization of 'sync gateway'. It should be 'Sync Gateway' to match the product name capitalization used elsewhere in the documentation.
| description: This controls whether to allow conflicting document revisions. This option is removed from sync gateway, and conflicts will not be allowed. | |
| description: This controls whether to allow conflicting document revisions. This option is removed from Sync Gateway, and conflicts will not be allowed. |
docs/api/components/schemas.yaml
Outdated
| deprecated: true | ||
| enable_shared_bucket_access: | ||
| description: Whether to use extended attributes to store Sync Gateway document (`_sync`) metadata. | ||
| description: Whether to use extended attributes to store Sync Gateway document (`_sync`) metadata. The extended attributes cannot be disabled. |
There was a problem hiding this comment.
[nitpick] The description is unclear about what 'cannot be disabled' refers to. Consider rephrasing to: 'Whether to use extended attributes to store Sync Gateway document (_sync) metadata. This option is deprecated and extended attributes are always enabled.' to better clarify the deprecated behavior.
| description: Whether to use extended attributes to store Sync Gateway document (`_sync`) metadata. The extended attributes cannot be disabled. | |
| description: Whether to use extended attributes to store Sync Gateway document (`_sync`) metadata. This option is deprecated and extended attributes are always enabled. |
CBG-4865
Describe your PR here...
{database}.cache.enable_star_channelPre-review checklist
fmt.Print,log.Print, ...)base.UD(docID),base.MD(dbName))docs/apiDependencies (if applicable)
Integration Tests
GSI=true,xattrs=truehttps://jenkins.sgwdev.com/job/SyncGatewayIntegration/0000/