api

package
v0.0.0-...-fe7df4e Latest Latest
Warning

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

Go to latest
Published: Jun 27, 2026 License: AGPL-3.0 Imports: 8 Imported by: 0

Documentation

Overview

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.0 DO NOT EDIT.

Index

Constants

View Source
const (
	ApiKeyAuthScopes apiKeyAuthContextKey = "ApiKeyAuth.Scopes"
)

Variables

This section is empty.

Functions

func Handler

func Handler(si ServerInterface) http.Handler

Handler creates http.Handler with routing matching OpenAPI spec.

func HandlerFromMux

func HandlerFromMux(si ServerInterface, m ServeMux) http.Handler

HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.

func HandlerFromMuxWithBaseURL

func HandlerFromMuxWithBaseURL(si ServerInterface, m ServeMux, baseURL string) http.Handler

func HandlerWithOptions

func HandlerWithOptions(si ServerInterface, options StdHTTPServerOptions) http.Handler

HandlerWithOptions creates http.Handler with additional options

Types

type BadRequest

type BadRequest = Error

BadRequest defines model for BadRequest.

type BadRequestJSONResponse

type BadRequestJSONResponse Error

type ComponentHealth

type ComponentHealth struct {
	// Details Optional extra info — must never contain credentials
	Details *map[string]interface{} `json:"details,omitempty"`
	Status  ComponentHealthStatus   `json:"status"`
}

ComponentHealth defines model for ComponentHealth.

type ComponentHealthStatus

type ComponentHealthStatus string

ComponentHealthStatus defines model for ComponentHealth.Status.

const (
	ComponentHealthStatusError ComponentHealthStatus = "error"
	ComponentHealthStatusOk    ComponentHealthStatus = "ok"
)

Defines values for ComponentHealthStatus.

func (ComponentHealthStatus) Valid

func (e ComponentHealthStatus) Valid() bool

Valid indicates whether the value is a known member of the ComponentHealthStatus enum.

type Conflict

type Conflict = Error

Conflict defines model for Conflict.

type ConflictJSONResponse

type ConflictJSONResponse Error

type DeleteResult

type DeleteResult struct {
	Success bool `json:"success"`
}

DeleteResult defines model for DeleteResult.

type DeleteSchema200JSONResponse

type DeleteSchema200JSONResponse DeleteResult

func (DeleteSchema200JSONResponse) VisitDeleteSchemaResponse

func (response DeleteSchema200JSONResponse) VisitDeleteSchemaResponse(w http.ResponseWriter) error

type DeleteSchema401JSONResponse

type DeleteSchema401JSONResponse struct{ UnauthorizedJSONResponse }

func (DeleteSchema401JSONResponse) VisitDeleteSchemaResponse

func (response DeleteSchema401JSONResponse) VisitDeleteSchemaResponse(w http.ResponseWriter) error

type DeleteSchema404JSONResponse

type DeleteSchema404JSONResponse struct{ NotFoundJSONResponse }

func (DeleteSchema404JSONResponse) VisitDeleteSchemaResponse

func (response DeleteSchema404JSONResponse) VisitDeleteSchemaResponse(w http.ResponseWriter) error

type DeleteSchemaRequestObject

type DeleteSchemaRequestObject struct {
	Name SchemaName `json:"name"`
}

type DeleteSchemaResponseObject

type DeleteSchemaResponseObject interface {
	VisitDeleteSchemaResponse(w http.ResponseWriter) error
}

type Error

type Error struct {
	Details *[]ErrorDetail `json:"details,omitempty"`
	Error   string         `json:"error"`
	Message string         `json:"message"`
}

Error defines model for Error.

type ErrorDetail

type ErrorDetail struct {
	Column  *int    `json:"column,omitempty"`
	Line    *int    `json:"line,omitempty"`
	Message *string `json:"message,omitempty"`
}

ErrorDetail defines model for ErrorDetail.

