query-orchestration/api/queryAPI/api.gen.go

// Package queryapi provides primitives to interact with the openapi HTTP API.
//
// Code generated by github.com/oapi-codegen/oapi-codegen/v2 version 2.4.1 DO NOT EDIT.
package queryapi

import (
	"bytes"
	"compress/gzip"
	"encoding/base64"
	"fmt"
	"net/http"
	"net/url"
	"path"
	"strings"
	"time"

	"github.com/getkin/kin-openapi/openapi3"
	"github.com/labstack/echo/v4"
	"github.com/oapi-codegen/runtime"
	openapi_types "github.com/oapi-codegen/runtime/types"
)

const (
	CognitoAuthScopes = "cognitoAuth.Scopes"
	JwtAuthScopes     = "jwtAuth.Scopes"
)

// Defines values for ClientStatus.
const (
	INSYNC     ClientStatus = "IN_SYNC"
	NOTSYNCED  ClientStatus = "NOT_SYNCED"
	NOTSYNCING ClientStatus = "NOT_SYNCING"
)

// Defines values for ExportStatus.
const (
	Completed  ExportStatus = "completed"
	Failed     ExportStatus = "failed"
	InProgress ExportStatus = "in_progress"
)

// Defines values for FieldFilterCondition.
const (
	ClosedInterval      FieldFilterCondition = "closed_interval"
	Exclude             FieldFilterCondition = "exclude"
	GreaterThan         FieldFilterCondition = "greater_than"
	Include             FieldFilterCondition = "include"
	LeftClosedInterval  FieldFilterCondition = "left_closed_interval"
	LessThan            FieldFilterCondition = "less_than"
	OpenInterval        FieldFilterCondition = "open_interval"
	RightClosedInterval FieldFilterCondition = "right_closed_interval"
)

// Defines values for QueryType.
const (
	CONTEXTFULL   QueryType = "CONTEXT_FULL"
	JSONEXTRACTOR QueryType = "JSON_EXTRACTOR"
)

// ClientCanSync If the client is allowing active syncs
type ClientCanSync = bool

// ClientCreate The properties for creation.
type ClientCreate struct {
	// Id The client external id
	Id ClientID `json:"id"`

	// Name The client name
	Name ClientName `json:"name"`
}

// ClientID The client external id
type ClientID = string

// ClientIDBody The client id.
type ClientIDBody struct {
	// Id The client external id
	Id ClientID `json:"id"`
}

// ClientName The client name
type ClientName = string

// ClientStatus Specifies the status of a client.
type ClientStatus string

// ClientStatusBody A client status information object.
type ClientStatusBody struct {
	// Status Specifies the status of a client.
	Status ClientStatus `json:"status"`
}

// ClientUpdate The properties that may be updated.
type ClientUpdate struct {
	// CanSync If the client is allowing active syncs
	CanSync *ClientCanSync `json:"can_sync,omitempty"`

	// Name The client name
	Name *ClientName `json:"name,omitempty"`
}

// CodeVersion The desired code version.
type CodeVersion = int64

// Collector Collector model.
type Collector struct {
	// ActiveVersion The desired version.
	ActiveVersion Version `json:"active_version"`

	// ClientId The client external id
	ClientId ClientID `json:"client_id"`

	// Fields The fields in the collector.
	Fields CollectorFields `json:"fields"`

	// LatestVersion The desired version.
	LatestVersion Version `json:"latest_version"`

	// MinimumCleanerVersion The desired code version.
	MinimumCleanerVersion CodeVersion `json:"minimum_cleaner_version"`

	// MinimumTextVersion The desired code version.
	MinimumTextVersion CodeVersion `json:"minimum_text_version"`
}

// CollectorField The field properties for the collector.
type CollectorField struct {
	// Name The output field name.
	Name CollectorFieldName `json:"name"`

	// QueryId The query id.
	QueryId QueryID `json:"query_id"`
}

// CollectorFieldName The output field name.
type CollectorFieldName = string

// CollectorFields The fields in the collector.
type CollectorFields = []CollectorField

// CollectorSet Payload for updating a Collector.
type CollectorSet struct {
	// ActiveVersion The desired version.
	ActiveVersion *Version `json:"active_version,omitempty"`

	// Fields The fields in the collector.
	Fields *CollectorFields `json:"fields,omitempty"`

	// MinimumCleanerVersion The desired code version.
	MinimumCleanerVersion *CodeVersion `json:"minimum_cleaner_version,omitempty"`

	// MinimumTextVersion The desired code version.
	MinimumTextVersion *CodeVersion `json:"minimum_text_version,omitempty"`
}

// DocClient The properties of a client.
type DocClient struct {
	// CanSync If the client is allowing active syncs
	CanSync ClientCanSync `json:"can_sync"`

	// Id The client external id
	Id ClientID `json:"id"`

	// Name The client name
	Name ClientName `json:"name"`
}

// Document The document properties.
type Document struct {
	// ClientId The client external id
	ClientId ClientID `json:"client_id"`

	// Fields The fields and the value for the document
	Fields map[string]interface{} `json:"fields"`

	// Hash The document hash
	Hash Hash `json:"hash"`

	// Id The document id.
	Id DocumentID `json:"id"`
}

// DocumentID The document id.
type DocumentID = openapi_types.UUID

// DocumentSummary The document summary properties.
type DocumentSummary struct {
	// Hash The document hash
	Hash Hash `json:"hash"`

	// Id The document id.
	Id DocumentID `json:"id"`
}

// ErrorMessage Description of error
type ErrorMessage struct {
	// Message Message describing the cause.
	Message string `json:"message"`
}

// ExportDetails Payload for export trigger response.
type ExportDetails struct {
	// ClientId The client external id
	ClientId ClientID `json:"client_id"`

	// OutputLocation The location in which the export zip file will be found.
	OutputLocation *string `json:"output_location,omitempty"`

	// Status The possible export states.
	Status ExportStatus `json:"status"`
}

// ExportID The export id.
type ExportID = openapi_types.UUID

// ExportStatus The possible export states.
type ExportStatus string

// ExportTrigger Payload for triggering an export.
type ExportTrigger struct {
	// FieldFilters Filter the scope based on field output values.
	FieldFilters *[]FieldFilter `json:"field_filters,omitempty"`

	// IngestionFilters Filter the scope based on ingestion parameters.
	IngestionFilters *struct {
		// EndDate The last date of ingestion.
		EndDate *time.Time `json:"end_date,omitempty"`

		// StartDate This first date of ingestion.
		StartDate *time.Time `json:"start_date,omitempty"`
	} `json:"ingestion_filters,omitempty"`
}

// FieldFilter Filtering a column
type FieldFilter struct {
	// Condition The possible field filtering conditions.
	Condition FieldFilterCondition `json:"condition"`

	// FieldName The output field name.
	FieldName CollectorFieldName `json:"field_name"`

	// Values The values useful to the filter.
	Values []string `json:"values"`
}

// FieldFilterCondition The possible field filtering conditions.
type FieldFilterCondition string

// Hash The document hash
type Hash = string

// IdMessage A single uuid.
type IdMessage struct {
	// Id Unique identifier for entity.
	Id openapi_types.UUID `json:"id"`
}

// ListDocuments The documents in the client.
type ListDocuments = []DocumentSummary

// ListQueries A set of queries.
type ListQueries struct {
	// Queries List of queries.
	Queries []Query `json:"queries"`
}

// Query A logic unit of execution.
type Query struct {
	// ActiveVersion The desired version.
	ActiveVersion Version `json:"active_version"`

	// Config Configuration for the query.
	Config *QueryConfig `json:"config,omitempty"`

	// Id The query id.
	Id QueryID `json:"id"`

	// LatestVersion The desired version.
	LatestVersion Version `json:"latest_version"`

	// RequiredQueries List of required query IDs.
	RequiredQueries *RequiredQueryIDs `json:"required_queries,omitempty"`

	// Type Specifies the type of the query.
	Type QueryType `json:"type"`
}

// QueryConfig Configuration for the query.
type QueryConfig = string

// QueryCreate The parameters required to create a query.
type QueryCreate struct {
	// Config Configuration for the query.
	Config *QueryConfig `json:"config,omitempty"`

	// RequiredQueries List of required query IDs.
	RequiredQueries *RequiredQueryIDs `json:"required_queries,omitempty"`

	// Type Specifies the type of the query.
	Type QueryType `json:"type"`
}

// QueryID The query id.
type QueryID = openapi_types.UUID

// QueryTestRequest The properties for a query test request.
type QueryTestRequest struct {
	// DocumentId The document id.
	DocumentId DocumentID `json:"document_id"`

	// QueryVersion The desired version.
	QueryVersion Version `json:"query_version"`
}

// QueryTestResponse The response from a query test.
type QueryTestResponse struct {
	// Value Result of the query test.
	Value string `json:"value"`
}

// QueryType Specifies the type of the query.
type QueryType string

// QueryUpdate The properties that may be updated for a query.
type QueryUpdate struct {
	// ActiveVersion The desired version.
	ActiveVersion *Version `json:"active_version,omitempty"`

	// Config Configuration for the query.
	Config *QueryConfig `json:"config,omitempty"`

	// RequiredQueries List of required query IDs.
	RequiredQueries *RequiredQueryIDs `json:"required_queries,omitempty"`
}

