v1

package
v6.2.13 Latest Latest
Warning

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

Go to latest
Published: Sep 22, 2026 License: GPL-3.0 Imports: 20 Imported by: 0

Documentation

Overview

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

View Source
const (
	JwtBearerAuthScopes = "jwtBearerAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewAddCompoundServiceRequest

func NewAddCompoundServiceRequest(server string, did string, body AddCompoundServiceJSONRequestBody) (*http.Request, error)

NewAddCompoundServiceRequest calls the generic AddCompoundService builder with application/json body

func NewAddCompoundServiceRequestWithBody

func NewAddCompoundServiceRequestWithBody(server string, did string, contentType string, body io.Reader) (*http.Request, error)

NewAddCompoundServiceRequestWithBody generates requests for AddCompoundService with any type of body

func NewAddEndpointRequest

func NewAddEndpointRequest(server string, did string, body AddEndpointJSONRequestBody) (*http.Request, error)

NewAddEndpointRequest calls the generic AddEndpoint builder with application/json body

func NewAddEndpointRequestWithBody

func NewAddEndpointRequestWithBody(server string, did string, contentType string, body io.Reader) (*http.Request, error)

NewAddEndpointRequestWithBody generates requests for AddEndpoint with any type of body

func NewDeleteEndpointsByTypeRequest

func NewDeleteEndpointsByTypeRequest(server string, did string, pType string) (*http.Request, error)

NewDeleteEndpointsByTypeRequest generates requests for DeleteEndpointsByType

func NewDeleteServiceRequest

func NewDeleteServiceRequest(server string, id string) (*http.Request, error)

NewDeleteServiceRequest generates requests for DeleteService

func NewGetCompoundServiceEndpointRequest

func NewGetCompoundServiceEndpointRequest(server string, did string, compoundServiceType string, endpointType string, params *GetCompoundServiceEndpointParams) (*http.Request, error)

NewGetCompoundServiceEndpointRequest generates requests for GetCompoundServiceEndpoint

func NewGetCompoundServicesRequest

func NewGetCompoundServicesRequest(server string, did string) (*http.Request, error)

NewGetCompoundServicesRequest generates requests for GetCompoundServices

func NewGetContactInformationRequest

func NewGetContactInformationRequest(server string, did string) (*http.Request, error)

NewGetContactInformationRequest generates requests for GetContactInformation

func NewSearchOrganizationsRequest

func NewSearchOrganizationsRequest(server string, params *SearchOrganizationsParams) (*http.Request, error)

NewSearchOrganizationsRequest generates requests for SearchOrganizations

func NewUpdateCompoundServiceRequest

func NewUpdateCompoundServiceRequest(server string, did string, pType string, body UpdateCompoundServiceJSONRequestBody) (*http.Request, error)

NewUpdateCompoundServiceRequest calls the generic UpdateCompoundService builder with application/json body

func NewUpdateCompoundServiceRequestWithBody

func NewUpdateCompoundServiceRequestWithBody(server string, did string, pType string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateCompoundServiceRequestWithBody generates requests for UpdateCompoundService with any type of body

func NewUpdateContactInformationRequest

func NewUpdateContactInformationRequest(server string, did string, body UpdateContactInformationJSONRequestBody) (*http.Request, error)

NewUpdateContactInformationRequest calls the generic UpdateContactInformation builder with application/json body

func NewUpdateContactInformationRequestWithBody

func NewUpdateContactInformationRequestWithBody(server string, did string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateContactInformationRequestWithBody generates requests for UpdateContactInformation with any type of body

func NewUpdateEndpointRequest

func NewUpdateEndpointRequest(server string, did string, pType string, body UpdateEndpointJSONRequestBody) (*http.Request, error)

NewUpdateEndpointRequest calls the generic UpdateEndpoint builder with application/json body

func NewUpdateEndpointRequestWithBody

func NewUpdateEndpointRequestWithBody(server string, did string, pType string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateEndpointRequestWithBody generates requests for UpdateEndpoint with any type of body

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 AddCompoundService200JSONResponse

type AddCompoundService200JSONResponse CompoundService

func (AddCompoundService200JSONResponse) VisitAddCompoundServiceResponse

func (response AddCompoundService200JSONResponse) VisitAddCompoundServiceResponse(w http.ResponseWriter) error

type AddCompoundServiceJSONRequestBody

type AddCompoundServiceJSONRequestBody = CompoundServiceProperties

AddCompoundServiceJSONRequestBody defines body for AddCompoundService for application/json ContentType.

type AddCompoundServiceRequestObject

type AddCompoundServiceRequestObject struct {
	Did  string `json:"did"`
	Body *AddCompoundServiceJSONRequestBody
}

type AddCompoundServiceResponse

type AddCompoundServiceResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *CompoundService
	ApplicationproblemJSONDefault *struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
}

func ParseAddCompoundServiceResponse

func ParseAddCompoundServiceResponse(rsp *http.Response) (*AddCompoundServiceResponse, error)

ParseAddCompoundServiceResponse parses an HTTP response from a AddCompoundServiceWithResponse call

func (AddCompoundServiceResponse) Status

Status returns HTTPResponse.Status

func (AddCompoundServiceResponse) StatusCode

func (r AddCompoundServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AddCompoundServiceResponseObject

type AddCompoundServiceResponseObject interface {
	VisitAddCompoundServiceResponse(w http.ResponseWriter) error
}

type AddCompoundServicedefaultApplicationProblemPlusJSONResponse

type AddCompoundServicedefaultApplicationProblemPlusJSONResponse struct {
	Body struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
	StatusCode int
}

func (AddCompoundServicedefaultApplicationProblemPlusJSONResponse) VisitAddCompoundServiceResponse

func (response AddCompoundServicedefaultApplicationProblemPlusJSONResponse) VisitAddCompoundServiceResponse(w http.ResponseWriter) error

type AddEndpoint200JSONResponse

type AddEndpoint200JSONResponse Endpoint

func (AddEndpoint200JSONResponse) VisitAddEndpointResponse

func (response AddEndpoint200JSONResponse) VisitAddEndpointResponse(w http.ResponseWriter) error

type AddEndpointJSONRequestBody

type AddEndpointJSONRequestBody = EndpointProperties

AddEndpointJSONRequestBody defines body for AddEndpoint for application/json ContentType.

type AddEndpointRequestObject

type AddEndpointRequestObject struct {
	Did  string `json:"did"`
	Body *AddEndpointJSONRequestBody
}

type AddEndpointResponse

type AddEndpointResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *Endpoint
	ApplicationproblemJSONDefault *struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
}

func ParseAddEndpointResponse

func ParseAddEndpointResponse(rsp *http.Response) (*AddEndpointResponse, error)

ParseAddEndpointResponse parses an HTTP response from a AddEndpointWithResponse call

func (AddEndpointResponse) Status

func (r AddEndpointResponse) Status() string

Status returns HTTPResponse.Status

func (AddEndpointResponse) StatusCode

func (r AddEndpointResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type AddEndpointResponseObject

type AddEndpointResponseObject interface {
	VisitAddEndpointResponse(w http.ResponseWriter) error
}

type AddEndpointdefaultApplicationProblemPlusJSONResponse

type AddEndpointdefaultApplicationProblemPlusJSONResponse struct {
	Body struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
	StatusCode int
}

func (AddEndpointdefaultApplicationProblemPlusJSONResponse) VisitAddEndpointResponse

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) AddCompoundService

func (c *Client) AddCompoundService(ctx context.Context, did string, body AddCompoundServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AddCompoundServiceWithBody

func (c *Client) AddCompoundServiceWithBody(ctx context.Context, did string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AddEndpoint

func (c *Client) AddEndpoint(ctx context.Context, did string, body AddEndpointJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) AddEndpointWithBody

func (c *Client) AddEndpointWithBody(ctx context.Context, did string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteEndpointsByType

func (c *Client) DeleteEndpointsByType(ctx context.Context, did string, pType string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteService

func (c *Client) DeleteService(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCompoundServiceEndpoint

func (c *Client) GetCompoundServiceEndpoint(ctx context.Context, did string, compoundServiceType string, endpointType string, params *GetCompoundServiceEndpointParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetCompoundServices

func (c *Client) GetCompoundServices(ctx context.Context, did string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetContactInformation

func (c *Client) GetContactInformation(ctx context.Context, did string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchOrganizations

func (c *Client) SearchOrganizations(ctx context.Context, params *SearchOrganizationsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateCompoundService

func (c *Client) UpdateCompoundService(ctx context.Context, did string, pType string, body UpdateCompoundServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateCompoundServiceWithBody

func (c *Client) UpdateCompoundServiceWithBody(ctx context.Context, did string, pType string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateContactInformation

func (c *Client) UpdateContactInformation(ctx context.Context, did string, body UpdateContactInformationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateContactInformationWithBody

func (c *Client) UpdateContactInformationWithBody(ctx context.Context, did string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateEndpoint

func (c *Client) UpdateEndpoint(ctx context.Context, did string, pType string, body UpdateEndpointJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateEndpointWithBody

func (c *Client) UpdateEndpointWithBody(ctx context.Context, did string, pType string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// GetCompoundServices request
	GetCompoundServices(ctx context.Context, did string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AddCompoundServiceWithBody request with any body
	AddCompoundServiceWithBody(ctx context.Context, did string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AddCompoundService(ctx context.Context, did string, body AddCompoundServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCompoundServiceEndpoint request
	GetCompoundServiceEndpoint(ctx context.Context, did string, compoundServiceType string, endpointType string, params *GetCompoundServiceEndpointParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateCompoundServiceWithBody request with any body
	UpdateCompoundServiceWithBody(ctx context.Context, did string, pType string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateCompoundService(ctx context.Context, did string, pType string, body UpdateCompoundServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetContactInformation request
	GetContactInformation(ctx context.Context, did string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateContactInformationWithBody request with any body
	UpdateContactInformationWithBody(ctx context.Context, did string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateContactInformation(ctx context.Context, did string, body UpdateContactInformationJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// AddEndpointWithBody request with any body
	AddEndpointWithBody(ctx context.Context, did string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	AddEndpoint(ctx context.Context, did string, body AddEndpointJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteEndpointsByType request
	DeleteEndpointsByType(ctx context.Context, did string, pType string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateEndpointWithBody request with any body
	UpdateEndpointWithBody(ctx context.Context, did string, pType string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateEndpoint(ctx context.Context, did string, pType string, body UpdateEndpointJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SearchOrganizations request
	SearchOrganizations(ctx context.Context, params *SearchOrganizationsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteService request
	DeleteService(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) AddCompoundServiceWithBodyWithResponse

func (c *ClientWithResponses) AddCompoundServiceWithBodyWithResponse(ctx context.Context, did string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddCompoundServiceResponse, error)

AddCompoundServiceWithBodyWithResponse request with arbitrary body returning *AddCompoundServiceResponse

func (*ClientWithResponses) AddCompoundServiceWithResponse

func (c *ClientWithResponses) AddCompoundServiceWithResponse(ctx context.Context, did string, body AddCompoundServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*AddCompoundServiceResponse, error)

func (*ClientWithResponses) AddEndpointWithBodyWithResponse

func (c *ClientWithResponses) AddEndpointWithBodyWithResponse(ctx context.Context, did string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddEndpointResponse, error)

AddEndpointWithBodyWithResponse request with arbitrary body returning *AddEndpointResponse

func (*ClientWithResponses) AddEndpointWithResponse

func (c *ClientWithResponses) AddEndpointWithResponse(ctx context.Context, did string, body AddEndpointJSONRequestBody, reqEditors ...RequestEditorFn) (*AddEndpointResponse, error)

func (*ClientWithResponses) DeleteEndpointsByTypeWithResponse

func (c *ClientWithResponses) DeleteEndpointsByTypeWithResponse(ctx context.Context, did string, pType string, reqEditors ...RequestEditorFn) (*DeleteEndpointsByTypeResponse, error)

DeleteEndpointsByTypeWithResponse request returning *DeleteEndpointsByTypeResponse

func (*ClientWithResponses) DeleteServiceWithResponse

func (c *ClientWithResponses) DeleteServiceWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*DeleteServiceResponse, error)

DeleteServiceWithResponse request returning *DeleteServiceResponse

func (*ClientWithResponses) GetCompoundServiceEndpointWithResponse

func (c *ClientWithResponses) GetCompoundServiceEndpointWithResponse(ctx context.Context, did string, compoundServiceType string, endpointType string, params *GetCompoundServiceEndpointParams, reqEditors ...RequestEditorFn) (*GetCompoundServiceEndpointResponse, error)

GetCompoundServiceEndpointWithResponse request returning *GetCompoundServiceEndpointResponse

func (*ClientWithResponses) GetCompoundServicesWithResponse

func (c *ClientWithResponses) GetCompoundServicesWithResponse(ctx context.Context, did string, reqEditors ...RequestEditorFn) (*GetCompoundServicesResponse, error)

GetCompoundServicesWithResponse request returning *GetCompoundServicesResponse

func (*ClientWithResponses) GetContactInformationWithResponse

func (c *ClientWithResponses) GetContactInformationWithResponse(ctx context.Context, did string, reqEditors ...RequestEditorFn) (*GetContactInformationResponse, error)

GetContactInformationWithResponse request returning *GetContactInformationResponse

func (*ClientWithResponses) SearchOrganizationsWithResponse

func (c *ClientWithResponses) SearchOrganizationsWithResponse(ctx context.Context, params *SearchOrganizationsParams, reqEditors ...RequestEditorFn) (*SearchOrganizationsResponse, error)

SearchOrganizationsWithResponse request returning *SearchOrganizationsResponse

func (*ClientWithResponses) UpdateCompoundServiceWithBodyWithResponse

func (c *ClientWithResponses) UpdateCompoundServiceWithBodyWithResponse(ctx context.Context, did string, pType string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateCompoundServiceResponse, error)

UpdateCompoundServiceWithBodyWithResponse request with arbitrary body returning *UpdateCompoundServiceResponse

func (*ClientWithResponses) UpdateCompoundServiceWithResponse

func (c *ClientWithResponses) UpdateCompoundServiceWithResponse(ctx context.Context, did string, pType string, body UpdateCompoundServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateCompoundServiceResponse, error)

func (*ClientWithResponses) UpdateContactInformationWithBodyWithResponse

func (c *ClientWithResponses) UpdateContactInformationWithBodyWithResponse(ctx context.Context, did string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateContactInformationResponse, error)

UpdateContactInformationWithBodyWithResponse request with arbitrary body returning *UpdateContactInformationResponse

func (*ClientWithResponses) UpdateContactInformationWithResponse

func (c *ClientWithResponses) UpdateContactInformationWithResponse(ctx context.Context, did string, body UpdateContactInformationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateContactInformationResponse, error)

func (*ClientWithResponses) UpdateEndpointWithBodyWithResponse

func (c *ClientWithResponses) UpdateEndpointWithBodyWithResponse(ctx context.Context, did string, pType string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateEndpointResponse, error)

UpdateEndpointWithBodyWithResponse request with arbitrary body returning *UpdateEndpointResponse

func (*ClientWithResponses) UpdateEndpointWithResponse

func (c *ClientWithResponses) UpdateEndpointWithResponse(ctx context.Context, did string, pType string, body UpdateEndpointJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateEndpointResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetCompoundServicesWithResponse request
	GetCompoundServicesWithResponse(ctx context.Context, did string, reqEditors ...RequestEditorFn) (*GetCompoundServicesResponse, error)

	// AddCompoundServiceWithBodyWithResponse request with any body
	AddCompoundServiceWithBodyWithResponse(ctx context.Context, did string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddCompoundServiceResponse, error)

	AddCompoundServiceWithResponse(ctx context.Context, did string, body AddCompoundServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*AddCompoundServiceResponse, error)

	// GetCompoundServiceEndpointWithResponse request
	GetCompoundServiceEndpointWithResponse(ctx context.Context, did string, compoundServiceType string, endpointType string, params *GetCompoundServiceEndpointParams, reqEditors ...RequestEditorFn) (*GetCompoundServiceEndpointResponse, error)

	// UpdateCompoundServiceWithBodyWithResponse request with any body
	UpdateCompoundServiceWithBodyWithResponse(ctx context.Context, did string, pType string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateCompoundServiceResponse, error)

	UpdateCompoundServiceWithResponse(ctx context.Context, did string, pType string, body UpdateCompoundServiceJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateCompoundServiceResponse, error)

	// GetContactInformationWithResponse request
	GetContactInformationWithResponse(ctx context.Context, did string, reqEditors ...RequestEditorFn) (*GetContactInformationResponse, error)

	// UpdateContactInformationWithBodyWithResponse request with any body
	UpdateContactInformationWithBodyWithResponse(ctx context.Context, did string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateContactInformationResponse, error)

	UpdateContactInformationWithResponse(ctx context.Context, did string, body UpdateContactInformationJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateContactInformationResponse, error)

	// AddEndpointWithBodyWithResponse request with any body
	AddEndpointWithBodyWithResponse(ctx context.Context, did string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AddEndpointResponse, error)

	AddEndpointWithResponse(ctx context.Context, did string, body AddEndpointJSONRequestBody, reqEditors ...RequestEditorFn) (*AddEndpointResponse, error)

	// DeleteEndpointsByTypeWithResponse request
	DeleteEndpointsByTypeWithResponse(ctx context.Context, did string, pType string, reqEditors ...RequestEditorFn) (*DeleteEndpointsByTypeResponse, error)

	// UpdateEndpointWithBodyWithResponse request with any body
	UpdateEndpointWithBodyWithResponse(ctx context.Context, did string, pType string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateEndpointResponse, error)

	UpdateEndpointWithResponse(ctx context.Context, did string, pType string, body UpdateEndpointJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateEndpointResponse, error)

	// SearchOrganizationsWithResponse request
	SearchOrganizationsWithResponse(ctx context.Context, params *SearchOrganizationsParams, reqEditors ...RequestEditorFn) (*SearchOrganizationsResponse, error)

	// DeleteServiceWithResponse request
	DeleteServiceWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*DeleteServiceResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CompoundService

type CompoundService did.Service

CompoundService is a type definition for the already defined did.CompoundService

type CompoundServiceProperties

type CompoundServiceProperties struct {
	// ServiceEndpoint A map containing service references and/or endpoints.
	ServiceEndpoint map[string]interface{} `json:"serviceEndpoint"`

	// Type type of the endpoint. May be freely chosen.
	Type string `json:"type"`
}

CompoundServiceProperties A creation request for a compound service that contains endpoints. The endpoints can be either absolute endpoints or references.

type ContactInformation

type ContactInformation = didman.ContactInformation

ContactInformation is a type definition for the already defined didman.ContactInformation

type DeleteEndpointsByType204Response

type DeleteEndpointsByType204Response struct {
}

func (DeleteEndpointsByType204Response) VisitDeleteEndpointsByTypeResponse

func (response DeleteEndpointsByType204Response) VisitDeleteEndpointsByTypeResponse(w http.ResponseWriter) error

type DeleteEndpointsByTypeRequestObject

type DeleteEndpointsByTypeRequestObject struct {
	Did  string `json:"did"`
	Type string `json:"type"`
}

type DeleteEndpointsByTypeResponse

type DeleteEndpointsByTypeResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationproblemJSONDefault *struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
}

func ParseDeleteEndpointsByTypeResponse

func ParseDeleteEndpointsByTypeResponse(rsp *http.Response) (*DeleteEndpointsByTypeResponse, error)

ParseDeleteEndpointsByTypeResponse parses an HTTP response from a DeleteEndpointsByTypeWithResponse call

func (DeleteEndpointsByTypeResponse) Status

Status returns HTTPResponse.Status

func (DeleteEndpointsByTypeResponse) StatusCode

func (r DeleteEndpointsByTypeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteEndpointsByTypeResponseObject

type DeleteEndpointsByTypeResponseObject interface {
	VisitDeleteEndpointsByTypeResponse(w http.ResponseWriter) error
}

type DeleteEndpointsByTypedefaultApplicationProblemPlusJSONResponse

type DeleteEndpointsByTypedefaultApplicationProblemPlusJSONResponse struct {
	Body struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
	StatusCode int
}

func (DeleteEndpointsByTypedefaultApplicationProblemPlusJSONResponse) VisitDeleteEndpointsByTypeResponse

func (response DeleteEndpointsByTypedefaultApplicationProblemPlusJSONResponse) VisitDeleteEndpointsByTypeResponse(w http.ResponseWriter) error

type DeleteService204Response

type DeleteService204Response struct {
}

func (DeleteService204Response) VisitDeleteServiceResponse

func (response DeleteService204Response) VisitDeleteServiceResponse(w http.ResponseWriter) error

type DeleteServiceRequestObject

type DeleteServiceRequestObject struct {
	Id string `json:"id"`
}

type DeleteServiceResponse

type DeleteServiceResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	ApplicationproblemJSONDefault *struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
}

func ParseDeleteServiceResponse

func ParseDeleteServiceResponse(rsp *http.Response) (*DeleteServiceResponse, error)

ParseDeleteServiceResponse parses an HTTP response from a DeleteServiceWithResponse call

func (DeleteServiceResponse) Status

func (r DeleteServiceResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteServiceResponse) StatusCode

func (r DeleteServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteServiceResponseObject

type DeleteServiceResponseObject interface {
	VisitDeleteServiceResponse(w http.ResponseWriter) error
}

type DeleteServicedefaultApplicationProblemPlusJSONResponse

type DeleteServicedefaultApplicationProblemPlusJSONResponse struct {
	Body struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
	StatusCode int
}

func (DeleteServicedefaultApplicationProblemPlusJSONResponse) VisitDeleteServiceResponse

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 Endpoint

type Endpoint did.Service

Endpoint is an alias for the already defined did.Service It's an alias (instead of a type definition) because we don't want to use the custom marshaler of did.Service, to make the response symmetric to the request body (given endpoint is a string, we want to return a string, rather than an array containing a string).

type EndpointProperties

type EndpointProperties struct {
	// Endpoint An endpoint URL or a reference to another service.
	Endpoint string `json:"endpoint"`

	// Type type of the endpoint. May be freely chosen.
	Type string `json:"type"`
}

EndpointProperties A combination of type and URL.

type EndpointResponse

type EndpointResponse struct {
	// Endpoint The endpoint URL.
	Endpoint string `json:"endpoint"`
}

EndpointResponse defines model for EndpointResponse.

type Error

type Error = problem.Problem

Error is a type definition for the already defined problem.Problem

type GetCompoundServiceEndpoint200JSONResponse

type GetCompoundServiceEndpoint200JSONResponse EndpointResponse

func (GetCompoundServiceEndpoint200JSONResponse) VisitGetCompoundServiceEndpointResponse

func (response GetCompoundServiceEndpoint200JSONResponse) VisitGetCompoundServiceEndpointResponse(w http.ResponseWriter) error

type GetCompoundServiceEndpoint200TextResponse

type GetCompoundServiceEndpoint200TextResponse string

func (GetCompoundServiceEndpoint200TextResponse) VisitGetCompoundServiceEndpointResponse

func (response GetCompoundServiceEndpoint200TextResponse) VisitGetCompoundServiceEndpointResponse(w http.ResponseWriter) error

type GetCompoundServiceEndpointParams

type GetCompoundServiceEndpointParams struct {
	// Resolve Whether to resolve references. When true and the given endpoint is a reference it returns the endpoint of the referenced service.
	// If false it returns the reference itself. Defaults to true.
	Resolve *bool `form:"resolve,omitempty" json:"resolve,omitempty"`

	// Accept The requested return type, defaults to application/json.
	Accept *string `json:"accept,omitempty"`
}

GetCompoundServiceEndpointParams defines parameters for GetCompoundServiceEndpoint.

type GetCompoundServiceEndpointRequestObject

type GetCompoundServiceEndpointRequestObject struct {
	Did                 string `json:"did"`
	CompoundServiceType string `json:"compoundServiceType"`
	EndpointType        string `json:"endpointType"`
	Params              GetCompoundServiceEndpointParams
}

type GetCompoundServiceEndpointResponse

type GetCompoundServiceEndpointResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *EndpointResponse
	ApplicationproblemJSONDefault *struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
}

func ParseGetCompoundServiceEndpointResponse

func ParseGetCompoundServiceEndpointResponse(rsp *http.Response) (*GetCompoundServiceEndpointResponse, error)

ParseGetCompoundServiceEndpointResponse parses an HTTP response from a GetCompoundServiceEndpointWithResponse call

func (GetCompoundServiceEndpointResponse) Status

Status returns HTTPResponse.Status

func (GetCompoundServiceEndpointResponse) StatusCode

func (r GetCompoundServiceEndpointResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCompoundServiceEndpointResponseObject

type GetCompoundServiceEndpointResponseObject interface {
	VisitGetCompoundServiceEndpointResponse(w http.ResponseWriter) error
}

type GetCompoundServiceEndpointdefaultApplicationProblemPlusJSONResponse

type GetCompoundServiceEndpointdefaultApplicationProblemPlusJSONResponse struct {
	Body struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
	StatusCode int
}

func (GetCompoundServiceEndpointdefaultApplicationProblemPlusJSONResponse) VisitGetCompoundServiceEndpointResponse

func (response GetCompoundServiceEndpointdefaultApplicationProblemPlusJSONResponse) VisitGetCompoundServiceEndpointResponse(w http.ResponseWriter) error

type GetCompoundServices200JSONResponse

type GetCompoundServices200JSONResponse []CompoundService

func (GetCompoundServices200JSONResponse) VisitGetCompoundServicesResponse

func (response GetCompoundServices200JSONResponse) VisitGetCompoundServicesResponse(w http.ResponseWriter) error

type GetCompoundServicesRequestObject

type GetCompoundServicesRequestObject struct {
	Did string `json:"did"`
}

type GetCompoundServicesResponse

type GetCompoundServicesResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *[]CompoundService
	ApplicationproblemJSONDefault *struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
}

func ParseGetCompoundServicesResponse

func ParseGetCompoundServicesResponse(rsp *http.Response) (*GetCompoundServicesResponse, error)

ParseGetCompoundServicesResponse parses an HTTP response from a GetCompoundServicesWithResponse call

func (GetCompoundServicesResponse) Status

Status returns HTTPResponse.Status

func (GetCompoundServicesResponse) StatusCode

func (r GetCompoundServicesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCompoundServicesResponseObject

type GetCompoundServicesResponseObject interface {
	VisitGetCompoundServicesResponse(w http.ResponseWriter) error
}

type GetCompoundServicesdefaultApplicationProblemPlusJSONResponse

type GetCompoundServicesdefaultApplicationProblemPlusJSONResponse struct {
	Body struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
	StatusCode int
}

func (GetCompoundServicesdefaultApplicationProblemPlusJSONResponse) VisitGetCompoundServicesResponse

func (response GetCompoundServicesdefaultApplicationProblemPlusJSONResponse) VisitGetCompoundServicesResponse(w http.ResponseWriter) error

type GetContactInformation200JSONResponse

type GetContactInformation200JSONResponse ContactInformation

func (GetContactInformation200JSONResponse) VisitGetContactInformationResponse

func (response GetContactInformation200JSONResponse) VisitGetContactInformationResponse(w http.ResponseWriter) error

type GetContactInformationRequestObject

type GetContactInformationRequestObject struct {
	Did string `json:"did"`
}

type GetContactInformationResponse

type GetContactInformationResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *ContactInformation
	ApplicationproblemJSONDefault *struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
}

func ParseGetContactInformationResponse

func ParseGetContactInformationResponse(rsp *http.Response) (*GetContactInformationResponse, error)

ParseGetContactInformationResponse parses an HTTP response from a GetContactInformationWithResponse call

func (GetContactInformationResponse) Status

Status returns HTTPResponse.Status

func (GetContactInformationResponse) StatusCode

func (r GetContactInformationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetContactInformationResponseObject

type GetContactInformationResponseObject interface {
	VisitGetContactInformationResponse(w http.ResponseWriter) error
}

type GetContactInformationdefaultApplicationProblemPlusJSONResponse

type GetContactInformationdefaultApplicationProblemPlusJSONResponse struct {
	Body struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
	StatusCode int
}

func (GetContactInformationdefaultApplicationProblemPlusJSONResponse) VisitGetContactInformationResponse

func (response GetContactInformationdefaultApplicationProblemPlusJSONResponse) VisitGetContactInformationResponse(w http.ResponseWriter) error

type HTTPClient

type HTTPClient struct {
	core.ClientConfig
	TokenGenerator core.AuthorizationTokenGenerator
}

HTTPClient holds the server address and other basic settings for the http client

func (HTTPClient) AddCompoundService

func (hb HTTPClient) AddCompoundService(did, serviceType string, references map[string]string) (*CompoundService, error)

AddCompoundService registers a compound service on the given DID.

func (HTTPClient) AddEndpoint

func (hb HTTPClient) AddEndpoint(did, endpointType, endpointURL string) (*Endpoint, error)

AddEndpoint registers a concrete endpoint URL on the given DID.

func (HTTPClient) DeleteEndpointsByType

func (hb HTTPClient) DeleteEndpointsByType(did, endpointType string) error

DeleteEndpointsByType deletes an endpoint by type on a DID document indicated by the did.

func (HTTPClient) DeleteService

func (hb HTTPClient) DeleteService(id ssi.URI) error

DeleteService tries to delete a service from the DID document indicated by the ID Returns an error if the service does not exists, is still in use or if the DID is not managed by this node.

func (HTTPClient) GetCompoundServices

func (hb HTTPClient) GetCompoundServices(did string) ([]CompoundService, error)

GetCompoundServices returns a list of compound services for a given DID string.

func (HTTPClient) GetContactInformation

func (hb HTTPClient) GetContactInformation(did string) (*ContactInformation, error)

GetContactInformation retrieves the contact information registered on the given DID. If the DID does not exist, an error is returned. If the DID does exist but has no contact information nothing is returned.

func (HTTPClient) UpdateContactInformation

func (hb HTTPClient) UpdateContactInformation(did string, information ContactInformation) error

UpdateContactInformation (over)writes the contact information on given DID. If the DID does not exist an error is returned.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type OrganizationSearchResult

type OrganizationSearchResult = didman.OrganizationSearchResult

OrganizationSearchResult is a type definition for the already defined didman.OrganizationSearchResult

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type SearchOrganizations200JSONResponse

type SearchOrganizations200JSONResponse []OrganizationSearchResult

func (SearchOrganizations200JSONResponse) VisitSearchOrganizationsResponse

func (response SearchOrganizations200JSONResponse) VisitSearchOrganizationsResponse(w http.ResponseWriter) error

type SearchOrganizationsParams

type SearchOrganizationsParams struct {
	// Query Query used for searching the organization by name. The query is matched to the organization's name in a SQL's "LIKE" fashion: it matches partial strings and also names that sound like the given query, using a phonetic transformation algorithm.
	Query string `form:"query" json:"query"`

	// DidServiceType Filters organizations by service of the given type in the organizations' DID document (optional).
	DidServiceType *string `form:"didServiceType,omitempty" json:"didServiceType,omitempty"`
}

SearchOrganizationsParams defines parameters for SearchOrganizations.

type SearchOrganizationsRequestObject

type SearchOrganizationsRequestObject struct {
	Params SearchOrganizationsParams
}

type SearchOrganizationsResponse

type SearchOrganizationsResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *[]OrganizationSearchResult
	ApplicationproblemJSONDefault *struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
}

func ParseSearchOrganizationsResponse

func ParseSearchOrganizationsResponse(rsp *http.Response) (*SearchOrganizationsResponse, error)

ParseSearchOrganizationsResponse parses an HTTP response from a SearchOrganizationsWithResponse call

func (SearchOrganizationsResponse) Status

Status returns HTTPResponse.Status

func (SearchOrganizationsResponse) StatusCode

func (r SearchOrganizationsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchOrganizationsResponseObject

type SearchOrganizationsResponseObject interface {
	VisitSearchOrganizationsResponse(w http.ResponseWriter) error
}

type SearchOrganizationsdefaultApplicationProblemPlusJSONResponse

type SearchOrganizationsdefaultApplicationProblemPlusJSONResponse struct {
	Body struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
	StatusCode int
}

func (SearchOrganizationsdefaultApplicationProblemPlusJSONResponse) VisitSearchOrganizationsResponse

func (response SearchOrganizationsdefaultApplicationProblemPlusJSONResponse) VisitSearchOrganizationsResponse(w http.ResponseWriter) error

type ServerInterface

type ServerInterface interface {
	// Get a list of compound services for a DID document.
	//
	// error responses:
	// * 400 - incorrect input
	// * 404 - unknown DID
	// (GET /internal/didman/v1/did/{did}/compoundservice)
	GetCompoundServices(ctx echo.Context, did string) error
	// Add a compound service to a DID Document.
	// (POST /internal/didman/v1/did/{did}/compoundservice)
	AddCompoundService(ctx echo.Context, did string) error
	// Retrieves the endpoint with the specified endpointType from the specified compound service.
	// (GET /internal/didman/v1/did/{did}/compoundservice/{compoundServiceType}/endpoint/{endpointType})
	GetCompoundServiceEndpoint(ctx echo.Context, did string, compoundServiceType string, endpointType string, params GetCompoundServiceEndpointParams) error
	// Update a compound service.
	// (PUT /internal/didman/v1/did/{did}/compoundservice/{type})
	UpdateCompoundService(ctx echo.Context, did string, pType string) error

	// (GET /internal/didman/v1/did/{did}/contactinfo)
	GetContactInformation(ctx echo.Context, did string) error
	// Add a predetermined DID Service with real life contact information
	// (PUT /internal/didman/v1/did/{did}/contactinfo)
	UpdateContactInformation(ctx echo.Context, did string) error
	// Add a service endpoint or a reference to a service.
	// (POST /internal/didman/v1/did/{did}/endpoint)
	AddEndpoint(ctx echo.Context, did string) error

	// (DELETE /internal/didman/v1/did/{did}/endpoint/{type})
	DeleteEndpointsByType(ctx echo.Context, did string, pType string) error
	// Update a service endpoint or a reference to a service.
	// (PUT /internal/didman/v1/did/{did}/endpoint/{type})
	UpdateEndpoint(ctx echo.Context, did string, pType string) error

	// (GET /internal/didman/v1/search/organizations)
	SearchOrganizations(ctx echo.Context, params SearchOrganizationsParams) error
	// Remove a service from a DID Document.
	// (DELETE /internal/didman/v1/service/{id})
	DeleteService(ctx echo.Context, id string) error
}

ServerInterface represents all server handlers.

func NewStrictHandler

func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) AddCompoundService

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

AddCompoundService converts echo context to params.

func (*ServerInterfaceWrapper) AddEndpoint

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

AddEndpoint converts echo context to params.

func (*ServerInterfaceWrapper) DeleteEndpointsByType

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

DeleteEndpointsByType converts echo context to params.

func (*ServerInterfaceWrapper) DeleteService

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

DeleteService converts echo context to params.

func (*ServerInterfaceWrapper) GetCompoundServiceEndpoint

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

GetCompoundServiceEndpoint converts echo context to params.

func (*ServerInterfaceWrapper) GetCompoundServices

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

GetCompoundServices converts echo context to params.

func (*ServerInterfaceWrapper) GetContactInformation

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

GetContactInformation converts echo context to params.

func (*ServerInterfaceWrapper) SearchOrganizations

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

SearchOrganizations converts echo context to params.

func (*ServerInterfaceWrapper) UpdateCompoundService

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

UpdateCompoundService converts echo context to params.

func (*ServerInterfaceWrapper) UpdateContactInformation

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

UpdateContactInformation converts echo context to params.

func (*ServerInterfaceWrapper) UpdateEndpoint

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

UpdateEndpoint converts echo context to params.

type StrictHandlerFunc

type StrictHandlerFunc = strictecho.StrictEchoHandlerFunc

type StrictMiddlewareFunc

type StrictMiddlewareFunc = strictecho.StrictEchoMiddlewareFunc

type StrictServerInterface

type StrictServerInterface interface {
	// Get a list of compound services for a DID document.
	//
	// error responses:
	// * 400 - incorrect input
	// * 404 - unknown DID
	// (GET /internal/didman/v1/did/{did}/compoundservice)
	GetCompoundServices(ctx context.Context, request GetCompoundServicesRequestObject) (GetCompoundServicesResponseObject, error)
	// Add a compound service to a DID Document.
	// (POST /internal/didman/v1/did/{did}/compoundservice)
	AddCompoundService(ctx context.Context, request AddCompoundServiceRequestObject) (AddCompoundServiceResponseObject, error)
	// Retrieves the endpoint with the specified endpointType from the specified compound service.
	// (GET /internal/didman/v1/did/{did}/compoundservice/{compoundServiceType}/endpoint/{endpointType})
	GetCompoundServiceEndpoint(ctx context.Context, request GetCompoundServiceEndpointRequestObject) (GetCompoundServiceEndpointResponseObject, error)
	// Update a compound service.
	// (PUT /internal/didman/v1/did/{did}/compoundservice/{type})
	UpdateCompoundService(ctx context.Context, request UpdateCompoundServiceRequestObject) (UpdateCompoundServiceResponseObject, error)

	// (GET /internal/didman/v1/did/{did}/contactinfo)
	GetContactInformation(ctx context.Context, request GetContactInformationRequestObject) (GetContactInformationResponseObject, error)
	// Add a predetermined DID Service with real life contact information
	// (PUT /internal/didman/v1/did/{did}/contactinfo)
	UpdateContactInformation(ctx context.Context, request UpdateContactInformationRequestObject) (UpdateContactInformationResponseObject, error)
	// Add a service endpoint or a reference to a service.
	// (POST /internal/didman/v1/did/{did}/endpoint)
	AddEndpoint(ctx context.Context, request AddEndpointRequestObject) (AddEndpointResponseObject, error)

	// (DELETE /internal/didman/v1/did/{did}/endpoint/{type})
	DeleteEndpointsByType(ctx context.Context, request DeleteEndpointsByTypeRequestObject) (DeleteEndpointsByTypeResponseObject, error)
	// Update a service endpoint or a reference to a service.
	// (PUT /internal/didman/v1/did/{did}/endpoint/{type})
	UpdateEndpoint(ctx context.Context, request UpdateEndpointRequestObject) (UpdateEndpointResponseObject, error)

	// (GET /internal/didman/v1/search/organizations)
	SearchOrganizations(ctx context.Context, request SearchOrganizationsRequestObject) (SearchOrganizationsResponseObject, error)
	// Remove a service from a DID Document.
	// (DELETE /internal/didman/v1/service/{id})
	DeleteService(ctx context.Context, request DeleteServiceRequestObject) (DeleteServiceResponseObject, error)
}

StrictServerInterface represents all server handlers.

type UpdateCompoundService200JSONResponse

type UpdateCompoundService200JSONResponse CompoundService

func (UpdateCompoundService200JSONResponse) VisitUpdateCompoundServiceResponse

func (response UpdateCompoundService200JSONResponse) VisitUpdateCompoundServiceResponse(w http.ResponseWriter) error

type UpdateCompoundServiceJSONRequestBody

type UpdateCompoundServiceJSONRequestBody = CompoundServiceProperties

UpdateCompoundServiceJSONRequestBody defines body for UpdateCompoundService for application/json ContentType.

type UpdateCompoundServiceRequestObject

type UpdateCompoundServiceRequestObject struct {
	Did  string `json:"did"`
	Type string `json:"type"`
	Body *UpdateCompoundServiceJSONRequestBody
}

type UpdateCompoundServiceResponse

type UpdateCompoundServiceResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *CompoundService
	ApplicationproblemJSONDefault *struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
}

func ParseUpdateCompoundServiceResponse

func ParseUpdateCompoundServiceResponse(rsp *http.Response) (*UpdateCompoundServiceResponse, error)

ParseUpdateCompoundServiceResponse parses an HTTP response from a UpdateCompoundServiceWithResponse call

func (UpdateCompoundServiceResponse) Status

Status returns HTTPResponse.Status

func (UpdateCompoundServiceResponse) StatusCode

func (r UpdateCompoundServiceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateCompoundServiceResponseObject

type UpdateCompoundServiceResponseObject interface {
	VisitUpdateCompoundServiceResponse(w http.ResponseWriter) error
}

type UpdateCompoundServicedefaultApplicationProblemPlusJSONResponse

type UpdateCompoundServicedefaultApplicationProblemPlusJSONResponse struct {
	Body struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
	StatusCode int
}

func (UpdateCompoundServicedefaultApplicationProblemPlusJSONResponse) VisitUpdateCompoundServiceResponse

func (response UpdateCompoundServicedefaultApplicationProblemPlusJSONResponse) VisitUpdateCompoundServiceResponse(w http.ResponseWriter) error

type UpdateContactInformation200JSONResponse

type UpdateContactInformation200JSONResponse ContactInformation

func (UpdateContactInformation200JSONResponse) VisitUpdateContactInformationResponse

func (response UpdateContactInformation200JSONResponse) VisitUpdateContactInformationResponse(w http.ResponseWriter) error

type UpdateContactInformationJSONRequestBody

type UpdateContactInformationJSONRequestBody = ContactInformation

UpdateContactInformationJSONRequestBody defines body for UpdateContactInformation for application/json ContentType.

type UpdateContactInformationRequestObject

type UpdateContactInformationRequestObject struct {
	Did  string `json:"did"`
	Body *UpdateContactInformationJSONRequestBody
}

type UpdateContactInformationResponse

type UpdateContactInformationResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *ContactInformation
	ApplicationproblemJSONDefault *struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
}

func ParseUpdateContactInformationResponse

func ParseUpdateContactInformationResponse(rsp *http.Response) (*UpdateContactInformationResponse, error)

ParseUpdateContactInformationResponse parses an HTTP response from a UpdateContactInformationWithResponse call

func (UpdateContactInformationResponse) Status

Status returns HTTPResponse.Status

func (UpdateContactInformationResponse) StatusCode

func (r UpdateContactInformationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateContactInformationResponseObject

type UpdateContactInformationResponseObject interface {
	VisitUpdateContactInformationResponse(w http.ResponseWriter) error
}

type UpdateContactInformationdefaultApplicationProblemPlusJSONResponse

type UpdateContactInformationdefaultApplicationProblemPlusJSONResponse struct {
	Body struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
	StatusCode int
}

func (UpdateContactInformationdefaultApplicationProblemPlusJSONResponse) VisitUpdateContactInformationResponse

func (response UpdateContactInformationdefaultApplicationProblemPlusJSONResponse) VisitUpdateContactInformationResponse(w http.ResponseWriter) error

type UpdateEndpoint200JSONResponse

type UpdateEndpoint200JSONResponse Endpoint

func (UpdateEndpoint200JSONResponse) VisitUpdateEndpointResponse

func (response UpdateEndpoint200JSONResponse) VisitUpdateEndpointResponse(w http.ResponseWriter) error

type UpdateEndpointJSONRequestBody

type UpdateEndpointJSONRequestBody = EndpointProperties

UpdateEndpointJSONRequestBody defines body for UpdateEndpoint for application/json ContentType.

type UpdateEndpointRequestObject

type UpdateEndpointRequestObject struct {
	Did  string `json:"did"`
	Type string `json:"type"`
	Body *UpdateEndpointJSONRequestBody
}

type UpdateEndpointResponse

type UpdateEndpointResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *Endpoint
	ApplicationproblemJSONDefault *struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
}

func ParseUpdateEndpointResponse

func ParseUpdateEndpointResponse(rsp *http.Response) (*UpdateEndpointResponse, error)

ParseUpdateEndpointResponse parses an HTTP response from a UpdateEndpointWithResponse call

func (UpdateEndpointResponse) Status

func (r UpdateEndpointResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateEndpointResponse) StatusCode

func (r UpdateEndpointResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateEndpointResponseObject

type UpdateEndpointResponseObject interface {
	VisitUpdateEndpointResponse(w http.ResponseWriter) error
}

type UpdateEndpointdefaultApplicationProblemPlusJSONResponse

type UpdateEndpointdefaultApplicationProblemPlusJSONResponse struct {
	Body struct {
		// Detail A human-readable explanation specific to this occurrence of the problem.
		Detail string `json:"detail"`

		// Status HTTP statuscode
		Status float32 `json:"status"`

		// Title A short, human-readable summary of the problem type.
		Title string `json:"title"`
	}
	StatusCode int
}

func (UpdateEndpointdefaultApplicationProblemPlusJSONResponse) VisitUpdateEndpointResponse

func (response UpdateEndpointdefaultApplicationProblemPlusJSONResponse) VisitUpdateEndpointResponse(w http.ResponseWriter) error

type Wrapper

type Wrapper struct {
	Didman didman.Didman
}

Wrapper implements the generated interface from oapi-codegen

func (*Wrapper) AddCompoundService

AddCompoundService handles calls to add a compound service. A CompoundService consists of a type and a map of name -> serviceEndpoint(Ref).

This method checks the params: valid DID and type format Converts the request to an CompoundService Calls didman.AddCompoundService, which does the heavy lifting. Converts the response of AddCompoundService, which is a did.Service back to a CompoundService Sets the http status OK and adds the CompoundService to the response

func (*Wrapper) AddEndpoint

AddEndpoint handles calls to add a service. It only checks params and sets the correct return status code. didman.AddEndpoint does the heavy lifting.

func (*Wrapper) DeleteEndpointsByType

DeleteEndpointsByType handles calls to delete an endpoint. It only checks params and sets the correct return status code. didman.DeleteEndpoint does the heavy lifting.

func (*Wrapper) DeleteService

DeleteService handles calls to delete a service. It only checks params and sets the correct return status code. didman.DeleteService does the heavy lifting.

func (*Wrapper) GetCompoundServiceEndpoint

GetCompoundServiceEndpoint handles calls to read a specific endpoint of a compound service.

func (*Wrapper) GetCompoundServices

GetCompoundServices handles calls to get a list of compound services for a provided DID string. Its checks params, calls Didman and sets http return values.

func (*Wrapper) GetContactInformation

GetContactInformation handles requests for contact information for a specific DID. It parses the did path param and passes it to didman.GetContactInformation.

func (*Wrapper) ResolveStatusCode

func (w *Wrapper) ResolveStatusCode(err error) int

ResolveStatusCode maps errors returned by this API to specific HTTP status codes.

func (*Wrapper) Routes

func (w *Wrapper) Routes(router core.EchoRouter)

Routes registers the routes from the open api spec to the echo router.

func (*Wrapper) SearchOrganizations

SearchOrganizations handles requests for searching organizations, meaning it looks for (valid) Verifiable Credentials that map to the "organization" concept and where its subject resolves to an active DID Document. It optionally filters only on organizations which DID documents contain a service with the specified type.

func (*Wrapper) UpdateCompoundService

UpdateCompoundService handles calls to update a compound service.

func (*Wrapper) UpdateContactInformation

UpdateContactInformation handles requests for updating contact information for a specific DID. It parses the did path param and unmarshals the request body and passes them to didman.UpdateContactInformation.

func (*Wrapper) UpdateEndpoint

UpdateEndpoint handles calls to update a service. It only checks params and sets the correct return status code. didman.UpdateEndpoint does the heavy lifting.

Jump to

Keyboard shortcuts

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