request

Documentation

Index

• type CreateBackendRequest
  • func (payload *CreateBackendRequest) Decode(r *http.Request) error
• type CreateOrganizationRequest
  • func (payload *CreateOrganizationRequest) Decode(r *http.Request) error
  • func (payload *CreateOrganizationRequest) Validate() error
• type CreateProjectRequest
  • func (payload *CreateProjectRequest) Decode(r *http.Request) error
  • func (payload *CreateProjectRequest) Validate() error
• type CreateSourceRequest
  • func (payload *CreateSourceRequest) Decode(r *http.Request) error
• type CreateStackRequest
  • func (payload *CreateStackRequest) Decode(r *http.Request) error
  • func (payload *CreateStackRequest) Validate() error
• type CreateWorkspaceRequest
  • func (payload *CreateWorkspaceRequest) Decode(r *http.Request) error
• type StackImportRequest
  • func (payload *StackImportRequest) Decode(r *http.Request) error
• type UpdateBackendRequest
  • func (payload *UpdateBackendRequest) Decode(r *http.Request) error
• type UpdateOrganizationRequest
  • func (payload *UpdateOrganizationRequest) Decode(r *http.Request) error
  • func (payload *UpdateOrganizationRequest) Validate() error
• type UpdateProjectRequest
  • func (payload *UpdateProjectRequest) Decode(r *http.Request) error
  • func (payload *UpdateProjectRequest) Validate() error
• type UpdateSourceRequest
  • func (payload *UpdateSourceRequest) Decode(r *http.Request) error
• type UpdateStackRequest
  • func (payload *UpdateStackRequest) Decode(r *http.Request) error
  • func (payload *UpdateStackRequest) Validate() error
• type UpdateVariableRequest
  • func (payload *UpdateVariableRequest) Decode(r *http.Request) error
• type UpdateWorkspaceRequest
  • func (payload *UpdateWorkspaceRequest) Decode(r *http.Request) error
• type WorkspaceCredentials
  • func (payload *WorkspaceCredentials) Decode(r *http.Request) error

Types

type CreateBackendRequest

type CreateBackendRequest struct {
	// Name is the name of the backend.
	Name string `json:"name" binding:"required"`
	// Description is a human-readable description of the backend.
	Description string `json:"description"`
	// BackendConfig is the configuration of the backend.
	BackendConfig v1.BackendConfig `json:"backendConfig"`
}

CreateBackendRequest represents the create request structure for backend.

func (*CreateBackendRequest) Decode

func (payload *CreateBackendRequest) Decode(r *http.Request) error

type CreateOrganizationRequest

type CreateOrganizationRequest struct {
	// Name is the name of the organization.
	Name string `json:"name"`
	// Description is a human-readable description of the organization.
	Description string `json:"description"`
	// Labels are custom labels associated with the organization.
	Labels []string `json:"labels"`
	// Owners is a list of owners for the organization.
	Owners []string `json:"owners" binding:"required"`
}

CreateOrganizationRequest represents the create request structure for organization.

func (*CreateOrganizationRequest) Decode

func (payload *CreateOrganizationRequest) Decode(r *http.Request) error

func (*CreateOrganizationRequest) Validate

func (payload *CreateOrganizationRequest) Validate() error

type CreateProjectRequest

type CreateProjectRequest struct {
	// Name is the name of the project.
	Name string `json:"name"`
	// SourceID is the configuration source id associated with the project.
	SourceID uint `json:"sourceID"`
	// OrganizationID is the organization id associated with the project.
	OrganizationID uint `json:"organizationID"`
	// Description is a human-readable description of the project.
	Description string `json:"description"`
	// Path is the relative path of the project within the sources.
	Path string `json:"path"`
	// Domain is the domain of the project, typically serving as the parent folder name for the project.
	Domain string `json:"domain" binding:"required"`
	// Labels are custom labels associated with the project.
	Labels []string `json:"labels"`
	// Owners is a list of owners for the project.
	Owners []string `json:"owners"`
}

CreateProjectRequest represents the create request structure for project.

func (*CreateProjectRequest) Decode

func (payload *CreateProjectRequest) Decode(r *http.Request) error

func (*CreateProjectRequest) Validate

func (payload *CreateProjectRequest) Validate() error

type CreateSourceRequest

type CreateSourceRequest struct {
	// SourceProvider is the type of the source provider.
	SourceProvider string `json:"sourceProvider" binding:"required"`
	// Remote is the source URL, including scheme.
	Remote string `json:"remote" binding:"required"`
	// Description is a human-readable description of the source.
	Description string `json:"description"`
	// Labels are custom labels associated with the source.
	Labels []string `json:"labels"`
	// Owners is a list of owners for the source.
	Owners []string `json:"owners"`
}

CreateSourceRequest represents the create request structure for source.

func (*CreateSourceRequest) Decode

func (payload *CreateSourceRequest) Decode(r *http.Request) error

type CreateStackRequest

type CreateStackRequest struct {
	// Name is the name of the stack.
	Name string `json:"name" binding:"required"`
	// ProjectID is the project id of the stack within the source.
	ProjectID uint `json:"projectID"`
	// ProjectName is the project name of the stack within the source.
	ProjectName string `json:"projectName"`
	// Type is the type of the stack.
	Type string `json:"type"`
	// Path is the relative path of the stack within the source.
	Path string `json:"path"`
	// DesiredVersion is the desired revision of stack.
	DesiredVersion string `json:"desiredVersion"`
	// Description is a human-readable description of the stack.
	Description string `json:"description"`
	// Labels are custom labels associated with the stack.
	Labels []string `json:"labels"`
	// Owners is a list of owners for the stack.
	Owners []string `json:"owners"`
}

CreateStackRequest represents the create request structure for stack.

func (*CreateStackRequest) Decode

func (payload *CreateStackRequest) Decode(r *http.Request) error

func (*CreateStackRequest) Validate

func (payload *CreateStackRequest) Validate() error

type CreateWorkspaceRequest

type CreateWorkspaceRequest struct {
	// Name is the name of the workspace.
	Name string `json:"name" binding:"required"`
	// Description is a human-readable description of the workspace.
	Description string `json:"description"`
	// Labels are custom labels associated with the workspace.
	Labels []string `json:"labels"`
	// Owners is a list of owners for the workspace.
	Owners []string `json:"owners" binding:"required"`
	// BackendID is the configuration backend id associated with the workspace.
	BackendID uint `json:"backendID" binding:"required"`
}

CreateWorkspaceRequest represents the create request structure for workspace.

func (*CreateWorkspaceRequest) Decode

func (payload *CreateWorkspaceRequest) Decode(r *http.Request) error

type StackImportRequest

type StackImportRequest struct {
	ImportedResources map[string]string `json:"importedResources"`
}

func (*StackImportRequest) Decode

func (payload *StackImportRequest) Decode(r *http.Request) error

type UpdateBackendRequest

type UpdateBackendRequest struct {
	// ID is the id of the backend.
	ID                   uint `json:"id" binding:"required"`
	CreateBackendRequest `json:",inline" yaml:",inline"`
}

UpdateBackendRequest represents the update request structure for backend.

func (*UpdateBackendRequest) Decode

func (payload *UpdateBackendRequest) Decode(r *http.Request) error

type UpdateOrganizationRequest

type UpdateOrganizationRequest struct {
	// ID is the id of the organization.
	ID                        uint `json:"id" binding:"required"`
	CreateOrganizationRequest `json:",inline" yaml:",inline"`
}

UpdateOrganizationRequest represents the update request structure for organization.

func (*UpdateOrganizationRequest) Decode

func (payload *UpdateOrganizationRequest) Decode(r *http.Request) error

func (*UpdateOrganizationRequest) Validate

func (payload *UpdateOrganizationRequest) Validate() error

type UpdateProjectRequest

