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

V2: Support produce comment #1551

Merged
merged 3 commits into from
Apr 17, 2023
Merged

V2: Support produce comment #1551

merged 3 commits into from
Apr 17, 2023

Conversation

Nerzal
Copy link
Contributor

@Nerzal Nerzal commented Apr 14, 2023

Describe the PR
Add basic support for the produce comment.
The implementation is based on some assumptions and is only been done to be able to parse swaggo v1 comments.

Relation issue
#1550

Additional context
We should update the //@Success comment in the future to incorporate the changes and additional fields of open api v3.1.0.
The support of the produce comment is more of a workaround right now.

Looking at the structure of the V3 data, i'd recommend either additional comment types or expanding the //@Success.
image

@Nerzal Nerzal added enhancement v2 Used for all v2 related issues labels Apr 14, 2023
@codecov
Copy link

codecov bot commented Apr 14, 2023

Codecov Report

Patch coverage: 80.48% and project coverage change: +0.01 🎉

Comparison is base (a3046bf) 77.66% compared to head (bddf978) 77.67%.

❗ Current head bddf978 differs from pull request most recent head 54675d1. Consider uploading reports for the commit 54675d1 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##               v2    #1551      +/-   ##
==========================================
+ Coverage   77.66%   77.67%   +0.01%     
==========================================
  Files          21       21              
  Lines        5488     5528      +40     
==========================================
+ Hits         4262     4294      +32     
- Misses       1044     1048       +4     
- Partials      182      186       +4     
Impacted Files Coverage Δ
parserv3.go 74.78% <50.00%> (-0.22%) ⬇️
operationv3.go 83.60% <83.78%> (+0.01%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@ubogdan ubogdan merged commit 21247c7 into swaggo:v2 Apr 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement v2 Used for all v2 related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants