models

Documentation

Index

• type API
  • func (m *API) MarshalBinary() ([]byte, error)
  • func (m *API) UnmarshalBinary(b []byte) error
  • func (m *API) Validate(formats strfmt.Registry) error
• type Error
  • func (m *Error) MarshalBinary() ([]byte, error)
  • func (m *Error) UnmarshalBinary(b []byte) error
  • func (m *Error) Validate(formats strfmt.Registry) error
• type Status
  • func (m Status) Validate(formats strfmt.Registry) error
• type Tag
  • func (m *Tag) MarshalBinary() ([]byte, error)
  • func (m *Tag) UnmarshalBinary(b []byte) error
  • func (m *Tag) Validate(formats strfmt.Registry) error

Types

type API

type API struct {

	// the authentication method for api consumers (public, basic, oidc, etc.)
	Authentication string `json:"authentication,omitempty"`

	// enable Cross-Origin Resource Sharing (CORS)
	Cors bool `json:"cors,omitempty"`

	// a easy way to disable an API without deleting it.
	Enabled bool `json:"enabled,omitempty"`

	// the name of the function associated with
	// Required: true
	Function *string `json:"function"`

	// a list of domain names that point to the API
	Hosts []string `json:"hosts"`

	// id
	ID strfmt.UUID `json:"id,omitempty"`

	// kind
	// Read Only: true
	// Pattern: ^[\w\d\-]+$
	Kind string `json:"kind,omitempty"`

	// a list of HTTP/S methods that point to the API
	Methods []string `json:"methods"`

	// name
	// Required: true
	// Pattern: ^[\w\d\-]+$
	Name *string `json:"name"`

	// a list of support protocols (i.e. http, https)
	Protocols []string `json:"protocols"`

	// status
	Status Status `json:"status,omitempty"`

	// tags
	Tags []*Tag `json:"tags"`

	// the tls credentials (imported from serverless secret) for https connection
	TLS string `json:"tls,omitempty"`

	// a list of URIs prefixes that point to the API
	Uris []string `json:"uris"`
}

API API swagger:model API

func (*API) MarshalBinary

func (m *API) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*API) UnmarshalBinary

func (m *API) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*API) Validate

func (m *API) Validate(formats strfmt.Registry) error

Validate validates this API

type Error

type Error struct {

	// code
	Code int64 `json:"code,omitempty"`

	// message
	// Required: true
	Message *string `json:"message"`
}

Error error swagger:model Error

func (*Error) MarshalBinary

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error) UnmarshalBinary

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error) Validate

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type Status

type Status string

Status status swagger:model Status

const (

	// StatusCREATING captures enum value "CREATING"
	StatusCREATING Status = "CREATING"

	// StatusREADY captures enum value "READY"
	StatusREADY Status = "READY"

	// StatusUPDATING captures enum value "UPDATING"
	StatusUPDATING Status = "UPDATING"

	// StatusDELETED captures enum value "DELETED"
	StatusDELETED Status = "DELETED"

	// StatusERROR captures enum value "ERROR"
	StatusERROR Status = "ERROR"
)

func (Status) Validate

func (m Status) Validate(formats strfmt.Registry) error

Validate validates this status

type Tag

type Tag struct {

	// key
	Key string `json:"key,omitempty"`

	// value
	Value string `json:"value,omitempty"`
}

Tag tag swagger:model Tag

func (*Tag) MarshalBinary

func (m *Tag) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Tag) UnmarshalBinary

func (m *Tag) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Tag) Validate

func (m *Tag) Validate(formats strfmt.Registry) error

Validate validates this tag