api

package module
v0.0.0-...-93b16a7 Latest Latest
Warning

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

 Go to latest Published: Mar 26, 2024 License: EUPL-1.2 Imports: 17 Imported by: 0

Documentation

Overview

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSwagger 

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func Handler 

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux 

func HandlerFromMux(si ServerInterface, r chi.Router) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL 

func HandlerFromMuxWithBaseURL(si ServerInterface, r chi.Router, baseURL string) http.Handler

func HandlerWithOptions 

func HandlerWithOptions(si ServerInterface, options ChiServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

func NewCreateWorldRequest 

func NewCreateWorldRequest(server string, params *CreateWorldParams, body CreateWorldJSONRequestBody) (*http.Request, error)

NewCreateWorldRequest calls the generic CreateWorld builder with application/json body

func NewCreateWorldRequestWithBody 

func NewCreateWorldRequestWithBody(server string, params *CreateWorldParams, contentType string, body io.Reader) (*http.Request, error)

NewCreateWorldRequestWithBody generates requests for CreateWorld with any type of body

func NewDeleteWorldByIdRequest 

func NewDeleteWorldByIdRequest(server string, worldId PathWorldId, params *DeleteWorldByIdParams) (*http.Request, error)

NewDeleteWorldByIdRequest generates requests for DeleteWorldById

func NewReadWorldByIdRequest 

func NewReadWorldByIdRequest(server string, worldId PathWorldId, params *ReadWorldByIdParams) (*http.Request, error)

NewReadWorldByIdRequest generates requests for ReadWorldById

func NewSearchWorldsRequest 

func NewSearchWorldsRequest(server string, params *SearchWorldsParams) (*http.Request, error)

NewSearchWorldsRequest generates requests for SearchWorlds

func NewUpdateWorldByIdRequest 

func NewUpdateWorldByIdRequest(server string, worldId PathWorldId, params *UpdateWorldByIdParams, body UpdateWorldByIdJSONRequestBody) (*http.Request, error)

NewUpdateWorldByIdRequest calls the generic UpdateWorldById builder with application/json body

func NewUpdateWorldByIdRequestWithBody 

func NewUpdateWorldByIdRequestWithBody(server string, worldId PathWorldId, params *UpdateWorldByIdParams, contentType string, body io.Reader) (*http.Request, error)

NewUpdateWorldByIdRequestWithBody generates requests for UpdateWorldById with any type of body

func PathToRawSpec 

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type BadRequestErrorResponse 

type BadRequestErrorResponse struct {
	Errors []Error `json:"errors"`
}

BadRequestErrorResponse defines model for BadRequestErrorResponse.

type BadRequestErrorResponseJSONResponse 

type BadRequestErrorResponseJSONResponse struct {
	Errors []Error `json:"errors"`
}

type ChiServerOptions 

type ChiServerOptions struct {
	BaseURL          string
	BaseRouter       chi.Router
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

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) CreateWorld 

func (c *Client) CreateWorld(ctx context.Context, params *CreateWorldParams, body CreateWorldJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) CreateWorldWithBody 

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

func (*Client) DeleteWorldById 

func (c *Client) DeleteWorldById(ctx context.Context, worldId PathWorldId, params *DeleteWorldByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ReadWorldById 

func (c *Client) ReadWorldById(ctx context.Context, worldId PathWorldId, params *ReadWorldByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SearchWorlds 

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

func (*Client) UpdateWorldById 

func (c *Client) UpdateWorldById(ctx context.Context, worldId PathWorldId, params *UpdateWorldByIdParams, body UpdateWorldByIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateWorldByIdWithBody 

func (c *Client) UpdateWorldByIdWithBody(ctx context.Context, worldId PathWorldId, params *UpdateWorldByIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// SearchWorlds request
	SearchWorlds(ctx context.Context, params *SearchWorldsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	CreateWorld(ctx context.Context, params *CreateWorldParams, body CreateWorldJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteWorldById request
	DeleteWorldById(ctx context.Context, worldId PathWorldId, params *DeleteWorldByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReadWorldById request
	ReadWorldById(ctx context.Context, worldId PathWorldId, params *ReadWorldByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateWorldByIdWithBody request with any body
	UpdateWorldByIdWithBody(ctx context.Context, worldId PathWorldId, params *UpdateWorldByIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateWorldById(ctx context.Context, worldId PathWorldId, params *UpdateWorldByIdParams, body UpdateWorldByIdJSONRequestBody, 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) CreateWorldWithBodyWithResponse 

func (c *ClientWithResponses) CreateWorldWithBodyWithResponse(ctx context.Context, params *CreateWorldParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateWorldResponse, error)

CreateWorldWithBodyWithResponse request with arbitrary body returning *CreateWorldResponse

func (*ClientWithResponses) CreateWorldWithResponse 

func (c *ClientWithResponses) CreateWorldWithResponse(ctx context.Context, params *CreateWorldParams, body CreateWorldJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWorldResponse, error)

func (*ClientWithResponses) DeleteWorldByIdWithResponse 

func (c *ClientWithResponses) DeleteWorldByIdWithResponse(ctx context.Context, worldId PathWorldId, params *DeleteWorldByIdParams, reqEditors ...RequestEditorFn) (*DeleteWorldByIdResponse, error)

DeleteWorldByIdWithResponse request returning *DeleteWorldByIdResponse

func (*ClientWithResponses) ReadWorldByIdWithResponse 

func (c *ClientWithResponses) ReadWorldByIdWithResponse(ctx context.Context, worldId PathWorldId, params *ReadWorldByIdParams, reqEditors ...RequestEditorFn) (*ReadWorldByIdResponse, error)

ReadWorldByIdWithResponse request returning *ReadWorldByIdResponse

func (*ClientWithResponses) SearchWorldsWithResponse 

func (c *ClientWithResponses) SearchWorldsWithResponse(ctx context.Context, params *SearchWorldsParams, reqEditors ...RequestEditorFn) (*SearchWorldsResponse, error)

SearchWorldsWithResponse request returning *SearchWorldsResponse

func (*ClientWithResponses) UpdateWorldByIdWithBodyWithResponse 

func (c *ClientWithResponses) UpdateWorldByIdWithBodyWithResponse(ctx context.Context, worldId PathWorldId, params *UpdateWorldByIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateWorldByIdResponse, error)

UpdateWorldByIdWithBodyWithResponse request with arbitrary body returning *UpdateWorldByIdResponse

func (*ClientWithResponses) UpdateWorldByIdWithResponse 

func (c *ClientWithResponses) UpdateWorldByIdWithResponse(ctx context.Context, worldId PathWorldId, params *UpdateWorldByIdParams, body UpdateWorldByIdJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateWorldByIdResponse, error)

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// SearchWorldsWithResponse request
	SearchWorldsWithResponse(ctx context.Context, params *SearchWorldsParams, reqEditors ...RequestEditorFn) (*SearchWorldsResponse, error)

	// CreateWorldWithBodyWithResponse request with any body
	CreateWorldWithBodyWithResponse(ctx context.Context, params *CreateWorldParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateWorldResponse, error)

	CreateWorldWithResponse(ctx context.Context, params *CreateWorldParams, body CreateWorldJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateWorldResponse, error)

	// DeleteWorldByIdWithResponse request
	DeleteWorldByIdWithResponse(ctx context.Context, worldId PathWorldId, params *DeleteWorldByIdParams, reqEditors ...RequestEditorFn) (*DeleteWorldByIdResponse, error)

	// ReadWorldByIdWithResponse request
	ReadWorldByIdWithResponse(ctx context.Context, worldId PathWorldId, params *ReadWorldByIdParams, reqEditors ...RequestEditorFn) (*ReadWorldByIdResponse, error)

	// UpdateWorldByIdWithBodyWithResponse request with any body
	UpdateWorldByIdWithBodyWithResponse(ctx context.Context, worldId PathWorldId, params *UpdateWorldByIdParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateWorldByIdResponse, error)

	UpdateWorldByIdWithResponse(ctx context.Context, worldId PathWorldId, params *UpdateWorldByIdParams, body UpdateWorldByIdJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateWorldByIdResponse, error)
}

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

type CreateWorld201JSONResponse 

type CreateWorld201JSONResponse struct{ WorldResponseJSONResponse }

func (CreateWorld201JSONResponse) VisitCreateWorldResponse 

func (response CreateWorld201JSONResponse) VisitCreateWorldResponse(w http.ResponseWriter) error

type CreateWorld400JSONResponse 

type CreateWorld400JSONResponse struct {
	BadRequestErrorResponseJSONResponse
}

func (CreateWorld400JSONResponse) VisitCreateWorldResponse 

func (response CreateWorld400JSONResponse) VisitCreateWorldResponse(w http.ResponseWriter) error

type CreateWorldJSONBody 

type CreateWorldJSONBody struct {
	// Data A new world, that hasn't been assigned an ID yet.
	Data WorldOnlyAttributes `json:"data"`
}

CreateWorldJSONBody defines parameters for CreateWorld.

type CreateWorldJSONRequestBody 

type CreateWorldJSONRequestBody CreateWorldJSONBody

CreateWorldJSONRequestBody defines body for CreateWorld for application/json ContentType.

type CreateWorldParams 

type CreateWorldParams struct {
	// FSCVWLVerwerkingsActiviteit id of the verwerking type
	FSCVWLVerwerkingsActiviteit *externalRef0.FSCVWLVerwerkingsActiviteit `json:"FSC-VWL-Verwerkings-Activiteit,omitempty"`

	// FSCVWLVerwerkingsSpan transaction uuid of the incoming request
	FSCVWLVerwerkingsSpan *externalRef0.FSCVWLVerwerkingsSpan `json:"FSC-VWL-Verwerkings-Span,omitempty"`

	// FSCVWLSysteem identifier for the system processing the verwerking
	FSCVWLSysteem *externalRef0.FSCVWLSysteem `json:"FSC-VWL-Systeem,omitempty"`

	// FSCVWLVerwerker the party doing the verwerking, this does not have to be the party responsible for the verwerking
	FSCVWLVerwerker *externalRef0.FSCVWLVerwerker `json:"FSC-VWL-Verwerker,omitempty"`

	// FSCVWLVerantwoordelijke the party responsible for the verwerking, this does not have to be the party doing the verwerking itself
	FSCVWLVerantwoordelijke *externalRef0.FSCVWLVerantwoordelijke `json:"FSC-VWL-Verantwoordelijke,omitempty"`
}

CreateWorldParams defines parameters for CreateWorld.

type CreateWorldRequestObject 

type CreateWorldRequestObject struct {
	Params CreateWorldParams
	Body   *CreateWorldJSONRequestBody
}

type CreateWorldResponse 

type CreateWorldResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *WorldResponse
	JSON400      *BadRequestErrorResponse
}

func ParseCreateWorldResponse 

func ParseCreateWorldResponse(rsp *http.Response) (*CreateWorldResponse, error)

ParseCreateWorldResponse parses an HTTP response from a CreateWorldWithResponse call

func (CreateWorldResponse) Status 

func (r CreateWorldResponse) Status() string

Status returns HTTPResponse.Status

func (CreateWorldResponse) StatusCode 

func (r CreateWorldResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateWorldResponseObject 

type CreateWorldResponseObject interface {
	VisitCreateWorldResponse(w http.ResponseWriter) error
}

type DeleteWorldById204JSONResponse 

type DeleteWorldById204JSONResponse struct{ EmptyResponseJSONResponse }

func (DeleteWorldById204JSONResponse) VisitDeleteWorldByIdResponse 

func (response DeleteWorldById204JSONResponse) VisitDeleteWorldByIdResponse(w http.ResponseWriter) error

type DeleteWorldById400JSONResponse 

type DeleteWorldById400JSONResponse struct {
	BadRequestErrorResponseJSONResponse
}

func (DeleteWorldById400JSONResponse) VisitDeleteWorldByIdResponse 

func (response DeleteWorldById400JSONResponse) VisitDeleteWorldByIdResponse(w http.ResponseWriter) error

type DeleteWorldByIdParams 

type DeleteWorldByIdParams struct {
	// FSCVWLVerwerkingsActiviteit id of the verwerking type
	FSCVWLVerwerkingsActiviteit *externalRef0.FSCVWLVerwerkingsActiviteit `json:"FSC-VWL-Verwerkings-Activiteit,omitempty"`

	// FSCVWLVerwerkingsSpan transaction uuid of the incoming request
	FSCVWLVerwerkingsSpan *externalRef0.FSCVWLVerwerkingsSpan `json:"FSC-VWL-Verwerkings-Span,omitempty"`

	// FSCVWLSysteem identifier for the system processing the verwerking
	FSCVWLSysteem *externalRef0.FSCVWLSysteem `json:"FSC-VWL-Systeem,omitempty"`

	// FSCVWLVerwerker the party doing the verwerking, this does not have to be the party responsible for the verwerking
	FSCVWLVerwerker *externalRef0.FSCVWLVerwerker `json:"FSC-VWL-Verwerker,omitempty"`

	// FSCVWLVerantwoordelijke the party responsible for the verwerking, this does not have to be the party doing the verwerking itself
	FSCVWLVerantwoordelijke *externalRef0.FSCVWLVerantwoordelijke `json:"FSC-VWL-Verantwoordelijke,omitempty"`
}

DeleteWorldByIdParams defines parameters for DeleteWorldById.

type DeleteWorldByIdRequestObject 

type DeleteWorldByIdRequestObject struct {
	WorldId PathWorldId `json:"worldId"`
	Params  DeleteWorldByIdParams
}

type DeleteWorldByIdResponse 

type DeleteWorldByIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON204      *EmptyResponse
	JSON400      *BadRequestErrorResponse
}

func ParseDeleteWorldByIdResponse 

func ParseDeleteWorldByIdResponse(rsp *http.Response) (*DeleteWorldByIdResponse, error)

ParseDeleteWorldByIdResponse parses an HTTP response from a DeleteWorldByIdWithResponse call

func (DeleteWorldByIdResponse) Status 

func (r DeleteWorldByIdResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteWorldByIdResponse) StatusCode 

func (r DeleteWorldByIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteWorldByIdResponseObject 

type DeleteWorldByIdResponseObject interface {
	VisitDeleteWorldByIdResponse(w http.ResponseWriter) error
}

type EmptyResponse 

type EmptyResponse = map[string]interface{}

EmptyResponse defines model for EmptyResponse.

type EmptyResponseJSONResponse 

type EmptyResponseJSONResponse map[string]interface{}

type Error 

type Error struct {
	Message *string `json:"message,omitempty"`
}

Error The error that occured while processing this request.

type GoneErrorResponse 

type GoneErrorResponse struct {
	Errors []Error `json:"errors"`
}

GoneErrorResponse defines model for GoneErrorResponse.

type GoneErrorResponseJSONResponse 

type GoneErrorResponseJSONResponse struct {
	Errors []Error `json:"errors"`
}

type HttpRequestDoer 

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

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InvalidParamFormatError 

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error 

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap 

func (e *InvalidParamFormatError) Unwrap() error

type MiddlewareFunc 

type MiddlewareFunc func(http.Handler) http.Handler

type PathWorldId 

type PathWorldId = WorldId

PathWorldId UUID of a world.

type QueryName 

type QueryName = string

QueryName defines model for queryName.

type ReadWorldById200JSONResponse 

type ReadWorldById200JSONResponse struct{ WorldResponseJSONResponse }

func (ReadWorldById200JSONResponse) VisitReadWorldByIdResponse 

func (response ReadWorldById200JSONResponse) VisitReadWorldByIdResponse(w http.ResponseWriter) error

type ReadWorldById400JSONResponse 

type ReadWorldById400JSONResponse struct {
	BadRequestErrorResponseJSONResponse
}

func (ReadWorldById400JSONResponse) VisitReadWorldByIdResponse 

func (response ReadWorldById400JSONResponse) VisitReadWorldByIdResponse(w http.ResponseWriter) error

type ReadWorldById410JSONResponse 

type ReadWorldById410JSONResponse struct{ GoneErrorResponseJSONResponse }

func (ReadWorldById410JSONResponse) VisitReadWorldByIdResponse 

func (response ReadWorldById410JSONResponse) VisitReadWorldByIdResponse(w http.ResponseWriter) error

type ReadWorldByIdParams 

type ReadWorldByIdParams struct {
	// FSCVWLVerwerkingsActiviteit id of the verwerking type
	FSCVWLVerwerkingsActiviteit *externalRef0.FSCVWLVerwerkingsActiviteit `json:"FSC-VWL-Verwerkings-Activiteit,omitempty"`

	// FSCVWLVerwerkingsSpan transaction uuid of the incoming request
	FSCVWLVerwerkingsSpan *externalRef0.FSCVWLVerwerkingsSpan `json:"FSC-VWL-Verwerkings-Span,omitempty"`

	// FSCVWLSysteem identifier for the system processing the verwerking
	FSCVWLSysteem *externalRef0.FSCVWLSysteem `json:"FSC-VWL-Systeem,omitempty"`

	// FSCVWLVerwerker the party doing the verwerking, this does not have to be the party responsible for the verwerking
	FSCVWLVerwerker *externalRef0.FSCVWLVerwerker `json:"FSC-VWL-Verwerker,omitempty"`

	// FSCVWLVerantwoordelijke the party responsible for the verwerking, this does not have to be the party doing the verwerking itself
	FSCVWLVerantwoordelijke *externalRef0.FSCVWLVerantwoordelijke `json:"FSC-VWL-Verantwoordelijke,omitempty"`
}

ReadWorldByIdParams defines parameters for ReadWorldById.

type ReadWorldByIdRequestObject 

type ReadWorldByIdRequestObject struct {
	WorldId PathWorldId `json:"worldId"`
	Params  ReadWorldByIdParams
}

type ReadWorldByIdResponse 

type ReadWorldByIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorldResponse
	JSON400      *BadRequestErrorResponse
	JSON410      *GoneErrorResponse
}

func ParseReadWorldByIdResponse 

func ParseReadWorldByIdResponse(rsp *http.Response) (*ReadWorldByIdResponse, error)

ParseReadWorldByIdResponse parses an HTTP response from a ReadWorldByIdWithResponse call

func (ReadWorldByIdResponse) Status 

func (r ReadWorldByIdResponse) Status() string

Status returns HTTPResponse.Status

func (ReadWorldByIdResponse) StatusCode 

func (r ReadWorldByIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReadWorldByIdResponseObject 

type ReadWorldByIdResponseObject interface {
	VisitReadWorldByIdResponse(w http.ResponseWriter) error
}

type RequestEditorFn 

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

RequestEditorFn is the function signature for the RequestEditor callback function

type RequiredHeaderError 

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

func (*RequiredHeaderError) Error 

func (e *RequiredHeaderError) Error() string

func (*RequiredHeaderError) Unwrap 

func (e *RequiredHeaderError) Unwrap() error

type RequiredParamError 

type RequiredParamError struct {
	ParamName string
}

func (*RequiredParamError) Error 

func (e *RequiredParamError) Error() string

type SearchWorlds200JSONResponse 

type SearchWorlds200JSONResponse struct{ WorldsResponseJSONResponse }

func (SearchWorlds200JSONResponse) VisitSearchWorldsResponse 

func (response SearchWorlds200JSONResponse) VisitSearchWorldsResponse(w http.ResponseWriter) error

type SearchWorlds400JSONResponse 

type SearchWorlds400JSONResponse struct {
	BadRequestErrorResponseJSONResponse
}

func (SearchWorlds400JSONResponse) VisitSearchWorldsResponse 

func (response SearchWorlds400JSONResponse) VisitSearchWorldsResponse(w http.ResponseWriter) error

type SearchWorldsParams 

type SearchWorldsParams struct {
	// Name (part of) the name of a world.
	Name *QueryName `form:"name,omitempty" json:"name,omitempty"`

	// FSCVWLVerwerkingsActiviteit id of the verwerking type
	FSCVWLVerwerkingsActiviteit *externalRef0.FSCVWLVerwerkingsActiviteit `json:"FSC-VWL-Verwerkings-Activiteit,omitempty"`

	// FSCVWLVerwerkingsSpan transaction uuid of the incoming request
	FSCVWLVerwerkingsSpan *externalRef0.FSCVWLVerwerkingsSpan `json:"FSC-VWL-Verwerkings-Span,omitempty"`

	// FSCVWLSysteem identifier for the system processing the verwerking
	FSCVWLSysteem *externalRef0.FSCVWLSysteem `json:"FSC-VWL-Systeem,omitempty"`

	// FSCVWLVerwerker the party doing the verwerking, this does not have to be the party responsible for the verwerking
	FSCVWLVerwerker *externalRef0.FSCVWLVerwerker `json:"FSC-VWL-Verwerker,omitempty"`

	// FSCVWLVerantwoordelijke the party responsible for the verwerking, this does not have to be the party doing the verwerking itself
	FSCVWLVerantwoordelijke *externalRef0.FSCVWLVerantwoordelijke `json:"FSC-VWL-Verantwoordelijke,omitempty"`
}

SearchWorldsParams defines parameters for SearchWorlds.

type SearchWorldsRequestObject 

type SearchWorldsRequestObject struct {
	Params SearchWorldsParams
}

type SearchWorldsResponse 

type SearchWorldsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorldsResponse
	JSON400      *BadRequestErrorResponse
}

func ParseSearchWorldsResponse 

func ParseSearchWorldsResponse(rsp *http.Response) (*SearchWorldsResponse, error)

ParseSearchWorldsResponse parses an HTTP response from a SearchWorldsWithResponse call

func (SearchWorldsResponse) Status 

func (r SearchWorldsResponse) Status() string

Status returns HTTPResponse.Status

func (SearchWorldsResponse) StatusCode 

func (r SearchWorldsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SearchWorldsResponseObject 

type SearchWorldsResponseObject interface {
	VisitSearchWorldsResponse(w http.ResponseWriter) error
}

type ServerInterface 

type ServerInterface interface {
	// Search worlds
	// (GET /worlds)
	SearchWorlds(w http.ResponseWriter, r *http.Request, params SearchWorldsParams)
	// Create a new world
	// (POST /worlds)
	CreateWorld(w http.ResponseWriter, r *http.Request, params CreateWorldParams)
	// Deletes a world
	// (DELETE /worlds/{worldId})
	DeleteWorldById(w http.ResponseWriter, r *http.Request, worldId PathWorldId, params DeleteWorldByIdParams)
	// Read world by ID
	// (GET /worlds/{worldId})
	ReadWorldById(w http.ResponseWriter, r *http.Request, worldId PathWorldId, params ReadWorldByIdParams)
	// Updates all attributes of a world
	// (PUT /worlds/{worldId})
	UpdateWorldById(w http.ResponseWriter, r *http.Request, worldId PathWorldId, params UpdateWorldByIdParams)
}

ServerInterface represents all server handlers.

func NewStrictHandler 

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

func NewStrictHandlerWithOptions 

func NewStrictHandlerWithOptions(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc, options StrictHTTPServerOptions) ServerInterface

type ServerInterfaceWrapper 

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) CreateWorld 

func (siw *ServerInterfaceWrapper) CreateWorld(w http.ResponseWriter, r *http.Request)

CreateWorld operation middleware

func (*ServerInterfaceWrapper) DeleteWorldById 

func (siw *ServerInterfaceWrapper) DeleteWorldById(w http.ResponseWriter, r *http.Request)

DeleteWorldById operation middleware

func (*ServerInterfaceWrapper) ReadWorldById 

func (siw *ServerInterfaceWrapper) ReadWorldById(w http.ResponseWriter, r *http.Request)

ReadWorldById operation middleware

func (*ServerInterfaceWrapper) SearchWorlds 

func (siw *ServerInterfaceWrapper) SearchWorlds(w http.ResponseWriter, r *http.Request)

SearchWorlds operation middleware

func (*ServerInterfaceWrapper) UpdateWorldById 

func (siw *ServerInterfaceWrapper) UpdateWorldById(w http.ResponseWriter, r *http.Request)

UpdateWorldById operation middleware

type StrictHTTPServerOptions 

type StrictHTTPServerOptions struct {
	RequestErrorHandlerFunc  func(w http.ResponseWriter, r *http.Request, err error)
	ResponseErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type StrictHandlerFunc 

type StrictHandlerFunc = strictnethttp.StrictHTTPHandlerFunc

type StrictMiddlewareFunc 

type StrictMiddlewareFunc = strictnethttp.StrictHTTPMiddlewareFunc

type StrictServerInterface 

type StrictServerInterface interface {
	// Search worlds
	// (GET /worlds)
	SearchWorlds(ctx context.Context, request SearchWorldsRequestObject) (SearchWorldsResponseObject, error)
	// Create a new world
	// (POST /worlds)
	CreateWorld(ctx context.Context, request CreateWorldRequestObject) (CreateWorldResponseObject, error)
	// Deletes a world
	// (DELETE /worlds/{worldId})
	DeleteWorldById(ctx context.Context, request DeleteWorldByIdRequestObject) (DeleteWorldByIdResponseObject, error)
	// Read world by ID
	// (GET /worlds/{worldId})
	ReadWorldById(ctx context.Context, request ReadWorldByIdRequestObject) (ReadWorldByIdResponseObject, error)
	// Updates all attributes of a world
	// (PUT /worlds/{worldId})
	UpdateWorldById(ctx context.Context, request UpdateWorldByIdRequestObject) (UpdateWorldByIdResponseObject, error)
}

StrictServerInterface represents all server handlers.

type TooManyValuesForParamError 

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error 

func (e *TooManyValuesForParamError) Error() string

type UnescapedCookieParamError 

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error 

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap 

func (e *UnescapedCookieParamError) Unwrap() error

type Unimplemented 

type Unimplemented struct{}

func (Unimplemented) CreateWorld 

func (_ Unimplemented) CreateWorld(w http.ResponseWriter, r *http.Request, params CreateWorldParams)

Create a new world (POST /worlds)

func (Unimplemented) DeleteWorldById 

func (_ Unimplemented) DeleteWorldById(w http.ResponseWriter, r *http.Request, worldId PathWorldId, params DeleteWorldByIdParams)

Deletes a world (DELETE /worlds/{worldId})

func (Unimplemented) ReadWorldById 

func (_ Unimplemented) ReadWorldById(w http.ResponseWriter, r *http.Request, worldId PathWorldId, params ReadWorldByIdParams)

Read world by ID (GET /worlds/{worldId})

func (Unimplemented) SearchWorlds 

func (_ Unimplemented) SearchWorlds(w http.ResponseWriter, r *http.Request, params SearchWorldsParams)

Search worlds (GET /worlds)

func (Unimplemented) UpdateWorldById 

func (_ Unimplemented) UpdateWorldById(w http.ResponseWriter, r *http.Request, worldId PathWorldId, params UpdateWorldByIdParams)

Updates all attributes of a world (PUT /worlds/{worldId})

type UnmarshalingParamError 

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error 

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap 

func (e *UnmarshalingParamError) Unwrap() error

type UpdateWorldById200JSONResponse 

type UpdateWorldById200JSONResponse struct{ WorldResponseJSONResponse }

func (UpdateWorldById200JSONResponse) VisitUpdateWorldByIdResponse 

func (response UpdateWorldById200JSONResponse) VisitUpdateWorldByIdResponse(w http.ResponseWriter) error

type UpdateWorldById400JSONResponse 

type UpdateWorldById400JSONResponse struct {
	BadRequestErrorResponseJSONResponse
}

func (UpdateWorldById400JSONResponse) VisitUpdateWorldByIdResponse 

func (response UpdateWorldById400JSONResponse) VisitUpdateWorldByIdResponse(w http.ResponseWriter) error

type UpdateWorldById410JSONResponse 

type UpdateWorldById410JSONResponse struct{ GoneErrorResponseJSONResponse }

func (UpdateWorldById410JSONResponse) VisitUpdateWorldByIdResponse 

func (response UpdateWorldById410JSONResponse) VisitUpdateWorldByIdResponse(w http.ResponseWriter) error

type UpdateWorldByIdJSONBody 

type UpdateWorldByIdJSONBody struct {
	// Data A known world, including all attributes.
	Data World `json:"data"`
}

UpdateWorldByIdJSONBody defines parameters for UpdateWorldById.

type UpdateWorldByIdJSONRequestBody 

type UpdateWorldByIdJSONRequestBody UpdateWorldByIdJSONBody

UpdateWorldByIdJSONRequestBody defines body for UpdateWorldById for application/json ContentType.

type UpdateWorldByIdParams 

type UpdateWorldByIdParams struct {
	// FSCVWLVerwerkingsActiviteit id of the verwerking type
	FSCVWLVerwerkingsActiviteit *externalRef0.FSCVWLVerwerkingsActiviteit `json:"FSC-VWL-Verwerkings-Activiteit,omitempty"`

	// FSCVWLVerwerkingsSpan transaction uuid of the incoming request
	FSCVWLVerwerkingsSpan *externalRef0.FSCVWLVerwerkingsSpan `json:"FSC-VWL-Verwerkings-Span,omitempty"`

	// FSCVWLSysteem identifier for the system processing the verwerking
	FSCVWLSysteem *externalRef0.FSCVWLSysteem `json:"FSC-VWL-Systeem,omitempty"`

	// FSCVWLVerwerker the party doing the verwerking, this does not have to be the party responsible for the verwerking
	FSCVWLVerwerker *externalRef0.FSCVWLVerwerker `json:"FSC-VWL-Verwerker,omitempty"`

	// FSCVWLVerantwoordelijke the party responsible for the verwerking, this does not have to be the party doing the verwerking itself
	FSCVWLVerantwoordelijke *externalRef0.FSCVWLVerantwoordelijke `json:"FSC-VWL-Verantwoordelijke,omitempty"`
}

UpdateWorldByIdParams defines parameters for UpdateWorldById.

type UpdateWorldByIdRequestObject 

type UpdateWorldByIdRequestObject struct {
	WorldId PathWorldId `json:"worldId"`
	Params  UpdateWorldByIdParams
	Body    *UpdateWorldByIdJSONRequestBody
}

type UpdateWorldByIdResponse 

type UpdateWorldByIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *WorldResponse
	JSON400      *BadRequestErrorResponse
	JSON410      *GoneErrorResponse
}

func ParseUpdateWorldByIdResponse 

func ParseUpdateWorldByIdResponse(rsp *http.Response) (*UpdateWorldByIdResponse, error)

ParseUpdateWorldByIdResponse parses an HTTP response from a UpdateWorldByIdWithResponse call

func (UpdateWorldByIdResponse) Status 

func (r UpdateWorldByIdResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateWorldByIdResponse) StatusCode 

func (r UpdateWorldByIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateWorldByIdResponseObject 

type UpdateWorldByIdResponseObject interface {
	VisitUpdateWorldByIdResponse(w http.ResponseWriter) error
}

type World 

type World struct {
	// Id UUID of a world.
	Id WorldId `json:"id"`

	// Name Pretty name of a world.
	Name WorldName `json:"name"`
}

World defines model for World.

type WorldId 

type WorldId = openapi_types.UUID

WorldId UUID of a world.

type WorldName 

type WorldName = string

WorldName Pretty name of a world.

type WorldOnlyAttributes 

type WorldOnlyAttributes struct {
	// Name Pretty name of a world.
	Name WorldName `json:"name"`
}

WorldOnlyAttributes defines model for WorldOnlyAttributes.

type WorldOnlyAttributesRequest 

type WorldOnlyAttributesRequest struct {
	// Data A new world, that hasn't been assigned an ID yet.
	Data WorldOnlyAttributes `json:"data"`
}

WorldOnlyAttributesRequest defines model for WorldOnlyAttributesRequest.

type WorldOnlyId 

type WorldOnlyId struct {
	// Id UUID of a world.
	Id WorldId `json:"id"`
}

WorldOnlyId Base schema for world entities with ID.

type WorldPartialOnlyAttributes 

type WorldPartialOnlyAttributes struct {
	// Name Pretty name of a world.
	Name *WorldName `json:"name,omitempty"`
}

WorldPartialOnlyAttributes Base schema for world entities with attributes.

type WorldRequest 

type WorldRequest struct {
	// Data A known world, including all attributes.
	Data World `json:"data"`
}

WorldRequest defines model for WorldRequest.

type WorldResponse 

type WorldResponse struct {
	// Data A known world, including all attributes.
	Data World `json:"data"`
}

WorldResponse defines model for WorldResponse.

type WorldResponseJSONResponse 

type WorldResponseJSONResponse struct {
	Body struct {
		// Data A known world, including all attributes.
		Data World `json:"data"`
	}

	Headers WorldResponseResponseHeaders
}

type WorldResponseResponseHeaders 

type WorldResponseResponseHeaders struct {
	FSCVWLSysteem               string
	FSCVWLVerantwoordelijke     string
	FSCVWLVerwerker             string
	FSCVWLVerwerkingsActiviteit string
	FSCVWLVerwerkingsSpan       openapi_types.UUID
}

type WorldsResponse 

type WorldsResponse struct {
	Data []World `json:"data"`
}

WorldsResponse defines model for WorldsResponse.

type WorldsResponseJSONResponse 

type WorldsResponseJSONResponse struct {
	Body struct {
		Data []World `json:"data"`
	}

	Headers WorldsResponseResponseHeaders
}

type WorldsResponseResponseHeaders 

type WorldsResponseResponseHeaders struct {
	FSCVWLSysteem               string
	FSCVWLVerantwoordelijke     string
	FSCVWLVerwerker             string
	FSCVWLVerwerkingsActiviteit string
	FSCVWLVerwerkingsSpan       openapi_types.UUID
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.