[Task] Define the client-admin registration protocol compatibility contract

[Aias00]

Description

Background

After splitting Java client modules into shenyu-client-java, the client repo and main ShenYu repo must remain compatible through stable registration protocols rather than shared source code.

We need an explicit compatibility contract for client registration, heartbeat, discovery instance registration, and MCP registration.

Tasks

• List all client-to-admin registration endpoints.
• Document request and response fields for each endpoint.
• Document beat/heartbeat payload and lifecycle behavior.
• Document discovery instance registration payload and lifecycle behavior.
• Document MCP registration endpoint /shenyu-client/register-mcp.
• Identify fields that are required, optional, deprecated, or newly added.
• Define compatibility rules for additive fields, removed fields, and default values.
• Define how old clients should behave with new admin versions.
• Define how new clients should behave with old admin versions.

Expected Output

A protocol compatibility document covering:

• HTTP paths
• DTO fields
• Required/optional field semantics
• Backward compatibility rules
• Forward compatibility rules
• Error handling expectations
• Version compatibility notes

Acceptance Criteria

• The document is specific enough to guide both main repo and client repo changes.
• Existing registration flows are covered.
• Future protocol changes can be reviewed against this document.

Task List

No response

[github-actions]

👋 Hello @yuluo-yx

A new issue has been opened by @Aias00:

• Title: [Task] Define the client-admin registration protocol compatibility contract
• Link: [Task] Define the client-admin registration protocol compatibility contract #6365

Please review when you have time. Thank you! 🙏