// RequiredQueryIDs List of required query IDs.
type RequiredQueryIDs = []QueryID

// Version The desired version.
type Version = int32

// InternalError Description of error
type InternalError = ErrorMessage

// InvalidRequest Description of error
type InvalidRequest = ErrorMessage

// TooManyRequests Description of error
type TooManyRequests = ErrorMessage

// Unauthorized Description of error
type Unauthorized = ErrorMessage

// LoginCallbackParams defines parameters for LoginCallback.
type LoginCallbackParams struct {
	// Code Authorization code from Cognito
	Code string `form:"code" json:"code"`

	// State State parameter for CSRF protection
	State string `form:"state" json:"state"`
}

// CreateClientJSONRequestBody defines body for CreateClient for application/json ContentType.
type CreateClientJSONRequestBody = ClientCreate

// UpdateClientJSONRequestBody defines body for UpdateClient for application/json ContentType.
type UpdateClientJSONRequestBody = ClientUpdate

// SetCollectorByClientIdJSONRequestBody defines body for SetCollectorByClientId for application/json ContentType.
type SetCollectorByClientIdJSONRequestBody = CollectorSet

// TriggerExportJSONRequestBody defines body for TriggerExport for application/json ContentType.
type TriggerExportJSONRequestBody = ExportTrigger

// CreateQueryJSONRequestBody defines body for CreateQuery for application/json ContentType.
type CreateQueryJSONRequestBody = QueryCreate

// UpdateQueryJSONRequestBody defines body for UpdateQuery for application/json ContentType.
type UpdateQueryJSONRequestBody = QueryUpdate

// TestQueryJSONRequestBody defines body for TestQuery for application/json ContentType.
type TestQueryJSONRequestBody = QueryTestRequest

// ServerInterface represents all server handlers.
type ServerInterface interface {
	// Create a new client
	// (POST /client)
	CreateClient(ctx echo.Context) error
	// Get a client by ID
	// (GET /client/{id})
	GetClient(ctx echo.Context, id ClientID) error
	// Update a client
	// (PATCH /client/{id})
	UpdateClient(ctx echo.Context, id ClientID) error
	// Get a collector by client ID
	// (GET /client/{id}/collector)
	GetCollectorByClientId(ctx echo.Context, id ClientID) error
	// Set a collector
	// (PATCH /client/{id}/collector)
	SetCollectorByClientId(ctx echo.Context, id ClientID) error
	// List the documents for a client
	// (GET /client/{id}/documents)
	ListDocumentsByClientId(ctx echo.Context, id ClientID) error
	// Trigger an export
	// (POST /client/{id}/export)
	TriggerExport(ctx echo.Context, id ClientID) error
	// Get client sync status
	// (GET /client/{id}/status)
	GetStatusByClientId(ctx echo.Context, id ClientID) error
	// Get document details by its id
	// (GET /document/{id})
	GetDocument(ctx echo.Context, id DocumentID) error
	// Check export state.
	// (GET /export/{id})
	ExportState(ctx echo.Context, id ExportID) error
	// Get the home page menu
	// (GET /home)
	GetHomePage(ctx echo.Context) error
	// Login to the application
	// (GET /login)
	Login(ctx echo.Context) error
	// OAuth2 callback endpoint
	// (GET /login-callback)
	LoginCallback(ctx echo.Context, params LoginCallbackParams) error
	// Logout from the application
	// (GET /logout)
	Logout(ctx echo.Context) error
	// List queries
	// (GET /query)
	ListQueries(ctx echo.Context) error
	// Create a new query
	// (POST /query)
	CreateQuery(ctx echo.Context) error
	// Get a query by ID
	// (GET /query/{id})
	GetQuery(ctx echo.Context, id QueryID) error
	// Update a query
	// (PATCH /query/{id})
	UpdateQuery(ctx echo.Context, id QueryID) error
	// Test a query
	// (POST /query/{id}/test)
	TestQuery(ctx echo.Context, id QueryID) error
}

// ServerInterfaceWrapper converts echo contexts to parameters.
type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

// CreateClient converts echo context to params.
func (w *ServerInterfaceWrapper) CreateClient(ctx echo.Context) error {
	var err error

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.CreateClient(ctx)
	return err
}

// GetClient converts echo context to params.
func (w *ServerInterfaceWrapper) GetClient(ctx echo.Context) error {
	var err error
	// ------------- Path parameter "id" -------------
	var id ClientID

	err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
	}

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.GetClient(ctx, id)
	return err
}

