Skip to content

[go-server] Change Routes type from []Route to map[string]Route#15084

Merged
wing328 merged 3 commits intoOpenAPITools:7.0.xfrom
lwj5:embed
Apr 11, 2023
Merged

[go-server] Change Routes type from []Route to map[string]Route#15084
wing328 merged 3 commits intoOpenAPITools:7.0.xfrom
lwj5:embed

Conversation

@lwj5
Copy link
Copy Markdown
Contributor

@lwj5 lwj5 commented Mar 31, 2023

Change merge branch for PR #10140

Since the operation ID should be unique for each API group, it is more rightly for the routes to be map[string]Route instead of the name being a field of Route.

Also, this allows for easy embedding compared to using []Route.

For example, if you wish to embed the controller and "override" a DeleteOrder you would have to "override" the whole Routes() method like so...

// Routes returns all of the api route for the StoreApiController
func (c *StoreApiController) Routes() Routes {
	return Routes{
		"DeleteOrder": Route{
			strings.ToUpper("Delete"),
			"/v2/store/order/{orderId}",
			c.DeleteOrder,
		},
		"GetInventory": Route{
			strings.ToUpper("Get"),
			"/v2/store/inventory",
			c.GetInventory,
		},
		"GetOrderById": Route{
			strings.ToUpper("Get"),
			"/v2/store/order/{orderId}",
			c.GetOrderById,
		},
		"PlaceOrder": Route{
			strings.ToUpper("Post"),
			"/v2/store/order",
			c.PlaceOrder,
		},
	}
}

Now with the new change, you may do:

// Routes returns all of the api route for the StoreApiController
func (c *StoreApiController) Routes() Routes {
	routes := c.StoreApiController.Routes() // Get "parent" Routes()
	routes["DeleteOrder"] = Route{
		strings.ToUpper("Delete"),
		"/v2/store/order/{orderId}",
		c.DeleteOrder,
	}
	return routes
}

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • In case you are adding a new generator, run the following additional script :
    ./bin/utils/ensure-up-to-date.sh
    
    Commit all changed files.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@lwj5
Copy link
Copy Markdown
Contributor Author

lwj5 commented Mar 31, 2023

@wing328 this was pending for a little from the last PR, now ready to be merged

@antihax (2017/11) @grokify (2018/07) @kemokemo (2018/09) @jirikuncar (2021/01) @ph4r5h4d (2021/04) for review

@wing328
Copy link
Copy Markdown
Member

wing328 commented Apr 10, 2023

@lwj5 thanks for your PRs. Are you free tomorrow (Tue) at around 3pm HKT to have a quick chat (IM) via Slack to quickly go through your PRs?

@lwj5
Copy link
Copy Markdown
Contributor Author

lwj5 commented Apr 10, 2023

@wing328 yes let's do that

@wing328 wing328 merged commit 792c49a into OpenAPITools:7.0.x Apr 11, 2023
@lwj5 lwj5 deleted the embed branch April 11, 2023 08:16
@lwj5 lwj5 restored the embed branch April 11, 2023 08:16
@lwj5 lwj5 deleted the embed branch April 11, 2023 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants