Port api reference to specification repo #261
Merged
Conversation
This file contains 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
Co-authored-by: Mark Hulbert <[email protected]>
Added in spec commit d5e8fc6.
ConnectionDetails doesn’t form part of the public API (it’s marked as “internal” in the spec’s IDL), so this link will never resolve.
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)
…iptions for `attach` and `subscribe`.
Added description for the TB4.
Which were not very good
…m-public-API Remove public mention of `ConnectionDetails`
…sion Fix terminology used to refer to REST API version
Add descriptions of `whenState` methods
Add api docs for mutable message fields
ttypic
reviewed
Jan 6, 2025
looks like this is a 9 year old bug in redcarpet vmg/redcarpet#477 i'll figure something out |
|
switched from redcarpet to kramdown |
redcarpet can't deal with pipes in tables vmg/redcarpet#477
SimonWoolf
force-pushed
the
add-api-reference
branch
from
b800557 to
64b2746
Compare
ttypic
approved these changes
Jan 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Context: ably/sdk-api-reference#44 (comment)
Internal discussion with @m-hulbert : https://ably-real-time.slack.com/archives/C01LR5XFHFX/p1735928965057959
The existing sdk api reference repo was clearly not working well. The existence of that repo is not much known to anyone but the SDK team, who had at some point been instructed to update it in lockstep with the specification repo and have the deved team approve all PRs, which is no longer tenable given resource constraints on that team. The reason for it being its own repo instead of a file in the specification repo is lost to history.
There is certainly still value in having a file for shared docstrings between different sdks. But it should be a file in the specifications repo, where it can be versioned along with the spec, modified by the same pr that adds the same fields to the spec, and rendered to https://sdk.ably.com/ for the convenience of SDK devs.
This PR does that. (As a repo merge, preserving full history on both sides). After it is merged, I will archive the sdk-api-reference repo.
FYI @ttypic @lawrence-forooghian @owenpearson @sacOO7 @paddybyers