// UpdateClient converts echo context to params.
func (w *ServerInterfaceWrapper) UpdateClient(ctx echo.Context) error {
	var err error
	// ------------- Path parameter "id" -------------
	var id ClientID

	err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
	}

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.UpdateClient(ctx, id)
	return err
}

// GetCollectorByClientId converts echo context to params.
func (w *ServerInterfaceWrapper) GetCollectorByClientId(ctx echo.Context) error {
	var err error
	// ------------- Path parameter "id" -------------
	var id ClientID

	err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
	}

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.GetCollectorByClientId(ctx, id)
	return err
}

// SetCollectorByClientId converts echo context to params.
func (w *ServerInterfaceWrapper) SetCollectorByClientId(ctx echo.Context) error {
	var err error
	// ------------- Path parameter "id" -------------
	var id ClientID

	err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
	}

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.SetCollectorByClientId(ctx, id)
	return err
}

// ListDocumentsByClientId converts echo context to params.
func (w *ServerInterfaceWrapper) ListDocumentsByClientId(ctx echo.Context) error {
	var err error
	// ------------- Path parameter "id" -------------
	var id ClientID

	err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
	}

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.ListDocumentsByClientId(ctx, id)
	return err
}

// TriggerExport converts echo context to params.
func (w *ServerInterfaceWrapper) TriggerExport(ctx echo.Context) error {
	var err error
	// ------------- Path parameter "id" -------------
	var id ClientID

	err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
	}

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.TriggerExport(ctx, id)
	return err
}

// GetStatusByClientId converts echo context to params.
func (w *ServerInterfaceWrapper) GetStatusByClientId(ctx echo.Context) error {
	var err error
	// ------------- Path parameter "id" -------------
	var id ClientID

	err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
	}

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.GetStatusByClientId(ctx, id)
	return err
}

// GetDocument converts echo context to params.
func (w *ServerInterfaceWrapper) GetDocument(ctx echo.Context) error {
	var err error
	// ------------- Path parameter "id" -------------
	var id DocumentID

	err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
	}

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.GetDocument(ctx, id)
	return err
}

// ExportState converts echo context to params.
func (w *ServerInterfaceWrapper) ExportState(ctx echo.Context) error {
	var err error
	// ------------- Path parameter "id" -------------
	var id ExportID

	err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
	}

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.ExportState(ctx, id)
	return err
}

// GetHomePage converts echo context to params.
func (w *ServerInterfaceWrapper) GetHomePage(ctx echo.Context) error {
	var err error

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.GetHomePage(ctx)
	return err
}

// Login converts echo context to params.
func (w *ServerInterfaceWrapper) Login(ctx echo.Context) error {
	var err error

	ctx.Set(CognitoAuthScopes, []string{"openid", "email", "profile"})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.Login(ctx)
	return err
}

// LoginCallback converts echo context to params.
func (w *ServerInterfaceWrapper) LoginCallback(ctx echo.Context) error {
	var err error

	// Parameter object where we will unmarshal all parameters from the context
	var params LoginCallbackParams
	// ------------- Required query parameter "code" -------------

	err = runtime.BindQueryParameter("form", true, true, "code", ctx.QueryParams(), &params.Code)
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter code: %s", err))
	}

	// ------------- Required query parameter "state" -------------

	err = runtime.BindQueryParameter("form", true, true, "state", ctx.QueryParams(), &params.State)
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter state: %s", err))
	}

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.LoginCallback(ctx, params)
	return err
}

// Logout converts echo context to params.
func (w *ServerInterfaceWrapper) Logout(ctx echo.Context) error {
	var err error

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.Logout(ctx)
	return err
}

// ListQueries converts echo context to params.
func (w *ServerInterfaceWrapper) ListQueries(ctx echo.Context) error {
	var err error

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.ListQueries(ctx)
	return err
}

// CreateQuery converts echo context to params.
func (w *ServerInterfaceWrapper) CreateQuery(ctx echo.Context) error {
	var err error

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.CreateQuery(ctx)
	return err
}

// GetQuery converts echo context to params.
func (w *ServerInterfaceWrapper) GetQuery(ctx echo.Context) error {
	var err error
	// ------------- Path parameter "id" -------------
	var id QueryID

	err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
	}

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.GetQuery(ctx, id)
	return err
}

// UpdateQuery converts echo context to params.
func (w *ServerInterfaceWrapper) UpdateQuery(ctx echo.Context) error {
	var err error
	// ------------- Path parameter "id" -------------
	var id QueryID

	err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
	}

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.UpdateQuery(ctx, id)
	return err
}

// TestQuery converts echo context to params.
func (w *ServerInterfaceWrapper) TestQuery(ctx echo.Context) error {
	var err error
	// ------------- Path parameter "id" -------------
	var id QueryID

	err = runtime.BindStyledParameterWithOptions("simple", "id", ctx.Param("id"), &id, runtime.BindStyledParameterOptions{ParamLocation: runtime.ParamLocationPath, Explode: false, Required: true})
	if err != nil {
		return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Invalid format for parameter id: %s", err))
	}

	ctx.Set(JwtAuthScopes, []string{})

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.TestQuery(ctx, id)
	return err
}

// 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 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
}

// RegisterHandlers adds each server route to the EchoRouter.
func RegisterHandlers(router EchoRouter, si ServerInterface) {
	RegisterHandlersWithBaseURL(router, si, "")
}

// Registers handlers, and prepends BaseURL to the paths, so that the paths
// can be served under a prefix.
func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string) {

	wrapper := ServerInterfaceWrapper{
		Handler: si,
	}

	router.POST(baseURL+"/client", wrapper.CreateClient)
	router.GET(baseURL+"/client/:id", wrapper.GetClient)
	router.PATCH(baseURL+"/client/:id", wrapper.UpdateClient)
	router.GET(baseURL+"/client/:id/collector", wrapper.GetCollectorByClientId)
	router.PATCH(baseURL+"/client/:id/collector", wrapper.SetCollectorByClientId)
	router.GET(baseURL+"/client/:id/documents", wrapper.ListDocumentsByClientId)
	router.POST(baseURL+"/client/:id/export", wrapper.TriggerExport)
	router.GET(baseURL+"/client/:id/status", wrapper.GetStatusByClientId)
	router.GET(baseURL+"/document/:id", wrapper.GetDocument)
	router.GET(baseURL+"/export/:id", wrapper.ExportState)
	router.GET(baseURL+"/home", wrapper.GetHomePage)
	router.GET(baseURL+"/login", wrapper.Login)
	router.GET(baseURL+"/login-callback", wrapper.LoginCallback)
	router.GET(baseURL+"/logout", wrapper.Logout)
	router.GET(baseURL+"/query", wrapper.ListQueries)
	router.POST(baseURL+"/query", wrapper.CreateQuery)
	router.GET(baseURL+"/query/:id", wrapper.GetQuery)
	router.PATCH(baseURL+"/query/:id", wrapper.UpdateQuery)
	router.POST(baseURL+"/query/:id/test", wrapper.TestQuery)

}

