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

tags.name which is showing in doc was the description in version 2.x.x but now is modified to the class name in version 3.0.0 #964

Open
3 tasks done
jackmiking opened this issue Nov 26, 2024 · 3 comments

Comments

@jackmiking
Copy link

Contact Details

[email protected]

Version

3.0.9

Plugin

smart-doc-maven-plugin

Build tool version

3.0.9

Jdk version

11

Describe the bug (Bug描述,社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

the tags[].name in the generated file is modified to controller's name. Torna or Yapi use (tags[].name) as the group name showing in the page. That make the class name exposing to user which make it hard to understand.

Expected Behavior (您期望的结果,社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

please use the description as the tags[].name first if it is presented.

Current Behavior (当前结果,社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

use the controller's name as the tags[].name

Steps to Reproduce (Bug产生步骤,请尽量提供用例代码。社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

it is a general situation.

  1. add a description to a controller
  2. generated the openapi json format doc.
  3. the tags[].name in the generated doc is using the controller name instead the description.

Possible Solution (Bug解决建议,社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

No response

Context (Bug影响描述,社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

No response

Validations

  • Check if you're on the latest smart-doc version. (请检查是否为最新版本)
  • Read the docs. (请先阅读官方文档)
  • Check that there isn't already an issue that reports the same bug to avoid creating a duplicate. (检查是否存在报告相同错误的问题,以避免产生重复)
@shalousun
Copy link
Collaborator

The issue seems to be that some community users need the controller's name when generating code using OpenAPI.

@jackmiking
Copy link
Author

jackmiking commented Nov 26, 2024 via email

@jackmiking
Copy link
Author

could there be a flag to set whether to use controller name as tags name ?

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

No branches or pull requests

2 participants