type GetSchema200JSONResponse

type GetSchema200JSONResponse SchemaDetail

func (GetSchema200JSONResponse) VisitGetSchemaResponse

func (response GetSchema200JSONResponse) VisitGetSchemaResponse(w http.ResponseWriter) error

type GetSchema401JSONResponse

type GetSchema401JSONResponse struct{ UnauthorizedJSONResponse }

func (GetSchema401JSONResponse) VisitGetSchemaResponse

func (response GetSchema401JSONResponse) VisitGetSchemaResponse(w http.ResponseWriter) error

type GetSchema404JSONResponse

type GetSchema404JSONResponse struct{ NotFoundJSONResponse }

func (GetSchema404JSONResponse) VisitGetSchemaResponse

func (response GetSchema404JSONResponse) VisitGetSchemaResponse(w http.ResponseWriter) error

type GetSchemaRequestObject

type GetSchemaRequestObject struct {
	Name SchemaName `json:"name"`
}

type GetSchemaResponseObject

type GetSchemaResponseObject interface {
	VisitGetSchemaResponse(w http.ResponseWriter) error
}

type GetSchemaStatus200JSONResponse

type GetSchemaStatus200JSONResponse SchemaStatus

func (GetSchemaStatus200JSONResponse) VisitGetSchemaStatusResponse

func (response GetSchemaStatus200JSONResponse) VisitGetSchemaStatusResponse(w http.ResponseWriter) error

type GetSchemaStatus401JSONResponse

type GetSchemaStatus401JSONResponse struct{ UnauthorizedJSONResponse }

func (GetSchemaStatus401JSONResponse) VisitGetSchemaStatusResponse

func (response GetSchemaStatus401JSONResponse) VisitGetSchemaStatusResponse(w http.ResponseWriter) error

type GetSchemaStatus404JSONResponse

type GetSchemaStatus404JSONResponse struct{ NotFoundJSONResponse }

func (GetSchemaStatus404JSONResponse) VisitGetSchemaStatusResponse

func (response GetSchemaStatus404JSONResponse) VisitGetSchemaStatusResponse(w http.ResponseWriter) error

type GetSchemaStatusRequestObject

type GetSchemaStatusRequestObject struct {
	Name SchemaName `json:"name"`
}

type GetSchemaStatusResponseObject

type GetSchemaStatusResponseObject interface {
	VisitGetSchemaStatusResponse(w http.ResponseWriter) error
}

type Info200JSONResponse

type Info200JSONResponse InfoResponse

func (Info200JSONResponse) VisitInfoResponse

func (response Info200JSONResponse) VisitInfoResponse(w http.ResponseWriter) error

type InfoRequestObject

type InfoRequestObject struct {
}

type InfoResponse

type InfoResponse struct {
	BuiltAt *time.Time `json:"built_at,omitempty"`

	// Commit Git commit SHA
	Commit  *string `json:"commit,omitempty"`
	Version string  `json:"version"`
}

InfoResponse defines model for InfoResponse.

type InfoResponseObject

type InfoResponseObject interface {
	VisitInfoResponse(w http.ResponseWriter) error
}

type InvalidParamFormatError

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

func (*InvalidParamFormatError) Error

func (e *InvalidParamFormatError) Error() string

func (*InvalidParamFormatError) Unwrap

func (e *InvalidParamFormatError) Unwrap() error

type ListSchemas200JSONResponse

type ListSchemas200JSONResponse SchemaList

func (ListSchemas200JSONResponse) VisitListSchemasResponse

func (response ListSchemas200JSONResponse) VisitListSchemasResponse(w http.ResponseWriter) error

type ListSchemas401JSONResponse

type ListSchemas401JSONResponse struct{ UnauthorizedJSONResponse }

func (ListSchemas401JSONResponse) VisitListSchemasResponse

func (response ListSchemas401JSONResponse) VisitListSchemasResponse(w http.ResponseWriter) error

type ListSchemasRequestObject

type ListSchemasRequestObject struct {
}

type ListSchemasResponseObject

type ListSchemasResponseObject interface {
	VisitListSchemasResponse(w http.ResponseWriter) error
}

type Liveness200JSONResponse

type Liveness200JSONResponse LivenessResponse

func (Liveness200JSONResponse) VisitLivenessResponse

func (response Liveness200JSONResponse) VisitLivenessResponse(w http.ResponseWriter) error

type LivenessRequestObject

type LivenessRequestObject struct {
}

type LivenessResponse

type LivenessResponse struct {
	Status LivenessResponseStatus `json:"status"`
}

LivenessResponse defines model for LivenessResponse.

type LivenessResponseObject

type LivenessResponseObject interface {
	VisitLivenessResponse(w http.ResponseWriter) error
}

type LivenessResponseStatus

type LivenessResponseStatus string

LivenessResponseStatus defines model for LivenessResponse.Status.

const (
	LivenessResponseStatusOk LivenessResponseStatus = "ok"
)

Defines values for LivenessResponseStatus.

func (LivenessResponseStatus) Valid

func (e LivenessResponseStatus) Valid() bool

Valid indicates whether the value is a known member of the LivenessResponseStatus enum.

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

type NotFound

type NotFound = Error

NotFound defines model for NotFound.

type NotFoundJSONResponse

type NotFoundJSONResponse Error

type Readiness200JSONResponse

type Readiness200JSONResponse ReadinessResponse

func (Readiness200JSONResponse) VisitReadinessResponse

func (response Readiness200JSONResponse) VisitReadinessResponse(w http.ResponseWriter) error

type Readiness503JSONResponse

type Readiness503JSONResponse ReadinessResponse

func (Readiness503JSONResponse) VisitReadinessResponse

func (response Readiness503JSONResponse) VisitReadinessResponse(w http.ResponseWriter) error

type ReadinessRequestObject

type ReadinessRequestObject struct {
}

type ReadinessResponse

type ReadinessResponse struct {
	Components map[string]ComponentHealth `json:"components"`
	Status     ReadinessResponseStatus    `json:"status"`
}

ReadinessResponse defines model for ReadinessResponse.

type ReadinessResponseObject

type ReadinessResponseObject interface {
	VisitReadinessResponse(w http.ResponseWriter) error
}

type ReadinessResponseStatus

type ReadinessResponseStatus string

ReadinessResponseStatus defines model for ReadinessResponse.Status.

const (
	Degraded ReadinessResponseStatus = "degraded"
	Ok       ReadinessResponseStatus = "ok"
)

Defines values for ReadinessResponseStatus.

func (ReadinessResponseStatus) Valid

func (e ReadinessResponseStatus) Valid() bool

Valid indicates whether the value is a known member of the ReadinessResponseStatus enum.

type RequiredHeaderError

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

func (*RequiredHeaderError) Error

func (e *RequiredHeaderError) Error() string

func (*RequiredHeaderError) Unwrap

func (e *RequiredHeaderError) Unwrap() error

type RequiredParamError

type RequiredParamError struct {
	ParamName string
}

func (*RequiredParamError) Error

func (e *RequiredParamError) Error() string

type SchemaChange

type SchemaChange struct {
	Destructive bool `json:"destructive"`

	// Field Field name (for field-level changes)
	Field *string `json:"field,omitempty"`

	// FieldType GraphQL scalar type (for field_added)
	FieldType *string `json:"fieldType,omitempty"`

	// On Type name the change applies to
	On   string           `json:"on"`
	Type SchemaChangeType `json:"type"`
}

SchemaChange defines model for SchemaChange.

type SchemaChangeType

type SchemaChangeType string

SchemaChangeType defines model for SchemaChange.Type.

const (
	FieldAdded   SchemaChangeType = "field_added"
	FieldRemoved SchemaChangeType = "field_removed"
	TypeAdded    SchemaChangeType = "type_added"
	TypeRemoved  SchemaChangeType = "type_removed"
)

Defines values for SchemaChangeType.

func (SchemaChangeType) Valid

func (e SchemaChangeType) Valid() bool

Valid indicates whether the value is a known member of the SchemaChangeType enum.

type SchemaDetail

type SchemaDetail struct {
	CreatedAt       time.Time `json:"created_at"`
	Description     *string   `json:"description,omitempty"`
	GraphqlEndpoint string    `json:"graphql_endpoint"`
	Name            string    `json:"name"`
	Sdl             string    `json:"sdl"`
	UpdatedAt       time.Time `json:"updated_at"`
	Version         int       `json:"version"`
}

SchemaDetail defines model for SchemaDetail.

type SchemaList

type SchemaList struct {
	Schemas []SchemaSummary `json:"schemas"`
}

SchemaList defines model for SchemaList.

type SchemaName

type SchemaName = string

SchemaName defines model for SchemaName.

type SchemaStatus

type SchemaStatus struct {
	Name      string             `json:"name"`
	Status    SchemaStatusStatus `json:"status"`
	UpdatedAt time.Time          `json:"updated_at"`
	Version   int                `json:"version"`
}

SchemaStatus defines model for SchemaStatus.

type SchemaStatusStatus

type SchemaStatusStatus string

SchemaStatusStatus defines model for SchemaStatus.Status.

const (
	SchemaStatusStatusError     SchemaStatusStatus = "error"
	SchemaStatusStatusMigrating SchemaStatusStatus = "migrating"
	SchemaStatusStatusReady     SchemaStatusStatus = "ready"
)

Defines values for SchemaStatusStatus.

func (SchemaStatusStatus) Valid

func (e SchemaStatusStatus) Valid() bool

Valid indicates whether the value is a known member of the SchemaStatusStatus enum.

type SchemaSummary

type SchemaSummary struct {
	Name      string    `json:"name"`
	UpdatedAt time.Time `json:"updated_at"`
	Version   int       `json:"version"`
}

SchemaSummary defines model for SchemaSummary.

type SchemaUploadRequest

type SchemaUploadRequest struct {
	// Changelog Comment describing this change (like a commit message)
	Changelog *string `json:"changelog,omitempty"`

	// Description Human-readable description of the schema
	Description *string `json:"description,omitempty"`

	// Sdl GraphQL SDL defining the domain model
	Sdl string `json:"sdl"`
}

SchemaUploadRequest defines model for SchemaUploadRequest.

type SchemaUploadResponse

type SchemaUploadResponse struct {
	// Changes Present in preview mode — list of schema changes
	Changes         *[]SchemaChange `json:"changes,omitempty"`
	GraphqlEndpoint *string         `json:"graphql_endpoint,omitempty"`

	// IsDestructive Present in preview mode — true if any change would cause data loss
	IsDestructive *bool                      `json:"is_destructive,omitempty"`
	Name          string                     `json:"name"`
	Status        SchemaUploadResponseStatus `json:"status"`
	UpdatedAt     time.Time                  `json:"updated_at"`
	Version       int                        `json:"version"`
}

SchemaUploadResponse defines model for SchemaUploadResponse.

type SchemaUploadResponseStatus

type SchemaUploadResponseStatus string

SchemaUploadResponseStatus defines model for SchemaUploadResponse.Status.

const (
	Applied SchemaUploadResponseStatus = "applied"
	Preview SchemaUploadResponseStatus = "preview"
)

Defines values for SchemaUploadResponseStatus.

func (SchemaUploadResponseStatus) Valid

func (e SchemaUploadResponseStatus) Valid() bool

Valid indicates whether the value is a known member of the SchemaUploadResponseStatus enum.

type ServeMux

type ServeMux interface {
	HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
	http.Handler
}

ServeMux is an abstraction of http.ServeMux.