type UpdateProjectRequest struct {
	// ID is the id of the project.
	ID                   uint `json:"id" binding:"required"`
	CreateProjectRequest `json:",inline" yaml:",inline"`
}

UpdateProjectRequest represents the update request structure for project.

func (*UpdateProjectRequest) Decode

func (payload *UpdateProjectRequest) Decode(r *http.Request) error

func (*UpdateProjectRequest) Validate

func (payload *UpdateProjectRequest) Validate() error

type UpdateSourceRequest

type UpdateSourceRequest struct {
	// ID is the id of the source.
	ID uint `json:"id" binding:"required"`
	// SourceProvider is the type of the source provider.
	SourceProvider string `json:"sourceProvider"`
	// Remote is the source URL, including scheme.
	Remote string `json:"remote"`
	// Description is a human-readable description of the source.
	Description string `json:"description"`
	// Labels are custom labels associated with the source.
	Labels []string `json:"labels"`
	// Owners is a list of owners for the source.
	Owners []string `json:"owners"`
}

UpdateSourceRequest represents the update request structure for source.

func (*UpdateSourceRequest) Decode

func (payload *UpdateSourceRequest) Decode(r *http.Request) error

type UpdateStackRequest

type UpdateStackRequest struct {
	// ID is the id of the stack.
	ID                 uint `json:"id" binding:"required"`
	CreateStackRequest `json:",inline" yaml:",inline"`
}

UpdateStackRequest represents the update request structure for stack.

func (*UpdateStackRequest) Decode

func (payload *UpdateStackRequest) Decode(r *http.Request) error

func (*UpdateStackRequest) Validate

func (payload *UpdateStackRequest) Validate() error

type UpdateVariableRequest

type UpdateVariableRequest struct {
	// Project is the project related to stack
	Project string `json:"project,omitempty"`
	// Path is the relative path of the stack within the source.
	Path     string `json:"path,omitempty"`
	IsSecret bool   `json:"isSecret,omitempty"`
	// key is the unique index to use value in specific stack
	Key string `json:"key,omitempty"`
	// value is the plain value of no sensitive data
	Value       string              `json:"value,omitempty"`
	SecretValue *entity.SecretValue `json:"secretValue,omitempty"`
}

func (*UpdateVariableRequest) Decode

func (payload *UpdateVariableRequest) Decode(r *http.Request) error

type UpdateWorkspaceRequest

type UpdateWorkspaceRequest struct {
	// ID is the id of the workspace.
	ID uint `json:"id" binding:"required"`
	// Name is the name of the workspace.
	Name string `json:"name"`
	// Description is a human-readable description of the workspace.
	Description string `json:"description"`
	// Labels are custom labels associated with the workspace.
	Labels map[string]string `json:"labels"`
	// Owners is a list of owners for the workspace.
	Owners []string `json:"owners" binding:"required"`
	// BackendID is the configuration backend id associated with the workspace.
	BackendID uint `json:"backendID" binding:"required"`
}

UpdateWorkspaceRequest represents the update request structure for workspace.

func (*UpdateWorkspaceRequest) Decode

func (payload *UpdateWorkspaceRequest) Decode(r *http.Request) error

type WorkspaceCredentials

type WorkspaceCredentials struct {
	KubeConfigContent string `json:"kubeConfigContent,omitempty"`
	KubeConfigPath    string `json:"kubeConfigPath,omitempty"`
	AliCloudAccessKey string `json:"alicloudAccessKey,omitempty"`
	AliCloudSecretKey string `json:"alicloudSecretKey,omitempty"`
	AliCloudRegion    string `json:"alicloudRegion,omitempty"`
	AwsAccessKey      string `json:"awsAccessKey,omitempty"`
	AwsSecretKey      string `json:"awsSecretKey,omitempty"`
	AwsRegion         string `json:"awsRegion,omitempty"`
}

func (*WorkspaceCredentials) Decode

func (payload *WorkspaceCredentials) Decode(r *http.Request) error