iuf

package
v0.3.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 3, 2022 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

* * MIT License * * (C) Copyright 2022 Hewlett Packard Enterprise Development LP * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. *

* * MIT License * * (C) Copyright 2022 Hewlett Packard Enterprise Development LP * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. *

* * MIT License * * (C) Copyright 2022 Hewlett Packard Enterprise Development LP * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. *

* * MIT License * * (C) Copyright 2022 Hewlett Packard Enterprise Development LP * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. *

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type IufController 

type IufController struct {
	// contains filtered or unexported fields
}

IufController data type

func NewIufController 

func NewIufController(workflowService services.WorkflowService, iufService services.IufService, logger utils.Logger) IufController

NewIufController creates new Ncn controller

func (IufController) CreateActivity added in v0.3.1 

func (u IufController) CreateActivity(c *gin.Context)

CreateActivity @Summary Create an IUF activity @Param activity body iuf.CreateActivityRequest true "IUF activity" @Tags Activities @Accept json @Produce json @Success 201 @Failure 400 {object} utils.ResponseError @Failure 500 {object} utils.ResponseError @Router /iuf/v1/activities [post]

func (IufController) GetActivity added in v0.3.1 

func (u IufController) GetActivity(c *gin.Context)

GetActivity @Summary Get an IUF activity @Param activity_name path string true "activity name" @Tags Activities @Accept json @Produce json @Success 200 {object} iuf.Activity @Failure 500 {object} utils.ResponseError @Router /iuf/v1/activities/{activity_name} [get]

func (IufController) GetHistory added in v0.3.1 

func (u IufController) GetHistory(c *gin.Context)

GetHistory @Summary Get a history item of an iuf activity @Param start_time path string true "start time of a history item" @Tags History @Accept json @Produce json @Success 200 {object} iuf.History @Failure 501 "Not Implemented" @Router /iuf/v1/activities/{activity_id}/history/{start_time} [get]

func (IufController) GetSession added in v0.3.1 

func (u IufController) GetSession(c *gin.Context)

GetSession @Summary Get a session of an IUF activity @Param activity_name path string true "activity name" @Param session_name path string true "session name" @Tags Sessions @Accept json @Produce json @Success 200 {object} iuf.Session @Failure 501 "Not Implemented" @Router /iuf/v1/activities/{activity_name}/sessions/{session_name} [get]

func (IufController) HistoryAbortAction added in v0.3.1 

func (u IufController) HistoryAbortAction(c *gin.Context)

HistoryAbortAction @Summary Abort a session @Param activity_name path string true "activity name" @Param action_request body iuf.HistoryActionRequest true "Action Request" @Tags History @Accept json @Produce json @Success 201 "Created" @Failure 501 "Not Implemented" @Router /iuf/v1/activities/{activity_name}/history/abort [post]

func (IufController) HistoryBlockedAction added in v0.3.1 

func (u IufController) HistoryBlockedAction(c *gin.Context)

HistoryBlockedAction @Summary Mark a session blocked @Param activity_name path string true "activity name" @Param action_request body iuf.HistoryActionRequest true "Action Request" @Tags History @Accept json @Produce json @Success 201 "Created" @Failure 501 "Not Implemented" @Router /iuf/v1/activities/{activity_name}/history/blocked [post]

func (IufController) HistoryPausedAction added in v0.3.1 

func (u IufController) HistoryPausedAction(c *gin.Context)

HistoryPausedAction @Summary Pause a session @Param activity_name path string true "activity name" @Param action_request body iuf.HistoryActionRequest true "Action Request" @Tags History @Accept json @Produce json @Success 201 "Created" @Failure 501 "Not Implemented" @Router /iuf/v1/activities/{activity_name}/history/paused [post]

func (IufController) HistoryResumeAction added in v0.3.1 

func (u IufController) HistoryResumeAction(c *gin.Context)

HistoryResumeAction @Summary Resume an activity @Param activity_name path string true "activity name" @Param action_request body iuf.HistoryActionRequest true "Action Request" @Tags History @Accept json @Produce json @Success 201 "Created" @Failure 501 "Not Implemented" @Router /iuf/v1/activities/{activity_name}/history/resume [post]

func (IufController) HistoryRunAction added in v0.3.1 

func (u IufController) HistoryRunAction(c *gin.Context)

HistoryRunAction @Summary Run a session @Param activity_name path string true "activity name" @Param action_request body iuf.HistoryActionRequest true "Action Request" @Tags History @Accept json @Produce json @Success 201 "Created" @Failure 501 "Not Implemented" @Router /iuf/v1/activities/{activity_name}/history/run [post]

func (IufController) ListActivities added in v0.3.1 

func (u IufController) ListActivities(c *gin.Context)

ListActivities @Summary List IUF activities @Tags Activities @Accept json @Produce json @Success 200 {object} []iuf.Activity @Failure 500 {object} utils.ResponseError @Router /iuf/v1/activities [get]

func (IufController) ListHistory added in v0.3.1 

func (u IufController) ListHistory(c *gin.Context)

ListHistory @Summary List history of an iuf activity @Tags History @Accept json @Produce json @Success 200 {object} []iuf.History @Failure 501 "Not Implemented" @Router /iuf/v1/activities/{activity_id}/history [get]

func (IufController) ListSessions added in v0.3.1 

func (u IufController) ListSessions(c *gin.Context)

ListSessions @Summary List sessions of an IUF activity @Param activity_name path string true "activity name" @Tags Sessions @Accept json @Produce json @Success 200 {object} []iuf.Session @Failure 501 "Not Implemented" @Router /iuf/v1/activities/{activity_name}/sessions [get]

func (IufController) PatchActivity added in v0.3.1 

func (u IufController) PatchActivity(c *gin.Context)

PatchActivity @Summary Get an IUF activity @Param activity_name path string true "activity name" @Param activity body iuf.PatchActivityRequest true "IUF activity" @Tags Activities @Accept json @Produce json @Success 200 {object} iuf.Activity @Failure 500 {object} utils.ResponseError @Router /iuf/v1/activities/{activity_name} [patch]

func (IufController) ReplaceHistoryComment added in v0.3.1 

func (u IufController) ReplaceHistoryComment(c *gin.Context)

ReplaceHistoryComment @Summary Get a history item of an iuf activity @Param start_time path string true "start time of a history item" @Param activity body iuf.ReplaceHistoryCommentRequest true "Modify comment of a history" @Tags History @Accept json @Produce json @Success 200 {object} iuf.History @Failure 501 "Not Implemented" @Router /iuf/v1/activities/{activity_id}/history/{start_time} [patch]

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.