Skip to content
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.

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

[TRIVIAL] docs(API-CHANGELOG): clarify changes for V2 #4773

Merged
merged 4 commits into from
Dec 6, 2023

Conversation

intelliot
Copy link
Collaborator

@intelliot intelliot commented Oct 18, 2023

High Level Overview of Change

Clarify changes for api_version: 2 in API-CHANGELOG.md.

Context of Change

With version 2.0.0, api_version: 2 will be promoted to general availability. Breaking API changes after that point will take effect in api_version: 3 or later.

Type of Change

  • Documentation update
  • Chore (no impact to binary, e.g. .gitignore, formatting, dropping support for older tooling)

API Impact

This documents API changes, making it easier for developers to update integrations to utilize upcoming API improvements.

[TRIVIAL]: Documentation only, no code changes

@intelliot intelliot requested review from ckniffen and oeggert October 18, 2023 04:54
@intelliot intelliot changed the title docs(API-CHANGELOG): add planned changes for V2 [TRIVIAL] docs(API-CHANGELOG): add planned changes for V2 Oct 24, 2023
@intelliot intelliot changed the title [TRIVIAL] docs(API-CHANGELOG): add planned changes for V2 [TRIVIAL] docs(API-CHANGELOG): clarify changes for V2 Dec 2, 2023
@intelliot intelliot requested review from Bronek and ximinez December 2, 2023 15:08
API-CHANGELOG.md Outdated Show resolved Hide resolved
API-CHANGELOG.md Outdated Show resolved Hide resolved
API-CHANGELOG.md Outdated Show resolved Hide resolved
API-CHANGELOG.md Outdated Show resolved Hide resolved
API-CHANGELOG.md Outdated Show resolved Hide resolved
API-CHANGELOG.md Outdated Show resolved Hide resolved
@intelliot
Copy link
Collaborator Author

I think I've applied your suggestions. Thanks!

@intelliot intelliot merged commit 3b191a3 into XRPLF:develop Dec 6, 2023
16 checks passed
@intelliot intelliot deleted the v2-planned-changes branch December 6, 2023 22:27
@intelliot
Copy link
Collaborator Author

Merged because this only touches a markdown file (no code).

sophiax851 pushed a commit to sophiax851/rippled that referenced this pull request Jun 12, 2024
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.

2 participants