Aias00 opened a new issue, #6365:
URL: https://github.com/apache/shenyu/issues/6365
### 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_
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
