Documentation ¶
Overview ¶
Package request contains plain old Go types used in the Gin endpoint handlers and Swaggo documentation for the HTTP request models, with Gin- and Swaggo-specific Go tags.
Copied from https://github.com/iver-wharf/wharf-api/blob/v5.1.2/pkg/model/request/request.go
Index ¶
- type Branch
- type BranchListUpdate
- type BranchUpdate
- type BuildInputs
- type BuildStatus
- type BuildStatusUpdate
- type Log
- type LogOrStatusUpdate
- type Project
- type ProjectOverridesUpdate
- type ProjectUpdate
- type Provider
- type ProviderName
- type ProviderSearch
- type ProviderUpdate
- type Token
- type TokenSearch
- type TokenUpdate
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BranchListUpdate ¶
type BranchListUpdate struct { DefaultBranch string `json:"defaultBranch" extensions:"x-nullable"` Branches []BranchUpdate `json:"branches"` }
BranchListUpdate specifies fields when resetting all branches for a project.
type BranchUpdate ¶
type BranchUpdate struct {
Name string `json:"name" validate:"required"`
}
BranchUpdate specifies fields for a single branch.
type BuildInputs ¶
type BuildInputs map[string]interface{}
BuildInputs is a key-value object of input variables used when starting a new build, where the key is the input variable name and the value is its string, boolean, or numeric value.
type BuildStatus ¶
type BuildStatus string
BuildStatus is an enum of different states for a build.
const ( // BuildScheduling means the build has been registered, but no code // execution has begun yet. This is usually quite an ephemeral state. BuildScheduling BuildStatus = "Scheduling" // BuildRunning means the build is executing right now. The execution // engine has load in the target code paths and repositories. BuildRunning BuildStatus = "Running" // BuildCompleted means the build has finished execution successfully. BuildCompleted BuildStatus = "Completed" // BuildFailed means that something went wrong with the build. Could be a // misconfiguration in the .wharf-ci.yml file, or perhaps a scripting error // in some build step. BuildFailed BuildStatus = "Failed" )
type BuildStatusUpdate ¶
type BuildStatusUpdate struct {
Status BuildStatus `json:"status" enums:"Scheduling,Running,Completed,Failed"`
}
BuildStatusUpdate allows you to update the status of a build.
type Log ¶ added in v2.1.0
type Log struct { BuildID uint WorkerLogID uint WorkerStepID uint Timestamp time.Time Message string }
Log is a new log message to be added to a build.
type LogOrStatusUpdate ¶
type LogOrStatusUpdate struct { Message string `json:"message"` Timestamp time.Time `json:"timestamp" format:"date-time"` Status BuildStatus `json:"status" enums:",Scheduling,Running,Completed,Failed"` }
LogOrStatusUpdate is a single log line, together with its timestamp of when it was logged; or a build status update.
The build status field takes precedence, and if set it will update the build's status, while the message and the timestamp is ignored.
type Project ¶
type Project struct { Name string `json:"name" validate:"required" binding:"required"` GroupName string `json:"groupName"` Description string `json:"description"` AvatarURL string `json:"avatarUrl"` TokenID uint `json:"tokenId" minimum:"0"` ProviderID uint `json:"providerId" minimum:"0"` BuildDefinition string `json:"buildDefinition"` GitURL string `json:"gitUrl"` RemoteProjectID string `json:"remoteProjectId"` }
Project specifies fields when creating a new project.
type ProjectOverridesUpdate ¶
type ProjectOverridesUpdate struct { Description string `json:"description"` AvatarURL string `json:"avatarUrl"` GitURL string `json:"gitUrl"` }
ProjectOverridesUpdate specifies fields when updating a project's overrides.
type ProjectUpdate ¶
type ProjectUpdate struct { Name string `json:"name" validate:"required" binding:"required"` GroupName string `json:"groupName"` Description string `json:"description"` AvatarURL string `json:"avatarUrl"` TokenID uint `json:"tokenId" minimum:"0"` ProviderID uint `json:"providerId" minimum:"0"` BuildDefinition string `json:"buildDefinition"` GitURL string `json:"gitUrl"` }
ProjectUpdate specifies fields when updating a project.
type Provider ¶
type Provider struct { Name ProviderName `json:"name" enums:"azuredevops,gitlab,github" validate:"required" binding:"required"` URL string `json:"url" validate:"required" binding:"required"` TokenID uint `json:"tokenId" minimum:"0"` }
Provider specifies fields when creating a new provider.
type ProviderName ¶
type ProviderName string
ProviderName is an enum of different providers that are available over at https://github.com/iver-wharf
const ( // ProviderAzureDevOps refers to the Azure DevOps provider plugin, // https://github.com/iver-wharf/wharf-provider-azuredevops ProviderAzureDevOps ProviderName = "azuredevops" // ProviderGitLab refers to the GitLab provider plugin, // https://github.com/iver-wharf/wharf-provider-gitlab ProviderGitLab ProviderName = "gitlab" // ProviderGitHub refers to the GitHub provider plugin, // https://github.com/iver-wharf/wharf-provider-github ProviderGitHub ProviderName = "github" // ProviderNameValues is a concatenated list of the different provider names // available. Useful in validation error messages. ProviderNameValues = ProviderAzureDevOps + ", " + ProviderGitLab + ", " + ProviderGitHub )
func (ProviderName) IsValid ¶
func (name ProviderName) IsValid() bool
IsValid returns false if the underlying type is an unknown enum value.
ProviderGitHub.IsValid() // => true (ProviderName("")).IsValid() // => false
func (ProviderName) ValidString ¶
func (name ProviderName) ValidString() (string, bool)
ValidString returns the name as a string if valid, as well as the boolean value true, or false if the name is invalid.
ProviderGitHub.ValidString() // => "github", true (ProviderName("")).ValidString() // => "", false
type ProviderSearch ¶
type ProviderSearch struct { Name ProviderName `json:"name" enums:"azuredevops,gitlab,github"` URL string `json:"url"` TokenID uint `json:"tokenId" minimum:"0"` }
ProviderSearch holds values used in verbatim searches for providers.
type ProviderUpdate ¶
type ProviderUpdate struct { Name ProviderName `json:"name" enums:"azuredevops,gitlab,github" validate:"required" binding:"required"` URL string `json:"url" validate:"required" binding:"required"` TokenID uint `json:"tokenId" minimum:"0"` }
ProviderUpdate specifies fields when updating a provider.
type Token ¶
type Token struct { Token string `json:"token" format:"password" validate:"required"` UserName string `json:"userName" validate:"required"` ProviderID uint `json:"providerId" minimum:"0"` }
Token specifies fields when creating a new token.
type TokenSearch ¶
type TokenSearch struct { Token string `json:"token" format:"password"` UserName string `json:"userName"` }
TokenSearch holds values used in verbatim searches for tokens.
type TokenUpdate ¶
type TokenUpdate struct { Token string `json:"token" format:"password" validate:"required"` UserName string `json:"userName" validate:"required"` }
TokenUpdate specifies fields when updating a token.