doc: remove todos, add note on URLs #4
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
ansermino
requested changes
Jul 22, 2024
FIPS/fip-common_node_api.md
Outdated
| @@ -49,6 +49,9 @@ Additionally, by establishing a specification we seek to establish a greater res | |||
| Using the OpenRPC specification format we define several groups of methods. These methods are defined in the OpenRPC specification found here: https://github.com/ChainSafe/filecoin-openrpc-spec. A list of the methods is included below for posterity. | |||
|
|
|||
| All methods are reproduced identically to their present implementation in Lotus 1.26.1. | |||
| Note that Lotus hosts two different API's at HTTP paths [`/rpc/v0`](https://github.com/filecoin-project/lotus/blob/v1.28.0-rc5/documentation/en/api-v0-methods.md) and [`/rpc/v1`](https://github.com/filecoin-project/lotus/blob/v1.28.0-rc5/documentation/en/api-v1-unstable-methods.md), | |||
| with the latter being marked as _unstable_. | |||
| This document aims to specify the _latest_ API version (in this case, `v1`) and breaking changes will be negotiated through further FIPs. | |||
There was a problem hiding this comment.
Suggested change
| This document aims to specify the _latest_ API version (in this case, `v1`) and breaking changes will be negotiated through further FIPs. | |
| This document aims to specify the `V1` API. |
"latest" and "version" are a bit confusing here as the version of Lotus is mentioned just before. Additional changes via FIP is defined below.
Yes, we floated the idea of e.g a
I've written this section from that descriptivist PoV - does that match your expectation? |
ansermino
approved these changes
Aug 7, 2024
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.
Now tracked here: https://github.com/ChainSafe/filecoin-common-node-api/issues