Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIMeta ¶
type APIMeta struct {
// Number of APIs returned in the response
Count int64 `json:"count,omitempty"`
// All or sub set of info about APIs in the MGW
List []*APIMetaListItem `json:"list"`
// Total number of APIs available in the MGW
Total int64 `json:"total,omitempty"`
}
APIMeta API meta
swagger:model APIMeta
func (*APIMeta) ContextValidate ¶
ContextValidate validate this API meta based on the context it is used
func (*APIMeta) MarshalBinary ¶
MarshalBinary interface implementation
func (*APIMeta) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type APIMetaListItem ¶
type APIMetaListItem struct {
// api name
APIName string `json:"apiName,omitempty"`
// api type
APIType string `json:"apiType,omitempty"`
// context
Context string `json:"context,omitempty"`
// gateway envs
GatewayEnvs []string `json:"gateway-envs"`
// version
Version string `json:"version,omitempty"`
// vhost
Vhost string `json:"vhost,omitempty"`
}
APIMetaListItem API meta list item
swagger:model APIMetaListItem
func (*APIMetaListItem) ContextValidate ¶
ContextValidate validates this API meta list item based on context it is used
func (*APIMetaListItem) MarshalBinary ¶
func (m *APIMetaListItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIMetaListItem) UnmarshalBinary ¶
func (m *APIMetaListItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Credentials ¶
type Credentials struct {
// Password of the microgateway REST API user
// Required: true
// Max Length: 100
// Pattern: ^[a-zA-Z0-9_~.@-]*$
Password *string `json:"password"`
// Username of the microgateway REST API user
// Required: true
// Max Length: 100
// Pattern: ^[a-zA-Z0-9_~.@-]*$
Username *string `json:"username"`
}
Credentials credentials
swagger:model Credentials
func (*Credentials) ContextValidate ¶
ContextValidate validates this credentials based on context it is used
func (*Credentials) MarshalBinary ¶
func (m *Credentials) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Credentials) UnmarshalBinary ¶
func (m *Credentials) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeployResponse ¶
type DeployResponse struct {
// action
Action string `json:"action,omitempty"`
// info
Info string `json:"info,omitempty"`
}
DeployResponse deploy response
swagger:model DeployResponse
func (*DeployResponse) ContextValidate ¶
ContextValidate validates this deploy response based on context it is used
func (*DeployResponse) MarshalBinary ¶
func (m *DeployResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeployResponse) UnmarshalBinary ¶
func (m *DeployResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// Error code
// Required: true
Code *int64 `json:"code"`
// A detail description about the error message.
//
Description string `json:"description,omitempty"`
// If there are more than one error list them out.
// For example, list out validation errors by each field.
//
Error []*ErrorListItem `json:"error"`
// Error message.
// Required: true
Message *string `json:"message"`
// Preferably an url with more details about the error.
//
MoreInfo string `json:"moreInfo,omitempty"`
}
Error Error object returned with 4XX HTTP status
swagger:model Error
func (*Error) ContextValidate ¶
ContextValidate validate this error based on the context it is used
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ErrorListItem ¶
type ErrorListItem struct {
// Error code
// Required: true
Code *string `json:"code"`
// Description about individual errors occurred
//
// Required: true
Message *string `json:"message"`
}
ErrorListItem Description of individual errors that may have occurred during a request.
swagger:model ErrorListItem
func (*ErrorListItem) ContextValidate ¶
ContextValidate validates this error list item based on context it is used
func (*ErrorListItem) MarshalBinary ¶
func (m *ErrorListItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorListItem) UnmarshalBinary ¶
func (m *ErrorListItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Principal ¶
type Principal struct {
// token
Token string `json:"token,omitempty"`
// username
Username string `json:"username,omitempty"`
}
Principal principal
swagger:model Principal
func (*Principal) ContextValidate ¶
ContextValidate validates this principal based on context it is used
func (*Principal) MarshalBinary ¶
MarshalBinary interface implementation
func (*Principal) UnmarshalBinary ¶
UnmarshalBinary interface implementation
Source Files