scripts

type Credential struct {
	ID    int    `json:"id,omitempty"`
	Type  string `json:"type,omitempty"`
	Name  string `json:"name"`
	Value string `json:"value"`
}

type Input struct {
	// StateTarget is the state which is to be reached by this deployment task
	// StateTarget is either Deployed or NotDeployed
	StateTarget State `json:"state_target"`

	// User describes the user of this deployment task
	User User `json:"user"`

	// Answers is an answered questionnaire relating to an Output.Questionnaire
	//
	// Maps question names (corresponding to the Output.Questionnaire) to the answers of the user.
	// The type of an answer must be string, if there is no mapping for the key in the corresponding Output.QuestionnaireAnswers.
	// If there is such a mapping the answer type must be of the type indicated by the mapping. See Output.QuestionnaireAnswers for details.
	Answers map[string]interface{} `json:"answers,omitempty"`
}

type Output struct {
	// State describes the state of the deployment, after the script execution.
	// When State == Questionnaire then Output.Questionnaire *must* be set.
	// When State == Questionnaire then Output.QuestionnaireAnswers *can* be set.
	// When State == Deployed then Output.Credentials *can* be set.
	State State `json:"state"`

	// Msg is a message for the user.
	Msg string `json:"message"`

	// Questionnaire allows the script to requets further information from the user.
	//
	// This field is Ignored when Output.State is not Questionnaire.
	// Questionnaire maps a question name to a question text.
	Questionnaire map[string]string `json:"questionnaire,omitempty"`

	// QuestionnaireAnswers allows the script to control which answers the user can give.
	//
	// This field is Ignored when Output.State is not Questionnaire.
	// QuestionnaireAnswers maps a question name (corresponding to the question names in Output.Questionnaire) to one of the following:
	// 	- a boolean value indicating a yes/no question with the default selection being the value itself
	// 	- a list of strings or integers indicating that the user must select one of the options of the list
	// 	- a string value indicating that the answer must be of type string. The value itself will be set as default answer for the user.
	//
	// Providing a mapping in QuestionnaireAnswers for a question is optional. If no mapping is provided the default answer must be a string.
	QuestionnaireAnswers map[string]interface{} `json:"questionnaire_answers,omitempty"`

	// Credentials are additionnal credentials for the user.
	// Examples are additional passwords.
	// This field is ignored by the client when Output.State is not Deployed.
	// Credentials maps a credential name to a credential value.
	Credentials map[string]string `json:"credentials,omitempty"`

	// UserCredentialStates are the State s of the credentials found in Input.User.Credentials.
	// This field is not mandatory. The client will assume that all credentials have the State
	// Output.State if this field is not given.
	UserCredentialStates UserCredentialStates `json:"user_credential_states,omitempty"`
}

type State string

type User struct {
	UserInfo    UserInfo        `json:"userinfo"`
	Credentials UserCredentials `json:"credentials"`
}

type UserCredentialStates map[string]map[string]State

type UserCredentials map[string][]Credential

type UserInfo map[string]interface{}