This repository was archived by the owner on Jan 7, 2025. It is now read-only.
Fix terminology used to refer to REST API version#40
Merged
lawrence-forooghian merged 1 commit intoDec 5, 2024
Conversation
There is no longer a concept of a "major" version; as of protocol version 2, the protocol version is a single integer (see spec point CSV2a). Unfortunately, the linked ably.com REST API versioning documentation still refers to API versions 1.1 and 1.2, but that’s a separate issue — the REST API documentation needs to be versioned and updated for newer protocol versions, which Mark says is planned. Relevant conversation in [1], where Mark says: > For the docstring I think we can drop "major" and just refer to it as > "version" since this will be the case going forwards. We can leave the > link in for now too even if it'll be a little wonky until we release the > versioned REST API. [1] ably/ably-js#1670 (comment)
lawrence-forooghian
requested review from
VeskeR,
m-hulbert,
owenpearson and
ttypic
lawrence-forooghian
added a commit
to ably/ably-js
that referenced
this pull request
Mar 20, 2024
Taken from sdk-api-reference commit 7cc5a28 (see [1], not merged yet). [1] ably/sdk-api-reference#40
lawrence-forooghian
added a commit
to ably/ably-js
that referenced
this pull request
Mar 20, 2024
Taken from sdk-api-reference commit 7cc5a28 (see [1], not merged yet). [1] ably/sdk-api-reference#40
m-hulbert
approved these changes
Dec 5, 2024
lawrence-forooghian
deleted the
remove-mention-of-major-REST-api-version
branch
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
There is no longer a concept of a "major" version; as of protocol version 2, the protocol version is a single integer (see spec point CSV2a).
Unfortunately, the linked ably.com REST API versioning documentation still refers to API versions 1.1 and 1.2, but that’s a separate issue — the REST API documentation needs to be versioned and updated for newer protocol versions, which Mark says is planned.
Relevant conversation in ably/ably-js#1670 (comment), where Mark says: