Skip to content

Rename user-visible consensus term wording to view#7993

Open
Copilot wants to merge 5 commits into
mainfrom
copilot/rename-remaining-occurrences-of-term
Open

Rename user-visible consensus term wording to view#7993
Copilot wants to merge 5 commits into
mainfrom
copilot/rename-remaining-occurrences-of-term

Conversation

Copilot AI commented Jun 27, 2026

Copy link
Copy Markdown
Contributor

CCF uses “view” as the public name for the consensus epoch in transaction IDs, but a few user-facing descriptions still referred to this as “term”. This cleans up those remaining references without changing any API shape or wire format.

  • Public API docs

    • Removed the View/Term synonym note from the public TxID header comment.
  • REST/OpenAPI schemas

    • Updated governance schema descriptions for transaction IDs and invalid transaction status to say “view” instead of “term”.
  • Architecture docs

    • Updated the consensus PreVote documentation and diagrams to consistently describe leader epochs as views.

Co-authored-by: achamayou <4016369+achamayou@users.noreply.github.com>
Copilot AI changed the title [WIP] Rename remaining occurrences of term in the code Rename user-visible consensus term wording to view Jun 27, 2026
Copilot AI requested a review from achamayou June 27, 2026 07:12
@achamayou achamayou marked this pull request as ready for review June 27, 2026 07:14
@achamayou achamayou requested a review from a team as a code owner June 27, 2026 07:14
Copilot AI review requested due to automatic review settings June 27, 2026 07:14
@achamayou

Copy link
Copy Markdown
Member

@copilot are there public APIs that expose the word "term"?

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates user-facing documentation and schema descriptions to consistently use “view” (CCF’s public term for the consensus epoch in TxIDs) instead of “term”, without changing API shapes or wire formats.

Changes:

  • Removed the View/Term synonym note from the public TxID header comment.
  • Updated governance OpenAPI/JSON schema descriptions for transaction IDs and invalid transaction status to say “view”.
  • Updated the consensus architecture documentation (including PreVote text and diagrams) to use “view” terminology.

Custom instructions used:

  • .github/copilot-instructions.md
  • .github/instructions/reviewing.instructions.md

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

File Description
include/ccf/tx_id.h Removes the user-facing “View/Term are synonymous” note from the TxID documentation.
doc/schemas/gov/2024-07-01/gov.json Updates schema descriptions to refer to TxID “view” rather than “term”.
doc/schemas/gov/2023-06-01-preview/gov.json Same schema description updates for the preview version.
doc/architecture/consensus/index.rst Updates consensus/PreVote documentation wording and diagrams to use “view”.

Comment thread doc/architecture/consensus/index.rst Outdated
Comment thread doc/architecture/consensus/index.rst Outdated
Comment thread doc/architecture/consensus/index.rst Outdated
Comment thread doc/architecture/consensus/index.rst Outdated
Comment thread doc/architecture/consensus/index.rst Outdated
Co-authored-by: achamayou <4016369+achamayou@users.noreply.github.com>
achamayou and others added 2 commits June 27, 2026 09:19
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants