api

Documentation

Index

• Constants
• type ActiveLastPub
• type Certificate
• type CertificateCreateRequest
• type CertificateUpdateRequest
• type PubOp
• type PubRequest
• type RepubRequest
• type Site
• type SiteCertificateLinkRequest
• type SiteCertificateResponse
• type SiteConfigAddRequest
• type SiteConfigChange
• type SiteConfigVersion
• type SiteConfiguration
• type SiteCreateRequest
• type SiteDetailsRequest
• type SiteUpdateRequest
• type UnpubRequest

Constants

const OPERATION_TYPE_UNPUBLISH = "Unpublish"

const SITES_HOSTNAME = "media-sites"

Types

type ActiveLastPub

type ActiveLastPub struct {
	Last   *PubOp `json:"last"`
	Active *PubOp `json:"active"`
}

ActiveLastPub - Contains values for activeAndLastPublishingOperation

type Certificate

type Certificate struct {
	CertId           int64  `json:"certId"`
	Certificate      string `json:"certificate"`
	CertificateChain string `json:"certificateChain"`
	//PrivateKey       string `json:"privateKey"`
	//Email            string `json:"email"`
	Description string `json:"description"`
	PkHash      string `json:"pkHash"`
	Tenant      string `json:"tenant"`
	Domain      string `json:"domain"`
	Status      string `json:"status"`
	Type        string `json:"type"`
}

Certificate - Model for the Certificate object

type CertificateCreateRequest

type CertificateCreateRequest struct {
	Certificate      string `json:"certificate"`
	CertificateChain string `json:"certificateChain"`
	PrivateKey       string `json:"privateKey"`
	//Email            string `json:"email"`
	Description string `json:"description"`
}

CertificateCreateRequest - Model for creating a new Certificate

type CertificateUpdateRequest

type CertificateUpdateRequest struct {
	Certificate      string `json:"certificate"`
	CertificateChain string `json:"certificateChain"`
	PrivateKey       string `json:"privateKey"`
	//Email            string `json:"email"`
	Description string `json:"description"`
}

CertificateUpdateRequest - Model for updating an existing Certificate

type PubOp

type PubOp struct {
	PublishId                   string          `json:"publishId"`
	CreationTimeMilli           int             `json:"creationTimeMilli"`
	OwnerOrgId                  string          `json:"ownerOrgId"`
	LastUpdateTimeMilli         int             `json:"lastUpdateTimeMilli"`
	RevisionId                  string          `json:"revisionId"`
	Target                      string          `json:"target"`
	Username                    string          `json:"username"`
	PublishState                string          `json:"publishState"`
	PublishStatus               string          `json:"publishStatus"`
	PublishAcceptanceStatus     string          `json:"publishAcceptanceStatus"`
	PublishHidden               bool            `json:"publishHidden"`
	PublishMode                 string          `json:"publishMode"`
	OperationType               string          `json:"operationType"`
	StatusLine                  []string        `json:"statusLine"`
	ConfigLastModifiedTimeMilli int             `json:"configLastModifiedTimeMilli"`
	IsActive                    bool            `json:"isActive"`
	ValidatorsErrDetails        json.RawMessage `json:"validatorsErrDetails"`
}

PubOp - Model for the publishing operation of a Site

type PubRequest

type PubRequest struct {
	RevisionId string `json:"revisionId"`
	Target     string `json:"target,omitempty"`
}

PubRequest - Model for requesting a new Publish operation

type RepubRequest

type RepubRequest struct {
	Target string `json:"target"`
}

RepubRequest - Model for requesting a new Republish operation

type Site

