replaced :id in controllers' comment by :execution for better readability

This commit is contained in:
pb 2025-03-10 16:27:16 +01:00
parent 3bbb15c459
commit 4f2a713516

View File

@ -93,7 +93,7 @@ func (c *AdmiraltyController) GetAllTargets() {
// @Description find one Admiralty Target
// @Param id path string true "the name of the target to get"
// @Success 200
// @router /targets/:id [get]
// @router /targets/:execution [get]
func (c *AdmiraltyController) GetOneTarget() {
id := c.Ctx.Input.Param(":id")
serv, err := infrastructure.NewService()
@ -121,7 +121,7 @@ func (c *AdmiraltyController) GetOneTarget() {
// @Description Create an Admiralty Source on remote cluster
// @Param execution path string true "execution id of the workflow"
// @Success 200
// @router /source/:id [post]
// @router /source/:execution [post]
func (c *AdmiraltyController) CreateSource() {
execution := c.Ctx.Input.Param(":execution")
@ -156,7 +156,7 @@ func (c *AdmiraltyController) CreateSource() {
// @Description Create an Admiralty Target in the namespace associated to the executionID
// @Param execution path string true "execution id of the workflow"
// @Success 201
// @router /target/:id [post]
// @router /target/:execution [post]
func (c *AdmiraltyController) CreateAdmiraltyTarget(){
var data map[string]interface{}
@ -208,7 +208,7 @@ func (c *AdmiraltyController) CreateAdmiraltyTarget(){
// @Param execution path string true "execution id of the workflow"
// @Success 200
// @router /secret/:id [get]
// @router /secret/:execution [get]
func(c *AdmiraltyController) GetKubeSecret() {
var data map[string]interface{}
@ -257,7 +257,7 @@ func(c *AdmiraltyController) GetKubeSecret() {
// @Param execution path string true "execution id of the workflow"
// @Param kubeconfig body controllers.Kubeconfig true "Kubeconfig to use when creating secret"
// @Success 200
// @router /secret/:id [post]
// @router /secret/:execution [post]
func (c *AdmiraltyController) CreateKubeSecret() {
var kubeconfig RemoteKubeconfig
var respData map[string]interface{}
@ -308,7 +308,7 @@ func (c *AdmiraltyController) CreateKubeSecret() {
// @Param execution path string true "execution id of the workflow"
// @Success 200
// @Success 203
// @router /node/:id [get]
// @router /node/:execution [get]
func (c *AdmiraltyController) GetNodeReady(){
var secret v1.Secret
@ -438,7 +438,7 @@ func isTokenExpired(token string) (*bool, error){
// @Param execution path string true "execution id of the workflow"
// @Success 200
// @router /kubeconfig/:id [get]
// @router /kubeconfig/:execution [get]
func (c *AdmiraltyController) GetAdmiraltyKubeconfig() {
execution := c.Ctx.Input.Param(":execution")