Commit 91d2d788 authored by Lukas Burgey's avatar Lukas Burgey

Update field descriptions and remove obsolete types

parent 456d73af
...@@ -21,21 +21,13 @@ type ( ...@@ -21,21 +21,13 @@ type (
// UserCredentials maps a credential type to the credentials of this type // UserCredentials maps a credential type to the credentials of this type
UserCredentials map[string][]Credential UserCredentials map[string][]Credential
// Group a group of which User is a member of
Group struct {
Name string `json:"name"`
}
// UserInfo info about the user // UserInfo info about the user
UserInfo map[string]interface{} UserInfo map[string]interface{}
// User describes the user info // User contains information concerning the user of a deployment
User struct { User struct {
// Email string `json:"email"`
// Groups []Group `json:"groups"`
UserInfo UserInfo `json:"userinfo"` UserInfo UserInfo `json:"userinfo"`
Credentials UserCredentials `json:"credentials,omitempty"` Credentials UserCredentials `json:"credentials"`
} }
// Input of the deployment script // Input of the deployment script
...@@ -49,7 +41,9 @@ type ( ...@@ -49,7 +41,9 @@ type (
// Credentials the credentials to deploy // Credentials the credentials to deploy
// maps the credential type to the according credentials // maps the credential type to the according credentials
// TODO this should move into Input.User //
// This is now located in Input.User.Credentials
// This field will therefore be removed in the future!
Credentials UserCredentials `json:"credentials,omitempty"` Credentials UserCredentials `json:"credentials,omitempty"`
// Questionnaire is an answered questionnaire // Questionnaire is an answered questionnaire
...@@ -66,7 +60,6 @@ type ( ...@@ -66,7 +60,6 @@ type (
// when State == Deployed then Output.Credentials *can* be set // when State == Deployed then Output.Credentials *can* be set
State State `json:"state"` State State `json:"state"`
// TODO use this correctly
// Message for the user // Message for the user
Msg string `json:"message"` Msg string `json:"message"`
...@@ -80,9 +73,10 @@ type ( ...@@ -80,9 +73,10 @@ type (
// Maps a credential name to a credential value // Maps a credential name to a credential value
Credentials map[string]string `json:"credentials,omitempty"` Credentials map[string]string `json:"credentials,omitempty"`
// UserCredentialStates states of the credentials provided by the user (not by the script!) // 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 is not given // 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"` UserCredentialStates UserCredentialStates `json:"user_credential_states,omitempty"`
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment