DOC-14382 channel history#973
Open
iamfortune wants to merge 29 commits into
Open
Conversation
RIT3shSapata
requested changes
Jun 4, 2026
RIT3shSapata
left a comment
RIT3shSapata
left a comment
There was a problem hiding this comment.
The API specs have changed, please refer to the following for the latest API Spec:
@adamcfraser would like your opinion on two things:
- Do we want to mention that this implementation is just a phase 1 implementation and then also add a note that this would be an automated process in a future release?
- Should the User's history compaction be called
User Channel History CompactionorUser Access History Compaction?
RIT3shSapata
requested changes
Jun 4, 2026
RIT3shSapata
left a comment
RIT3shSapata
left a comment
There was a problem hiding this comment.
The API specs have changed, please refer to the following for the latest API Spec:
@adamcfraser would like your opinion on two things:
- Do we want to mention that this implementation is just a phase 1 implementation and then also add a note that this would be an automated process in a future release?
- Should the User's history compaction be called
User Channel History CompactionorUser Access History Compaction?
RIT3shSapata
reviewed
Jun 4, 2026
There was a problem hiding this comment.
Another thing that I just noticed is that the Channel compaction is missing from the bottom of the page:
Contributor
Author
There was a problem hiding this comment.
I've updated this with the current filename but will change depending on feedback from @adamcfraser on the specific name for this feature/file.
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
Co-authored-by: Ritesh Sapata <34858159+RIT3shSapata@users.noreply.github.com>
RIT3shSapata
requested changes
Jun 8, 2026
RIT3shSapata
left a comment
RIT3shSapata
left a comment
There was a problem hiding this comment.
Everything LGTM, just a few changes in the name
| For the full API reference, see xref:ROOT:rest_api_admin_static.adoc#tag/Document/operation/post_keyspace-_history_compact[POST /{keyspace}/_history/compact]. | ||
|
|
||
|
|
||
| == User Channel History |
There was a problem hiding this comment.
@iamfortune please rename this to User Access History
Suggested change
| == User Channel History | |
| == User Access History |
|
|
||
| == User Channel History | ||
|
|
||
| === About User Channel History |
There was a problem hiding this comment.
Suggested change
| === About User Channel History | |
| === About User Access History |
| The operation does not affect the user's current channel access, does not modify underlying documents, and does not interrupt active continuous replications. | ||
|
|
||
|
|
||
| === Retrieve User Channel History |
There was a problem hiding this comment.
Suggested change
| === Retrieve User Channel History | |
| === Retrieve User Access History |
| } | ||
| ---- | ||
|
|
||
| The response shows all channel history entries organised by scope and collection. |
There was a problem hiding this comment.
Suggested change
| The response shows all channel history entries organised by scope and collection. | |
| The response shows all access history entries organised by scope and collection. |
| For the full API reference, see xref:ROOT:rest_api_admin_static.adoc#tag/Database-Security/operation/get_db-_user-name-_access_history[GET /{db}/_user/{name}/_access_history]. | ||
|
|
||
|
|
||
| === Compact User Channel History |
There was a problem hiding this comment.
Suggested change
| === Compact User Channel History | |
| === Compact User Access History |
| } | ||
| ---- | ||
|
|
||
| The response confirms the channels removed from the user's history. |
There was a problem hiding this comment.
Suggested change
| The response confirms the channels removed from the user's history. | |
| The response confirms the channels removed from the user's access history. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs Issue: DOC-14382
PR to add channel history for GSW 4.1
Preview URL:
https://preview.docs-test.couchbase.com/docs-sync-gateway-DOC-14382-channel-history-p1
You will need the Docs Team credentials on Confluence.