Skip to content

CBG-5715: add x-enumDescriptions to enums that only listed values #8653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
torcolvin merged 2 commits into from
Sep 7, 2026
Merged

CBG-5715: add x-enumDescriptions to enums that only listed values #8653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d8a154
CBG-5715: add x-enumDescriptions to enums that only listed values
torcolvin Aug 21, 2026
07c18d9
CBG-5715: fix sgcollect redact_level default and bychannel filter typo
torcolvin Aug 23, 2026
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
3 changes: 3 additions & 0 deletions docs/api/components/parameters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ compact-type:
enum:
- attachment
- tombstone
x-enumDescriptions:
attachment: Clean up legacy (pre-3.0) attachments.
tombstone: Purge the JSON bodies of old, non-current revisions.

@bbrks bbrks Sep 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not what tombstone compaction does. The description below, and the one in the standalone db compact yaml file somehow ended up incorrect too and I think that is tripping Claude up in this.

I'm happy to merge this x-enumDescriptions fix as part of the stack, and do a follow-up to correct the compact descriptions though. I'll file a separate ticket so this isn't forgotten.

https://jira.issues.couchbase.com/browse/CBG-5833

// Compact runs tombstone compaction from view and/or GSI indexes - ensuring there's nothing left in the indexes for tombstoned documents that have been purged by the server.

description: |-
This is the type of compaction to use. The type must be either:
* `attachment` for cleaning up legacy (pre-3.0) attachments
Expand Down
40 changes: 34 additions & 6 deletions docs/api/components/schemas.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1435,7 +1435,7 @@ Database:
description: >
The domain of the role for which audit logging is disabled.
enum: [cbs, sgw]
x-enumDescription:
x-enumDescriptions:
cbs: Couchbase Server RBAC
sgw: Sync Gateway Role
type: string
Expand All @@ -1453,7 +1453,7 @@ Database:
The domain of the user for which audit logging is disabled.
type: string
enum: [cbs, sgw]
x-enumDescription:
x-enumDescriptions:
cbs: Couchbase Server User
sgw: Sync Gateway User
name:
Expand Down Expand Up @@ -1742,6 +1742,11 @@ Database:
- "Lax"
- "None"
- "Strict"
x-enumDescriptions:
Default: Omit the SameSite attribute entirely.
Lax: Blocked on cross-site requests, but allowed when a user navigates to the site directly.
None: Allowed on all requests, including cross-site. Requires the cookie to be marked `Secure`.
Strict: Only sent on same-site requests.
sgr_tls_skip_verify:
description: Enable self-signed certificates for SG-replicate testing.
type: boolean
Expand Down Expand Up @@ -1891,7 +1896,7 @@ Database-audit:
description: >
The domain of the role for which audit logging is disabled.
enum: [cbs, sgw]
x-enumDescription:
x-enumDescriptions:
cbs: Couchbase Server User
sgw: Sync Gateway User
type: string
Expand All @@ -1908,7 +1913,7 @@ Database-audit:
description: >
The domain of the role for which audit logging is disabled.
enum: [cbs, sgw]
x-enumDescription:
x-enumDescriptions:
cbs: Couchbase Server RBAC
sgw: Sync Gateway Role
type: string
Expand Down Expand Up @@ -1938,7 +1943,7 @@ Database-audit-verbose:
description: >
The domain of the role for which audit logging is disabled.
enum: [cbs, sgw]
x-enumDescription:
x-enumDescriptions:
cbs: Couchbase Server User
sgw: Sync Gateway User
type: string
Expand All @@ -1955,7 +1960,7 @@ Database-audit-verbose:
description: >
The domain of the role for which audit logging is disabled.
enum: [cbs, sgw]
x-enumDescription:
x-enumDescriptions:
cbs: Couchbase Server RBAC
sgw: Sync Gateway Role
type: string
Expand Down Expand Up @@ -2013,6 +2018,12 @@ Resync-status:
- stopping
- stopped
- error
x-enumDescriptions:
running: Currently running.
completed: Finished successfully.
stopping: In the process of stopping.
stopped: Stopped before completion.
error: Failed with an error.
start_time:
description: The ISO-8601 date and time the resync operation was started.
type: string
Expand Down Expand Up @@ -2055,6 +2066,12 @@ Attachment-Migration-status:
- stopping
- stopped
- error
x-enumDescriptions:
running: Currently running.
completed: Finished successfully.
stopping: In the process of stopping.
stopped: Stopped before completion.
error: Failed with an error.
start_time:
description: The ISO-8601 date and time the attachment migration operation was started.
type: string
Expand Down Expand Up @@ -2093,6 +2110,12 @@ Metadata-Migration-status:
- stopping
- stopped
- error
x-enumDescriptions:
running: Currently running.
completed: Finished successfully.
stopping: In the process of stopping.
stopped: Stopped before completion.
error: Failed with an error.
start_time:
description: The ISO-8601 date and time the metadata migration operation was started.
type: string
Expand Down Expand Up @@ -2531,6 +2554,11 @@ Logging-config:
- partial
- full
- unset
x-enumDescriptions:
none: No redaction; logs may contain sensitive data.
partial: Redacts sensitive data from logs. Default.
full: Not implemented separately; behaves the same as `partial`.
unset: Not explicitly configured; behaves the same as `partial`.
readOnly: true
console:
$ref: '#/Console-logging-config'
Expand Down
6 changes: 6 additions & 0 deletions docs/api/paths/admin/_profile-profilename.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ parameters:
- threadcreate
- mutex
- goroutine
x-enumDescriptions:
heap: A snapshot of memory usage, useful for spotting memory leaks.
block: Where the server is waiting on locks or channels.
threadcreate: Where new OS threads were created.
mutex: Where goroutines are contending for the same lock.
goroutine: A snapshot of everything the server is currently doing.
post:
summary: Create point-in-time profile
description: |-
Expand Down
5 changes: 4 additions & 1 deletion docs/api/paths/admin/_sgcollect_info.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,13 @@ post:
redact_level:
description: The redaction level to use for redacting the collected logs.
type: string
default: partial
default: none
enum:
- partial
- none
x-enumDescriptions:
partial: Redacts sensitive data from the collected logs.
none: No redaction; collected logs may contain sensitive data. Default.
Comment thread
torcolvin marked this conversation as resolved.
redact_salt:
description: The salt to use for the log redactions.
type: string
Expand Down
4 changes: 4 additions & 0 deletions docs/api/paths/admin/db-_replicationStatus-replicationid.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ put:
- start
- stop
- reset
x-enumDescriptions:
start: Start a stopped replication.
stop: Stop an active replication.
reset: Reset replication checkpoints. The replication must be stopped first.
responses:
'200':
description: Successfully changed target state of replicator
Expand Down
15 changes: 13 additions & 2 deletions docs/api/paths/admin/keyspace-_changes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ get:
enum:
- main_only
- all_docs
x-enumDescriptions:
main_only: Return only the current winning revision.
all_docs: Return all leaf revisions, including conflicts and deleted conflicts.
- name: active_only
in: query
description: Set true to exclude deleted documents and notifications for documents the user no longer has access to from the changes feed.
Expand All @@ -58,9 +61,12 @@ get:
enum:
- sync_gateway/bychannel
- _doc_ids
x-enumDescriptions:
sync_gateway/bychannel: Filter by channel, using the `channels` parameter.
Comment thread
torcolvin marked this conversation as resolved.
_doc_ids: Filter by document ID, using the `doc_ids` parameter. Requires `feed=normal`.
- name: channels
in: query
description: 'A comma-separated list of channel names to filter the response to only the channels specified. To use this option, the `filter` query option must be set to `sync_gateway/bychannels`.'
description: 'A comma-separated list of channel names to filter the response to only the channels specified. To use this option, the `filter` query option must be set to `sync_gateway/bychannel`.'
schema:
type: string
- name: doc_ids
Expand Down Expand Up @@ -100,6 +106,11 @@ get:
- longpoll
- continuous
- websocket
x-enumDescriptions:
normal: Return all current changes at once, then close the connection.
longpoll: As `normal`, but if there are no changes yet, waits for the next change (or the heartbeat/timeout) before sending its single response.
continuous: Stream each change as it happens, over a single long-lived connection.
websocket: Stream changes over a WebSocket connection.

