bucketapi

package
v0.2.8 Latest Latest
Warning

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

Go to latest
Published: Jun 8, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterHandlers

func RegisterHandlers(router fiber.Router, si ServerInterface)

RegisterHandlers creates http.Handler with routing matching OpenAPI spec.

func RegisterHandlersWithOptions

func RegisterHandlersWithOptions(router fiber.Router, si ServerInterface, options FiberServerOptions)

RegisterHandlersWithOptions creates http.Handler with additional options

Types

type AddBucketScope201Response

type AddBucketScope201Response struct {
}

func (AddBucketScope201Response) VisitAddBucketScopeResponse

func (response AddBucketScope201Response) VisitAddBucketScopeResponse(ctx fiber.Ctx) error

type AddBucketScope400Response

type AddBucketScope400Response struct {
}

func (AddBucketScope400Response) VisitAddBucketScopeResponse

func (response AddBucketScope400Response) VisitAddBucketScopeResponse(ctx fiber.Ctx) error

type AddBucketScope401Response

type AddBucketScope401Response struct {
}

func (AddBucketScope401Response) VisitAddBucketScopeResponse

func (response AddBucketScope401Response) VisitAddBucketScopeResponse(ctx fiber.Ctx) error

type AddBucketScope403Response

type AddBucketScope403Response struct {
}

func (AddBucketScope403Response) VisitAddBucketScopeResponse

func (response AddBucketScope403Response) VisitAddBucketScopeResponse(ctx fiber.Ctx) error

type AddBucketScope404Response

type AddBucketScope404Response struct {
}

func (AddBucketScope404Response) VisitAddBucketScopeResponse

func (response AddBucketScope404Response) VisitAddBucketScopeResponse(ctx fiber.Ctx) error

type AddBucketScope409Response

type AddBucketScope409Response struct {
}

func (AddBucketScope409Response) VisitAddBucketScopeResponse

func (response AddBucketScope409Response) VisitAddBucketScopeResponse(ctx fiber.Ctx) error

type AddBucketScope500Response

type AddBucketScope500Response struct {
}

func (AddBucketScope500Response) VisitAddBucketScopeResponse

func (response AddBucketScope500Response) VisitAddBucketScopeResponse(ctx fiber.Ctx) error

type AddBucketScopeJSONRequestBody

type AddBucketScopeJSONRequestBody = AddBucketScopeRequest

AddBucketScopeJSONRequestBody defines body for AddBucketScope for application/json ContentType.

type AddBucketScopeRequest

type AddBucketScopeRequest struct {
	Organization string `json:"organization"`

	// Path Optional s3://bucket/prefix path override
	Path      *string `json:"path,omitempty"`
	ProjectId string  `json:"project_id"`
}

AddBucketScopeRequest defines model for AddBucketScopeRequest.

type AddBucketScopeRequestObject

type AddBucketScopeRequestObject struct {
	Bucket string `json:"bucket"`
	Body   *AddBucketScopeJSONRequestBody
}

type AddBucketScopeResponseObject

type AddBucketScopeResponseObject interface {
	VisitAddBucketScopeResponse(ctx fiber.Ctx) error
}

type BucketMetadata

type BucketMetadata struct {
	Bucket      *string   `json:"bucket,omitempty"`
	EndpointUrl *string   `json:"endpoint_url,omitempty"`
	Programs    *[]string `json:"programs,omitempty"`
	Provider    *string   `json:"provider,omitempty"`
	Region      *string   `json:"region,omitempty"`
}

BucketMetadata defines model for BucketMetadata.

type BucketsResponse

type BucketsResponse struct {
	S3BUCKETS map[string]BucketMetadata `json:"S3_BUCKETS"`
}

BucketsResponse defines model for BucketsResponse.

type DeleteBucket204Response

type DeleteBucket204Response struct {
}

func (DeleteBucket204Response) VisitDeleteBucketResponse

func (response DeleteBucket204Response) VisitDeleteBucketResponse(ctx fiber.Ctx) error

type DeleteBucket400Response

type DeleteBucket400Response struct {
}

func (DeleteBucket400Response) VisitDeleteBucketResponse

func (response DeleteBucket400Response) VisitDeleteBucketResponse(ctx fiber.Ctx) error

type DeleteBucket401Response

type DeleteBucket401Response struct {
}

func (DeleteBucket401Response) VisitDeleteBucketResponse

func (response DeleteBucket401Response) VisitDeleteBucketResponse(ctx fiber.Ctx) error

type DeleteBucket403Response

type DeleteBucket403Response struct {
}

func (DeleteBucket403Response) VisitDeleteBucketResponse

func (response DeleteBucket403Response) VisitDeleteBucketResponse(ctx fiber.Ctx) error

type DeleteBucket404Response

type DeleteBucket404Response struct {
}

func (DeleteBucket404Response) VisitDeleteBucketResponse

func (response DeleteBucket404Response) VisitDeleteBucketResponse(ctx fiber.Ctx) error

type DeleteBucket500Response

type DeleteBucket500Response struct {
}

func (DeleteBucket500Response) VisitDeleteBucketResponse

func (response DeleteBucket500Response) VisitDeleteBucketResponse(ctx fiber.Ctx) error

type DeleteBucketRequestObject

type DeleteBucketRequestObject struct {
	Bucket string `json:"bucket"`
}

type DeleteBucketResponseObject

type DeleteBucketResponseObject interface {
	VisitDeleteBucketResponse(ctx fiber.Ctx) error
}

type DeleteBucketScope204Response added in v0.2.8

type DeleteBucketScope204Response struct {
}

func (DeleteBucketScope204Response) VisitDeleteBucketScopeResponse added in v0.2.8

func (response DeleteBucketScope204Response) VisitDeleteBucketScopeResponse(ctx fiber.Ctx) error

type DeleteBucketScope400Response added in v0.2.8

type DeleteBucketScope400Response struct {
}

func (DeleteBucketScope400Response) VisitDeleteBucketScopeResponse added in v0.2.8

func (response DeleteBucketScope400Response) VisitDeleteBucketScopeResponse(ctx fiber.Ctx) error

type DeleteBucketScope401Response added in v0.2.8

type DeleteBucketScope401Response struct {
}

func (DeleteBucketScope401Response) VisitDeleteBucketScopeResponse added in v0.2.8

func (response DeleteBucketScope401Response) VisitDeleteBucketScopeResponse(ctx fiber.Ctx) error

type DeleteBucketScope403Response added in v0.2.8

type DeleteBucketScope403Response struct {
}

func (DeleteBucketScope403Response) VisitDeleteBucketScopeResponse added in v0.2.8

func (response DeleteBucketScope403Response) VisitDeleteBucketScopeResponse(ctx fiber.Ctx) error

type DeleteBucketScope404Response added in v0.2.8

type DeleteBucketScope404Response struct {
}

func (DeleteBucketScope404Response) VisitDeleteBucketScopeResponse added in v0.2.8

func (response DeleteBucketScope404Response) VisitDeleteBucketScopeResponse(ctx fiber.Ctx) error

type DeleteBucketScope500Response added in v0.2.8

type DeleteBucketScope500Response struct {
}

func (DeleteBucketScope500Response) VisitDeleteBucketScopeResponse added in v0.2.8

func (response DeleteBucketScope500Response) VisitDeleteBucketScopeResponse(ctx fiber.Ctx) error

type DeleteBucketScopeParams added in v0.2.8

type DeleteBucketScopeParams struct {
	Organization string `form:"organization" json:"organization"`
	ProjectId    string `form:"project_id" json:"project_id"`
}

DeleteBucketScopeParams defines parameters for DeleteBucketScope.

type DeleteBucketScopeRequestObject added in v0.2.8

type DeleteBucketScopeRequestObject struct {
	Bucket string `json:"bucket"`
	Params DeleteBucketScopeParams
}

type DeleteBucketScopeResponseObject added in v0.2.8

type DeleteBucketScopeResponseObject interface {
	VisitDeleteBucketScopeResponse(ctx fiber.Ctx) error
}

type DeleteProjectData200JSONResponse added in v0.2.8

type DeleteProjectData200JSONResponse DeleteProjectDataResponse

func (DeleteProjectData200JSONResponse) VisitDeleteProjectDataResponse added in v0.2.8

func (response DeleteProjectData200JSONResponse) VisitDeleteProjectDataResponse(ctx fiber.Ctx) error

type DeleteProjectData400Response added in v0.2.8

type DeleteProjectData400Response struct {
}

func (DeleteProjectData400Response) VisitDeleteProjectDataResponse added in v0.2.8

func (response DeleteProjectData400Response) VisitDeleteProjectDataResponse(ctx fiber.Ctx) error

type DeleteProjectData401Response added in v0.2.8

type DeleteProjectData401Response struct {
}

func (DeleteProjectData401Response) VisitDeleteProjectDataResponse added in v0.2.8

func (response DeleteProjectData401Response) VisitDeleteProjectDataResponse(ctx fiber.Ctx) error

type DeleteProjectData403Response added in v0.2.8

type DeleteProjectData403Response struct {
}

func (DeleteProjectData403Response) VisitDeleteProjectDataResponse added in v0.2.8

func (response DeleteProjectData403Response) VisitDeleteProjectDataResponse(ctx fiber.Ctx) error

type DeleteProjectData500Response added in v0.2.8

type DeleteProjectData500Response struct {
}

func (DeleteProjectData500Response) VisitDeleteProjectDataResponse added in v0.2.8

func (response DeleteProjectData500Response) VisitDeleteProjectDataResponse(ctx fiber.Ctx) error

type DeleteProjectDataRequestObject added in v0.2.8

type DeleteProjectDataRequestObject struct {
	Organization string `json:"organization"`
	ProjectId    string `json:"project_id"`
}

type DeleteProjectDataResponse added in v0.2.8

type DeleteProjectDataResponse struct {
	DeletedBucketScopes int    `json:"deleted_bucket_scopes"`
	DeletedObjects      int    `json:"deleted_objects"`
	Organization        string `json:"organization"`
	ProjectId           string `json:"project_id"`
}

DeleteProjectDataResponse defines model for DeleteProjectDataResponse.

type DeleteProjectDataResponseObject added in v0.2.8

type DeleteProjectDataResponseObject interface {
	VisitDeleteProjectDataResponse(ctx fiber.Ctx) error
}

type FiberServerOptions

type FiberServerOptions struct {
	BaseURL     string
	Middlewares []MiddlewareFunc
}

FiberServerOptions provides options for the Fiber server.

type ListBuckets200JSONResponse

type ListBuckets200JSONResponse BucketsResponse

func (ListBuckets200JSONResponse) VisitListBucketsResponse

func (response ListBuckets200JSONResponse) VisitListBucketsResponse(ctx fiber.Ctx) error

type ListBuckets401Response

type ListBuckets401Response struct {
}

func (ListBuckets401Response) VisitListBucketsResponse

func (response ListBuckets401Response) VisitListBucketsResponse(ctx fiber.Ctx) error

type ListBuckets403Response

type ListBuckets403Response struct {
}

func (ListBuckets403Response) VisitListBucketsResponse

func (response ListBuckets403Response) VisitListBucketsResponse(ctx fiber.Ctx) error

type ListBuckets500Response

type ListBuckets500Response struct {
}

func (ListBuckets500Response) VisitListBucketsResponse

func (response ListBuckets500Response) VisitListBucketsResponse(ctx fiber.Ctx) error

type ListBucketsRequestObject

type ListBucketsRequestObject struct {
}

type ListBucketsResponseObject

type ListBucketsResponseObject interface {
	VisitListBucketsResponse(ctx fiber.Ctx) error
}

type MiddlewareFunc

type MiddlewareFunc fiber.Handler

type PutBucket201Response

type PutBucket201Response struct {
}

func (PutBucket201Response) VisitPutBucketResponse

func (response PutBucket201Response) VisitPutBucketResponse(ctx fiber.Ctx) error

type PutBucket400Response

type PutBucket400Response struct {
}

func (PutBucket400Response) VisitPutBucketResponse

func (response PutBucket400Response) VisitPutBucketResponse(ctx fiber.Ctx) error

type PutBucket401Response

type PutBucket401Response struct {
}

func (PutBucket401Response) VisitPutBucketResponse

func (response PutBucket401Response) VisitPutBucketResponse(ctx fiber.Ctx) error

type PutBucket403Response

type PutBucket403Response struct {
}

func (PutBucket403Response) VisitPutBucketResponse

func (response PutBucket403Response) VisitPutBucketResponse(ctx fiber.Ctx) error

type PutBucket409Response

type PutBucket409Response struct {
}

func (PutBucket409Response) VisitPutBucketResponse

func (response PutBucket409Response) VisitPutBucketResponse(ctx fiber.Ctx) error

type PutBucket500Response

type PutBucket500Response struct {
}

func (PutBucket500Response) VisitPutBucketResponse

func (response PutBucket500Response) VisitPutBucketResponse(ctx fiber.Ctx) error

type PutBucketJSONRequestBody

type PutBucketJSONRequestBody = PutBucketRequest

PutBucketJSONRequestBody defines body for PutBucket for application/json ContentType.

type PutBucketRequest

type PutBucketRequest struct {
	AccessKey    *string `json:"access_key,omitempty"`
	Bucket       string  `json:"bucket"`
	Endpoint     *string `json:"endpoint,omitempty"`
	Organization string  `json:"organization"`

	// Path Optional s3://bucket/prefix path override
	Path      *string `json:"path,omitempty"`
	ProjectId string  `json:"project_id"`

	// Provider Storage backend provider (s3|gcs|azure|file). Defaults to s3.
	Provider  *string `json:"provider,omitempty"`
	Region    *string `json:"region,omitempty"`
	SecretKey *string `json:"secret_key,omitempty"`
}