// Base64 encoded, gzipped, json marshaled Swagger object
var swaggerSpec = []string{

	"H4sIAAAAAAAC/+xceW8juXL/KkTnAQF2dUs+gyDxs2d2tJhrbU/eS2xHoLpLEne7SZlk29YM/N0DXn23",
	"LkveBWLAf1hqNlksVv2qWPxRPzyfRXNGgUrhnf7wZoAD4PrfSyzhI4mIVB8CED4nc0kY9U71IxSqZ4jQ",
	"CeMRVg8Qoch8QLeefvpvj4QG7PHfJYmgaf6/9byGB084mofgnXrdTsc16na8hif8GURYjVjZ5lC1ifDT",
	"R6BTOfNO+72GN8dSAldi/e9Np3ly97NrbD79zWt4cjFXHQnJCZ16z8/P6i2OI5B2ruchASqHF+WpXs8A",
	"+fopGl60vIZH1LdzLGdew6M4Uv2SwGt4HO5jwiHwTiWPITuTv3GYeKfev7RTVbfNU9FOBlYyXTA/jpbI",
	"Edjne5EkM7iS5d3TnPFaSUA/3YscycBKit9i4Is6IYYXiE2QnAG6V812L4obXRsMBzFnVIC2lyFVJofD",
	"d5wzrr7wGZVAtavg+TwkvvaI9u9CSftj3amr3j6BEHgKZtD8pN2oSAB/AI5AtVfTrvPaqsFs23baUI80",
	"pA84JMEl3Mcg5CtOSQ+LuBkXjVmw2NGMrhn7hOnCzki82pQuraGgeM4okoyhCNOFm6HYwewa3iVIvmie",
	"TSTwsm98jqMxcOUbAnxGA4HGMGEckOQLQqcITzGhrSwMd3udrE8YEFe+Q2W/ZxCXRHHknR4fDjqdhhcR",
	"aj53EmwlVMIUuFLIc8P7RnEsZ4yT78rnXlvxjzOgKM6IsBOLenYqykSMc0yvFtQvr8HQAJONHEQgHIbs",
	"UWvfl+QBkFhQX6ShacxYCJiqtbU9c8ASqoFvztkcuCQgVLxFvmpKmF7S9JF6lQTrxx8HmOu0/6xaGlB0",
	"uHpjgFb3cZdMi41/B1+ms1oRYeHJApzuK80Azs7OCnH/MBf3W1VRPh3z7yxYLB2XBC/TXVkT9Sr4bLVc",
	"K4xWYX72HCTkFdA72EADVxLLWJQHvZqDTybKjJStCt1KwQa2omiMoMrPb7zh59HVf38+9xre5y/X+t93",
	"F5kPw8+/ZOZcLUD1Mpy5edvxswml0V15bUQyodXrYydfXCPbRf06fZsH6zignGGJIrxAYwX46pUKW/Ix",
	"HQmLE6sldqCynUuWp8MC+C/gghisrUgrQSitIJ8FgB5MSzWHbBg4HGTDwEmv1+8f9Tr9w+ODwdHRYScX",
	"FLrloKCkCEPwJauIV8kjFLEAwrL6DGSOHtJJLNOHm+tzwzOWNdoMBicEwmC1cTmh35vmzw0vxBKE3EJM",
	"q7mRr0IA8HV7yC5sphcJT3KrLgoekiov0Um9qDXDl5TSKC5mpQPmdFtttFqiYiTUIde9XLajtbwpN7bx",
	"qoanNxhr2FG6Y8jr0mJ60s3qWdeHCRbLeSytAlTHre1CQ8GA67WsMLmsWiIh2tBLtJXip6F5U8tpxcKc",
	"40VOqiuoqDt8xYuQ4UCvtQZbnVCh8/ol3xo6tkaBv44zlyzsgvkG6FZGtUISsKNo9ielo41U4rtqrejC",
	"x4qaS6qDCo28LM7U+h2mgXa8BxzGkCCcEymbJP5wEi26iZeb11JhFz3vdNBLP/ZdNcR9ceCd3nQbvUb/",
	"rsp6ZljMVs3vg2qz1koXyk2llctGHz1yorBla7iycmYy/TS37nRPDo47waQ57k+Om0f9wXHzBI+7zS4c",
	"HIz7k+4xBEfZVCiOtUSFrUgJXJ08V3EUYb5YIZQwrZaa2OtqX49WpejcHrw0q4v0k4IQXZ/KW2nkXvUW",
	"LEZRLCQi1A/jABBG7uFzcfJR3YBWEmS+HSuj14EKxwLyC50MN1W77wjQlLEgu9nYIogWNOekrNSbrmpe",
	"gMQkFMsDm62tSk6mU+DI1R13hDomexiFzJRgqi3TPVWB/3FG/JnWqhXsO5mjCQkBPZIwVNueCYtpwa1E",
	"/7Tdxu2ztnmn3ev0Djq9br+t/Kfli4eCtjuD45y69futn9Wf7UEX838cP7dbP9/eqh4qk5r1NoZmMWo2",
	"hlngWbJJXKs+XoM20BwEB93mUbfvN0+OAZqDwwEc94+73Um3vwXa5OZTHdqZEGQcJoKpiRmUcft7paYQ",
	"JAS6ij6aczblIFTKP8EkhKByd28GvjaWutyqrTnrhI1aMcomrSF+NCGhO5jJd/hePzDVCp/NAY2xgAAx",
	"arNhmxrruCfWTlJ17ma6XiNDJXQKQsmzjZjJyyg9fyprAWgwqi8+hFhIpB4riE06zG3Y1dOmJBGUT8uq",
	"XIbL2uGIQBPCdzhgObOoyjWyS1KjXpP6+yyMI1qGRkYDItfImTMDnSfvuORstP2G0Zhg9QKaZygWMIlD",
	"JJk2FGNMOZvdfE+Xmm630ymabgHnMjNsZPSViH63fFnOsxpeAjjGMSfJkiUj5dAnBCFGcobV+FNd+ebu",
	"ox8yAcGIUAn8AYdew2NzoNnPIUzkqNyMk+ms6nubb2hgNv9VQdsHm28tSdtsWrosjtWs0zCoTaHOkCB0",
	"GgLSkbKmKp1/5Rsl9zEgEgCVZEKAmzSCSiIXrY3DyXq17I9ESJdEiuV6SssHyX5yLVgu5tCroVkJ9VsM",
	"nFR53hkSIBWC3ZsWZd3e172q+i28udYMdDUoL/dBt7fCL50UVVo3HVZMLWRT4qOYEi0nPIEfV58IbV9K",
	"ZXRCpmvN+Nw0XWsjkhTMXlA+ddobZRZw2auXtr0dW1dtjKrXkPVaNazcM+kuSvXN0rxq1/U80XCxPK6+",
	"j7nJyF0RIKE8LIOf29sfrZ9ub58rQcgMuuyYMUlRkJusilb6uFFt1xIRSrF3c0v589dQv127OHWJvtZB",
	"fVUBJocHzaPDo8PmcQAnzZPBoH+AT/r9/hHeIs83woOQGZbGytNhu05IGaEjIZQXzYH1aLPagStpb+q0",
	"Bd1nRy92WbskRhFmc1ytCbd1RhPOopwiygowtbIy0w1EHMoczyjpYOPAX5i1GbJ+ftacl53ZqjdLJCiX",
	"VP169eXz6N0/ry/Pzq+/XHoN7/zL5+t3/7wevf/28WNl0qPH3f7gM2tvf3boeTmgVO1LSq1qc4UEMY3N",
	"DC82TBuMd61IeNY61q050c0Te3rdwdHguH84OFrB7ml4AvyYE7m4UuI6yJ9SItlZLCtyZvWtSkZtSSlW",
	"+S06i/B3RtG5eRENL7620FChp8kYL9+fHx/1DtCv/7hGYwVcc67Mx7eY5kTQcwrZo7EvS/fRw5yzAEpf",
	"fuOhd+rNpJyL03Y7YP73RUs1aMWiCVjIZreFtVx2Pi2fRW2mWvTaCZlIk1TZ3O7UI0xUn2e+D0Ko6BgL",
	"4P8qkHlg9ioKUr1fQKIvw4tzJNkfYDesE2L4HcWX3SNlgar1S+Q2w2WNWX+v+v79UboVGwPmwN878/j1",
	"H9dekV2llkJ3hthYYkIhQHgigSdriHPrvO1yaifQjCgtUgqiavqG9UXohDlSGfZldh2iyJ/GhFIQ4j8x",
	"5iBB6SIlg34i/gxDiD75v9hmXsOLtXqNWlXrErHs7Osw2c3kszDtqugL92cgpM3QBPAHNTU1m5D4YMOT",
	"lSCm9rsgGfnx8bFlcwc3viRSm0ZV/2dfh2qX7lzf67Q6ra4u7c6B4jnxTr1+q9PqezogzbSdtv3k3G/O",
	"qhIHkwcKhBGFR8fIeSTSVH7nnD2QAAIUmAJ2y1i2EWgYJO/b00WDviCkY/zshP6X48VV0P8M5mn5qvNV",
	"PytdygYucnt7ne6OZbYMtAqZzXMrYoBErKFgEofhrliwg06n7o1k1u0C+Ve/1l39Wo7lqV7qnax+qUjL",
	"fW54B+vJmKVcZwORd3rzIwWzm7vnu4Yn3MGbtcycYStQwVOhciTLETMu692pbq2vtH+Q4FmJNa1iIlyC",
	"5AQetMcIk5L5zm3GC0SksOT4vJv8AjLjIzmj6+zM6NJj/nqLyzjym5G93MhUdMeZ9R9eLLGx/OWTm2qZ",
	"0iaZ47s7Del+RZJlknZhzlaI0MSYLIor468Fb/PyK4C33VqsAG+VCJmGq6G6UxHKzLTdnuQNU3dv7mYd",
	"syF1TTxt+1ka6AbImlBELbjmrmSVMdY1//vCOk+wT8BNua1VgJuI/oa5+8DcrGUkVpG1yJRRuE8AvgLp",
	"hk9FWg29V/XGugcQzpIrV4PwGPSRSSWxdhUuD5bRvFWvb7C8e4+4ynvEcicoInOQPc1bgczKHEJb6EqP",
	"+caL7J2nKmjOnRq+DjbnDyqXJMTJNNTE3ixyNxapq6EydxhsasSlxCFZo53AdNG4Dd9Ilz9egPyVlZMh",
	"JZLo3DvDkZtzptCt7AGWK2WIU3uC+TwrqwbnraAWx7XmW69aGkk5EBUSvstxIN+y+L04p7WQlI+XcUdL",
	"KayNFinRco1QIRbUd9f71srf7X3B10neizcU62OEncJbHr/zPN5dAU0NZT/1E2XGLhStW+CTmaxY34tJ",
	"CGDWls3pf8mIL9JrGvss9ZkxKozWPXuz193ba1DQbWoKu01pslwLbbyWDb/UdM9n4P9h7NaPOXfIpYkC",
	"Oe513mRTFjns02TzNyHqY/8MCzQGoChhpr8Z8I5ORJR95G4CtJZE/k1NNv39Hm2wM2Yo1HUgG3NqTPXD",
	"9aePKAIaozmemstumRNlCPThuKhE2g8sgq8qk1xpthKeZHsmozBvr3mptCT2paT6oeZhJFMyZrkUursc",
	"G6jbGRwfHBUY2z/V/BBVYexkGCXFm8HvDLEr19DZvHotn+uGbEpord3m93y6LZqE7FGFAQ4B4eDrExjJ",
	"sgwX21AJUFEa0QMWDLjf6VU5jRkg23vac95kPtZe8/p2+dFdPajspOLXgGJOVrDeHEWl9VMl+e3NgJca",
	"8HOjwKS6cfShhuf4RI4aVKyz6KWz65mJzattvOnjMBxj/49aY/+AaRBaU/+ieukh9w4KYu7uXFrrsYUP",
	"dAk+EJc+51hY5ndGNCUz6xyYBgie/BmmUxCIWORlfwAVNd5y7iQvhagyAW3J6O5n4zRRL6UKqXZLfzlu",
	"mSPcnDX/Bze/d5ont7fNUfWPEDZKRwg6SUumohVwfnX5XilVKkTR61klq5BVp6U1wnY7vcHGwt5tikwZ",
	"I7Q8sbSEY2xlQ6RyuFrf2/aQ9R91mPX/CX1ygFJ0dKDBnJFcxbYSUFgsa4HkI5saOFCZHGKx2UAbxZmf",
	"8tDFIhBCGw0N6mKpGSeRqRIelCAviKaqf50pqDQ0Y8pJCvEy6w2dgG82u6eDB7OEGuc3iYn37obVSm5C",
	"mL8Ulr2KrG//+pxI4ARXn4K5a2p7Pvlyw1TsNM6KM3jbXu/wzOs+WV9na5rKe/Z1aLbUa5BwzcWBjTm4",
	"v9nUYB8nS9krY9swcO8zsv0FTpkMu/qNfPtK5Fu3+hUekUDvFqxb4yfLSbepU+wJbO1V3zobeyvB74H6",
	"lSx8ju+Vx9mNSpfJxavNeLYZoF6DZrt3fF5OsjW0WPcbFMlPitm7YsnVvS14t8bS32i3r0C7XRtJ29Je",
	"E36BI1SmKu/0TwxoIDYXi2NqDkfrspb8790USDEg5N7dIntvusY3ChelN+HFdPYhrL3bXCWtkVHE4RtV",
	"bVdsGKXS5a6l++IP1VXGr5wFsZ/cANRXF+OKi5s+i9oPXe1adoxiT1+cc6gsOtRoqpJozWIQadEvT4so",
	"lxNrunFM0GxPRXboup2lnNGkr9Kh97p9pTsm21Oi+XV7MCeamR7yR5nrdpO/x5r2li0WPN89/18AAAD/",
	"/1+CAiY6ZwAA",
}