- name: request_plus
in: query
Expand Down Expand Up @@ -172,7 +183,7 @@ post:
description: Set a filter to either filter by channels or document IDs.
type: string
channels:
description: 'A comma-separated list of channel names to filter the response to only the channels specified. To use this option, the `filter` query option must be set to `sync_gateway/bychannels`.'
description: 'A comma-separated list of channel names to filter the response to only the channels specified. To use this option, the `filter` query option must be set to `sync_gateway/bychannel`.'
type: string
doc_ids:
description: 'An array of document IDs to filter the documents in the response to only the documents specified. To use this option, the `filter` query option must be set to `_doc_ids` and the `feed` parameter must be `normal`.'
Expand Down
15 changes: 13 additions & 2 deletions docs/api/paths/public/keyspace-_changes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ get:
enum:
- main_only
- all_docs
x-enumDescriptions:
main_only: Return only the current winning revision.
all_docs: Return all leaf revisions, including conflicts and deleted conflicts.
- name: active_only
in: query
description: Set true to exclude deleted documents and notifications for documents the user no longer has access to from the changes feed.
Expand All @@ -53,9 +56,12 @@ get:
enum:
- sync_gateway/bychannel
- _doc_ids
x-enumDescriptions:
sync_gateway/bychannel: Filter by channel, using the `channels` parameter.
Comment thread
torcolvin marked this conversation as resolved.
_doc_ids: Filter by document ID, using the `doc_ids` parameter. Requires `feed=normal`.
- name: channels
in: query
description: 'A comma-separated list of channel names to filter the response to only the channels specified. To use this option, the `filter` query option must be set to `sync_gateway/bychannels`.'
description: 'A comma-separated list of channel names to filter the response to only the channels specified. To use this option, the `filter` query option must be set to `sync_gateway/bychannel`.'
schema:
type: string
- name: doc_ids
Expand Down Expand Up @@ -95,6 +101,11 @@ get:
- longpoll
- continuous
- websocket
x-enumDescriptions:
normal: Return all current changes at once, then close the connection.
longpoll: As `normal`, but if there are no changes yet, waits for the next change (or the heartbeat/timeout) before sending its single response.
continuous: Stream each change as it happens, over a single long-lived connection.
websocket: Stream changes over a WebSocket connection.
- name: request_plus
in: query
description: 'When true, ensures all valid documents written prior to the request being issued are included in the response. This is only applicable for non-continuous feeds.'
Expand Down Expand Up @@ -159,7 +170,7 @@ post:
description: Set a filter to either filter by channels or document IDs.
type: string
channels:
description: 'A comma-separated list of channel names to filter the response to only the channels specified. To use this option, the `filter` query option must be set to `sync_gateway/bychannels`.'
description: 'A comma-separated list of channel names to filter the response to only the channels specified. To use this option, the `filter` query option must be set to `sync_gateway/bychannel`.'
type: string
doc_ids:
description: 'An array of document IDs to filter the documents in the response to only the documents specified. To use this option, the `filter` query option must be set to `_doc_ids` and the `feed` parameter must be `normal`.'
Expand Down
Loading