swagger

package
v0.76.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 28, 2024 License: MIT Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type App

type App struct {
	// The ID of the app
	Id string `json:"Id"`
	// The name of the app
	Name string `json:"Name"`
	// The scheduler associated with the app
	Scheduler string `json:"Scheduler,omitempty"`
	// 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 AppAndChannels

type AppAndChannels struct {
	App *App `json:"App"`
	// Channels of the app
	Channels []AppChannel `json:"Channels"`
}

type AppChannel

type AppChannel struct {
	Adoption *ChannelAdoption `json:"Adoption,omitempty"`
	// AirgapEnabled indicates if airgap builds will be created automatically for this channel
	AirgapEnabled bool `json:"AirgapEnabled,omitempty"`
	// Description that will be shown during license installation
	Description string `json:"Description"`
	// The ID of the channel
	Id string `json:"Id"`
	// IsDefault shows if channel is default or not
	IsDefault     bool           `json:"IsDefault,omitempty"`
	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 AppCollector added in v0.12.0

type AppCollector struct {
	Config    string    `json:"Config,omitempty"`
	CreatedAt time.Time `json:"CreatedAt,omitempty"`
	Name      string    `json:"Name,omitempty"`
	SpecID    string    `json:"ID,omitempty"`
}

type AppCollectorInfo added in v0.12.0

type AppCollectorInfo struct {
	// The active channels
	ActiveChannels []AppChannel `json:"ActiveChannels,omitempty"`
	// The application ID
	AppId string `json:"AppId,omitempty"`
	// Collector Config
	Config string `json:"Config,omitempty"`
	// The spec ID
	SpecId string `json:"SpecId,omitempty"`
	// The time at which the release was created
	CreatedAt time.Time `json:"CreatedAt,omitempty"`
	// If the release is editable
	Name string `json:"Name,omitempty"`
}

AppCollectorInfo represents an app collector

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 of the app that is to be created.
	Name string `json:"name"`
	// Scheduler of the app that is to be created
	Scheduler string `json:"scheduler,omitempty"`
}

type Body1

type Body1 struct {
	// Password of the user
	Password string `json:"password"`
}

type Body11

type Body11 struct {
	// If activation is required this is the email the code will be sent to.
	ActivationEmail       string `json:"activation_email"`
	AirgapDownloadEnabled bool   `json:"airgap_download_enabled"`
	// App Id that this license will be associated with.
	AppId string `json:"app_id"`
	// License Label name, ie name of customer who is using license.
	Assignee string `json:"assignee"`
	// deprecated
	AssistedSetupEnabled bool `json:"assisted_setup_enabled,omitempty"`
	// Channel id that the license will be associated with.
	ChannelId string `json:"channel_id"`
	// Date that the license will expire, can be null for no expiration or formatted by year-month-day ex. 2016-02-02.
	ExpirationDate string `json:"expiration_date"`
	// Defines expiration policy for this license.  Values: ignore: replicated will take no action on a expired license noupdate-norestart: application updates will not be downloaded, and once the application is stopped, it will not be started again noupdate-stop: application updates will not be downloaded and the application will be stopped
	ExpirationPolicy string `json:"expiration_policy"`
	// Defines whether this license should use the external support bundle generator.
	ExternalSupportBundle bool `json:"external_support_bundle,omitempty"`
	// An array of field values for custom fields of a given app
	FieldValues []LicenseFieldValue `json:"field_values"`
	// LicenseType can be set to \"dev\", \"trial\", or \"prod\"
	LicenseType string `json:"license_type"`
	// If this license requires activation set to true, make sure to set activation email as well.
	RequireActivation bool `json:"require_activation"`
	// If set to automatic will auto update remote license installation with every release. If set to manual will update only when on-premise admin clicks the install update button.
	UpdatePolicy string `json:"update_policy"`
	// Defines whether this license should use support bundle specs from console.
	UseConsoleSupportSpec bool `json:"use_console_support_spec,omitempty"`
}

type Body12

type Body12 struct {
	// If activation is required this is the email the code will be sent to.
	ActivationEmail       string `json:"activation_email"`
	AirgapDownloadEnabled bool   `json:"airgap_download_enabled"`
	// License Label name, ie name of customer who is using license.
	Assignee             string `json:"assignee"`
	AssistedSetupEnabled bool   `json:"assisted_setup_enabled"`
	// Channel id that the license will be associated with.
	ChannelId string `json:"channel_id"`
	// Date that the license will expire, can be null for no expiration or formated by year-month-day ex. 2016-02-02.
	ExpirationDate string `json:"expiration_date"`
	// Defines expiration policy for this license.  Values: ignore: replicated will take no action on a expired license noupdate-norestart: application updates will not be downloaded, and once the application is stopped, it will not be started again noupdate-stop: application updates will not be downloaded and the application will be stopped
	ExpirationPolicy string `json:"expiration_policy"`
	// Defines whether this license should use the external support bundle generator.
	ExternalSupportBundle bool `json:"external_support_bundle,omitempty"`
	// An array of field values for custom fields of a given app
	FieldValues []LicenseFieldValue `json:"field_values"`
	// A license can be optionally locked to a specific release
	IsAppVersionLocked bool `json:"is_app_version_locked,omitempty"`
	// LicenseType can be set to \"dev\", \"trial\", or \"prod\"
	LicenseType string `json:"license_type"`
	// If app version is locked, this is the version to lock it to (sequence)
	LockedAppVersion int64 `json:"locked_app_version,omitempty"`
	// If this license requires activation set to true, make sure to set activation email as well.
	RequireActivation bool `json:"require_activation"`
	// If set to automatic will auto update remote license installation with every release. If set to manual will update only when on-premise admin clicks the install update button.
	UpdatePolicy string `json:"update_policy"`
	// Defines whether this license should use support bundle specs from console.
	UseConsoleSupportSpec bool `json:"use_console_support_spec,omitempty"`
}

type Body13

type Body13 struct {
	// Begining date formated by year-month-day ex. 2016-02-02.
	Begin string `json:"begin"`
	// Ending date formated by year-month-day ex. 2016-02-02.
	End string `json:"end"`
	// Can be set to Monthly, Quarterly, Annually, One Time, or Other to indicate interval that this billing happens.
	Frequency string `json:"frequency"`
	// LicenseType can be set to \"dev\", \"trial\", or \"prod\"
	LicenseType string `json:"license_type"`
	// Amount of money associated with this billing event.
	Revenue string `json:"revenue"`
}

type Body14

type Body14 struct {
	Amount                      int64  `json:"amount"`
	Description                 string `json:"description"`
	VendorDueFromCustomerDate   string `json:"vendor_due_from_customer_date"`
	VendorInvoiceToCustomerDate string `json:"vendor_invoice_to_customer_date"`
	VendorPaidByCustomerDate    string `json:"vendor_paid_by_customer_date"`
}

type Body15

type Body15 struct {
	Amount                      int64  `json:"amount"`
	Description                 string `json:"description"`
	VendorDueFromCustomerDate   string `json:"vendor_due_from_customer_date"`
	VendorInvoiceToCustomerDate string `json:"vendor_invoice_to_customer_date"`
	VendorPaidByCustomerDate    string `json:"vendor_paid_by_customer_date"`
}

type Body16

type Body16 struct {
	ChannelId string `json:"channel_id,omitempty"`
}

type Body17

type Body17 struct {
	ExpirationDate string `json:"expiration_date"`
}

type Body18

type Body18 struct {
	Field string `json:"field"`
	Value string `json:"value"`
}

type Body19

type Body19 struct {
	LicenseFieldValues []LicenseFieldValue `json:"LicenseFieldValues"`
}

type Body2

type Body2 struct {
	// ChannelID to create branding for
	ChannelId string `json:"channel_id"`
	// CSS to apply to the channel
	Css string `json:"css"`
}

type Body4

type Body4 struct {
	AirgapEnabled bool   `json:"airgap_enabled,omitempty"`
	Description   string `json:"description,omitempty"`
	IsDefault     bool   `json:"is_default,omitempty"`
	Name          string `json:"name"`
}

type Body5

type Body5 struct {
	ReleaseNotes string `json:"release_notes"`
	Required     bool   `json:"required"`
	Version      string `json:"version"`
}

type Body6

type Body6 struct {
	Default_ string `json:"default"`
	Hidden   bool   `json:"hidden"`
	Name     string `json:"name"`
	Required bool   `json:"required"`
	Title    string `json:"title"`
	Type_    string `json:"type"`
}

type Body7

type Body7 struct {
	// Optional default value for this licensefield.
	Default_ string `json:"default"`
	// Indicates if this field will be visible from the on-premise license screen.
	Hidden bool `json:"hidden"`
	// Title of custom license field to display.
	Title string `json:"title"`
}

type Body8

type Body8 struct {
	// An array of fields that have values you are trying to search for
	Fields []LicenseFieldNameValue `json:"fields"`
}

type BodyCreateChannel

type BodyCreateChannel struct {
	AirgapEnabled bool   `json:"airgap_enabled,omitempty"`
	Description   string `json:"description,omitempty"`
	Name          string `json:"name"`
}

type BodyCreateCollector added in v0.12.0

type BodyCreateCollector struct {
	//  Is there a default collector?
	Source string `json:"source,omitempty"`
}

type BodyCreateRelease

type BodyCreateRelease struct {
	// Currently supported values for this field are \"copy\" and \"latest\". When set to \"copy\", sourcedata must be set to release number to copy YAML from. When set to \"latest\", YAML will be copied from the latest app release. When omitted, the release will be created with default placeholder YAML.
	Source string `json:"source,omitempty"`
	// If source is set to \"copy\", sourcedata must be the release number to copy YAML from.
	Sourcedata int64 `json:"sourcedata"`
}

type BodyPromoteCollector added in v0.12.0

type BodyPromoteCollector struct {
	ChannelIDs []string `json:"channels"`
}

type BodyPromoteRelease

type BodyPromoteRelease struct {
	Channels     []string `json:"channels"`
	Label        string   `json:"label"`
	ReleaseNotes string   `json:"release_notes"`
	Required     bool     `json:"required"`
}

type Branding

type Branding struct {
	Created  time.Time `json:"created,omitempty"`
	Css      string    `json:"css,omitempty"`
	Default_ bool      `json:"default,omitempty"`
	Updated  time.Time `json:"updated,omitempty"`
}

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 ChannelRelease

type ChannelRelease struct {
	AirgapBuildError  string    `json:"airgap_build_error,omitempty"`
	AirgapBuildStatus string    `json:"airgap_build_status,omitempty"`
	ChannelId         string    `json:"channel_id,omitempty"`
	ChannelSequence   int64     `json:"channel_sequence,omitempty"`
	Created           time.Time `json:"created,omitempty"`
	ReleaseNotes      string    `json:"release_notes,omitempty"`
	ReleaseSequence   int64     `json:"release_sequence,omitempty"`
	Required          bool      `json:"required,omitempty"`
	Updated           time.Time `json:"updated,omitempty"`
	Version           string    `json:"version,omitempty"`
}

type GetChannelInlineResponse200

type GetChannelInlineResponse200 struct {
	Channel  *AppChannel      `json:"channel"`
	Releases []ChannelRelease `json:"releases"`
}

type InlineResponse200

type InlineResponse200 struct {
	Branding map[string]Branding `json:"branding,omitempty"`
	Channels []AppChannel        `json:"channels,omitempty"`
}

type InlineResponse2001

type InlineResponse2001 struct {
	AppChannel []AppChannel `json:"AppChannel,omitempty"`
}

type InlineResponse20010

type InlineResponse20010 struct {
	LicenseBillingEvent *LicenseBillingEvent `json:"LicenseBillingEvent"`
}

type InlineResponse20011

type InlineResponse20011 struct {
	License *LicenseInstance `json:"License,omitempty"`
}

type InlineResponse20012

type InlineResponse20012 struct {
	ListInstances []LicenseInstance `json:"ListInstances,omitempty"`
}

type InlineResponse20013

type InlineResponse20013 struct {
	License *LicenseInstanceUntracked `json:"License,omitempty"`
}

type InlineResponse2003

type InlineResponse2003 struct {
	AppChannels []AppChannel `json:"AppChannels,omitempty"`
}

type InlineResponse2004

type InlineResponse2004 struct {
	ListAppLicenseFieldsResponse []LicenseField `json:"ListAppLicenseFieldsResponse,omitempty"`
}

type InlineResponse2005

type InlineResponse2005 struct {
	Licenses []License `json:"Licenses,omitempty"`
}

type InlineResponse2006

type InlineResponse2006 struct {
	// List of License IDs
	LicenseIDs []string `json:"LicenseIDs,omitempty"`
}

type InlineResponse2007

type InlineResponse2007 struct {
	License *License `json:"License"`
}

type InlineResponse2008

type InlineResponse2008 struct {
	Password string `json:"password"`
}

type InlineResponse2009

type InlineResponse2009 struct {
	BillingEvents []LicenseBillingEvent `json:"BillingEvents,omitempty"`
}

type InlineResponse201

type InlineResponse201 struct {
	License *License `json:"License,omitempty"`
}

type InstalledAppVersion

type InstalledAppVersion struct {
	Label           string    `json:"Label,omitempty"`
	LastCheck       time.Time `json:"LastCheck,omitempty"`
	Sequence        int64     `json:"Sequence,omitempty"`
	UpdateAvailable bool      `json:"UpdateAvailable,omitempty"`
}

type License

type License struct {
	ActivationEmail        string                `json:"ActivationEmail,omitempty"`
	ActiveInstanceCount    int64                 `json:"ActiveInstanceCount,omitempty"`
	AirgapDownloadEnabled  bool                  `json:"AirgapDownloadEnabled,omitempty"`
	AirgapDownloadPassword []int32               `json:"AirgapDownloadPassword,omitempty"`
	Anonymous              bool                  `json:"Anonymous,omitempty"`
	AppId                  string                `json:"AppId,omitempty"`
	AppStatus              string                `json:"AppStatus,omitempty"`
	Archived               bool                  `json:"Archived,omitempty"`
	Assignee               string                `json:"Assignee,omitempty"`
	AssistedSetupEnabled   bool                  `json:"AssistedSetupEnabled,omitempty"`
	Billing                *LicenseBilling       `json:"Billing,omitempty"`
	BillingEvents          []LicenseBillingEvent `json:"BillingEvents,omitempty"`
	ChannelId              string                `json:"ChannelId,omitempty"`
	ChannelName            string                `json:"ChannelName,omitempty"`
	Clouds                 string                `json:"Clouds,omitempty"`
	ExpirationPolicy       string                `json:"ExpirationPolicy,omitempty"`
	ExpireDate             time.Time             `json:"ExpireDate,omitempty"`
	ExternalSupportBundle  bool                  `json:"ExternalSupportBundle,omitempty"`
	FieldValues            []LicenseFieldValue   `json:"FieldValues,omitempty"`
	GrantDate              time.Time             `json:"GrantDate,omitempty"`
	Id                     string                `json:"Id,omitempty"`
	InactiveInstanceCount  int64                 `json:"InactiveInstanceCount,omitempty"`
	IsAppVersionLocked     bool                  `json:"IsAppVersionLocked,omitempty"`
	IsInstanceTracked      bool                  `json:"IsInstanceTracked,omitempty"`
	LastSync               time.Time             `json:"LastSync,omitempty"`
	LicenseType            string                `json:"LicenseType,omitempty"`
	LicenseVersions        *LicenseVersions      `json:"LicenseVersions,omitempty"`
	LockedAppVersion       int64                 `json:"LockedAppVersion,omitempty"`
	RequireActivation      bool                  `json:"RequireActivation,omitempty"`
	RevokationDate         time.Time             `json:"RevokationDate,omitempty"`
	UntrackedInstanceCount int64                 `json:"UntrackedInstanceCount,omitempty"`
	UpdatePolicy           string                `json:"UpdatePolicy,omitempty"`
	UseConsoleSupportSpec  bool                  `json:"UseConsoleSupportSpec,omitempty"`
}

type LicenseBilling

type LicenseBilling struct {
	Begin     time.Time `json:"begin,omitempty"`
	End       time.Time `json:"end,omitempty"`
	Frequency string    `json:"frequency,omitempty"`
	Revenue   string    `json:"revenue,omitempty"`
}

type LicenseBillingEvent

type LicenseBillingEvent struct {
	Amount                      int64     `json:"amount,omitempty"`
	Description                 string    `json:"description,omitempty"`
	EventDate                   time.Time `json:"event_date,omitempty"`
	Id                          string    `json:"id,omitempty"`
	VendorDueFromCustomerDate   time.Time `json:"vendor_due_from_customer_date,omitempty"`
	VendorInvoiceToCustomerDate time.Time `json:"vendor_invoice_to_customer_date,omitempty"`
	VendorPaidByCustomerDate    time.Time `json:"vendor_paid_by_customer_date,omitempty"`
}

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 LicenseField

type LicenseField struct {
	Default_ string `json:"default,omitempty"`
	Hidden   bool   `json:"hidden,omitempty"`
	Name     string `json:"name,omitempty"`
	Required bool   `json:"required,omitempty"`
	Title    string `json:"title,omitempty"`
	Type_    string `json:"type,omitempty"`
}

type LicenseFieldNameValue

type LicenseFieldNameValue struct {
	Field string       `json:"field,omitempty"`
	Value *interface{} `json:"value,omitempty"`
}

type LicenseFieldValue

type LicenseFieldValue struct {
	// The name of the custom field which you want to populate a value.
	Field string `json:"field"`
	// The value that you wish to populate the custom field with.
	Value string `json:"value"`
}

type LicenseInstance

type LicenseInstance struct {
	Active                    bool                            `json:"Active,omitempty"`
	AppStatus                 string                          `json:"AppStatus,omitempty"`
	AssistSessionId           string                          `json:"AssistSessionId,omitempty"`
	Cloud                     string                          `json:"Cloud,omitempty"`
	Created                   time.Time                       `json:"Created,omitempty"`
	InstanceId                string                          `json:"InstanceId,omitempty"`
	LastActive                time.Time                       `json:"LastActive,omitempty"`
	LicenseId                 string                          `json:"LicenseId,omitempty"`
	ReplicatedAgentVersion    string                          `json:"ReplicatedAgentVersion,omitempty"`
	ReplicatedOperatorVersion string                          `json:"ReplicatedOperatorVersion,omitempty"`
	ReplicatedSyncTime        time.Time                       `json:"ReplicatedSyncTime,omitempty"`
	ReplicatedUiVersion       string                          `json:"ReplicatedUiVersion,omitempty"`
	ReplicatedUpdaterVersion  string                          `json:"ReplicatedUpdaterVersion,omitempty"`
	ReplicatedVersion         string                          `json:"ReplicatedVersion,omitempty"`
	VersionHistory            []LicenseInstanceVersionHistory `json:"VersionHistory,omitempty"`
}

type LicenseInstanceUntracked

type LicenseInstanceUntracked struct {
	CurrentSequence           int64     `json:"CurrentSequence,omitempty"`
	CurrentVersion            string    `json:"CurrentVersion,omitempty"`
	LicenseId                 string    `json:"LicenseId,omitempty"`
	ReplicatedAgentVersion    string    `json:"ReplicatedAgentVersion,omitempty"`
	ReplicatedOperatorVersion string    `json:"ReplicatedOperatorVersion,omitempty"`
	ReplicatedSyncTime        time.Time `json:"ReplicatedSyncTime,omitempty"`
	ReplicatedUiVersion       string    `json:"ReplicatedUiVersion,omitempty"`
	ReplicatedUpdaterVersion  string    `json:"ReplicatedUpdaterVersion,omitempty"`
	ReplicatedVersion         string    `json:"ReplicatedVersion,omitempty"`
	SyncTime                  time.Time `json:"SyncTime,omitempty"`
}

type LicenseInstanceVersionHistory

type LicenseInstanceVersionHistory struct {
	InstanceId      string    `json:"InstanceId,omitempty"`
	Start           time.Time `json:"Start,omitempty"`
	Stop            time.Time `json:"Stop,omitempty"`
	VersionChannel  string    `json:"VersionChannel,omitempty"`
	VersionLabel    string    `json:"VersionLabel,omitempty"`
	VersionSequence int64     `json:"VersionSequence,omitempty"`
}

type LicenseVersions

type LicenseVersions struct {
	InstalledAppVersion *InstalledAppVersion `json:"InstalledAppVersion,omitempty"`
	ReplicatedVersions  map[string][]string  `json:"ReplicatedVersions,omitempty"`
}

type PlatformChannel added in v0.12.0

type PlatformChannel struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

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"`
}

type TestAppCollectorInfo added in v0.12.0

type TestAppCollectorInfo struct {
	// The active channels
	ActiveChannels []PlatformChannel `json:"PlatformChannel,omitempty"`
	// The spec ID
	AppId  string `json:"AppId,omitempty"`
	SpecId string `json:"SpecId,omitempty"`
	// The time at which the release was created
	CreatedAt time.Time `json:"CreatedAt,omitempty"`
	// If the release is editable
	Name string `json:"Name,omitempty"`
}

TestAppCollectorInfo represents an app collector

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL