Documentation
¶
Index ¶
- Constants
- Variables
- func MakeInternal(err error) *goa.ServiceError
- func MakeInvalidArg(err error) *goa.ServiceError
- func MakeNotFound(err error) *goa.ServiceError
- func MakeUnauthorized(err error) *goa.ServiceError
- func NewProbeEndpoint(s Service, authAPIKeyFn security.AuthAPIKeyFunc) goa.Endpoint
- type Auther
- type Client
- type Endpoints
- type ProbePayload
- type ProbeResponse
- type Service
Constants ¶
const ServiceName = "Injective Price Oracle API"
ServiceName is the name of the service as defined in the design. This is the same value that is set in the endpoint request contexts under the ServiceKey key.
Variables ¶
var MethodNames = [1]string{"probe"}
MethodNames lists the service method names as defined in the design. These are the same values that are set in the endpoint request contexts under the MethodKey key.
Functions ¶
func MakeInternal ¶
func MakeInternal(err error) *goa.ServiceError
MakeInternal builds a goa.ServiceError from an error.
func MakeInvalidArg ¶
func MakeInvalidArg(err error) *goa.ServiceError
MakeInvalidArg builds a goa.ServiceError from an error.
func MakeNotFound ¶
func MakeNotFound(err error) *goa.ServiceError
MakeNotFound builds a goa.ServiceError from an error.
func MakeUnauthorized ¶
func MakeUnauthorized(err error) *goa.ServiceError
MakeUnauthorized builds a goa.ServiceError from an error.
func NewProbeEndpoint ¶
func NewProbeEndpoint(s Service, authAPIKeyFn security.AuthAPIKeyFunc) goa.Endpoint
NewProbeEndpoint returns an endpoint function that calls the method "probe" of service "Injective Price Oracle API".
Types ¶
type Auther ¶
type Auther interface {
// APIKeyAuth implements the authorization logic for the APIKey security scheme.
APIKeyAuth(ctx context.Context, key string, schema *security.APIKeyScheme) (context.Context, error)
}
Auther defines the authorization functions to be implemented by the service.
type Client ¶
Client is the "Injective Price Oracle API" service client.
func NewClient ¶
NewClient initializes a "Injective Price Oracle API" service client given the endpoints.
func (*Client) Probe ¶
func (c *Client) Probe(ctx context.Context, p *ProbePayload) (res *ProbeResponse, err error)
Probe calls the "probe" endpoint of the "Injective Price Oracle API" service.
type Endpoints ¶
Endpoints wraps the "Injective Price Oracle API" service endpoints.
func NewEndpoints ¶
NewEndpoints wraps the methods of the "Injective Price Oracle API" service with endpoints.
type ProbePayload ¶
type ProbePayload struct {
// API key for authentication
Key *string
// TOML file contents
Content []byte
}
ProbePayload is the payload type of the Injective Price Oracle API service probe method.
type ProbeResponse ¶
type ProbeResponse struct {
// Result of the probe
Result string
}
ProbeResponse is the result type of the Injective Price Oracle API service probe method.
type Service ¶
type Service interface {
// Validate TOML file
Probe(context.Context, *ProbePayload) (res *ProbeResponse, err error)
}
Injective-Price-Oracle services API doc
Source Files