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

Added swaggo operation ID & renamed handlers #79

Merged
merged 6 commits into from
Sep 27, 2021

Conversation

applejag
Copy link
Contributor

@applejag applejag commented Sep 20, 2021

Summary

  • Added Swaggo // @id comment field, which adds Swagger operation IDs to the endpoints.
  • Changed name of Gin handler methods to correlate with the new Swagger op IDs

Motivation

Closes #67

@applejag applejag added the documentation Improvements or additions to documentation label Sep 20, 2021
@applejag applejag self-assigned this Sep 20, 2021
@applejag applejag added this to the RFC-0016 milestone Sep 20, 2021
Copy link
Member

@Alexamakans Alexamakans left a comment

Choose a reason for hiding this comment

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

LGTM! 👍🏻

branch.go Outdated
@@ -19,28 +19,30 @@ type branchModule struct {
func (m branchModule) Register(g *gin.RouterGroup) {
branches := g.Group("/branches")
{
branches.GET("", m.GetBranchesHandler)
branches.PUT("", m.PutBranchesHandler)
branches.GET("", m.getBrancheListHandler)
Copy link
Member

Choose a reason for hiding this comment

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

s/getBrancheListHandler/getBranchListHandler/

CHANGELOG.md Outdated Show resolved Hide resolved
@Alexamakans
Copy link
Member

Wouldn't this potentially count as a MAJOR version bump, since the function names when generating rest clients over at wharf-web will change? Or is it decoupled in a way that makes it not really count?

Copy link

@iverestefans iverestefans left a comment

Choose a reason for hiding this comment

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

LGTM!

@applejag
Copy link
Contributor Author

Wouldn't this potentially count as a MAJOR version bump, since the function names when generating rest clients over at wharf-web will change? Or is it decoupled in a way that makes it not really count?

The endpoints stay the same. So older versions will still work with the new version.

@applejag applejag merged commit 7cad157 into master Sep 27, 2021
@applejag applejag deleted the feature/add-swaggo-op-id branch September 27, 2021 08:48
@applejag applejag removed this from the RFC-0016 milestone Oct 12, 2021
@applejag applejag added this to the RFC-0016 milestone Nov 18, 2021
@applejag applejag mentioned this pull request Jan 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Swagger operation IDs to all endpoints
3 participants