api

package module
v0.0.0-...-8405c2a Latest Latest
Warning

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

Go to latest
Published: Apr 24, 2024 License: EUPL-1.2 Imports: 18 Imported by: 1

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 NewReadProcesByIdRequest

func NewReadProcesByIdRequest(server string, procesId PathProcesId, params *ReadProcesByIdParams) (*http.Request, error)

NewReadProcesByIdRequest generates requests for ReadProcesById

func NewReadProcessenByVreemdelingIdRequest

func NewReadProcessenByVreemdelingIdRequest(server string, vreemdelingId PathVreemdelingId, params *ReadProcessenByVreemdelingIdParams) (*http.Request, error)

NewReadProcessenByVreemdelingIdRequest generates requests for ReadProcessenByVreemdelingId

func NewReadProcessenRequest

func NewReadProcessenRequest(server string, params *ReadProcessenParams) (*http.Request, error)

NewReadProcessenRequest generates requests for ReadProcessen

func NewReadVreemdelingByIdRequest

func NewReadVreemdelingByIdRequest(server string, vreemdelingId PathVreemdelingId, params *ReadVreemdelingByIdParams) (*http.Request, error)

NewReadVreemdelingByIdRequest generates requests for ReadVreemdelingById

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 Attribute

type Attribute struct {
	Observations []Observation `json:"observations"`
	Value        interface{}   `json:"value"`
}

Attribute merged value of an attribute, including all observations about it.

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

func (c *Client) ReadProcesById(ctx context.Context, procesId PathProcesId, params *ReadProcesByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ReadProcessen

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

func (*Client) ReadProcessenByVreemdelingId

func (c *Client) ReadProcessenByVreemdelingId(ctx context.Context, vreemdelingId PathVreemdelingId, params *ReadProcessenByVreemdelingIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ReadVreemdelingById

func (c *Client) ReadVreemdelingById(ctx context.Context, vreemdelingId PathVreemdelingId, params *ReadVreemdelingByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

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

	// ReadProcesById request
	ReadProcesById(ctx context.Context, procesId PathProcesId, params *ReadProcesByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReadVreemdelingById request
	ReadVreemdelingById(ctx context.Context, vreemdelingId PathVreemdelingId, params *ReadVreemdelingByIdParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReadProcessenByVreemdelingId request
	ReadProcessenByVreemdelingId(ctx context.Context, vreemdelingId PathVreemdelingId, params *ReadProcessenByVreemdelingIdParams, 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) ReadProcesByIdWithResponse

func (c *ClientWithResponses) ReadProcesByIdWithResponse(ctx context.Context, procesId PathProcesId, params *ReadProcesByIdParams, reqEditors ...RequestEditorFn) (*ReadProcesByIdResponse, error)

ReadProcesByIdWithResponse request returning *ReadProcesByIdResponse

func (*ClientWithResponses) ReadProcessenByVreemdelingIdWithResponse

func (c *ClientWithResponses) ReadProcessenByVreemdelingIdWithResponse(ctx context.Context, vreemdelingId PathVreemdelingId, params *ReadProcessenByVreemdelingIdParams, reqEditors ...RequestEditorFn) (*ReadProcessenByVreemdelingIdResponse, error)

ReadProcessenByVreemdelingIdWithResponse request returning *ReadProcessenByVreemdelingIdResponse

func (*ClientWithResponses) ReadProcessenWithResponse

func (c *ClientWithResponses) ReadProcessenWithResponse(ctx context.Context, params *ReadProcessenParams, reqEditors ...RequestEditorFn) (*ReadProcessenResponse, error)

ReadProcessenWithResponse request returning *ReadProcessenResponse

func (*ClientWithResponses) ReadVreemdelingByIdWithResponse

func (c *ClientWithResponses) ReadVreemdelingByIdWithResponse(ctx context.Context, vreemdelingId PathVreemdelingId, params *ReadVreemdelingByIdParams, reqEditors ...RequestEditorFn) (*ReadVreemdelingByIdResponse, error)

ReadVreemdelingByIdWithResponse request returning *ReadVreemdelingByIdResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// ReadProcessenWithResponse request
	ReadProcessenWithResponse(ctx context.Context, params *ReadProcessenParams, reqEditors ...RequestEditorFn) (*ReadProcessenResponse, error)

	// ReadProcesByIdWithResponse request
	ReadProcesByIdWithResponse(ctx context.Context, procesId PathProcesId, params *ReadProcesByIdParams, reqEditors ...RequestEditorFn) (*ReadProcesByIdResponse, error)

	// ReadVreemdelingByIdWithResponse request
	ReadVreemdelingByIdWithResponse(ctx context.Context, vreemdelingId PathVreemdelingId, params *ReadVreemdelingByIdParams, reqEditors ...RequestEditorFn) (*ReadVreemdelingByIdResponse, error)

	// ReadProcessenByVreemdelingIdWithResponse request
	ReadProcessenByVreemdelingIdWithResponse(ctx context.Context, vreemdelingId PathVreemdelingId, params *ReadProcessenByVreemdelingIdParams, reqEditors ...RequestEditorFn) (*ReadProcessenByVreemdelingIdResponse, error)
}

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

type Error

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

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 Observation

type Observation struct {
	Attribute string    `json:"attribute"`
	CreatedAt time.Time `json:"createdAt"`

	// Id UUID of observation.
	Id            ObservationId `json:"id"`
	InvalidatedAt *time.Time    `json:"invalidatedAt,omitempty"`
	Source        string        `json:"source"`
	Value         interface{}   `json:"value"`
}

Observation Moment of registration of a specific observation of a vreemdeling.

type ObservationId

type ObservationId = openapi_types.UUID

ObservationId UUID of observation.

type PathProcesId

type PathProcesId = ProcesId

PathProcesId UUID of proces.

type PathVreemdelingId

type PathVreemdelingId = VreemdelingId

PathVreemdelingId V-number of vreemdeling.

type Proces

type Proces struct {
	Attributes    *map[string]Attribute `json:"attributes,omitempty"`
	CreatedAt     time.Time             `json:"createdAt"`
	DeletedAt     *time.Time            `json:"deletedAt,omitempty"`
	Id            openapi_types.UUID    `json:"id"`
	ProcesId      string                `json:"procesId"`
	Source        string                `json:"source"`
	Status        string                `json:"status"`
	Type          string                `json:"type"`
	VreemdelingId string                `json:"vreemdelingId"`
}

Proces Proces with its attributes

type ProcesId

type ProcesId = openapi_types.UUID

ProcesId UUID of proces.

type ProcesResponse

type ProcesResponse struct {
	// Data Proces with its attributes
	Data Proces `json:"data"`
}

ProcesResponse Proces response

type ProcesResponseJSONResponse

type ProcesResponseJSONResponse struct {
	Body ProcesResponse

	Headers ProcesResponseResponseHeaders
}

type ProcesResponseResponseHeaders

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

type ProcessenResponse

type ProcessenResponse struct {
	Data []Proces `json:"data"`
}

ProcessenResponse Processen response

type ProcessenResponseJSONResponse

type ProcessenResponseJSONResponse struct {
	Body ProcessenResponse

	Headers ProcessenResponseResponseHeaders
}

type ProcessenResponseResponseHeaders

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

type QueryAttributes

type QueryAttributes = []string

QueryAttributes defines model for queryAttributes.

type QueryAttributesOptional

type QueryAttributesOptional = []string

QueryAttributesOptional defines model for queryAttributesOptional.

type QuerySources

type QuerySources = []string

QuerySources defines model for querySources.

type ReadProcesById200JSONResponse

type ReadProcesById200JSONResponse struct{ ProcesResponseJSONResponse }

func (ReadProcesById200JSONResponse) VisitReadProcesByIdResponse

func (response ReadProcesById200JSONResponse) VisitReadProcesByIdResponse(w http.ResponseWriter) error

type ReadProcesById400JSONResponse

type ReadProcesById400JSONResponse struct {
	BadRequestErrorResponseJSONResponse
}

func (ReadProcesById400JSONResponse) VisitReadProcesByIdResponse

func (response ReadProcesById400JSONResponse) VisitReadProcesByIdResponse(w http.ResponseWriter) error

type ReadProcesByIdParams

type ReadProcesByIdParams struct {
	// Attributes Comma-separated list of attributes to show.
	Attributes *QueryAttributesOptional `form:"attributes,omitempty" json:"attributes,omitempty"`

	// Sources Comma-separated list of SIGMA sources to query. Query all sources if not specified.
	Sources *QuerySources `form:"sources,omitempty" json:"sources,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"`
}

ReadProcesByIdParams defines parameters for ReadProcesById.

type ReadProcesByIdRequestObject

type ReadProcesByIdRequestObject struct {
	ProcesId PathProcesId `json:"procesId"`
	Params   ReadProcesByIdParams
}

type ReadProcesByIdResponse

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

func ParseReadProcesByIdResponse

func ParseReadProcesByIdResponse(rsp *http.Response) (*ReadProcesByIdResponse, error)

ParseReadProcesByIdResponse parses an HTTP response from a ReadProcesByIdWithResponse call

func (ReadProcesByIdResponse) Status

func (r ReadProcesByIdResponse) Status() string

Status returns HTTPResponse.Status

func (ReadProcesByIdResponse) StatusCode

func (r ReadProcesByIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReadProcesByIdResponseObject

type ReadProcesByIdResponseObject interface {
	VisitReadProcesByIdResponse(w http.ResponseWriter) error
}

type ReadProcessen200JSONResponse

type ReadProcessen200JSONResponse struct{ ProcessenResponseJSONResponse }

func (ReadProcessen200JSONResponse) VisitReadProcessenResponse

func (response ReadProcessen200JSONResponse) VisitReadProcessenResponse(w http.ResponseWriter) error

type ReadProcessen400JSONResponse

type ReadProcessen400JSONResponse struct {
	BadRequestErrorResponseJSONResponse
}

func (ReadProcessen400JSONResponse) VisitReadProcessenResponse

func (response ReadProcessen400JSONResponse) VisitReadProcessenResponse(w http.ResponseWriter) error

type ReadProcessenByVreemdelingId200JSONResponse

type ReadProcessenByVreemdelingId200JSONResponse struct{ ProcessenResponseJSONResponse }

func (ReadProcessenByVreemdelingId200JSONResponse) VisitReadProcessenByVreemdelingIdResponse

func (response ReadProcessenByVreemdelingId200JSONResponse) VisitReadProcessenByVreemdelingIdResponse(w http.ResponseWriter) error

type ReadProcessenByVreemdelingId400JSONResponse

type ReadProcessenByVreemdelingId400JSONResponse struct {
	BadRequestErrorResponseJSONResponse
}

func (ReadProcessenByVreemdelingId400JSONResponse) VisitReadProcessenByVreemdelingIdResponse

func (response ReadProcessenByVreemdelingId400JSONResponse) VisitReadProcessenByVreemdelingIdResponse(w http.ResponseWriter) error

type ReadProcessenByVreemdelingIdParams

type ReadProcessenByVreemdelingIdParams struct {
	// Attributes Comma-separated list of attributes to show.
	Attributes *QueryAttributesOptional `form:"attributes,omitempty" json:"attributes,omitempty"`

	// Sources Comma-separated list of SIGMA sources to query. Query all sources if not specified.
	Sources *QuerySources `form:"sources,omitempty" json:"sources,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"`
}

ReadProcessenByVreemdelingIdParams defines parameters for ReadProcessenByVreemdelingId.

type ReadProcessenByVreemdelingIdRequestObject

type ReadProcessenByVreemdelingIdRequestObject struct {
	VreemdelingId PathVreemdelingId `json:"vreemdelingId"`
	Params        ReadProcessenByVreemdelingIdParams
}

type ReadProcessenByVreemdelingIdResponse

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

func ParseReadProcessenByVreemdelingIdResponse

func ParseReadProcessenByVreemdelingIdResponse(rsp *http.Response) (*ReadProcessenByVreemdelingIdResponse, error)

ParseReadProcessenByVreemdelingIdResponse parses an HTTP response from a ReadProcessenByVreemdelingIdWithResponse call

func (ReadProcessenByVreemdelingIdResponse) Status

Status returns HTTPResponse.Status

func (ReadProcessenByVreemdelingIdResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type ReadProcessenByVreemdelingIdResponseObject

type ReadProcessenByVreemdelingIdResponseObject interface {
	VisitReadProcessenByVreemdelingIdResponse(w http.ResponseWriter) error
}

type ReadProcessenParams

type ReadProcessenParams struct {
	// Attributes Comma-separated list of attributes to show.
	Attributes *QueryAttributesOptional `form:"attributes,omitempty" json:"attributes,omitempty"`

	// Sources Comma-separated list of SIGMA sources to query. Query all sources if not specified.
	Sources *QuerySources `form:"sources,omitempty" json:"sources,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"`
}

ReadProcessenParams defines parameters for ReadProcessen.

type ReadProcessenRequestObject

type ReadProcessenRequestObject struct {
	Params ReadProcessenParams
}

type ReadProcessenResponse

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

func ParseReadProcessenResponse

func ParseReadProcessenResponse(rsp *http.Response) (*ReadProcessenResponse, error)

ParseReadProcessenResponse parses an HTTP response from a ReadProcessenWithResponse call

func (ReadProcessenResponse) Status

func (r ReadProcessenResponse) Status() string

Status returns HTTPResponse.Status

func (ReadProcessenResponse) StatusCode

func (r ReadProcessenResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReadProcessenResponseObject

type ReadProcessenResponseObject interface {
	VisitReadProcessenResponse(w http.ResponseWriter) error
}

type ReadVreemdelingById200JSONResponse

type ReadVreemdelingById200JSONResponse struct {
	VreemdelingWithObservationsResponseJSONResponse
}

func (ReadVreemdelingById200JSONResponse) VisitReadVreemdelingByIdResponse

func (response ReadVreemdelingById200JSONResponse) VisitReadVreemdelingByIdResponse(w http.ResponseWriter) error

type ReadVreemdelingById400JSONResponse

type ReadVreemdelingById400JSONResponse struct {
	BadRequestErrorResponseJSONResponse
}

func (ReadVreemdelingById400JSONResponse) VisitReadVreemdelingByIdResponse

func (response ReadVreemdelingById400JSONResponse) VisitReadVreemdelingByIdResponse(w http.ResponseWriter) error

type ReadVreemdelingById410JSONResponse

type ReadVreemdelingById410JSONResponse struct{ GoneErrorResponseJSONResponse }

func (ReadVreemdelingById410JSONResponse) VisitReadVreemdelingByIdResponse

func (response ReadVreemdelingById410JSONResponse) VisitReadVreemdelingByIdResponse(w http.ResponseWriter) error

type ReadVreemdelingByIdParams

type ReadVreemdelingByIdParams struct {
	// Attributes Comma-separated list of required attributes to show.
	Attributes QueryAttributes `form:"attributes" json:"attributes"`

	// Sources Comma-separated list of SIGMA sources to query. Query all sources if not specified.
	Sources *QuerySources `form:"sources,omitempty" json:"sources,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"`
}

ReadVreemdelingByIdParams defines parameters for ReadVreemdelingById.

type ReadVreemdelingByIdRequestObject

type ReadVreemdelingByIdRequestObject struct {
	VreemdelingId PathVreemdelingId `json:"vreemdelingId"`
	Params        ReadVreemdelingByIdParams
}

type ReadVreemdelingByIdResponse

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

func ParseReadVreemdelingByIdResponse

func ParseReadVreemdelingByIdResponse(rsp *http.Response) (*ReadVreemdelingByIdResponse, error)

ParseReadVreemdelingByIdResponse parses an HTTP response from a ReadVreemdelingByIdWithResponse call

func (ReadVreemdelingByIdResponse) Status

Status returns HTTPResponse.Status

func (ReadVreemdelingByIdResponse) StatusCode

func (r ReadVreemdelingByIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReadVreemdelingByIdResponseObject

type ReadVreemdelingByIdResponseObject interface {
	VisitReadVreemdelingByIdResponse(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 ServerInterface

type ServerInterface interface {
	// Get all processen
	// (GET /processen)
	ReadProcessen(w http.ResponseWriter, r *http.Request, params ReadProcessenParams)
	// Find proces by ID
	// (GET /processen/{procesId})
	ReadProcesById(w http.ResponseWriter, r *http.Request, procesId PathProcesId, params ReadProcesByIdParams)
	// Find observations about a vreemdeling by ID
	// (GET /vreemdelingen/{vreemdelingId})
	ReadVreemdelingById(w http.ResponseWriter, r *http.Request, vreemdelingId PathVreemdelingId, params ReadVreemdelingByIdParams)
	// Find processen about a vreemdling by ID
	// (GET /vreemdelingen/{vreemdelingId}/processen)
	ReadProcessenByVreemdelingId(w http.ResponseWriter, r *http.Request, vreemdelingId PathVreemdelingId, params ReadProcessenByVreemdelingIdParams)
}

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

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

ReadProcesById operation middleware

func (*ServerInterfaceWrapper) ReadProcessen

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

ReadProcessen operation middleware

func (*ServerInterfaceWrapper) ReadProcessenByVreemdelingId

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

ReadProcessenByVreemdelingId operation middleware

func (*ServerInterfaceWrapper) ReadVreemdelingById

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

ReadVreemdelingById 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 StrictServerInterface

type StrictServerInterface interface {
	// Get all processen
	// (GET /processen)
	ReadProcessen(ctx context.Context, request ReadProcessenRequestObject) (ReadProcessenResponseObject, error)
	// Find proces by ID
	// (GET /processen/{procesId})
	ReadProcesById(ctx context.Context, request ReadProcesByIdRequestObject) (ReadProcesByIdResponseObject, error)
	// Find observations about a vreemdeling by ID
	// (GET /vreemdelingen/{vreemdelingId})
	ReadVreemdelingById(ctx context.Context, request ReadVreemdelingByIdRequestObject) (ReadVreemdelingByIdResponseObject, error)
	// Find processen about a vreemdling by ID
	// (GET /vreemdelingen/{vreemdelingId}/processen)
	ReadProcessenByVreemdelingId(ctx context.Context, request ReadProcessenByVreemdelingIdRequestObject) (ReadProcessenByVreemdelingIdResponseObject, error)
}

StrictServerInterface represents all server handlers.

type TooManyValuesForParamError

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error

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

func (_ Unimplemented) ReadProcesById(w http.ResponseWriter, r *http.Request, procesId PathProcesId, params ReadProcesByIdParams)

Find proces by ID (GET /processen/{procesId})

func (Unimplemented) ReadProcessen

func (_ Unimplemented) ReadProcessen(w http.ResponseWriter, r *http.Request, params ReadProcessenParams)

Get all processen (GET /processen)

func (Unimplemented) ReadProcessenByVreemdelingId

func (_ Unimplemented) ReadProcessenByVreemdelingId(w http.ResponseWriter, r *http.Request, vreemdelingId PathVreemdelingId, params ReadProcessenByVreemdelingIdParams)

Find processen about a vreemdling by ID (GET /vreemdelingen/{vreemdelingId}/processen)

func (Unimplemented) ReadVreemdelingById

func (_ Unimplemented) ReadVreemdelingById(w http.ResponseWriter, r *http.Request, vreemdelingId PathVreemdelingId, params ReadVreemdelingByIdParams)

Find observations about a vreemdeling by ID (GET /vreemdelingen/{vreemdelingId})

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 VreemdelingId

type VreemdelingId = string

VreemdelingId V-number of vreemdeling.

type VreemdelingWithObservations

type VreemdelingWithObservations struct {
	// Id V-number of vreemdeling.
	Id                   VreemdelingId        `json:"id"`
	AdditionalProperties map[string]Attribute `json:"-"`
}

VreemdelingWithObservations A known vreemdeling, with merged attributes and full list of relevant observations.

func (VreemdelingWithObservations) Get

func (a VreemdelingWithObservations) Get(fieldName string) (value Attribute, found bool)

Getter for additional properties for VreemdelingWithObservations. Returns the specified element and whether it was found

func (VreemdelingWithObservations) MarshalJSON

func (a VreemdelingWithObservations) MarshalJSON() ([]byte, error)

Override default JSON handling for VreemdelingWithObservations to handle AdditionalProperties

func (*VreemdelingWithObservations) Set

func (a *VreemdelingWithObservations) Set(fieldName string, value Attribute)

Setter for additional properties for VreemdelingWithObservations

func (*VreemdelingWithObservations) UnmarshalJSON

func (a *VreemdelingWithObservations) UnmarshalJSON(b []byte) error

Override default JSON handling for VreemdelingWithObservations to handle AdditionalProperties

type VreemdelingWithObservationsResponse

type VreemdelingWithObservationsResponse struct {
	// Data A known vreemdeling, with merged attributes and full list of relevant observations.
	Data VreemdelingWithObservations `json:"data"`
}

VreemdelingWithObservationsResponse Vreemdeling with observations response

type VreemdelingWithObservationsResponseResponseHeaders

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

Jump to

Keyboard shortcuts

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