apache / apache/shenyu

[BUG] API Document generation does not parse request parameters for RPC types (Dubbo/SOFA/TARS/gRPC)

Open
#6,338 3 comments 0 reactions 0 assignees View on GitHub
type: bug
Dominant language
Java
Stars
8.8k
Forks
3.1k
Avg merge
7d 1h
Merged PRs (30d)
85

Description

### Is there an existing issue for this?

- [x] I have searched the existing issues

### Current Behavior

The API document generation in `ApiDocRegistrarImpl.getDocument()` uses `OpenApiUtils.generateDocumentParameters()` for all RPC types without distinction. This method only supports parsing Spring Web annotations (`@RequestParam`, `@RequestPart`, path variables) for HTTP-style parameters. For non-HTTP RPC types (Dubbo, SOFA, TARS, gRPC), it fails to extract any meaningful request parameter information, since these RPC types do not use Spring Web annotations.

As a result, the generated API document for RPC types contains `responseType` (response details) but has empty/missing request parameter details — the document only has response, no request.

### Expected Behavior

_No response_

### Steps To Reproduce

_No response_

### Environment

```markdown
ShenYu version(s):
```

### Debug logs

_No response_

### Anything else?

_No response_

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at ApiDocRegistrarImpl.getDocument() and trace how OpenApiUtils.generateDocumentParameters() is applied to each RPC type. Compare the request-parameter handling for Dubbo, SOFA, TARS, and gRPC, then verify that generated API documents include request details as well as the existing responseType information.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.