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

// Package queryservice 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 queryservice

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

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

// 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 JobStatus.
const (
	INSYNC    JobStatus = "IN_SYNC"
	NOTSYNCED JobStatus = "NOT_SYNCED"
)

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

// ClientCreate defines model for ClientCreate.
type ClientCreate struct {
	// Name The client name
	Name string `json:"name"`
}

// ClientUpdate defines model for ClientUpdate.
type ClientUpdate struct {
	// CanSync If the client is allowing active syncs
	CanSync *bool `json:"can_sync,omitempty"`

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

// Document defines model for Document.
type Document struct {
	// Bucket The bucket containing the document
	Bucket string `json:"bucket"`

	// Id The document id
	Id openapi_types.UUID `json:"id"`

	// Key The path to the document
	Key string `json:"key"`
}

// ExportDetails Payload for export trigger response.
type ExportDetails struct {
	// JobId The job id relative to the export.
	JobId openapi_types.UUID `json:"job_id"`

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

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

// ExportStatus The possible export job 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 *string `json:"end_date,omitempty"`

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

	// JobId The job id of the query results to be exported.
	JobId openapi_types.UUID `json:"job_id"`
}

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

	// FieldName The name of the field in question.
	FieldName string `json:"field_name"`

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

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

// IdMessage defines model for IdMessage.
type IdMessage struct {
	// Id Unique identifier for entity.
	Id openapi_types.UUID `json:"id"`
}

// Job defines model for Job.
type Job struct {
	// CanSync Specifies whether the job is actively syncing
	CanSync bool `json:"can_sync"`

	// ClientId The client id the job belongs to
	ClientId openapi_types.UUID `json:"client_id"`

	// Id The job id
	Id openapi_types.UUID `json:"id"`

	// Status Specifies the status of a job.
	Status JobStatus `json:"status"`
}

// JobClient defines model for JobClient.
type JobClient struct {
	// CanSync If the client is allowing active syncs
	CanSync bool `json:"can_sync"`

	// Id The client id
	Id openapi_types.UUID `json:"id"`

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

// JobCollector JobCollector model.
type JobCollector struct {
	// ActiveVersion The active version of the collector.
	ActiveVersion int32 `json:"active_version"`

	// Fields The fields in the job collector.
	Fields []JobCollectorField `json:"fields"`

	// JobId The ID of the associated job.
	JobId openapi_types.UUID `json:"job_id"`

	// LatestVersion The latest version of the collector.
	LatestVersion int32 `json:"latest_version"`

	// MinimumCleanerVersion The minimum version for the document cleaner.
	MinimumCleanerVersion int32 `json:"minimum_cleaner_version"`

	// MinimumTextVersion The minimum version for the text parser.
	MinimumTextVersion int32 `json:"minimum_text_version"`
}

// JobCollectorField The field properties for the job collector.
type JobCollectorField struct {
	// Name The output field name.
	Name string `json:"name"`

	// QueryId The query id that will populate the result.
	QueryId openapi_types.UUID `json:"query_id"`
}

// JobCollectorUpdate Payload for updating a JobCollector.
type JobCollectorUpdate struct {
	// ActiveVersion The active version of the collector.
	ActiveVersion *int32 `json:"active_version,omitempty"`

	// Fields The fields in the job collector.
	Fields *[]JobCollectorField `json:"fields,omitempty"`

	// MinimumCleanerVersion The minimum version for the document cleaner.
	MinimumCleanerVersion *int32 `json:"minimum_cleaner_version,omitempty"`

	// MinimumTextVersion The minimum version for the text parser.
	MinimumTextVersion *int32 `json:"minimum_text_version,omitempty"`
}

// JobCreate defines model for JobCreate.
type JobCreate struct {
	// ClientId The client id the job belongs to
	ClientId openapi_types.UUID `json:"client_id"`
}

// JobStatus Specifies the status of a job.
type JobStatus string

// JobUpdate defines model for JobUpdate.
type JobUpdate struct {
	// CanSync Specifies whether the job is actively syncing
	CanSync *bool `json:"can_sync,omitempty"`
}

// ListDocuments The documents in the job.
type ListDocuments = []Document

// ListQueries defines model for ListQueries.
type ListQueries struct {
	// Queries List of queries.
	Queries []Query `json:"queries"`
}

// Query defines model for Query.
type Query struct {
	// ActiveVersion The active version of the query.
	ActiveVersion int32 `json:"active_version"`

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

	// Id Unique identifier for the query.
	Id openapi_types.UUID `json:"id"`

	// LatestVersion The latest version of the query.
	LatestVersion int32 `json:"latest_version"`

	// RequiredQueries List of required query IDs.
	RequiredQueries *[]openapi_types.UUID `json:"required_queries,omitempty"`

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

// QueryCreate defines model for QueryCreate.
type QueryCreate struct {
	// Config Configuration for the new query.
	Config *string `json:"config,omitempty"`

	// RequiredQueries List of required query IDs.
	RequiredQueries *[]openapi_types.UUID `json:"required_queries,omitempty"`

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

// QueryTestRequest defines model for QueryTestRequest.
type QueryTestRequest struct {
	// DocumentId ID of the document to test against.
	DocumentId openapi_types.UUID `json:"document_id"`

	// QueryVersion Version of the query to use for testing.
	QueryVersion int32 `json:"query_version"`
}

// QueryTestResponse defines model for QueryTestResponse.
type QueryTestResponse struct {
	// Value Result of the query test.
	Value string `json:"value"`
}

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

// QueryUpdate defines model for QueryUpdate.
type QueryUpdate struct {
	// ActiveVersion Updated active version.
	ActiveVersion *int32 `json:"active_version,omitempty"`

	// Config Updated configuration for the query.
	Config *string `json:"config,omitempty"`

	// RequiredQueries Updated list of required query IDs.
	RequiredQueries *[]openapi_types.UUID `json:"required_queries,omitempty"`
}

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

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

// CreateJobJSONRequestBody defines body for CreateJob for application/json ContentType.
type CreateJobJSONRequestBody = JobCreate

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

// UpdateJobJSONRequestBody defines body for UpdateJob for application/json ContentType.
type UpdateJobJSONRequestBody = JobUpdate

// UpdateJobCollectorByJobIdJSONRequestBody defines body for UpdateJobCollectorByJobId for application/json ContentType.
type UpdateJobCollectorByJobIdJSONRequestBody = JobCollectorUpdate

// 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 openapi_types.UUID) error
	// Update a client
	// (PATCH /client/{id})
	UpdateClient(ctx echo.Context, id openapi_types.UUID) error
	// Create a new job
	// (POST /job)
	CreateJob(ctx echo.Context) error
	// Trigger an export
	// (POST /job/export)
	TriggerExport(ctx echo.Context) error
	// Get a job by ID
	// (GET /job/{id})
	GetJob(ctx echo.Context, id openapi_types.UUID) error
	// Update a job
	// (PATCH /job/{id})
	UpdateJob(ctx echo.Context, id openapi_types.UUID) error
	// Get a job collector by ID
	// (GET /job/{id}/collector)
	GetJobCollectorByJobId(ctx echo.Context, id openapi_types.UUID) error
	// Update a job collector
	// (PATCH /job/{id}/collector)
	UpdateJobCollectorByJobId(ctx echo.Context, id openapi_types.UUID) error
	// List the documents for a job
	// (GET /job/{id}/documents)
	ListDocumentsByJobId(ctx echo.Context, id openapi_types.UUID) error
	// Check export state.
	// (GET /job/{id}/export)
	ExportState(ctx echo.Context, id openapi_types.UUID) 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 openapi_types.UUID) error
	// Update a query
	// (PATCH /query/{id})
	UpdateQuery(ctx echo.Context, id openapi_types.UUID) error
	// Test a query
	// (POST /query/{id}/test)
	TestQuery(ctx echo.Context, id openapi_types.UUID) 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

	// 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 openapi_types.UUID

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

	// 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 openapi_types.UUID

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	// Invoke the callback with all the unmarshaled arguments
	err = w.Handler.ListDocumentsByJobId(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 openapi_types.UUID

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

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

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

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

	// 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 openapi_types.UUID

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

	// 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 openapi_types.UUID

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

	// 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 openapi_types.UUID

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

	// 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.POST(baseURL+"/job", wrapper.CreateJob)
	router.POST(baseURL+"/job/export", wrapper.TriggerExport)
	router.GET(baseURL+"/job/:id", wrapper.GetJob)
	router.PATCH(baseURL+"/job/:id", wrapper.UpdateJob)
	router.GET(baseURL+"/job/:id/collector", wrapper.GetJobCollectorByJobId)
	router.PATCH(baseURL+"/job/:id/collector", wrapper.UpdateJobCollectorByJobId)
	router.GET(baseURL+"/job/:id/documents", wrapper.ListDocumentsByJobId)
	router.GET(baseURL+"/job/:id/export", wrapper.ExportState)
	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/+RbX2/bOBL/KoTuHg07u90nv3WTdOGg1/Sa9LCHRWFQ0thmKpMKSSX1Bv7uB/6VZJGW",
	"nETdHvapTUTOcGZ+84czzFOSsW3JKFApkvlTIrINbLH+73lBgMpzDliC+rnkrAQuCeivFG/1b3MQGSel",
	"JIwm8+R2AyjT+5BeMEnkroRkngjJCV0n+/0k4XBfEQ55Mv/DUPniV7H0DjKZ7CeW+ecyDzLPMF2KHc26",
	"B1iskKzPQATCRcEeCV0jnEnyAEhtE/W5UsYKwFSxfL5EndNfsKzaApXdk6dV9hVkmI35hjJGJSZUnVmJ",
	"kjtaHc6ThORhSm4PInkySVaMb7FM5klV6Z87ZL7CLkynxHKDJOs5x4FNNQ8rp6EdMvDlt5JxeQESk0J0",
	"uX/Eu4LhHK0YR6CXIsnJeg0ccRAlowKmyeRAuXcsXcZUcsdSRHLEocAaB1YqQ3s6REuskmUllwXLsKEb",
	"YuO+IkLR44ZkmwYX9Ccp0YoUgB5JUaAU0IpVNFfM4RveloXm92Y+mz0Z9e1nTwZ6JN/Pnu5Yqv+VZAtC",
	"4m25Xz4ZwiTfT/8kZejQQmJZaeX8k8MqmSf/mNUOP7PePjPGuDFrD+1pteppxa1545kFoMSEIGnhdaHs",
	"oQiC0PLTaqt4qbMVIEGxI3RZcrbmIJS/rjApIG8wr2U0zG8NPI5DyWJIxwPaMH4bRysCRb5ckUICD4jz",
	"Tn/QhhUZKwGlWECOGEV6IzJAQQ+4qIx0RMK21wbv1F5DOqljCuYc77Sr0zUIdYDnnMtvRiXmeAtqf1ds",
	"oPnSxdsAsrGQSH1GbFUTnEZAx2WUFBFoRfhAYqHoOsDNmUkD9xXwnQoYVSGFcvnU4Q/yAT4fdoQQ/pvG",
	"i9hFYw5lrKi2tKP6jNGcuKgyECXnfs9+YiEbT2Hqi9OKQSmhSj1xIxr4hqmZb6gSsKoKF0oNLlt47xBt",
	"o/pAvw0ZJg2N+KP0KP68qcMjAciIv/JG8ZxakagAIZZygxX/ta6BuPsxK5iAfEmoBP6Ai2SSsBJo8+cC",
	"VnLZXcbJehP6PaFZUeWg84D5XyjMLfJ/gRB4HaiHQt7wmZL7ChDJVf5YEeAml1JJ5O507Edwf8XSU6qz",
	"mxIydRaBHjcgNzZYaZ8VtkArdrpEU2cIFWkmH0bd39V9uSecQsHoWjn/kBx/PKwMoTAs4V6xNJJtNdVa",
	"ykmtzaMJ+IqlpmT+TsVyrwGG6Op17hCatosaTtaYjlhRQCZZIEo3v6Ity6HoZkijluUDcBGNM1Z1do2L",
	"uZkj3XI9QuWbn2sBVUhYm/Svg1Qk+ppvKoA7kLeoD6o2mtLqGBqqOY4l2sWFEw0LwTKCJeTqLINK6ULV",
	"ffK4Hs2al+pxSyjZVttlpoAL/DhLu9jz1BVj8zplqZzIW8I3+TzGaqcq2cRAnrHK3aIpro7IYTuWmhy6",
	"QJ+fGWzFYYxqB/NSdxA9tPNgC29DWC0LFja6KIzi2pSMOoFgaS5qJSsrpQd9OFNMnp5AbYDyzPsUV7c+",
	"4reZSq0xdWVz698+bv3tnD6IpEjjbtQK6gD0Na8I3GMdg7pQ1LdZvUpBErsU48r0xYflzX8/nCeT5MP1",
	"rf7v5UWwer5i6endxJfWqyHTvCdCuv6gON6+a/rKYA/xvceAYyje/66AW8HbarivP7SPpHYp5dsFg0+i",
	"OO16b32ObQghhkLnpM8PZzr8DvTkjNEVWXepn+vfV9z0+ZzXesqD7hThy1n4hK9fRJ2iBWeqZS883Eqb",
	"QhcXbaT0ynMIVvPzAIjdqoXBW4Em0alZOqqLQi8aQ0+CBoXHI/D4f1Ww3h3V3C0I+Ql0g6mrPhffgkmo",
	"vlj4DCwZ0jDGa0yoGNatN4VW1Dn+E/AIxacSYOwGQlVWz6m6m9IdnqNHX2aw0VWYboB1hfika9EDGcAo",
	"6HhiNgTjp7HIOJaU1c5OQHFp+erm+sPy8vfbT2/Pb68/JZPk/PrD7eXvt8t3n9+/D+ZnzTeWofsCvtmX",
	"HwT9F8Z5RzQ7Md73O7SjXIzi2N2iY6/nByvWPcnbjwvvZm35tD3QNc82IKSVXQB/IJmpACSRel4VWvf2",
	"4yKZJN5ayU/Ts+mZHqGVQHFJknnyZno2faPuKVhutJCzrG5fMRGYkJpYLBDW8dSWqY9EmglbydkDySFH",
	"uZkoTk1X1hxokfv9tklmrARC/srynY3o0rLHZVkQM8Wb3QkDNxMO+4Jla2K+b/uc5BXoXxgf1zL/fPbT",
	"q/Guu8Oa8YHujLYyfbIciSrLQIhVVRS7qbLLL2dngUBMH3ChR6ZaUyhluVq9nySi2m6xKsysUls2UdjA",
	"a6GigGF7Y1CTfFFbrZlnTyTfK5br0DD8E0hO4EEbW5igkzmLpztEpECLi66FfwPZMG9Lz2evpue60RrX",
	"s8fgUNU2p3J6zy8B/NuWKJNubNw2xW8gEW5oaXFxxBLK8RzLZP7H8QafpSkZ4tYwOjyphcp9Xfd1bmqu",
	"NuQnDbX23R2/6HCQbWIBU5iZLdGZuRUBFPqijm82fwfHt9lrkOOfRQ1c2eTwIicdiKEDCBkBPIp6PPnO",
	"zn4GRGt1Yz45VF+xdCRz1d2RHylIX7F07Ah9p1XqjHrF0o5FZ2Y8HjfsghJJtGkbD1tKztRxu5a0jzLM",
	"C42RrNl+/vEjWfSy9XBpJJ9WsIkmBauV+rFLw/z2zU4HAaenZt0lPJqXnS+Pl5RjHjVKLj6qc5OIrU5a",
	"WbjlcANSsKJhFPpXJ1sfwAdk2lHj9ik5NmK4MRPsUWD49DogDCsnnGXNafVp7ui39jumn6f8urti6SIf",
	"u3r2QsVyoD9623cj6q6XD/DIlloOfdOf7BlO6u/N7ZHWD+C2tcgnOHAQE+MUYgcDz5d4di3q2D4+AHRN",
	"b6/X9yKuFQDy5pyoJwAo8LmGUj1ASnd+ZBWKAK1h1Hfw//bwK5ay/emVPM8MtrppLlvDNOWigeDrz/MS",
	"t/dcRnL7FizqGj2IifMNZF8NILKKc3Xj0y+t9QC1+eq5jYX6DTeMCYH2w/941bzBAqUAFPk34XEkXNZv",
	"yqOA0FpxFxatj+mRYvikBkmt0ZEsf+/moL1FQNGe1TafpuvH4RknEjjB4VDgZsMjRwDHJmD8t4cSvG7h",
	"brrVx4PGvVeCA4fe1cLGgJ6H6eWf3PUwI+9x0m1zpvkj3ZONVUbufdxbxUaM6t3sGfdfY+rjhXZt15Ec",
	"y762iGl3lHtwjzuZuttrp1Vvd31qeLz1s7e/ur5u+PiAunp0135hA9pYc8zSuQcvvmQ+yVdn0j0y+GEQ",
	"FEwPl98gq0x+0K8ZeEXNk7ZYpmj/rdZBYxWEHB1PzUccw0H12vzto4hAZLvVarQPcl+SKDShftipPcAf",
	"wgD7yFleZX5ODuqqV/EimScbKUsxn81wSab2Dz2nGdvOHn5KFFost0N6187ewvzRKuRIMjuZETVa25OZ",
	"/WQYmTuWNmg0OlAnEKgvtW1SnUvtKTTrG2+TZOeKNpRkXctZYi2TDqVi6vsGlfZtYf9l/78AAAD//yRV",
	"PgtHPwAA",
}

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