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 {omitdoc} parameter property #58

Merged
merged 1 commit into from Jan 9, 2019

Conversation

Projects
None yet
2 participants
@Carpetsmoker
Copy link
Member

Carpetsmoker commented Jan 9, 2019

Add the {omitdoc} property, so that some struct fields can be omitted
from the generated OpenAPI document.

I decided on {omitdoc}, as "omit" is fairly common in Go, but just
{omit} and {-} is perhaps a but too obscure.

Add {omitdoc} parameter property
Add the {omitdoc} property, so that some struct fields can be omitted
from the generated OpenAPI document.

I decided on {omitdoc}, as "omit" is fairly common in Go, but just
{omit} and {-} is perhaps a but too obscure.

@Carpetsmoker Carpetsmoker requested a review from jrdnull Jan 9, 2019

@codecov

This comment has been minimized.

Copy link

codecov bot commented Jan 9, 2019

Codecov Report

Merging #58 into master will increase coverage by 0.27%.
The diff coverage is 87.5%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #58      +/-   ##
==========================================
+ Coverage    75.1%   75.37%   +0.27%     
==========================================
  Files          10       10              
  Lines        1173     1186      +13     
==========================================
+ Hits          881      894      +13     
  Misses        208      208              
  Partials       84       84
Impacted Files Coverage Δ
docparse/jsonschema.go 71.73% <100%> (+0.2%) ⬆️
openapi2/openapi2.go 91% <85.71%> (+0.52%) ⬆️

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 ab4bee5...62ad2e5. Read the comment docs.

1 similar comment
@codecov

This comment has been minimized.

Copy link

codecov bot commented Jan 9, 2019

Codecov Report

Merging #58 into master will increase coverage by 0.27%.
The diff coverage is 87.5%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #58      +/-   ##
==========================================
+ Coverage    75.1%   75.37%   +0.27%     
==========================================
  Files          10       10              
  Lines        1173     1186      +13     
==========================================
+ Hits          881      894      +13     
  Misses        208      208              
  Partials       84       84
Impacted Files Coverage Δ
docparse/jsonschema.go 71.73% <100%> (+0.2%) ⬆️
openapi2/openapi2.go 91% <85.71%> (+0.52%) ⬆️

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 ab4bee5...62ad2e5. Read the comment docs.

@jrdnull

jrdnull approved these changes Jan 9, 2019

Copy link
Contributor

jrdnull left a comment

Thanks, tested it out in my project and worked as expected 👍

@jrdnull jrdnull merged commit 746adb5 into master Jan 9, 2019

4 checks passed

codecov/patch 87.5% of diff hit (target 75.1%)
Details
codecov/project 75.37% (+0.27%) compared to ab4bee5
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@jrdnull jrdnull deleted the omitdoc branch Jan 9, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment