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

[ISSUE #4988] Fix swagger doc registered appName use contextPath #4989

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

GOODBOY008
Copy link
Member

Close #4988

@codecov-commenter
Copy link

codecov-commenter commented Aug 10, 2023

Codecov Report

Attention: 7 lines in your changes are missing coverage. Please review.

Comparison is base (d8c7b57) 60.99% compared to head (eefd1b1) 60.99%.

Files Patch % Lines
...ervice/manager/impl/RegisterApiDocServiceImpl.java 0.00% 5 Missing ⚠️
...ervice/manager/impl/PullSwaggerDocServiceImpl.java 0.00% 2 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##             master    #4989      +/-   ##
============================================
- Coverage     60.99%   60.99%   -0.01%     
  Complexity     8622     8622              
============================================
  Files          1258     1258              
  Lines         38426    38426              
  Branches       3679     3679              
============================================
- Hits          23439    23438       -1     
  Misses        12871    12871              
- Partials       2116     2117       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lianjunwei
Copy link
Contributor

lianjunwei commented Aug 10, 2023

Is it because the prefix is added with "/"? Because the apidoc generated by Shenyu annotation also uses contextpath as appname (i.e. the tagName field of the tag table). If you want to modify it, it is recommended to also modify the apidoc generated by the shenyu annotation. Strictly speaking, the appname field has not been designed for the database table yet, and we plan to add it later.

@GOODBOY008
Copy link
Member Author

@lianjunwei I am willing to complete the remaining tasks : add appName field in tag object. So can you show me detail plans?

@lianjunwei
Copy link
Contributor

lianjunwei commented Aug 13, 2023

@lianjunwei I am willing to complete the remaining tasks : add appName field in tag object. So can you show me detail plans?

@GOODBOY008 GOODBOY008Hi, The soonest, I will initiate a discussion next weekend, and I will notify you via email(dev@shenyu.apache.org) and WeChat contributor group in advance, and I will also remind you in the WeChat group.

@lianjunwei
Copy link
Contributor

In fact, at present, the apidoc function cannot get the appName, so the contextpath is temporarily used as the appName, and this function may be added later. In addition, the database table should also add the appname field

kimmking
kimmking previously approved these changes Jan 30, 2024
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

Successfully merging this pull request may close these issues.

[BUG] Swagger doc registered appname use contextPath
6 participants