// 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"` } // 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"` } // 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 // JobStatusBody defines model for JobStatusBody. type JobStatusBody struct { // JobId The job id JobId openapi_types.UUID `json:"job_id"` // Status Specifies the status of a job. Status JobStatus `json:"status"` } // 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 // UpdateJobJSONRequestBody defines body for UpdateJob for application/json ContentType. type UpdateJobJSONRequestBody = JobUpdate // UpdateJobCollectorByJobIdJSONRequestBody defines body for UpdateJobCollectorByJobId for application/json ContentType. type UpdateJobCollectorByJobIdJSONRequestBody = JobCollectorUpdate // 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 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 // 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 // Trigger an export // (POST /job/{id}/export) TriggerExport(ctx echo.Context, id openapi_types.UUID) error // Get job status by job ID // (GET /job/{id}/status) GetJobStatusByJobId(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 } // 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 } // TriggerExport converts echo context to params. func (w *ServerInterfaceWrapper) TriggerExport(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.TriggerExport(ctx, id) return err } // GetJobStatusByJobId converts echo context to params. func (w *ServerInterfaceWrapper) GetJobStatusByJobId(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.GetJobStatusByJobId(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.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.POST(baseURL+"/job/:id/export", wrapper.TriggerExport) router.GET(baseURL+"/job/:id/status", wrapper.GetJobStatusByJobId) 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/+Rb3W/bOBL/VwjdPRp2ut0nv3WTdOGg1/Sa9LCHRWFQ1NhmKpMKSTn1Bv7fF/zQBy3K", "kh2rm8U+tYnI+Z4fhzPMc0T4OuMMmJLR9DmSZAVrbP57mVJg6lIAVqB/zgTPQCgK5ivDa/PbBCQRNFOU", "s2ga3a8AEbMPmQWjSG0ziKaRVIKyZbTbjSIBjzkVkETT3y2Vr+UqHj8AUdFu5Jh/yZIgc4LZXG4ZaQow", "WyBVyUAlwmnKnyhbIkwU3QDS22QlV8x5Cphplqdr1JD+ipN8DUw1JY9z8g1UmI39hghnClOmZdaqJAWt", "BudRRJMwpWIPokk0ihZcrLGKplGem58bZL7BNkwnw2qFFO+QY8+nhofT09IOOfj6e8aFugKFaSqb3D/h", "bcpxghZcIDBLkRJ0uQSBBMiMMwnjaLRn3Acez9tM8sBjRBMkIMUmDpxWlva4j5V4rrJczVNOsKUbYlN8", "RZShpxUlqxoX9AfN0IKmgJ5omqIY0ILnLNHM4TteZ6nh93Y6mTxb8+0mzzb0aLKbPD/w2Pyr6Bqkwuts", "N3+2hGmyG/9Bs5DQUmGVG+P8W8Aimkb/mlQJP3HZPrHOuLNr9/3prFrSavfmXcksEEpcShqnpS20PzRB", "kEZ/lq81Ly1bCgo0O8rmmeBLAVLn6wLTFJIa80pHy/zehsfhUHIxZPCA1Zzvx9GCQprMFzRVIALqvDcf", "jGMl4RmgGEtIEGfIbEQ2UNAGp7nVjipYd/rgvd5rSUcVpmAh8NakOluC1AKcIle5GWVY4DXo/U21gSXz", "Am8DkY2lQvoz4ouK4Lgl6IRqJUUlWlDRk1gTXUN4W7ddi1mMyxHhab5mDc0JZwktkrqnky7LPbuRi5j2", "E0R/0apq39ggoQw95gdsaKMnTM1+Q7mERZ4WSGbDwgu3BlE/qPbyvKbDqGaRUpSvhw1/Wbfhgfy36i9K", "p5ScPCBIQcq5WmHNf2lKEFH8SFIuIZlTpkBscBqNIp4Bq/+cwkLNm8sEXa5Cv6eMpHkCBobt/0IoM0v+", "A1LiZaAcCZ05Xxh9zAHRRMP3goKwRxlTVG17HDfNMzVk/hseH1Mc3WVAtCwSPa1ArRxWmJNRuvoo3ZoK", "ScsQqpHscdR6yBZlV1ISjiHlbCmR4n2O2MOH9ylWq4s8qkzTYkxbdf6gerPTiH0sdp4y3NAuMr/LRjxN", "gSgeQNr6V7TmCaTNQ8aaZb4BIVuxwpnOrSlwkxSkvfShTL39qVJQp/XSnqAGaFoQ1H7TIFwEqke914Fd", "19bgYOjYPlSSzq4K1bCUnFCsINGy9KpGU106qcN2tGteasc1ZXSdr+dEBy6Iwyzd4pKnKbrqNxJH5Uje", "Cr6r0xjrnbrqkT15thW/LprazdEibMNTo/0U6MozG1vtYYyqBCu1bkR038u7q10tYb0sWJw85iC2rXFt", "vtpDACt718l4lms7GOEEyDxVxx+CDqBK5l2Gq7oH7ReCXK+xtWF96z8et/5xSR+MpJbe16BV0F7QV7xa", "wr3t0l0Ve+ZCaFbpkMTFEVOU2rOP87v/f7yMRtHH23vz3+urYAVcMvuFJ9umVbq7L33OtX4Ni0rvU7oV", "Nzw+vrP40uI5FGMfqFRFr1AebuXVk753qpd9yECGa97/zUE4xX0zPFYffJH0Lh1FbkFvSTSnbecVtGAb", "cpql0JD0dFw250hPSCKcLeiySf3S/D4XtudXwE9JudcFJ3xTDEt4/mrwGCsUrpp3hkex0tUCsys/Ujr1", "2Q9W+3OPELvXC4PXG0OiUXw1TNcaeq2HwVGhweDpQHj8XQ1sdrda7h6k+gym29U0X4FvwaOjuiGVpYTi", "yIQxXmLKZL/Ova0YW5Pjf4GM0HxyCdZvIHWJeMr1oa7dvhwd9rJDjqbBTDeuqcRnU1Tv6QDWQIcrDEuw", "XRoXGYeqC72zAShFfXFzd/txfv3b/ed3l/e3n6NRdHn78f76t/v5+y8fPgQLDcO37YTuAny7L9kD/Rfi", "fEGUHIn33QldUE4HSexA+9zMEha8Kcm7T7MyzXz9jD/QrSArkMrpLkFsKLEVgKLKzK5C6959mkWjqPRW", "9GZ8Mb4w47QMGM5oNI3eji/Gb/WFC6uVUXJCqj4cl4FpqcViibDBU1dvP1Flp22Z4BuaQIISO10c2xax", "FWiWlPtdt896CaQqylrCmXLscZal1E70Jg/ShpuFwy6w9KbnOz/nlMjB/MLmuNH5p4s3Z+NdtaoN4z3b", "WWsRI1mCZE4ISLnI03Q71n75+eIiAMRsg1MzPjWWQjFP9Gpdr+frNdaFmTOq5xMdG3gpNQpYtnc2aqKv", "eqtz8+SZJjvNchkajH8GJShsjLOlBR1SeDzeIqokml01PfwrqJp7PTtfnM3OVce43c5lDPY1bX1C5xv4", "V1AI13SfXR2wr06nglA0/f1w/9HRVBwJZ24DOnqhTsqiOTy1lZQfyKOasbqutl9NkpNVGwxKO5Wl5rz1", "8lrHVGs6280/IJ3dmdQrnQOudiGRO8g/X+pZucrg6Ei7Bzc16gGt+np7NK7e8HggL1Q9mdeEqDc8HhpO", "H4xJC6fe8Ljh0RNQ1HSmDkJo4cnh8LPNnmeHTaesh5meHXsApqZhLfVXQ2OZlz1wcdB0PAYRfw5ODIeE", "w55pMyH1meZxCVRu7U6lsuv+y/aGx7Nk6NKkVKoNs0rRe2dbyNpVfnm22M+0UpwTUq68ifjTjleQhJXK", "R6RjMBCGOS33ZmEvydNK1WEztmLUGUBeEif1RnpHEutYKm7cVYc93pY9/VAWe936H5DD/nSg7aAspdf6", "vMwLprmovKGDTrwAjpZivSSZSy4DJbMXHfatZ2toXK6AfLNxQXIhdJluXqeaiVn9pagfEtW7VxgyEvzH", "0oFIsAvQCksUAzBUvqM9DdKNNYqXusYO45r/ndKnXTUrSw4D38FLzYxRRQ1+115jZ4Jr9Go61b0ktmoO", "hM3+m+XXdJu59l7bnxXlnbpVQh0IKi95q6FwD1wvXpbnsijJ2gDdlmVupv1DarLa/LwFz53kZ77/+Dax", "9vgblmc6KB6LOXBnnZ76s+r6M33zUJ4IqkBQHD7pi9n4wAd8wSYQDu/2NThHNJgz/rHUrYgA07r3XN+j", "O2RHFEf3h+wkfxhcrY9qXxOq2tHIwF2iR2fYFqeW2XNCr8i6+vAVt/LrQPniHpG0WffsPaNSaQ8sm6nS", "v/opJ4V/9d21lro97qyDZ+wLG+vW/wNeS4/KrIkqXjq8msAIgvn1dyC5RXPzpELkzD4QbMN1/4/H9opm", "kGrwMKm/JOkfK+fm715mBHDo3pjRPW9+UaVsnrh0hp3eA2ITDrBPgic5KYf1IKJRlIs0mkYrpTI5nUxw", "RsfuL0/HhK8nmzeRjhbHbZ/ebeFvaf+KFhKkuJs4ySpa/YnTbtSPzAOPazRqndojCFTlp0+qUdoeQ7Pq", "KtVJNvoffUlWlZcj5rm0LxV7e6pR8W9Pu6+7PwMAAP//WyCUh9g/AAA=", } // 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 }