type Site struct {
	SiteId                           string         `json:"siteId"`
	OwnerOrgId                       string         `json:"ownerOrgId"`
	CreationTimeMilli                int            `json:"creationTimeMilli"`
	LastUpdateTimeMilli              int            `json:"lastUpdateTimeMilli"`
	CreatedUser                      string         `json:"createdUser"`
	LastUpdatedUser                  string         `json:"lastUpdatedUser"`
	SiteDnsCnameDelegationTarget     string         `json:"siteDnsCnameDelegationTarget"`
	SiteName                         string         `json:"siteName"`
	ApiVersion                       string         `json:"apiVersion"`
	ActiveAndLastPublishingOperation *ActiveLastPub `json:"activeAndLastPublishingOperation"`
	ServiceType                      string         `json:"serviceType"`
	RoutingMethod                    string         `json:"routingMethod"`
	ShouldProvisionToThirdPartyCdn   bool           `json:"shouldProvisionToThirdPartyCdn"`
	ServiceId                        string         `json:"serviceId"`
	IsSelfServiceBlocked             bool           `json:"isSelfServiceBlocked"`
	IsDeleted                        bool           `json:"IsDeleted"`
}

Site - Model for the Site object

type SiteCertificateLinkRequest

type SiteCertificateLinkRequest struct {
	CertificateId string `json:"certificateId"`
}

SiteCertificateLinkRequest - Model for requesting a new Link Request

type SiteCertificateResponse

type SiteCertificateResponse struct {
	CertificateId   string `json:"certificateId"`
	CertificateType string `json:"certificateType"`
	Target          string `json:"target"`
	State           string `json:"state"`
}

SiteCertificateResponse - Model for the config revision for a Site

type SiteConfigAddRequest

type SiteConfigAddRequest struct {
	HostIndex         json.RawMessage `json:"hostIndex"`
	ChangeDescription string          `json:"changeDescription"`
}

SiteConfigAddRequest - Model for creating a new SiteConfig

type SiteConfigChange

type SiteConfigChange struct {
	SiteId                  string          `tfsdk:"site_id"`
	OwnerOrgId              string          `json:"ownerOrgId"`
	SiteCreationTimeMilli   int             `json:"siteCreationTimeMilli"`
	SiteLastUpdateTimeMilli int             `json:"siteLastUpdateTimeMilli"`
	SiteCreatedUser         string          `json:"siteCreatedUser"`
	HostIndex               json.RawMessage `json:"hostIndex"`
	ChangeDescription       string          `json:"changeDescription"`
}

SiteConfigChange - Model for updating the SiteConfiguration object

type SiteConfigVersion

type SiteConfigVersion struct {
	SiteId              string          `json:"siteId"`
	RevisionId          string          `json:"revisionId"`
	RevisionNum         int             `json:"revisionNum"`
	OwnerOrgId          string          `json:"ownerOrgId"`
	CreationTimeMilli   int             `json:"creationTimeMilli"`
	LastUpdateTimeMilli int             `json:"lastUpdateTimeMilli"`
	CreatedUser         string          `json:"createdUser"`
	HostIndex           json.RawMessage `json:"hostIndex"`
	ChangeDescription   string          `json:"changeDescription"`
}

SiteConfigVersion - Model for the config revision for a Site

type SiteConfiguration

type SiteConfiguration struct {
	RevisionId                string          `json:"revisionId"`
	RevisionNum               int             `json:"revisionNum"`
	ConfigCreationTimeMilli   int             `json:"configCreationTimeMilli"`
	ConfigLastUpdateTimeMilli int             `json:"configLastUpdateTimeMilli"`
	ConfigCreatedUser         string          `json:"configCreatedUser"`
	HostIndex                 json.RawMessage `json:"hostIndex"`
	ChangeDescription         string          `json:"changeDescription"`
}

SiteConfiguration - Model for the SiteConfiguration object

type SiteCreateRequest

type SiteCreateRequest struct {
	SiteName      string `json:"siteName"`
	RoutingMethod string `json:"routingMethod,omitempty"`
}

SiteCreateRequest - Model for creating a new Site

type SiteDetailsRequest

type SiteDetailsRequest struct {
	SiteId string `json:"siteId"`
}

SiteDetailsRequest - Model for requesting Site details

type SiteUpdateRequest

type SiteUpdateRequest struct {
	SiteName string `json:"siteName"`
}

SiteUpdateRequest - Model for updating an existing Site

type UnpubRequest

type UnpubRequest struct {
	Target string `json:"target"`
}

UnpubRequest - Model for requesting a new Unpublish operation