Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Feb 11, 2026

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

  • Breaking change callout identifying removed v1/v2 REST APIs (/nacos/v1/*, /nacos/v2/*)
  • Two migration paths:

Legacy Adapter Installation

4-step process for users needing temporary compatibility:

  1. Download from GitHub releases or build from source
  2. Deploy JAR to ${NACOS_HOME}/plugins/ directory
  3. Verify adapter loads from Nacos logs
  4. Test v1/v2 API endpoints

Additional Content

  • Version compatibility matrix (adapter version must match Nacos version)
  • 6-step migration checklist for gradual transition
  • Prominent warnings that adapter is unsupported long-term

Uses MDX :::danger and :::caution callouts 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

  1. Chinese Documentation: src/content/docs/next/zh-cn/manual/admin/upgrading.mdx
  2. English Documentation: src/content/docs/next/en/manual/admin/upgrading.mdx

Content 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

  • Clear warning that v1 and v2 HTTP APIs have been removed starting from Nacos 3.2.0
  • Explanation that these APIs are now in a separate legacy adapter repository
  • Impact on existing users

3.2 Migration Options

Two options for users:

  • Option 1 (Recommended): Migrate to new v3 APIs and latest client SDKs
  • Option 2 (Temporary): Use the legacy API adapter

3.3 Installing the Legacy API Adapter

Include detailed step-by-step instructions:

Step 1: Build or Download the Adapter

  • Option A: Download from GitHub releases
    wget https://github.com/nacos-group/nacos-api-legacy-adapter/releases/download/v${version}/nacos-api-legacy-adapter-${version}.jar
  • Option B: Build from source
    git clone https://github.com/nacos-group/nacos-api-legacy-adapter.git
    cd nacos-api-legacy-adapter
    mvn clean install
    # Output: target/nacos-api-legacy-adapter-${version}.jar

Step 2: Install the Adapter

For Nacos Server Deployment:

# Place the JAR in the plugins directory
cp nacos-api-legacy-adapter-${version}.jar ${NACOS_HOME}/plugins/

# Restart Nacos
sh ${NACOS_HOME}/bin/shutdown.sh
sh ${NACOS_HOME}/bin/startup.sh -m standalone

For Embedded/Custom Applications:

<dependency>
    <groupId>com.alibaba.nacos</groupId>
    <artifactId>nacos-api-legacy-adapter</artifactId>
    <version>${nacos.version}</version>
</dependency>

Step 3: Verify Installation

tail -f ${NACOS_HOME}/logs/nacos.log
# Look for adapter loading confirmation

Step 4: Test Legacy APIs

curl -X GET "http://localhost:8848/nacos/v1/ns/instance/list?serviceName=test"

3.4 Version Compatibility Table

Nacos Version Legacy Adapter Version Compatibility
3.2.0 3.2.0 ✅ Compatible
3.3.0+ Match Nacos version ⚠️ Check compatibility

Important note: The adapter version must match your Nacos server version.

3.5 Planning Your Migration

Include migration checklist:

  1. Audit your API usage - Identify all v1/v2 API calls
  2. Review new v3 APIs - Understand the new API structure
  3. Update clients - Upgrade to latest Nacos client SDKs
  4. Test thoroughly - Test in staging environment
  5. Migrate gradually - Use feature flags or canary deployments
  6. Remove adapter - Once migration is complete, remove the adapter JAR

3.6 Getting Help

Important Warning Callouts

Use multiple prominent warning callouts throughout the section:

:::danger[重要警告] / :::danger[Important Warnings]
- 旧版API适配器**不保证**在未来的Nacos版本中继续支持
- 该模块**没有长期维护计划**
- 这只是**临时解决方案**,仅用于紧急迁移场景
- **强烈建议尽快迁移到v3 API和新客户端**
:::
:::caution[重大变更] / :::caution[Breaking Change]**Nacos 3.2.0** 开始,旧版 v1 和 v2 HTTP API 已从主仓库中**移除**。
:::

Chinese Documentation Content (src/content/docs/next/zh-cn/manual/admin/upgrading.mdx)

Insert after line 208 (after section 2.2):

## 3. 旧版HTTP API移除说明 (Nacos 3.2.0+)

### 3.1 API移除通知

:::caution[重大变更]**Nacos 3.2.0** 开始,旧版 v1 和 v2 HTTP API 已从 Nacos 主仓库中**移除**。
:::

旧版的 v1 和 v2 HTTP API 不再包含在默认的 Nacos server 发行版中。这些 API 已迁移到单独的旧版适配器模块中。

**受影响的API:**
- 所有 v1 REST APIs (例如: `/nacos/v1/ns/instance`, `/nacos/v1/cs/configs`)
- 所有 v2 REST APIs

### 3.2 迁移选项

您有两个选择:

#### 选项 1: 迁移到新API和客户端 (推荐)
- 使用新的 v3 API
- 升级到最新的 Nacos 客户端 SDK
- 参考: Nacos 官方文档

#### 选项 2: 使用旧版API适配器 (临时方案)
如果您需要时间进行迁移,可以临时使用旧版适配器恢复旧API。

### 3.3 安装旧版API适配器

:::danger[重要警告]
- 旧版API适配器**不保证**在未来的Nacos版本中继续支持
- 该模块**没有社区长期维护计划**
- 这只是**临时解决方案**,仅用于紧急迁移场景
- **强烈建议尽快迁移到 v3 API 和新客户端**
:::

#### 步骤 1: 构建或下载适配器

**方式 A: 从 Release 下载**
```bash
# 从 GitHub releases 下载
wget https://github.com/nacos-group/nacos-api-legacy-adapter/releases/download/v${version}/nacos-api-legacy-adapter-${version}.jar

方式 B: 从源码构建

git clone https://github.com/nacos-group/nacos-api-legacy-adapter.git
cd nacos-api-legac...

</details>



<!-- START COPILOT CODING AGENT SUFFIX -->

*This pull request was created from Copilot chat.*
>

<!-- START COPILOT CODING AGENT TIPS -->
---

✨ Let Copilot coding agent [set things up for you](https://github.com/nacos-group/nacos-group.github.io/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@lingma-agents
Copy link

lingma-agents bot commented Feb 11, 2026

无法获取合并请求的变更信息,代码审查流程终止。

Copilot AI and others added 2 commits February 11, 2026 03:37
…ade guides

Co-authored-by: KomachiSion <37170243+KomachiSion@users.noreply.github.com>
Co-authored-by: KomachiSion <37170243+KomachiSion@users.noreply.github.com>
Copilot AI changed the title [WIP] Update upgrade documentation for legacy HTTP API removal Document legacy HTTP API removal in Nacos 3.2.0+ upgrade guides Feb 11, 2026
Copilot AI requested a review from KomachiSion February 11, 2026 03:42
Copy link
Contributor

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.

Copy link
Contributor Author

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 官方文档
Copy link
Contributor

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

Copy link
Contributor Author

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>
Copilot AI changed the title Document legacy HTTP API removal in Nacos 3.2.0+ upgrade guides Add Nacos 3.2.0+ legacy HTTP API removal documentation Feb 11, 2026
Copilot AI requested a review from KomachiSion February 11, 2026 03:57
Copilot AI changed the title Add Nacos 3.2.0+ legacy HTTP API removal documentation Document legacy HTTP API removal in Nacos 3.2.0+ upgrade guides Feb 11, 2026
@KomachiSion KomachiSion marked this pull request as ready for review February 11, 2026 04:00
@KomachiSion KomachiSion merged commit 91cc07b into develop-astro-nacos Feb 11, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants