From 91ca4508157f90a92cb9c4888a5bc4881ea83d43 Mon Sep 17 00:00:00 2001 From: seokho-son Date: Tue, 25 Jan 2022 19:42:59 +0900 Subject: [PATCH] Add comments for required params for register --- src/api/rest/server/mcir/securitygroup.go | 2 +- src/api/rest/server/mcir/sshkey.go | 1 + src/api/rest/server/mcir/vnet.go | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/api/rest/server/mcir/securitygroup.go b/src/api/rest/server/mcir/securitygroup.go index 7c33a2657..bcd89604e 100644 --- a/src/api/rest/server/mcir/securitygroup.go +++ b/src/api/rest/server/mcir/securitygroup.go @@ -30,7 +30,7 @@ import ( // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(ns01) -// @Param option query string false "Option" Enums(register) +// @Param option query string false "Option: [required params for register] connectionName, name, vNetId, cspSecurityGroupId" Enums(register) // @Param securityGroupReq body mcir.TbSecurityGroupReq true "Details for an securityGroup object" // @Success 200 {object} mcir.TbSecurityGroupInfo // @Failure 404 {object} common.SimpleMsg diff --git a/src/api/rest/server/mcir/sshkey.go b/src/api/rest/server/mcir/sshkey.go index c3272c220..04d2c0b68 100644 --- a/src/api/rest/server/mcir/sshkey.go +++ b/src/api/rest/server/mcir/sshkey.go @@ -30,6 +30,7 @@ import ( // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(ns01) +// @Param option query string false "Option: [required params for register] connectionName, name, cspSshKeyId, fingerprint, username, publicKey, privateKey" Enums(register) // @Param sshKeyInfo body mcir.TbSshKeyReq true "Details for an SSH Key object" // @Success 200 {object} mcir.TbSshKeyInfo // @Failure 404 {object} common.SimpleMsg diff --git a/src/api/rest/server/mcir/vnet.go b/src/api/rest/server/mcir/vnet.go index 3a2df891c..aa061b43d 100644 --- a/src/api/rest/server/mcir/vnet.go +++ b/src/api/rest/server/mcir/vnet.go @@ -30,7 +30,7 @@ import ( // @Accept json // @Produce json // @Param nsId path string true "Namespace ID" default(ns01) -// @Param option query string false "Option" Enums(register) +// @Param option query string false "Option: [required params for register] connectionName, name, cspVNetId" Enums(register) // @Param vNetReq body mcir.TbVNetReq true "Details for an VNet object" // @Success 200 {object} mcir.TbVNetInfo // @Failure 404 {object} common.SimpleMsg