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.

Sign up for GitHub

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

Jump to bottom

Feature/implement response headers v2 #1841

Merged
merged 20 commits into from
Nov 25, 2020
Merged

Feature/implement response headers v2 #1841

merged 20 commits into from
Nov 25, 2020

Conversation

elijah-roberts
Copy link
Contributor

@elijah-roberts elijah-roberts commented Nov 25, 2020 •
edited
Loading

Pulling in changes from #1730 to v2

protoc-gen-swagger: Implement Response Header(s) object, Implement Field Enum,Example&Format attributes #1729

References to other Issues or PRs

#1729

Have you read the Contributing Guidelines?

Yes

Brief description of what is fixed or changed

I have implemented the following:

  • openapi headers object proto
  • openapi header object proto, implementing the Description, Type, Format, Default, and Pattern fields
  • updated the response proto to use the headers/header objects
  • updated the jsonSchema proto to implement the Format, Example and Enum fields
  • implemented/updated template structs to match the above proto changes
  • implemented validation of Type field (must be one of Integer, Number, Boolean, String)
  • implemented validation of Default field(any.Any type that must match the Type field)
  • created tests to cover Header(s) logic, and validation functions
  • updated example proto with example usage for adding headers, and using added fields

Other comments

Per the contributing guidelines I run the 2 docker commands, and attached the updated files to my PR

johanbrandhorst and others added 20 commits October 10, 2020 16:01
@johanbrandhorst
Update v1 renovate config (grpc-ecosystem#1738)
384bafa 
Not even sure if renovate cares to check this branch
but it can't hurt.
@johanbrandhorst
Update gorelease base for v1 (grpc-ecosystem#1748)
f6391fc
@elijah-roberts
feat: protoc-gen-swagger: Implement Response Header(s) object, Implem…
2831fda 
…ent Field Enum,Example&Format attributes grpc-ecosystem#1729
@elijah-roberts
fix: resolve linting errors
2a0e115
@elijah-roberts
fix: running per CI
cfa0455
@elijah-roberts
fix: Resolve PR requests
dfa5c22 
* a bunch of whitespace/format changes... have since added this to my IDE
* remove any.Any objects, and convert them to string
* move runtime regex strings to global variables
* update examples
* update tests
@elijah-roberts
fix: Running go mode tidy to cleanup go.mod and go.sum
f4ed5a6
@elijah-roberts
fix: Resolving PR comments
e615b55 
* remove regex logic, and update functions to use simple booleans
* cleanup example proto
* enforce CanonicalMIMEHeaderKey for header name
@elijah-roberts @johanbrandhorst
Update protoc-gen-swagger/genswagger/template.go
c943e16 
simplifying string check

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
@elijah-roberts @johanbrandhorst
Update protoc-gen-swagger/genswagger/template.go
7672f81 
fix: remove string comparisons

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
@elijah-roberts
fix: resolving MR requests
1cea661
@elijah-roberts
fix: unqouting error
5ef99d0
@elijah-roberts @johanbrandhorst
Update protoc-gen-swagger/genswagger/template.go
23275bf 
Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
@elijah-roberts @johanbrandhorst
Update protoc-gen-swagger/genswagger/template.go
89d01c9 
Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
@elijah-roberts
fix: adding requested changes
9b22951 
* parse unsigned ints with strconv.ParseUint
* update unqoute logic
@elijah-roberts
Updating integer switch
968e362
@johanbrandhorst
Minor nits
bbb50e6
@johanbrandhorst
Remove extra newlines
9e9c879
@elijah-roberts
Updating for v2
2079fa9
@elijah-roberts
Pulling in changes for v2
05b3e74
@google-cla
Copy link

google-cla bot commented Nov 25, 2020

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

@google-cla google-cla bot added the cla: no label Nov 25, 2020
@elijah-roberts elijah-roberts mentioned this pull request Nov 25, 2020
Merged
@elijah-roberts
Copy link
Contributor Author

@googlebot I consent.

@google-cla
Copy link

google-cla bot commented Nov 25, 2020

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

@johanbrandhorst
Copy link
Collaborator

@googlebot I consent.

@google-cla google-cla bot added cla: yes and removed cla: no labels Nov 25, 2020
johanbrandhorst
johanbrandhorst approved these changes Nov 25, 2020
View reviewed changes
Copy link
Collaborator

@johanbrandhorst johanbrandhorst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for this, I hope it wasn't too much trouble adapting from v1 to v2 😄. This PR still looks great!

@johanbrandhorst johanbrandhorst merged commit 865774a into grpc-ecosystem:master Nov 25, 2020
@EraYaN EraYaN mentioned this pull request Jun 9, 2021
Open
@johanbrandhorst johanbrandhorst mentioned this pull request Jul 9, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johanbrandhorst johanbrandhorst johanbrandhorst approved these changes

Assignees
No one assigned
Labels
cla: yes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@elijah-roberts @johanbrandhorst