-
Notifications
You must be signed in to change notification settings - Fork 196
Document legacy HTTP API removal in Nacos 3.2.0+ upgrade guides #1043
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document legacy HTTP API removal in Nacos 3.2.0+ upgrade guides #1043
Conversation
|
|
|
无法获取合并请求的变更信息,代码审查流程终止。 |
…ade guides Co-authored-by: KomachiSion <37170243+KomachiSion@users.noreply.github.com>
Co-authored-by: KomachiSion <37170243+KomachiSion@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please don't change package-lock.json file in this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reverted package-lock.json changes in commit 65c12d7. The PR now only includes the documentation changes.
Co-authored-by: KomachiSion <37170243+KomachiSion@users.noreply.github.com>
| #### 选项 1: 迁移到新API和客户端 (推荐) | ||
| - 使用新的 v3 API | ||
| - 升级到最新的 Nacos 客户端 SDK | ||
| - 参考: Nacos 官方文档 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
路径应该为:
v3 admin API: content/docs/next/manual/admin/admin-api.md
v3 console API: content/docs/next/manual/admin/console-api.md
nacos-client: content/docs/next/manual/user/java-sdk/overview/other-language.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added specific documentation links in commit 56a8b77:
- v3 Admin API:
./admin-api - v3 Console API:
./console-api - Nacos Client:
../user/overview/other-language
The links now point directly to the relevant documentation pages for users migrating to v3 APIs.
Co-authored-by: KomachiSion <37170243+KomachiSion@users.noreply.github.com>
Nacos 3.2.0 removed v1/v2 HTTP APIs from the main distribution. Users upgrading need guidance on migration paths and the optional legacy adapter.
Changes
Added Section 3: Legacy HTTP API Removal to upgrade documentation (
src/content/docs/next/{zh-cn,en}/manual/admin/upgrading.mdx):Migration Guidance
/nacos/v1/*,/nacos/v2/*)nacos-api-legacy-adapterrepositoryLegacy Adapter Installation
4-step process for users needing temporary compatibility:
${NACOS_HOME}/plugins/directoryAdditional Content
Uses MDX
:::dangerand:::cautioncallouts to emphasize temporary nature of adapter solution.Original prompt
Problem Statement
Starting from Nacos 3.2.0, the legacy v1 and v2 HTTP APIs have been removed from the main Nacos repository and moved to a separate legacy adapter repository (
nacos-group/nacos-api-legacy-adapter). Users upgrading to Nacos 3.2.0+ need clear documentation about this breaking change.Required Changes
Update both Chinese and English upgrade documentation files to include a new section about the legacy API removal and how to handle it.
Files to Update
src/content/docs/next/zh-cn/manual/admin/upgrading.mdxsrc/content/docs/next/en/manual/admin/upgrading.mdxContent Requirements
Add a new section "## 3. 旧版HTTP API移除说明 (Nacos 3.2.0+)" (for Chinese) and "## 3. Legacy HTTP API Removal (Nacos 3.2.0+)" (for English) after the current "## 2. 升级步骤" section.
The new section should include:
3.1 API Removal Notice
3.2 Migration Options
Two options for users:
3.3 Installing the Legacy API Adapter
Include detailed step-by-step instructions:
Step 1: Build or Download the Adapter
Step 2: Install the Adapter
For Nacos Server Deployment:
For Embedded/Custom Applications:
Step 3: Verify Installation
Step 4: Test Legacy APIs
curl -X GET "http://localhost:8848/nacos/v1/ns/instance/list?serviceName=test"3.4 Version Compatibility Table
Important note: The adapter version must match your Nacos server version.
3.5 Planning Your Migration
Include migration checklist:
3.6 Getting Help
Important Warning Callouts
Use multiple prominent warning callouts throughout the section:
Chinese Documentation Content (src/content/docs/next/zh-cn/manual/admin/upgrading.mdx)
Insert after line 208 (after section 2.2):
方式 B: 从源码构建