swagger

Documentation

Index

• type App
• type AppChannel
• type AppRelease
• type AppReleaseInfo
• type Body
• type Body1
• type ChannelAdoption
• type LicenseCounts
• type PreflightCheck

Types

type App

type App struct {

	// The ID of the app
	Id string `json:"Id"`

	// The name of the app
	Name string `json:"Name"`

	// A unique slug for the app
	Slug string `json:"Slug"`
}

An app belongs to a team. It contains channels onto which releases can be promoted.

type AppChannel

type AppChannel struct {
	Adoption *ChannelAdoption `json:"Adoption,omitempty"`

	// Description that will be shown during license installation
	Description string `json:"Description"`

	// The ID of the channel
	Id string `json:"Id"`

	LicenseCounts *LicenseCounts `json:"LicenseCounts,omitempty"`

	// The name of channel
	Name string `json:"Name"`

	// The position for which the channel occurs in a list
	Position int64 `json:"Position,omitempty"`

	// The label of the current release sequence
	ReleaseLabel string `json:"ReleaseLabel,omitempty"`

	// Release notes for the current release sequence
	ReleaseNotes string `json:"ReleaseNotes,omitempty"`

	// A reference to the current release sequence
	ReleaseSequence int64 `json:"ReleaseSequence,omitempty"`
}

An app channel belongs to an app. It contains references to the top (current) release in the channel.

type AppRelease

type AppRelease struct {
	Config string `json:"Config,omitempty"`

	CreatedAt time.Time `json:"CreatedAt,omitempty"`

	Editable bool `json:"Editable,omitempty"`

	EditedAt time.Time `json:"EditedAt,omitempty"`

	Sequence int64 `json:"Sequence,omitempty"`
}

type AppReleaseInfo

type AppReleaseInfo struct {

	// The active channels
	ActiveChannels []AppChannel `json:"ActiveChannels,omitempty"`

	// The application ID
	AppId string `json:"AppId,omitempty"`

	// The time at which the release was created
	CreatedAt time.Time `json:"CreatedAt,omitempty"`

	// If the release is editable
	Editable bool `json:"Editable,omitempty"`

	// The last time at which the release was changed
	EditedAt time.Time `json:"EditedAt,omitempty"`

	// Release preflight checks
	PreflightChecks []PreflightCheck `json:"PreflightChecks,omitempty"`

	// The app sequence number
	Sequence int64 `json:"Sequence,omitempty"`

	// The vendor supplied version
	Version string `json:"Version,omitempty"`
}

AppReleaseInfo represents an app release

type Body

type Body struct {
	Name string `json:"name"`

	Source string `json:"source"`

	Sourcedata int64 `json:"sourcedata"`
}

type Body1

type Body1 struct {
	Channels []string `json:"channels"`

	Label string `json:"label"`

	ReleaseNotes string `json:"release_notes"`

	Required bool `json:"required"`
}

type ChannelAdoption

type ChannelAdoption struct {
	CurrentVersionCountActive map[string]int64 `json:"current_version_count_active,omitempty"`

	CurrentVersionCountAll map[string]int64 `json:"current_version_count_all,omitempty"`

	OtherVersionCountActive map[string]int64 `json:"other_version_count_active,omitempty"`

	OtherVersionCountAll map[string]int64 `json:"other_version_count_all,omitempty"`

	PreviousVersionCountActive map[string]int64 `json:"previous_version_count_active,omitempty"`

	PreviousVersionCountAll map[string]int64 `json:"previous_version_count_all,omitempty"`
}

ChannelAdoption represents the versions that licenses are on in the channel

type LicenseCounts

type LicenseCounts struct {
	Active map[string]int64 `json:"active,omitempty"`

	Airgap map[string]int64 `json:"airgap,omitempty"`

	Inactive map[string]int64 `json:"inactive,omitempty"`

	Total map[string]int64 `json:"total,omitempty"`
}

LicenseCounts is a struct to hold license count information

type PreflightCheck

type PreflightCheck struct {
	Category string `json:"Category,omitempty"`

	CheckName string `json:"CheckName,omitempty"`

	CheckValue string `json:"CheckValue,omitempty"`

	IsRequired bool `json:"IsRequired,omitempty"`

	Scheduler string `json:"Scheduler,omitempty"`

	Score string `json:"Score,omitempty"`
}