type ServerInterface

type ServerInterface interface {
	// Liveness check — is the process alive?
	// (GET /api/v1/health/live)
	Liveness(w http.ResponseWriter, r *http.Request)
	// Readiness check — are all dependencies healthy?
	// (GET /api/v1/health/ready)
	Readiness(w http.ResponseWriter, r *http.Request)
	// Stratum version and build information
	// (GET /api/v1/info)
	Info(w http.ResponseWriter, r *http.Request)
	// List all schemas
	// (GET /api/v1/schemas)
	ListSchemas(w http.ResponseWriter, r *http.Request)
	// Delete a schema and its tables
	// (DELETE /api/v1/schemas/{name})
	DeleteSchema(w http.ResponseWriter, r *http.Request, name SchemaName)
	// Get a schema
	// (GET /api/v1/schemas/{name})
	GetSchema(w http.ResponseWriter, r *http.Request, name SchemaName)
	// Create or update a schema (upsert)
	// (POST /api/v1/schemas/{name})
	UpsertSchema(w http.ResponseWriter, r *http.Request, name SchemaName, params UpsertSchemaParams)
	// Get schema status and version
	// (GET /api/v1/schemas/{name}/status)
	GetSchemaStatus(w http.ResponseWriter, r *http.Request, name SchemaName)
}

ServerInterface represents all server handlers.

func NewStrictHandler

func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface

func NewStrictHandlerWithOptions

func NewStrictHandlerWithOptions(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc, options StrictHTTPServerOptions) ServerInterface

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) DeleteSchema

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

DeleteSchema operation middleware

func (*ServerInterfaceWrapper) GetSchema

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

GetSchema operation middleware

func (*ServerInterfaceWrapper) GetSchemaStatus

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

GetSchemaStatus operation middleware

func (*ServerInterfaceWrapper) Info

Info operation middleware

func (*ServerInterfaceWrapper) ListSchemas

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

ListSchemas operation middleware

func (*ServerInterfaceWrapper) Liveness

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

Liveness operation middleware

func (*ServerInterfaceWrapper) Readiness

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

Readiness operation middleware

func (*ServerInterfaceWrapper) UpsertSchema

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

UpsertSchema operation middleware

type StdHTTPServerOptions