PutBucketRequest defines model for PutBucketRequest.

type PutBucketRequestObject

type PutBucketRequestObject struct {
	Body *PutBucketJSONRequestBody
}

type PutBucketResponseObject

type PutBucketResponseObject interface {
	VisitPutBucketResponse(ctx fiber.Ctx) error
}

type ServerInterface

type ServerInterface interface {
	// List configured bucket credentials and org/project assignments
	// (GET /data/buckets)
	ListBuckets(c fiber.Ctx) error
	// Upsert bucket credential and claim org/project scope
	// (PUT /data/buckets)
	PutBucket(c fiber.Ctx) error
	// Delete bucket credential
	// (DELETE /data/buckets/{bucket})
	DeleteBucket(c fiber.Ctx, bucket string) error
	// Remove an org/project scope from an existing bucket
	// (DELETE /data/buckets/{bucket}/scopes)
	DeleteBucketScope(c fiber.Ctx, bucket string, params DeleteBucketScopeParams) error
	// Add an org/project scope to an existing bucket
	// (POST /data/buckets/{bucket}/scopes)
	AddBucketScope(c fiber.Ctx, bucket string) error
	// Delete Syfon records and bucket scopes for a project
	// (DELETE /data/projects/{organization}/{project_id})
	DeleteProjectData(c fiber.Ctx, organization string, projectId string) error
}

ServerInterface represents all server handlers.

func NewStrictHandler

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

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) AddBucketScope

func (siw *ServerInterfaceWrapper) AddBucketScope(c fiber.Ctx) error

AddBucketScope operation middleware

func (*ServerInterfaceWrapper) DeleteBucket

func (siw *ServerInterfaceWrapper) DeleteBucket(c fiber.Ctx) error

DeleteBucket operation middleware

func (*ServerInterfaceWrapper) DeleteBucketScope added in v0.2.8

func (siw *ServerInterfaceWrapper) DeleteBucketScope(c fiber.Ctx) error

DeleteBucketScope operation middleware

func (*ServerInterfaceWrapper) DeleteProjectData added in v0.2.8

func (siw *ServerInterfaceWrapper) DeleteProjectData(c fiber.Ctx) error

DeleteProjectData operation middleware

func (*ServerInterfaceWrapper) ListBuckets

func (siw *ServerInterfaceWrapper) ListBuckets(c fiber.Ctx) error

ListBuckets operation middleware

func (*ServerInterfaceWrapper) PutBucket

func (siw *ServerInterfaceWrapper) PutBucket(c fiber.Ctx) error

PutBucket operation middleware

type StrictHandlerFunc

type StrictHandlerFunc func(ctx fiber.Ctx, args interface{}) (interface{}, error)

type StrictMiddlewareFunc

type StrictMiddlewareFunc func(f StrictHandlerFunc, operationID string) StrictHandlerFunc

type StrictServerInterface

type StrictServerInterface interface {
	// List configured bucket credentials and org/project assignments
	// (GET /data/buckets)
	ListBuckets(ctx context.Context, request ListBucketsRequestObject) (ListBucketsResponseObject, error)
	// Upsert bucket credential and claim org/project scope
	// (PUT /data/buckets)
	PutBucket(ctx context.Context, request PutBucketRequestObject) (PutBucketResponseObject, error)
	// Delete bucket credential
	// (DELETE /data/buckets/{bucket})
	DeleteBucket(ctx context.Context, request DeleteBucketRequestObject) (DeleteBucketResponseObject, error)
	// Remove an org/project scope from an existing bucket
	// (DELETE /data/buckets/{bucket}/scopes)
	DeleteBucketScope(ctx context.Context, request DeleteBucketScopeRequestObject) (DeleteBucketScopeResponseObject, error)
	// Add an org/project scope to an existing bucket
	// (POST /data/buckets/{bucket}/scopes)
	AddBucketScope(ctx context.Context, request AddBucketScopeRequestObject) (AddBucketScopeResponseObject, error)
	// Delete Syfon records and bucket scopes for a project
	// (DELETE /data/projects/{organization}/{project_id})
	DeleteProjectData(ctx context.Context, request DeleteProjectDataRequestObject) (DeleteProjectDataResponseObject, error)
}

StrictServerInterface represents all server handlers.

Jump to

Keyboard shortcuts

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