api

Documentation

Index

• type AnnotationsResponse
• type Client
  • func NewClient(endpoint string) (*Client, error)
  • func (c *Client) CreateAnnotations(domain string, payload string) (resp []byte, err error)
  • func (c *Client) DeleteAnnotations(domain string, payload []byte) (resp []byte, err error)
  • func (c *Client) GetDomains(request DomainReq) (resp []*Domain, err error)
  • func (c *Client) GetDomainsFull(request DomainReq) (resp []*DomainFull, err error)
  • func (c *Client) ReadAnnotations(domain string, payload []byte) (resp map[string]any, err error)
  • func (c *Client) UpdateAnnotations(domain string, payload []byte) (resp []byte, err error)
• type Domain
• type DomainFull
• type DomainFullResponse
• type DomainReq
  • func (request *DomainReq) ToURLQuery() (url.Values, error)
• type DomainResponse
• type Exclude
• type Include
• type IncludeExclude
• type Metadata
• type Subdomain

Types

type AnnotationsResponse

type AnnotationsResponse struct {
	Domain Domain `json:"dt"`
}

type Client

type Client struct {
	Endpoint string
	// contains filtered or unexported fields
}

Client is a Domain Management Backend API client

func NewClient

func NewClient(endpoint string) (*Client, error)

func (*Client) CreateAnnotations

func (c *Client) CreateAnnotations(domain string, payload string) (resp []byte, err error)

func (*Client) DeleteAnnotations

func (c *Client) DeleteAnnotations(domain string, payload []byte) (resp []byte, err error)

func (*Client) GetDomains

func (c *Client) GetDomains(request DomainReq) (resp []*Domain, err error)

func (*Client) GetDomainsFull

func (c *Client) GetDomainsFull(request DomainReq) (resp []*DomainFull, err error)

func (*Client) ReadAnnotations

func (c *Client) ReadAnnotations(domain string, payload []byte) (resp map[string]any, err error)

func (*Client) UpdateAnnotations

func (c *Client) UpdateAnnotations(domain string, payload []byte) (resp []byte, err error)

type Domain

type Domain struct {
	Domain   string   `json:"domain"`
	Metadata Metadata `json:"metadata"`
}

type DomainFull

type DomainFull struct {
	Domain     string      `json:"domain"`
	Metadata   Metadata    `json:"metadata"`
	Subdomains []Subdomain `json:"subdomains"`
}

type DomainFullResponse

type DomainFullResponse struct {
	DomainsFull []*DomainFull `json:"dt"`
}

type DomainReq

type DomainReq struct {
	FilterDomains    *IncludeExclude `json:"domains,omitempty"`
	FilterSubdomains *IncludeExclude `json:"subdomains,omitempty"`
}

func (*DomainReq) ToURLQuery

func (request *DomainReq) ToURLQuery() (url.Values, error)

type DomainResponse

type DomainResponse struct {
	Domains []*Domain `json:"dt"`
}

type Exclude

type Exclude struct {
	Metadata *Metadata `json:"metadata" binding:"omitempty"`
}

type Include

type Include struct {
	Metadata *Metadata `json:"metadata" binding:"omitempty"`
}

type IncludeExclude

type IncludeExclude struct {
	Include *Include `json:"include,omitempty"`
	Exclude *Exclude `json:"exclude,omitempty"`
}

type Metadata

type Metadata struct {
	Labels      map[string]interface{} `json:"labels,omitempty"`
	Annotations map[string]interface{} `json:"annotations,omitempty"`
}

type Subdomain

type Subdomain struct {
	Fqdn     string   `json:"fqdn,omitempty"`
	Name     string   `json:"name"`
	Metadata Metadata `json:"metadata"`
}