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

792 lines
28 KiB
Go
Raw Normal View History

2025-01-15 19:45:51 +00:00
// 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"
2025-01-15 19:45:51 +00:00
)
// 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"
)
2025-01-15 19:45:51 +00:00
// Defines values for QueryType.
const (
CONTEXTFULL QueryType = "CONTEXT_FULL"
JSONEXTRACTOR QueryType = "JSON_EXTRACTOR"
)
2025-01-21 18:24:14 +00:00
// 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
2025-01-15 19:45:51 +00:00
// 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"`
2025-01-15 19:45:51 +00:00
}
// 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
2025-01-15 19:45:51 +00:00
// 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"`
2025-01-15 19:45:51 +00:00
}
2025-01-21 18:24:14 +00:00
// 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"`
2025-01-21 18:24:14 +00:00
// Name The client name
Name string `json:"name"`
}
2025-01-15 19:45:51 +00:00
// 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"`
2025-01-15 19:45:51 +00:00
}
// 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"`
2025-01-15 19:45:51 +00:00
}
// 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"`
2025-01-15 19:45:51 +00:00
}
// 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
2025-01-15 19:45:51 +00:00
// 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"`
2025-01-15 19:45:51 +00:00
// 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"`
2025-01-15 19:45:51 +00:00
// 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"`
2025-01-15 19:45:51 +00:00
// 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"`
2025-01-15 19:45:51 +00:00
// 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"`
2025-01-15 19:45:51 +00:00
}
2025-01-21 18:24:14 +00:00
// 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
2025-01-15 19:45:51 +00:00
// 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
2025-01-15 19:45:51 +00:00
// 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 {
2025-01-21 18:24:14 +00:00
// Create a new client
// (POST /client)
2025-01-21 18:24:14 +00:00
CreateClient(ctx echo.Context) error
// Get a client by ID
// (GET /client/{id})
GetClient(ctx echo.Context, id openapi_types.UUID) error
2025-01-21 18:24:14 +00:00
// 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
2025-01-15 19:45:51 +00:00
// Trigger an export
// (POST /job/export)
2025-01-15 19:45:51 +00:00
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
2025-01-15 19:45:51 +00:00
// Get a job collector by ID
// (GET /job/{id}/collector)
GetJobCollectorByJobId(ctx echo.Context, id openapi_types.UUID) error
2025-01-15 19:45:51 +00:00
// 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
// Get job status by job ID
// (GET /job/{id}/status)
GetJobStatusByJobId(ctx echo.Context, id openapi_types.UUID) error
2025-01-15 19:45:51 +00:00
// List queries
// (GET /query)
2025-01-15 19:45:51 +00:00
ListQueries(ctx echo.Context) error
// Create a new query
// (POST /query)
2025-01-15 19:45:51 +00:00
CreateQuery(ctx echo.Context) error
// Get a query by ID
// (GET /query/{id})
GetQuery(ctx echo.Context, id openapi_types.UUID) error
2025-01-15 19:45:51 +00:00
// Update a query
// (PATCH /query/{id})
UpdateQuery(ctx echo.Context, id openapi_types.UUID) error
2025-01-15 19:45:51 +00:00
// Test a query
// (POST /query/{id}/test)
TestQuery(ctx echo.Context, id openapi_types.UUID) error
2025-01-15 19:45:51 +00:00
}
// ServerInterfaceWrapper converts echo contexts to parameters.
type ServerInterfaceWrapper struct {
Handler ServerInterface
}
2025-01-21 18:24:14 +00:00
// 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
2025-01-21 18:24:14 +00:00
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
2025-01-21 18:24:14 +00:00
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
}
2025-01-15 19:45:51 +00:00
// 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 {
2025-01-15 19:45:51 +00:00
var err error
// ------------- Path parameter "id" -------------
var id openapi_types.UUID
2025-01-15 19:45:51 +00:00
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)
2025-01-15 19:45:51 +00:00
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 {
2025-01-15 19:45:51 +00:00
var err error
// ------------- Path parameter "id" -------------
var id openapi_types.UUID
2025-01-15 19:45:51 +00:00
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)
2025-01-15 19:45:51 +00:00
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
}
2025-01-15 19:45:51 +00:00
// 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
}
2025-01-21 18:24:14 +00:00
// GetQuery converts echo context to params.
func (w *ServerInterfaceWrapper) GetQuery(ctx echo.Context) error {
2025-01-15 19:45:51 +00:00
var err error
// ------------- Path parameter "id" -------------
var id openapi_types.UUID
2025-01-15 19:45:51 +00:00
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
2025-01-21 18:24:14 +00:00
err = w.Handler.GetQuery(ctx, id)
2025-01-15 19:45:51 +00:00
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
2025-01-15 19:45:51 +00:00
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
2025-01-15 19:45:51 +00:00
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+"/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)
2025-01-15 19:45:51 +00:00
}
// Base64 encoded, gzipped, json marshaled Swagger object
var swaggerSpec = []string{
"H4sIAAAAAAAC/+Rb3W/bOBL/VwjdPRp2ut0nv3WTdOGg1/Sa9LCHRWFQ1NhmKpMKSTn1Bv7fF/zSh0VZ",
"smN1s9inNhE5w5n5zQdnmOeI8HXGGTAlo+lzJMkK1tj89zKlwNSlAKxA/5wJnoFQFMxXhtfmtwlIImim",
"KGfRNLpfASJmHzILRpHaZhBNI6kEZctotxtFAh5zKiCJpr9bKl+LVTx+AKKi3cgx/5IlQeYEs7ncMtI8",
"wGyBVHkGKhFOU/5E2RJhougGkN4my3PFnKeAmWZ5ukSN019xkq+BqebJ45x8AxVmY78hwpnClOkza1ES",
"T6vBeRTRJEzJ70E0iUbRgos1VtE0ynPzc4PMN9iG6WRYrZDiHefYs6nh4eS0tEMGvv6ecaGuQGGayib3",
"T3ibcpygBRcIzFKkBF0uQSABMuNMwjga7Sn3gcfzNpU88BjRBAlIscGBk8rSHvfREs9Vlqt5ygm2dENs",
"/FdEGXpaUbKqcEF/0AwtaAroiaYpigEteM4SzRy+43WWGn5vp5PJs1XfbvJsoUeT3eT5gcfmX0XXIBVe",
"Z7v5syVMk934D5qFDi0VVrlRzr8FLKJp9K9J6fAT5+0Ta4w7u3bfnk6rBa12a94VzAJQ4lLSOC10oe2h",
"CYI08rN8rXnps6WgQLOjbJ4JvhQgtb8uME0hqTAvZbTM7y08DkPJYcjEA1Yxfh1HCwppMl/QVIEIiPPe",
"fDCGlYRngGIsIUGcIbMRWaCgDU5zKx1VsO60wXu915KOypiChcBb4+psCVIf4JRzFZtRhgVeg97fFBtY",
"MvfxNoBsLBXSnxFflATHLaATqpUUlWhBRU9ioejaw825TQOPOYitDhh5qqR2+djjD5IePh92hBD+q8Zr",
"sYvBHCI8zdesoXrCWUJ9VOmJkstiz27kINuewvQXrxWLUsq0etqNaOEbpma/oVzCIk99KLW4rOG9QbSO",
"6j39VmQYVTRSHKVD8ZdVHR4IQFb8RWGUglMtEqUg5VytsOa/NDWQ8D+SlEtI5pQpEBucRqOIZ8CqP6ew",
"UPPmMkGXq9DvKSNpnoDJA/Z/oTA3S/4DUuJloB4KecMXRh9zQDTR+WNBQdhcyhRV2+Ox34L7Gx4fU53d",
"ZUD0WSR6WoFauWBlfFa6Ai3dmhJNnyFUpNl82Or+vu5LCsIxpJwttfP3yfGHw8opWqseeVSqpkWZtuz9",
"QQVvpxL7aOw89wBD23t+l454mgJRPBBpq1/RmieQNrOcVct8A0K2xgqnOrfGx03iSdfchzL19qdSQO3W",
"S5vCTaBpiaD2mw7CHqg16r0qhqq0Jg6G6oZDyXJ25UXDUnJCsYJEn6VXOZzq2k0d1qNd81I9rimj63w9",
"Jxq4IA6zdIsLnqbqq16JHJUjeSv4rk5jrHfqskv25NlWfTs0tauj5bANS432XaDLzyy22mGMSgcrpG4g",
"um/3wBXPlrBeFixOTGHXimtb9pkkgJW9bGU8y7UezOFsQXh8EnQBqmDepbiyfdF+I8n1GlsbVrf+4+PW",
"P87pg0hqab4NWgXtgb7k1QL3tlt/WeyZG6lZpSGJfYrxpfbs4/zu/x8vo1H08fbe/Pf6KlgBF8x+4cm2",
"qZXue2GfvNavY1LKfUq75IbHx7c2X1o8hzD2gUrlm5XycC+x6vS9Xb1ohAY8XPP+bw7CCV5Xw2P5oX4k",
"vUujyC3ofRLNadt5BfVsQ0azFBonPT0umzzSMyQRzhZ02aR+aX6fC9t09OGnoNzrghO+KYZPeP5q8Bgt",
"eFPNO+HhV7paYHZVR0qnPPtgtT/3gNi9Xhi83hgSjeKrobpW6LUmg6OgweDpADz+rgo2u1s1dw9SfQbT",
"7Wqqz8e3YOoob0hFKaE4MjDGS0yZ7Dc6sBVjq3P8L+ARmk8uwdoNpC4RT7k+VKXbP0eHvuyUpakw041r",
"CvHZFNV7MoBV0OEKwxJsP41DxqHqQu9sBBRfX9zc3X6cX/92//nd5f3t52gUXd5+vL/+7X7+/suHD8FC",
"w/Bty9BdAd/uS/aC/gvjvCdKjoz33Q7tKaeDOHaz6NiZYcaCN0/y7tOscLO6fMYe6FaQFUjlZJcgNpTY",
"CkBRZYZnoXXvPs2iUVRYK3ozvhhfmHleBgxnNJpGb8cX47f6woXVygg5IWUfjsvAuNbGYomwiaeu3n6i",
"yo77MsE3NIEEJXa8ObYtYnugWVLsd90+ayWQype1hDPl2OMsS6kdKU4epIWbDYddwbI2vt/VfU6JHMwv",
"rI8bmX+6eHM23mWr2jDe053VFjEnS5DMCQEpF3mabsfaLj9fXAQCMdvg1MxvjaZQzBO9Wtfr+XqNdWHm",
"lFqzicYGXkodBSzbO4ua6Kve6sw8eabJTrNchibzn0EJChtjbGmDDvEWj7eIKolmV00L/wqqYt6ani/O",
"pueyY9yu5wKDfVVbHRHWFfwrKIQrss+uDuhXu5MnFE1/P9x/dDQVR8Kp2wQdvVA7pW8OT20lVQfyqKKs",
"rqvtV+PkZNUWBqUdC1OTb2t+rTHV6s528w9wZ5eTerlzwNQOErkL+edzPXuuAhwdbvfgpkY9Qqu+3h4d",
"V294PJAVyp7Ma4qoNzweOpw+GJV6o97wuGHRiR2stxt2xqiixrSVJzGZ4Pq4TUu65xz2bcdA1qw/HHlN",
"Fr2uPXk6q1mduOX7l4pd3TOehmmPT5Cm6XgwO3onHS41trnK2TOiE7aWDmsu0iMXahpWU3911itCbo+U",
"N2ikPSbZ/RwcBg+Z6XpERO02E1IdVx/nQMXWblcqBiq/bG94PEuGrjoLodrSUXH03t4W0nbpXzVd7Hta",
"cZwTXK64ZNYHWa/ACUuRj3DHIBCGKYT2xpwv8dNS1GE9tmTUCaCaEyfVGUmHE2ss+WZKOTyJt8W4JuTF",
"tUHMD/Dh+uCnLVEWp9fyvMwKpm+savMk7XiBOFoc6yXOXHAZyJlr6Cgr3yA0LldAvllckFwIfQMzL5/N",
"MLT6CrkOifJNNQyJhPpD/PZadIUligEYKt5onxbSjTZ8+W/0MD5QgR7VRSg1ObTFyyFxj2Dgn7rn0ufx",
"tihgc7mbcf+QRF6Zp7cEAXfyMxfNdZ1YffwNc7oGxaOfC3cWd2l9dl39uwHzcp8IqkBQHE4PflY+cFbw",
"bAJweLcvwTnQYBLDYyGbR4Bp5ddM36NbZEcWR/eL7GR/mEKpOrp9TR0GOyoZuGv06BTbYtTCe05oMFhT",
"H74XlXYdyF/co5I27Z690VAIXQuWTVfpnzKLyeFffeGpuG6Pi87gHvvCRru1/4B3maM8a6L8y4dXA4xg",
"ML/+DiS30dw8sRA5sw8G2+J6/a/Z9hrIINXgMKm+LOmPlXPzdy81AnHo3qjRPXd+UdfYPHnphJ3eA2IT",
"BtgnwZOcFMN70HfwXKTRNFoplcnpZIIzOnZ/CjsmfD3ZvIk0Why3fXq33t7S/lkvJEhxN4GSJVrrE6jd",
"qB+ZBx5XaFTae0cQKMvPOqlGaXsMzbIVUSXZuDT3JVlWXo5YzaR9qdibV4VK/R63+7r7MwAA//9iYIiE",
"aUAAAA==",
2025-01-15 19:45:51 +00:00
}
// 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
}