// GetSwagger returns the content of the embedded swagger specification file
// or error if failed to decode
func decodeSpec() ([]byte, error) {
	zipped, err := base64.StdEncoding.DecodeString(strings.Join(swaggerSpec, ""))
	if err != nil {
		return nil, fmt.Errorf("error base64 decoding spec: %w", err)
	}
	zr, err := gzip.NewReader(bytes.NewReader(zipped))
	if err != nil {
		return nil, fmt.Errorf("error decompressing spec: %w", err)
	}
	var buf bytes.Buffer
	_, err = buf.ReadFrom(zr)
	if err != nil {
		return nil, fmt.Errorf("error decompressing spec: %w", err)
	}

	return buf.Bytes(), nil
}

var rawSpec = decodeSpecCached()

// a naive cached of a decoded swagger spec
func decodeSpecCached() func() ([]byte, error) {
	data, err := decodeSpec()
	return func() ([]byte, error) {
		return data, err
	}
}

// Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error) {
	res := make(map[string]func() ([]byte, error))
	if len(pathToFile) > 0 {
		res[pathToFile] = rawSpec
	}

	return res
}

// 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 GetSwagger() (swagger *openapi3.T, err error) {
	resolvePath := PathToRawSpec("")

	loader := openapi3.NewLoader()
	loader.IsExternalRefsAllowed = true
	loader.ReadFromURIFunc = func(loader *openapi3.Loader, url *url.URL) ([]byte, error) {
		pathToFile := url.String()
		pathToFile = path.Clean(pathToFile)
		getSpec, ok := resolvePath[pathToFile]
		if !ok {
			err1 := fmt.Errorf("path not found: %s", pathToFile)
			return nil, err1
		}
		return getSpec()
	}
	var specData []byte
	specData, err = rawSpec()
	if err != nil {
		return
	}
	swagger, err = loader.LoadFromData(specData)
	if err != nil {
		return
	}
	return
}