Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 ¶
MarshalBinary interface implementation
func (*API) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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 ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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" )
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 ¶
MarshalBinary interface implementation
func (*Tag) UnmarshalBinary ¶
UnmarshalBinary interface implementation
Click to show internal directories.
Click to hide internal directories.