Skip to content
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

Here are a few ideas for generating request parameter documentation: #598

Open
visoeclipse opened this issue Sep 6, 2023 · 3 comments
Open
Labels
enhancement New feature or request

Comments

@visoeclipse
Copy link

visoeclipse commented Sep 6, 2023

Summary(关于这个pr的描述)

Currently, the output parameters include a since document explanation.
It is suggested that request information also be added, including author details.
This way, when a parameter field is added, we can know who added it and when.
Similarly, could the response also be improved with an author parameter description?
目前输出的参数是有since文档说明的,
建议request的也加上,包括author,
这样参数的字段新增是可以知道是谁在什么时候新增的这个字段。
同理响应能不能也完善上author的参数描述

Basic example(pr的用例)

  • @author xxxx
  • @SInCE 2023.09.06 17:21
    If the proposal involves a new or changed API, include a basic code example. Omit this section if it's not applicable.

Motivation(提出这个pr目的)

Why are we doing this? What use cases does it support? What is the expected outcome?

@visoeclipse visoeclipse added the enhancement New feature or request label Sep 6, 2023
@shalousun
Copy link
Collaborator

shalousun commented Sep 6, 2023

@visoeclipse If you're interested, you can join us in contributing to its improvement.

@codelhf
Copy link

codelhf commented Jan 8, 2024

请求入参中,Map类型的能否提供一个自定义参数标签注解,已有接口不能改

@shalousun shalousun changed the title 请求参数文档生成提几个想法 Here are a few ideas for generating request parameter documentation: Mar 10, 2024
@shalousun
Copy link
Collaborator

请求入参中,Map类型的能否提供一个自定义参数标签注解,已有接口不能改

Welcome to contribute with a pull request. It would be great to implement something similar to @response.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants