api

Documentation

Index

• type Client
• type Lookup
• type LookupPath
• type Resolver
• type Source
• type VirtualDomain

Types

type Client

type Client interface {
	// Resolve retrieves an VirtualDomain from the GitLab API and wraps it into a Lookup
	GetLookup(ctx context.Context, domain string) Lookup

	// Status checks the connectivity with the GitLab API
	Status() error
}

Client represents an interface we use to retrieve information from GitLab

type Lookup

type Lookup struct {
	Name   string
	Error  error
	Domain *VirtualDomain
}

Lookup defines an API lookup action with a response that GitLab sends

type LookupPath

type LookupPath struct {
	ProjectID     int    `json:"project_id,omitempty"`
	AccessControl bool   `json:"access_control,omitempty"`
	HTTPSOnly     bool   `json:"https_only,omitempty"`
	Prefix        string `json:"prefix,omitempty"`
	Source        Source `json:"source,omitempty"`
}

LookupPath represents a lookup path for a virtual domain

type Resolver

type Resolver interface {
	// Resolve retrieves an VirtualDomain from the GitLab API and wraps it into a Lookup
	Resolve(ctx context.Context, domain string) *Lookup

	// Status checks the connectivity with the GitLab API
	Status() error
}

Resolver represents an interface we use to retrieve information from GitLab in a more generic way. It can be a concrete API client or cached client.

type Source

type Source struct {
	Type string `json:"type,omitempty"`
	Path string `json:"path,omitempty"`
}

Source describes GitLab Page serving variant

type VirtualDomain

type VirtualDomain struct {
	Certificate string `json:"certificate,omitempty"`
	Key         string `json:"key,omitempty"`

	LookupPaths []LookupPath `json:"lookup_paths"`
}

VirtualDomain represents a GitLab Pages virtual domain that is being sent from GitLab API