Cb-tumblebug: Fix some REST API's HTTP methods

[jihoon-seo]

What happened
:
Some REST API's HTTP methods are inappropriate.

What you expected to happen
:

How to reproduce it (as minimally and precisely as possible)
:

Anything else we need to know?
:

Environment

• Source version or branch:
• OS:
• Others:

Proposed solution
:

cb-tumblebug/src/api/rest/server/server.go

-   g.POST("/:nsId/resources/filterSpecs", rest_mcir.RestFilterSpecs)
-   g.POST("/:nsId/resources/filterSpecsByRange", rest_mcir.RestFilterSpecsByRange)
-   g.POST("/:nsId/resources/testSortSpecs", rest_mcir.RestTestSortSpecs)
-
-   g.POST("/:nsId/resources/searchImage", rest_mcir.RestSearchImage)

+   g.GET("/:nsId/resources/filterSpecs", rest_mcir.RestFilterSpecs)
+   g.GET("/:nsId/resources/filterSpecsByRange", rest_mcir.RestFilterSpecsByRange)
+   g.GET("/:nsId/resources/testSortSpecs", rest_mcir.RestTestSortSpecs)
+
+   g.GET("/:nsId/resources/searchImage", rest_mcir.RestSearchImage)

In addition, related Swagger annotations also need to be updated.

cb-tumblebug/src/api/rest/server/mcir/spec.go

-// @Router /ns/{nsId}/resources/filterSpecs [post]
+// @Router /ns/{nsId}/resources/filterSpecs [get]

+ Swagger doc 파일도 re-generate 하시면 좋습니다.
다만 첫 기여자께서 Swagger doc 파일 업데이트가 어려우시다면
이 부분은 빼고 PR을 올려 주시면
CB-Tumblebug 메인테이너가 추후에 별도의 PR에서 Swagger doc 파일을 업데이트하는 것도 가능합니다. 😊

+ 만약 cb-webtool 에서 해당 REST API 를 활용중이었다면,
cb-webtool 에서 CB-Tumblebug 을 호출하는 부분의
HTTP method 도 업데이트가 필요합니다.

Any other context
:

[seokho-son]

@jihoon-seo
혹시 해당 REST method는 Swagger API 에서 Body가 있는 GET method를 허용하지 않아서,
의도적으로 POST method로 지정한 것은 아닌가요? ^^
ref: https://github.com/cloud-barista/cb-tumblebug/discussions/502

[jihoon-seo]

@seokho-son 맞네요.. 깜빡했습니다 😢

[jihoon-seo]

다음 REST API는 호출할 때 JSON body를 적어야 하는데 GET method로 되어 있습니다.

cb-tumblebug/src/api/rest/server/server.go

e.GET("/tumblebug/lookupSpec", rest_mcir.RestLookupSpec)

e.GET("/tumblebug/lookupImage", rest_mcir.RestLookupImage)

cb-tumblebug/src/api/rest/server/mcir/spec.go

// Request structure for RestLookupSpec
type RestLookupSpecRequest struct {
    ConnectionName string `json:"connectionName"`
    CspSpecName    string `json:"cspSpecName"`
}

// RestLookupSpec godoc
// @Summary Lookup spec
// @Description Lookup spec
// @Tags [Admin] Cloud environment management
// @Accept  json
// @Produce  json
// @Param lookupSpecReq body RestLookupSpecRequest true "Specify connectionName & cspSpecName"
// @Success 200 {object} mcir.SpiderSpecInfo
// @Failure 404 {object} common.SimpleMsg
// @Failure 500 {object} common.SimpleMsg
// @Router /lookupSpec [get]
func RestLookupSpec(c echo.Context) error {
    u := &RestLookupSpecRequest{}
    if err := c.Bind(u); err != nil {
        return err
    }

    fmt.Println("[Lookup spec]: " + u.CspSpecName)
    content, err := mcir.LookupSpec(u.ConnectionName, u.CspSpecName)
    if err != nil {
        common.CBLog.Error(err)
        return c.JSONBlob(http.StatusNotFound, []byte(err.Error()))
    }

    return c.JSON(http.StatusOK, &content)

}

cb-tumblebug/src/api/rest/server/mcir/image.go

// Request structure for RestLookupImage
type RestLookupImageRequest struct {
    ConnectionName string `json:"connectionName"`
    CspImageId     string `json:"cspImageId"`
}

// RestLookupImage godoc
// @Summary Lookup image
// @Description Lookup image
// @Tags [Admin] Cloud environment management
// @Accept  json
// @Produce  json
// @Param lookupImageReq body RestLookupImageRequest true "Specify connectionName & cspImageId"
// @Success 200 {object} mcir.SpiderImageInfo
// @Failure 404 {object} common.SimpleMsg
// @Failure 500 {object} common.SimpleMsg
// @Router /lookupImage [get]
func RestLookupImage(c echo.Context) error {

    u := &RestLookupImageRequest{}
    if err := c.Bind(u); err != nil {
        return err
    }

    fmt.Println("[Lookup image]: " + u.CspImageId)
    content, err := mcir.LookupImage(u.ConnectionName, u.CspImageId)
    if err != nil {
        common.CBLog.Error(err)
        return c.JSONBlob(http.StatusNotFound, []byte(err.Error()))
    }

    return c.JSON(http.StatusOK, &content)

}

---

아래 REST API들은 일반적인 REST 스타일과 다르게 되어 있습니다.

    e.GET("/tumblebug/lookupSpecs", rest_mcir.RestLookupSpecList)
    e.GET("/tumblebug/lookupSpec", rest_mcir.RestLookupSpec)

    e.GET("/tumblebug/lookupImages", rest_mcir.RestLookupImageList)
    e.GET("/tumblebug/lookupImage", rest_mcir.RestLookupImage)

cf) 일반적인 REST 스타일

    e.GET("/tumblebug/region", rest_common.RestGetRegionList)
    e.GET("/tumblebug/region/:regionName", rest_common.RestGetRegion)

[atg0831]

@jihoon-seo
Request에 body 값을 넣어서 REST API를 호출하기 위해서 method를 e.GET 에서 e.POST 로 변경하라는 뜻으로
이해했는데 혹시 맞을까요?

[seokho-son]

@atg0831 환영합니다.. ^0^
@jihoon-seo 신규 기여자를 위해, 해당 이슈에 대해서 조금 상세하게 가이드 부탁 드려도 될까요? ^^

[jihoon-seo]

[atg0831]

[seokho-son]

[seokho-son]