type StdHTTPServerOptions struct {
	BaseURL          string
	BaseRouter       ServeMux
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type StrictHTTPServerOptions

type StrictHTTPServerOptions struct {
	RequestErrorHandlerFunc  func(w http.ResponseWriter, r *http.Request, err error)
	ResponseErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type StrictHandlerFunc

type StrictHandlerFunc func(ctx context.Context, w http.ResponseWriter, r *http.Request, request any) (any, error)

type StrictMiddlewareFunc

type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc

type StrictServerInterface

type StrictServerInterface interface {
	// Liveness check — is the process alive?
	// (GET /api/v1/health/live)
	Liveness(ctx context.Context, request LivenessRequestObject) (LivenessResponseObject, error)
	// Readiness check — are all dependencies healthy?
	// (GET /api/v1/health/ready)
	Readiness(ctx context.Context, request ReadinessRequestObject) (ReadinessResponseObject, error)
	// Stratum version and build information
	// (GET /api/v1/info)
	Info(ctx context.Context, request InfoRequestObject) (InfoResponseObject, error)
	// List all schemas
	// (GET /api/v1/schemas)
	ListSchemas(ctx context.Context, request ListSchemasRequestObject) (ListSchemasResponseObject, error)
	// Delete a schema and its tables
	// (DELETE /api/v1/schemas/{name})
	DeleteSchema(ctx context.Context, request DeleteSchemaRequestObject) (DeleteSchemaResponseObject, error)
	// Get a schema
	// (GET /api/v1/schemas/{name})
	GetSchema(ctx context.Context, request GetSchemaRequestObject) (GetSchemaResponseObject, error)
	// Create or update a schema (upsert)
	// (POST /api/v1/schemas/{name})
	UpsertSchema(ctx context.Context, request UpsertSchemaRequestObject) (UpsertSchemaResponseObject, error)
	// Get schema status and version
	// (GET /api/v1/schemas/{name}/status)
	GetSchemaStatus(ctx context.Context, request GetSchemaStatusRequestObject) (GetSchemaStatusResponseObject, error)
}

StrictServerInterface represents all server handlers.

type TooManyValuesForParamError

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) Error

type Unauthorized

type Unauthorized = Error

Unauthorized defines model for Unauthorized.

type UnauthorizedJSONResponse

type UnauthorizedJSONResponse Error

type UnescapedCookieParamError

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

func (*UnescapedCookieParamError) Error

func (e *UnescapedCookieParamError) Error() string

func (*UnescapedCookieParamError) Unwrap

func (e *UnescapedCookieParamError) Unwrap() error

type UnmarshalingParamError

type UnmarshalingParamError struct {
	ParamName string
	Err       error
}

func (*UnmarshalingParamError) Error

func (e *UnmarshalingParamError) Error() string

func (*UnmarshalingParamError) Unwrap

func (e *UnmarshalingParamError) Unwrap() error

type UpsertSchema200JSONResponse

type UpsertSchema200JSONResponse SchemaUploadResponse

func (UpsertSchema200JSONResponse) VisitUpsertSchemaResponse

func (response UpsertSchema200JSONResponse) VisitUpsertSchemaResponse(w http.ResponseWriter) error

type UpsertSchema400JSONResponse

type UpsertSchema400JSONResponse struct{ BadRequestJSONResponse }

func (UpsertSchema400JSONResponse) VisitUpsertSchemaResponse

func (response UpsertSchema400JSONResponse) VisitUpsertSchemaResponse(w http.ResponseWriter) error

type UpsertSchema401JSONResponse

type UpsertSchema401JSONResponse struct{ UnauthorizedJSONResponse }

func (UpsertSchema401JSONResponse) VisitUpsertSchemaResponse

func (response UpsertSchema401JSONResponse) VisitUpsertSchemaResponse(w http.ResponseWriter) error

type UpsertSchema409JSONResponse

type UpsertSchema409JSONResponse struct{ ConflictJSONResponse }

func (UpsertSchema409JSONResponse) VisitUpsertSchemaResponse

func (response UpsertSchema409JSONResponse) VisitUpsertSchemaResponse(w http.ResponseWriter) error

type UpsertSchema422JSONResponse

type UpsertSchema422JSONResponse struct{ ValidationErrorJSONResponse }

func (UpsertSchema422JSONResponse) VisitUpsertSchemaResponse

func (response UpsertSchema422JSONResponse) VisitUpsertSchemaResponse(w http.ResponseWriter) error

type UpsertSchemaJSONRequestBody

type UpsertSchemaJSONRequestBody = SchemaUploadRequest

UpsertSchemaJSONRequestBody defines body for UpsertSchema for application/json ContentType.

type UpsertSchemaParams

type UpsertSchemaParams struct {
	// Preview If true, return a preview of changes without applying them
	Preview *bool `form:"preview,omitempty" json:"preview,omitempty"`
}

UpsertSchemaParams defines parameters for UpsertSchema.

type UpsertSchemaRequestObject

type UpsertSchemaRequestObject struct {
	Name   SchemaName `json:"name"`
	Params UpsertSchemaParams
	Body   *UpsertSchemaJSONRequestBody
}

type UpsertSchemaResponseObject

type UpsertSchemaResponseObject interface {
	VisitUpsertSchemaResponse(w http.ResponseWriter) error
}

type ValidationError

type ValidationError = Error

ValidationError defines model for ValidationError.

type ValidationErrorJSONResponse

type ValidationErrorJSONResponse Error

Jump to

Keyboard shortcuts

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