models

Documentation

Index

• type Application
• type ApplicationBuilder
  • func NewApplicationBuilder() ApplicationBuilder
• type ApplicationRegistration
• type ApplicationSummary
• type JobSummary
• type PipelineParameters

Types

type Application

type Application struct {
	// Registration registration details
	Registration ApplicationRegistration `json:"registration"`
}

Application details of an application

type ApplicationBuilder

type ApplicationBuilder interface {
	WithName(string) ApplicationBuilder
	WithSharedSecret(string) ApplicationBuilder
	Build() *Application
}

ApplicationBuilder Handles construction of application detail

func NewApplicationBuilder

func NewApplicationBuilder() ApplicationBuilder

NewApplicationBuilder Constructor

type ApplicationRegistration

type ApplicationRegistration struct {
	// Name the unique name of the Radix application
	Name string `json:"name"`

	// SharedSecret the shared secret of the webhook
	SharedSecret *string `json:"sharedSecret"`
}

ApplicationRegistration ApplicationRegistration describe an application

type ApplicationSummary

type ApplicationSummary struct {
	// Name the name of the application
	Name string `json:"name"`
}

ApplicationSummary describe an application

type JobSummary

type JobSummary struct {
	// Name of the job
	Name string `json:"name"`

	// AppName of the application
	AppName string `json:"appName"`

	// Branch branch to build from
	Branch string `json:"branch"`

	// CommitID the commit ID of the branch to build
	CommitID string `json:"commitID"`

	// TriggeredBy of the job
	TriggeredBy string `json:"triggeredBy"`
}

JobSummary holds general information about job

type PipelineParameters

type PipelineParameters struct {
	// Branch the branch to build
	//
	// required: true
	// example: master
	Branch string `json:"branch"`

	// CommitID the commit ID of the branch to build
	//
	// required: true
	// example: 4faca8595c5283a9d0f17a623b9255a0d9866a2e
	CommitID string `json:"commitID"`

	// TriggeredBy creator of job
	//
	// required: true
	// example: 4faca8595c5283a9d0f17a623b9255a0d9866a2e
	TriggeredBy string `json:"triggeredBy"`
}

PipelineParameters describe branch to build and its commit ID