Skip to content

Commit

Permalink
Fix API typo and tags (#952)
Browse files Browse the repository at this point in the history
* Fix typo resouce to resource

* Change API category name

* Rename API group tags
  • Loading branch information
jihoon-seo authored Nov 10, 2021
2 parents f0b358f + a176337 commit d3817f3
Show file tree
Hide file tree
Showing 26 changed files with 950 additions and 950 deletions.
126 changes: 63 additions & 63 deletions src/api/rest/docs/v0.3.10.yaml

Large diffs are not rendered by default.

126 changes: 63 additions & 63 deletions src/api/rest/docs/v0.3.12.yaml

Large diffs are not rendered by default.

122 changes: 61 additions & 61 deletions src/api/rest/docs/v0.3.5.yaml

Large diffs are not rendered by default.

126 changes: 63 additions & 63 deletions src/api/rest/docs/v0.4.0.yaml

Large diffs are not rendered by default.

144 changes: 72 additions & 72 deletions src/api/rest/docs/v0.4.10.yaml

Large diffs are not rendered by default.

144 changes: 72 additions & 72 deletions src/api/rest/docs/v0.4.11.yaml

Large diffs are not rendered by default.

148 changes: 74 additions & 74 deletions src/api/rest/docs/v0.4.12.yaml

Large diffs are not rendered by default.

130 changes: 65 additions & 65 deletions src/api/rest/docs/v0.4.4.yaml

Large diffs are not rendered by default.

130 changes: 65 additions & 65 deletions src/api/rest/docs/v0.4.5.yaml

Large diffs are not rendered by default.

130 changes: 65 additions & 65 deletions src/api/rest/docs/v0.4.6.yaml

Large diffs are not rendered by default.

130 changes: 65 additions & 65 deletions src/api/rest/docs/v0.4.7.yaml

Large diffs are not rendered by default.

130 changes: 65 additions & 65 deletions src/api/rest/docs/v0.4.8.yaml

Large diffs are not rendered by default.

132 changes: 66 additions & 66 deletions src/api/rest/docs/v0.4.9.yaml

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions src/api/rest/server/common/utility.go
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ func RestGetSwagger(c echo.Context) error {
// RestGetConnConfig godoc
// @Summary Get registered ConnConfig info
// @Description Get registered ConnConfig info
// @Tags [Admin] Cloud environment management
// @Tags [Admin] Multi-Cloud environment configuration
// @Accept json
// @Produce json
// @Param connConfigName path string true "Name of connection config (cloud config)"
Expand All @@ -146,7 +146,7 @@ func RestGetConnConfig(c echo.Context) error {
// RestGetConnConfigList godoc
// @Summary List all registered ConnConfig
// @Description List all registered ConnConfig
// @Tags [Admin] Cloud environment management
// @Tags [Admin] Multi-Cloud environment configuration
// @Accept json
// @Produce json
// @Success 200 {object} common.ConnConfigList
Expand All @@ -170,7 +170,7 @@ func RestGetConnConfigList(c echo.Context) error {
// RestGetRegion godoc
// @Summary Get registered region info
// @Description Get registered region info
// @Tags [Admin] Cloud environment management
// @Tags [Admin] Multi-Cloud environment configuration
// @Accept json
// @Produce json
// @Param regionName path string true "Name of region to retrieve"
Expand All @@ -197,7 +197,7 @@ func RestGetRegion(c echo.Context) error {
// RestGetRegionList godoc
// @Summary List all registered regions
// @Description List all registered regions
// @Tags [Admin] Cloud environment management
// @Tags [Admin] Multi-Cloud environment configuration
// @Accept json
// @Produce json
// @Success 200 {object} common.RegionList
Expand Down Expand Up @@ -337,7 +337,7 @@ type RestInspectResourcesRequest struct {
// RestInspectResources godoc
// @Summary Inspect Resources (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug, CB-Spider, CSP
// @Description Inspect Resources (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug, CB-Spider, CSP
// @Tags [Admin] Cloud environment management
// @Tags [Admin] System management
// @Accept json
// @Produce json
// @Param connectionName body RestInspectResourcesRequest true "Specify connectionName and resource type"
Expand Down
20 changes: 10 additions & 10 deletions src/api/rest/server/mcir/common.go
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ func RestGetResource(c echo.Context) error {
// RestCheckResource godoc
// @Summary Check resources' existence
// @Description Check resources' existence
// @Tags [Admin] System management
// @Tags [Infra resource] MCIR Common
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand Down Expand Up @@ -317,7 +317,7 @@ func RestTestGetAssociatedObjectCount(c echo.Context) error {
// RestLoadCommonResource godoc
// @Summary Load Common Resources from internal asset files
// @Description Load Common Resources from internal asset files (Spec, Image)
// @Tags [Admin] Cloud environment management
// @Tags [Admin] Multi-Cloud environment configuration
// @Accept json
// @Produce json
// @Success 200 {object} common.IdList
Expand All @@ -335,19 +335,19 @@ func RestLoadCommonResource(c echo.Context) error {
return c.JSON(http.StatusOK, output)
}

// RestLoadDefaultResouce godoc
// RestLoadDefaultResource godoc
// @Summary Load Default Resource from internal asset file
// @Description Load Default Resource from internal asset file
// @Tags [Admin] Cloud environment management
// @Tags [Infra resource] MCIR Common
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
// @Param option query string true "Option" Enums(all,vnet,sg,sshkey)
// @Param connectionName query string false "connectionName of cloud for designated resource" default()
// @Success 200 {object} common.SimpleMsg
// @Failure 404 {object} common.SimpleMsg
// @Router /ns/{nsId}/loadDefaultResouce [get]
func RestLoadDefaultResouce(c echo.Context) error {
// @Router /ns/{nsId}/loadDefaultResource [get]
func RestLoadDefaultResource(c echo.Context) error {
nsId := c.Param("nsId")
resType := c.QueryParam("option")

Expand All @@ -365,17 +365,17 @@ func RestLoadDefaultResouce(c echo.Context) error {
return c.JSON(http.StatusOK, &mapA)
}

// RestDelAllDefaultResouces godoc
// RestDelAllDefaultResources godoc
// @Summary Delete all Default Resource Objects in the given namespace
// @Description Delete all Default Resource Objects in the given namespace
// @Tags [Admin] Cloud environment management
// @Tags [Infra resource] MCIR Common
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
// @Success 200 {object} common.IdList
// @Failure 404 {object} common.SimpleMsg
// @Router /ns/{nsId}/defaultResouces [delete]
func RestDelAllDefaultResouces(c echo.Context) error {
// @Router /ns/{nsId}/defaultResources [delete]
func RestDelAllDefaultResources(c echo.Context) error {

nsId := c.Param("nsId")

Expand Down
20 changes: 10 additions & 10 deletions src/api/rest/server/mcir/image.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import (
// RestPostImage godoc
// @Summary Register image
// @Description Register image
// @Tags [MCIR] Image management
// @Tags [Infra resource] MCIR Image management
// @Accept json
// @Produce json
// @Param registeringMethod query string true "registerWithInfo or registerWithId"
Expand Down Expand Up @@ -89,7 +89,7 @@ func RestPostImage(c echo.Context) error {
// RestPutImage godoc
// @Summary Update image
// @Description Update image
// @Tags [MCIR] Image management
// @Tags [Infra resource] MCIR Image management
// @Accept json
// @Produce json
// @Param imageInfo body mcir.TbImageInfo true "Details for an image object"
Expand Down Expand Up @@ -128,7 +128,7 @@ type RestLookupImageRequest struct {
// RestLookupImage godoc
// @Summary Lookup image
// @Description Lookup image
// @Tags [Admin] Cloud environment management
// @Tags [Infra resource] MCIR Common
// @Accept json
// @Produce json
// @Param lookupImageReq body RestLookupImageRequest true "Specify connectionName & cspImageId"
Expand Down Expand Up @@ -157,7 +157,7 @@ func RestLookupImage(c echo.Context) error {
// RestLookupImageList godoc
// @Summary Lookup image list
// @Description Lookup image list
// @Tags [Admin] Cloud environment management
// @Tags [Infra resource] MCIR Common
// @Accept json
// @Produce json
// @Param lookupImagesReq body common.TbConnectionName true "Specify connectionName"
Expand Down Expand Up @@ -190,7 +190,7 @@ func RestLookupImageList(c echo.Context) error {
// RestFetchImages godoc
// @Summary Fetch images
// @Description Fetch images
// @Tags [MCIR] Image management
// @Tags [Infra resource] MCIR Image management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand Down Expand Up @@ -245,7 +245,7 @@ func RestFetchImages(c echo.Context) error {
// RestGetImage godoc
// @Summary Get image
// @Description Get image
// @Tags [MCIR] Image management
// @Tags [Infra resource] MCIR Image management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand All @@ -267,7 +267,7 @@ type RestGetAllImageResponse struct {
// RestGetAllImage godoc
// @Summary List all images or images' ID
// @Description List all images or images' ID
// @Tags [MCIR] Image management
// @Tags [Infra resource] MCIR Image management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand All @@ -284,7 +284,7 @@ func RestGetAllImage(c echo.Context) error {
// RestDelImage godoc
// @Summary Delete image
// @Description Delete image
// @Tags [MCIR] Image management
// @Tags [Infra resource] MCIR Image management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand All @@ -300,7 +300,7 @@ func RestDelImage(c echo.Context) error {
// RestDelAllImage godoc
// @Summary Delete all images
// @Description Delete all images
// @Tags [MCIR] Image management
// @Tags [Infra resource] MCIR Image management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand All @@ -321,7 +321,7 @@ type RestSearchImageRequest struct {
// RestSearchImage godoc
// @Summary Search image
// @Description Search image
// @Tags [MCIR] Image management
// @Tags [Infra resource] MCIR Image management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand Down
12 changes: 6 additions & 6 deletions src/api/rest/server/mcir/securitygroup.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import (
// RestPostSecurityGroup godoc
// @Summary Create Security Group
// @Description Create Security Group
// @Tags [MCIR] Security group management
// @Tags [Infra resource] MCIR Security group management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand Down Expand Up @@ -64,7 +64,7 @@ func RestPostSecurityGroup(c echo.Context) error {
// RestPutSecurityGroup godoc
// @Summary Update Security Group
// @Description Update Security Group
// @Tags [MCIR] Security group management
// @Tags [Infra resource] MCIR Security group management
// @Accept json
// @Produce json
// @Param securityGroupInfo body mcir.TbSecurityGroupInfo true "Details for an securityGroup object"
Expand All @@ -82,7 +82,7 @@ func RestPutSecurityGroup(c echo.Context) error {
// RestGetSecurityGroup godoc
// @Summary Get Security Group
// @Description Get Security Group
// @Tags [MCIR] Security group management
// @Tags [Infra resource] MCIR Security group management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand All @@ -104,7 +104,7 @@ type RestGetAllSecurityGroupResponse struct {
// RestGetAllSecurityGroup godoc
// @Summary List all Security Groups or Security Groups' ID
// @Description List all Security Groups or Security Groups' ID
// @Tags [MCIR] Security group management
// @Tags [Infra resource] MCIR Security group management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand All @@ -121,7 +121,7 @@ func RestGetAllSecurityGroup(c echo.Context) error {
// RestDelSecurityGroup godoc
// @Summary Delete Security Group
// @Description Delete Security Group
// @Tags [MCIR] Security group management
// @Tags [Infra resource] MCIR Security group management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand All @@ -137,7 +137,7 @@ func RestDelSecurityGroup(c echo.Context) error {
// RestDelAllSecurityGroup godoc
// @Summary Delete all Security Groups
// @Description Delete all Security Groups
// @Tags [MCIR] Security group management
// @Tags [Infra resource] MCIR Security group management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand Down
22 changes: 11 additions & 11 deletions src/api/rest/server/mcir/spec.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import (
// RestPostSpec godoc
// @Summary Register spec
// @Description Register spec
// @Tags [MCIR] Spec management
// @Tags [Infra resource] MCIR Spec management
// @Accept json
// @Produce json
// @Param registeringMethod query string true "registerWithInfo or else"
Expand Down Expand Up @@ -84,7 +84,7 @@ func RestPostSpec(c echo.Context) error {
// RestPutSpec godoc
// @Summary Update spec
// @Description Update spec
// @Tags [MCIR] Spec management
// @Tags [Infra resource] MCIR Spec management
// @Accept json
// @Produce json
// @Param specInfo body mcir.TbSpecInfo true "Details for an spec object"
Expand Down Expand Up @@ -123,7 +123,7 @@ type RestLookupSpecRequest struct {
// RestLookupSpec godoc
// @Summary Lookup spec
// @Description Lookup spec
// @Tags [Admin] Cloud environment management
// @Tags [Infra resource] MCIR Common
// @Accept json
// @Produce json
// @Param lookupSpecReq body RestLookupSpecRequest true "Specify connectionName & cspSpecName"
Expand Down Expand Up @@ -151,7 +151,7 @@ func RestLookupSpec(c echo.Context) error {
// RestLookupSpecList godoc
// @Summary Lookup spec list
// @Description Lookup spec list
// @Tags [Admin] Cloud environment management
// @Tags [Infra resource] MCIR Common
// @Accept json
// @Produce json
// @Param lookupSpecsReq body common.TbConnectionName true "Specify connectionName"
Expand Down Expand Up @@ -184,7 +184,7 @@ func RestLookupSpecList(c echo.Context) error {
// RestFetchSpecs godoc
// @Summary Fetch specs
// @Description Fetch specs
// @Tags [MCIR] Spec management
// @Tags [Infra resource] MCIR Spec management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand Down Expand Up @@ -236,7 +236,7 @@ type RestFilterSpecsResponse struct {
// RestFilterSpecs godoc
// @Summary Filter specs
// @Description Filter specs
// @Tags [MCIR] Spec management
// @Tags [Infra resource] MCIR Spec management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand Down Expand Up @@ -270,7 +270,7 @@ func RestFilterSpecs(c echo.Context) error {
// RestFilterSpecsByRange godoc
// @Summary Filter specs by range
// @Description Filter specs by range
// @Tags [MCIR] Spec management
// @Tags [Infra resource] MCIR Spec management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand Down Expand Up @@ -332,7 +332,7 @@ func RestTestSortSpecs(c echo.Context) error {
// RestGetSpec godoc
// @Summary Get spec
// @Description Get spec
// @Tags [MCIR] Spec management
// @Tags [Infra resource] MCIR Spec management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand All @@ -354,7 +354,7 @@ type RestGetAllSpecResponse struct {
// RestGetAllSpec godoc
// @Summary List all specs or specs' ID
// @Description List all specs or specs' ID
// @Tags [MCIR] Spec management
// @Tags [Infra resource] MCIR Spec management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand All @@ -371,7 +371,7 @@ func RestGetAllSpec(c echo.Context) error {
// RestDelSpec godoc
// @Summary Delete spec
// @Description Delete spec
// @Tags [MCIR] Spec management
// @Tags [Infra resource] MCIR Spec management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand All @@ -387,7 +387,7 @@ func RestDelSpec(c echo.Context) error {
// RestDelAllSpec godoc
// @Summary Delete all specs
// @Description Delete all specs
// @Tags [MCIR] Spec management
// @Tags [Infra resource] MCIR Spec management
// @Accept json
// @Produce json
// @Param nsId path string true "Namespace ID" default(ns01)
Expand Down
Loading

0 comments on commit d3817f3

Please sign in to comment.