v1

Documentation

Index

• type Error
  • func (p *Error) Render(w http.ResponseWriter, r *http.Request) error
• type HealthCheckResult
• type PlacementRequest
  • func (p *PlacementRequest) Bind(r *http.Request) error
• type PlacementResponse
  • func (p *PlacementResponse) Render(w http.ResponseWriter, r *http.Request) error
• type ResourceRequest
  • func (p *ResourceRequest) Bind(r *http.Request) error
• type SimpleMessage
  • func (p *SimpleMessage) Render(w http.ResponseWriter, r *http.Request) error
• type TokenRequest
  • func (t *TokenRequest) Bind(r *http.Request) error
• type TokenResponse
  • func (t *TokenResponse) Render(w http.ResponseWriter, r *http.Request) error

Types

type Error

type Error struct {
	Err            error `json:"-"`                   // low-level runtime error
	HTTPStatusCode int   `json:"http_code,omitempty"` // http response status code

	Message        string   `json:"message"`                   // user-facing
	AppCode        int64    `json:"code,omitempty"`            // application-specific error code
	ErrorText      string   `json:"error,omitempty"`           // application-level error message, for debugging
	ErrorMultiline []string `json:"error_multiline,omitempty"` // application-level error message, for debugging
}

func (*Error) Render

func (p *Error) Render(w http.ResponseWriter, r *http.Request) error

type HealthCheckResult

type HealthCheckResult struct {
	HTTPStatusCode int    `json:"http_code,omitempty"` // http response status code
	Message        string `json:"message"`
}

type PlacementRequest

type PlacementRequest struct {
	ServiceUuid string            `json:"service_uuid"`
	Resources   []ResourceRequest `json:"resources"`
	Annotations map[string]string `json:"annotations"`
}

func (*PlacementRequest) Bind

func (p *PlacementRequest) Bind(r *http.Request) error

type PlacementResponse

type PlacementResponse struct {
	HTTPStatusCode int    `json:"http_code,omitempty"` // http response status code
	Message        string `json:"message"`
	Placement      models.PlacementWithCreds
}

func (*PlacementResponse) Render

func (p *PlacementResponse) Render(w http.ResponseWriter, r *http.Request) error

type ResourceRequest

type ResourceRequest struct {
	Kind  string `json:"kind"`
	Count int    `json:"count"`
}

func (*ResourceRequest) Bind

func (p *ResourceRequest) Bind(r *http.Request) error

type SimpleMessage

type SimpleMessage struct {
	Message          string   `json:"message"`
	MessageMultiline []string `json:"message_multiline,omitempty"`
}

func (*SimpleMessage) Render

func (p *SimpleMessage) Render(w http.ResponseWriter, r *http.Request) error

type TokenRequest

type TokenRequest struct {
	Claims map[string]any `json:"claims"`
}

func (*TokenRequest) Bind

func (t *TokenRequest) Bind(r *http.Request) error

type TokenResponse

type TokenResponse struct {
	Token           string     `json:"token,omitempty"`
	AccessToken     string     `json:"access_token,omitempty"`
	RefreshToken    string     `json:"refresh_token,omitempty"`
	Exp             *time.Time `json:"exp,omitempty"`
	AccessTokenExp  *time.Time `json:"access_token_exp,omitempty"`
	RefreshTokenExp *time.Time `json:"refresh_token_exp,omitempty"`
}

func (*TokenResponse) Render

func (t *TokenResponse) Render(w http.ResponseWriter, r *http.Request) error