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

add support for empty response #989

Merged
merged 1 commit into from
Aug 31, 2021
Merged

Conversation

ubogdan
Copy link
Contributor

@ubogdan ubogdan commented Aug 30, 2021

Describe the PR
Add support for "nil" type for the empty response

Relation issue
#941 #1163

Additional context
NONE

@codecov
Copy link

codecov bot commented Aug 30, 2021

Codecov Report

Merging #989 (3861e45) into master (0bbefcf) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #989   +/-   ##
=======================================
  Coverage   92.50%   92.51%           
=======================================
  Files           8        8           
  Lines        1921     1923    +2     
=======================================
+ Hits         1777     1779    +2     
  Misses         81       81           
  Partials       63       63           
Impacted Files Coverage Δ
schema.go 100.00% <ø> (ø)
operation.go 94.26% <100.00%> (+0.01%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0bbefcf...3861e45. Read the comment docs.

@sdghchj sdghchj merged commit eef90d0 into master Aug 31, 2021
@sdghchj sdghchj deleted the support_for_empty_response branch August 31, 2021 02:41
@cristian-aldea
Copy link

Hello, I wanted to make a PR to document this features that was added.

Do I just need to update the README?
Do I need to update any other parts of this project to update this page? https://swaggo.github.io/swaggo.io/declarative_comments_format/api_operation.html

@ubogdan
Copy link
Contributor Author

ubogdan commented Mar 18, 2022

Technically all the features need to be updated in README.md and README_zh-CN.md.
I'm ok if you update only the English version.

@cristian-aldea
Copy link

I'll see if I can update both.

Thanks, I'll send the PR sometime this weekend

@cristian-aldea
Copy link

cristian-aldea commented Mar 19, 2022

There seems to be some discrepancy between the content for "Param Type" in https://swaggo.github.io/swaggo.io/declarative_comments_format/api_operation.html and in the README.md. Which is the source of truth?

"Param Type" in README:

- query
- path
- header
- body
- formData

"Param Type" on website:

* object (struct)
* string (string)
* integer (int, uint, uint32, uint64)
* number (float32)
* boolean (bool)
* array

The content from https://swaggo.github.io/swaggo.io/ seems more accurate, but where does it come from?

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.

3 participants