devapi

package
v1.0.0-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 27, 2023 License: Apache-2.0 Imports: 11 Imported by: 1

Documentation

Overview

Package devapi provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.11.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterHandlers

func RegisterHandlers(router EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

func RegisterHandlersWithBaseURL

func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)

Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.

Types

type Config

type Config struct {
	DidConfigService          didConfigService
	RequestObjectStoreService requestObjectStoreService
}

type Controller

type Controller struct {
	// contains filtered or unexported fields
}

func NewController

func NewController(
	config *Config,
) *Controller

func (*Controller) DidConfig

func (c *Controller) DidConfig(ctx echo.Context, profileType string, profileID string) error

DidConfig requests well-known DID config. GET /{profileType}/profiles/{profileID}/well-known/did-config.

func (*Controller) RequestObjectByUuid

func (c *Controller) RequestObjectByUuid(ctx echo.Context, uuid string) error

RequestObjectByUuid Receive request object by uuid. GET /request-object/{uuid}.

type DidConfig

type DidConfig struct {
	// context.
	Context *string `json:"@context,omitempty"`

	// Presentation in jws(string) or jsonld(object) formats
	LinkedDids *[]interface{} `json:"linked_dids,omitempty"`
}

DID Config response.

type EchoRouter

type EchoRouter interface {
	CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}

This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration

type ServerInterface

type ServerInterface interface {
	// Request request object by uuid
	// (GET /request-object/{uuid})
	RequestObjectByUuid(ctx echo.Context, uuid string) error
	// Request did-config
	// (GET /{profileType}/profiles/{profileID}/well-known/did-config)
	DidConfig(ctx echo.Context, profileType string, profileID string) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) DidConfig

func (w *ServerInterfaceWrapper) DidConfig(ctx echo.Context) error

DidConfig converts echo context to params.

func (*ServerInterfaceWrapper) RequestObjectByUuid

func (w *ServerInterfaceWrapper) RequestObjectByUuid(ctx echo.Context) error

RequestObjectByUuid converts echo context to params.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL