rest: introduce the concept of stable and unstable apis #19701
Merged
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
3 Skipped Deployments
|
bmwill
force-pushed
the
rest-stabilization
branch
from
6f18c5a to
9a1a303
Compare
bmwill
force-pushed
the
rest-stabilization
branch
from
9a1a303 to
80a7360
Compare
bmwill
force-pushed
the
rest-stabilization
branch
from
80a7360 to
2e2aa1a
Compare
sadhansood
approved these changes
Oct 4, 2024
Contributor
sadhansood
left a comment
sadhansood
left a comment
There was a problem hiding this comment.
Thanks @bmwill, this looks great. And thanks for adding the list full checkpoint as well. I didn't see it but is it possible to add an endpoint which tells user whether unstable endpoints are enabled on the server.
Contributor
Author
No and i don't know if we should (although you can technically get this information via the openapi spec/explorer) |
Contributor
Makes sense! |
Enable marking APIs as either stable or unstable. By default unstable APIs are disabled and not served but the `enable_unstable_apis` can be set to `true` in order to enable serving of unstable APIs. Example enabling enable_unstable_apis in fullnode.yaml: ```yaml enable_experimental_rest_api: true rest: enable_unstable_apis: true ```
Stabalize the get and list checkpoints apis as well as introduce a new list full checkpoints api.
Until the rest service as a whole is "stabalized" with a sane set of default stable apis, have the default be to enable all unstable apis.
bmwill
force-pushed
the
rest-stabilization
branch
from
2e2aa1a to
75528ae
Compare
Closed
12 tasks
jkrvivian
added a commit
to iotaledger/iota
that referenced
this pull request
Jun 6, 2025
) # Description of change - Upstream range: [v1.35.4, v1.36.2) - Port the following Sui's commits which are contained in the single PR MystenLabs/sui#19701 - MystenLabs/sui@512a4e0 - MystenLabs/sui@7d05486 - MystenLabs/sui@ea81ea5 - MystenLabs/sui@591f96c - MystenLabs/sui@13c1ec7 - MystenLabs/sui@3b665eb - Descriptions from commits - Enable marking APIs as either stable or unstable. By default unstable APIs are disabled and not served but the `enable_unstable_apis` can be set to `true` in order to enable serving of unstable APIs. - Stabalize the get and list checkpoints apis as well as introduce a new list full checkpoints api. - Until the rest service as a whole is "stabalized" with a sane set of default stable apis, have the default be to enable all unstable apis. - Notes - The `enable_experimental_rest_api` was renamed to be `enable_rest_api` in #3740 - The `worker_public_key` was renamed to be `protocol_public_key` in #3151 - Because the `iota-sdk-types` does not exit, remain original `iota-sdk2` instead - The `proc-macro2` version is updated in the upstream change, hence here we update it to be the latest version accordingly. (see https://crates.io/crates/proc-macro2) ## Links to any relevant issues Part of #3990 ## Type of change - Enhancement (a non-breaking change which adds functionality) ## How the change has been tested Ran the local network with `RUST_LOG=info cargo run --release --bin iota start --force-regenesis --with-faucet` --------- Co-authored-by: jkrvivian <[email protected]>
muXxer
pushed a commit
to iotaledger/iota
that referenced
this pull request
Jun 10, 2025
) # Description of change - Upstream range: [v1.35.4, v1.36.2) - Port the following Sui's commits which are contained in the single PR MystenLabs/sui#19701 - MystenLabs/sui@512a4e0 - MystenLabs/sui@7d05486 - MystenLabs/sui@ea81ea5 - MystenLabs/sui@591f96c - MystenLabs/sui@13c1ec7 - MystenLabs/sui@3b665eb - Descriptions from commits - Enable marking APIs as either stable or unstable. By default unstable APIs are disabled and not served but the `enable_unstable_apis` can be set to `true` in order to enable serving of unstable APIs. - Stabalize the get and list checkpoints apis as well as introduce a new list full checkpoints api. - Until the rest service as a whole is "stabalized" with a sane set of default stable apis, have the default be to enable all unstable apis. - Notes - The `enable_experimental_rest_api` was renamed to be `enable_rest_api` in #3740 - The `worker_public_key` was renamed to be `protocol_public_key` in #3151 - Because the `iota-sdk-types` does not exit, remain original `iota-sdk2` instead - The `proc-macro2` version is updated in the upstream change, hence here we update it to be the latest version accordingly. (see https://crates.io/crates/proc-macro2) ## Links to any relevant issues Part of #3990 ## Type of change - Enhancement (a non-breaking change which adds functionality) ## How the change has been tested Ran the local network with `RUST_LOG=info cargo run --release --bin iota start --force-regenesis --with-faucet` --------- Co-authored-by: jkrvivian <[email protected]>
filipdulic
pushed a commit
to iotaledger/iota
that referenced
this pull request
Jul 16, 2025
) # Description of change - Upstream range: [v1.35.4, v1.36.2) - Port the following Sui's commits which are contained in the single PR MystenLabs/sui#19701 - MystenLabs/sui@512a4e0 - MystenLabs/sui@7d05486 - MystenLabs/sui@ea81ea5 - MystenLabs/sui@591f96c - MystenLabs/sui@13c1ec7 - MystenLabs/sui@3b665eb - Descriptions from commits - Enable marking APIs as either stable or unstable. By default unstable APIs are disabled and not served but the `enable_unstable_apis` can be set to `true` in order to enable serving of unstable APIs. - Stabalize the get and list checkpoints apis as well as introduce a new list full checkpoints api. - Until the rest service as a whole is "stabalized" with a sane set of default stable apis, have the default be to enable all unstable apis. - Notes - The `enable_experimental_rest_api` was renamed to be `enable_rest_api` in #3740 - The `worker_public_key` was renamed to be `protocol_public_key` in #3151 - Because the `iota-sdk-types` does not exit, remain original `iota-sdk2` instead - The `proc-macro2` version is updated in the upstream change, hence here we update it to be the latest version accordingly. (see https://crates.io/crates/proc-macro2) ## Links to any relevant issues Part of #3990 ## Type of change - Enhancement (a non-breaking change which adds functionality) ## How the change has been tested Ran the local network with `RUST_LOG=info cargo run --release --bin iota start --force-regenesis --with-faucet` --------- Co-authored-by: jkrvivian <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Describe the changes or additions included in this PR.
Test plan
How did you test the new or updated feature?
Release notes
Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.
For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.