chore(docs): mark v0 API as "deprecated" and v1 as "stable" #13264
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Lotus API documentation and code to clarify API versioning by marking the v0 API as "deprecated", the v1 API as "stable", and the v2 API as "experimental". The changes primarily involve renaming output files to reflect these stability levels and updating comments throughout the codebase.
- Refactors documentation generation to use descriptive file names indicating API stability
- Updates API interface documentation to clarify version stability and recommendations
- Reorganizes code structure with constants for better maintainability
Reviewed Changes
Copilot reviewed 7 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| gen/docs/main.go | Refactored to use constants for file paths with stability indicators and reorganized generation functions |
| documentation/en/api-methods-v2-experimental.md | Updated experimental API warning message for clarity |
| api/v2api/full.go | Enhanced documentation to clarify experimental status and recommend v1 API |
| api/v0api/gateway.go | Updated comments to mark v0 as deprecated and v1 as stable |
| api/v0api/full.go | Added deprecation warning and recommendation to use v1 API |
| api/api_gateway.go | Added comprehensive documentation for Gateway API purpose and stability |
| api/api_full.go | Updated comments to indicate v1 API stability |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
1b525b8 to
4ddcbe6
Compare
rjan90
approved these changes
Aug 13, 2025
There was a problem hiding this comment.
I do not think there anything will break, at least from the https://lotus.filecoin.io perspective.
BigLep
approved these changes
Aug 13, 2025
8 tasks
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.
Ref: #13249
@rjan90 @TippyFlitsUK any idea of what might break if we rename these files in documentation/en?