Skip to content

Support human readable project name #7357

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

Merged
klesh merged 3 commits into from
Apr 22, 2024
Merged

Support human readable project name #7357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a7d9a3
feat: name your project whatever you like
Apr 22, 2024
07e44ff
docs: add comment explaing why router.UseRawPath is needed
Apr 22, 2024
63bfffc
fix: python test
Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions backend/server/api/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@ func CreateApiServer() *gin.Engine {
func SetupApiServer(router *gin.Engine) {
// Set gin mode
gin.SetMode(basicRes.GetConfig("MODE"))
// Required for `/projects/hello%20%2F%20world` to be parsed properly with `/projects/:projectName`
// end up with `name = "hello / world"`
router.UseRawPath = true

// Endpoint to proceed database migration
router.GET("/proceed-db-migration", func(ctx *gin.Context) {
Expand Down
4 changes: 2 additions & 2 deletions backend/server/api/project/project.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ func PostProject(c *gin.Context) {
// @Failure 500 {string} errcode.Error "Internal Error"
// @Router /projects/:projectName [patch]
func PatchProject(c *gin.Context) {
projectName := c.Param("projectName")[1:]
projectName := c.Param("projectName")

var body map[string]interface{}
err := c.ShouldBind(&body)
Expand All @@ -171,7 +171,7 @@ func PatchProject(c *gin.Context) {
// @Failure 500 {string} errcode.Error "Internal Error"
// @Router /projects/:projectName [delete]
func DeleteProject(c *gin.Context) {
projectName := c.Param("projectName")[1:]
projectName := c.Param("projectName")
err := services.DeleteProject(projectName)
if err != nil {
shared.ApiOutputError(c, errors.Default.Wrap(err, "error deleting project"))
Expand Down
4 changes: 2 additions & 2 deletions backend/server/api/router.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ func RegisterRouter(r *gin.Engine, basicRes context.BasicRes) {
// project api
r.GET("/projects/:projectName", project.GetProject)
r.GET("/projects/:projectName/check", project.GetProjectCheck)
r.PATCH("/projects/*projectName", project.PatchProject)
r.DELETE("/projects/*projectName", project.DeleteProject)
r.PATCH("/projects/:projectName", project.PatchProject)
r.DELETE("/projects/:projectName", project.DeleteProject)
r.POST("/projects", project.PostProject)
r.GET("/projects", project.GetProjects)
// on board api
Expand Down