lfsapi

package
v0.2.5 Latest Latest
Warning

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

Go to latest
Published: Apr 27, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

Package lfsapi 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 AccessMethod

type AccessMethod struct {
	AccessId       *string                     `json:"access_id,omitempty"`
	AccessUrl      *AccessMethodAccessUrl      `json:"access_url,omitempty"`
	Authorizations *AccessMethodAuthorizations `json:"authorizations,omitempty"`
	Region         *string                     `json:"region,omitempty"`
	Type           *string                     `json:"type,omitempty"`
}

AccessMethod defines model for AccessMethod.

type AccessMethodAccessUrl

type AccessMethodAccessUrl struct {
	Url *string `json:"url,omitempty"`
}

AccessMethodAccessUrl defines model for AccessMethodAccessUrl.

type AccessMethodAuthorizations

type AccessMethodAuthorizations struct {
	BearerAuthIssuers *[]string `json:"bearer_auth_issuers,omitempty"`
}

AccessMethodAuthorizations defines model for AccessMethodAuthorizations.

type Action

type Action struct {
	// ExpiresAt RFC3339 timestamp
	ExpiresAt *time.Time         `json:"expires_at,omitempty"`
	ExpiresIn *int32             `json:"expires_in,omitempty"`
	Header    *map[string]string `json:"header,omitempty"`
	Href      string             `json:"href"`
}

Action defines model for Action.

type BatchActions

type BatchActions struct {
	Download *Action `json:"download,omitempty"`
	Upload   *Action `json:"upload,omitempty"`
	Verify   *Action `json:"verify,omitempty"`
}

BatchActions defines model for BatchActions.

type BatchRequest

type BatchRequest struct {
	HashAlgo  *string               `json:"hash_algo,omitempty"`
	Objects   []BatchRequestObject  `json:"objects"`
	Operation BatchRequestOperation `json:"operation"`
	Ref       *RefSpec              `json:"ref,omitempty"`
	Transfers *[]string             `json:"transfers,omitempty"`
}

BatchRequest defines model for BatchRequest.

type BatchRequestObject

type BatchRequestObject struct {
	Oid  string `json:"oid"`
	Size int64  `json:"size"`
}

BatchRequestObject defines model for BatchRequestObject.

type BatchRequestOperation

type BatchRequestOperation string

BatchRequestOperation defines model for BatchRequest.Operation.

const (
	Download BatchRequestOperation = "download"
	Upload   BatchRequestOperation = "upload"
)

Defines values for BatchRequestOperation.

type BatchResponse

type BatchResponse struct {
	HashAlgo *string               `json:"hash_algo,omitempty"`
	Objects  []BatchResponseObject `json:"objects"`
	Transfer *string               `json:"transfer,omitempty"`
}

BatchResponse defines model for BatchResponse.

type BatchResponseObject

type BatchResponseObject struct {
	Actions       *BatchActions `json:"actions,omitempty"`
	Authenticated *bool         `json:"authenticated,omitempty"`
	Error         *ObjectError  `json:"error,omitempty"`
	Oid           string        `json:"oid"`
	Size          int64         `json:"size"`
}

BatchResponseObject defines model for BatchResponseObject.

type Checksum

type Checksum struct {
	Checksum string `json:"checksum"`
	Type     string `json:"type"`
}

Checksum defines model for Checksum.

type DrsObjectCandidate

type DrsObjectCandidate struct {
	AccessMethods *[]AccessMethod `json:"access_methods,omitempty"`
	Aliases       *[]string       `json:"aliases,omitempty"`
	Checksums     *[]Checksum     `json:"checksums,omitempty"`
	Description   *string         `json:"description,omitempty"`
	Id            *string         `json:"id,omitempty"`
	MimeType      *string         `json:"mime_type,omitempty"`
	Name          *string         `json:"name,omitempty"`
	Size          *int64          `json:"size,omitempty"`
}

DrsObjectCandidate defines model for DrsObjectCandidate.

type FiberServerOptions

type FiberServerOptions struct {
	BaseURL     string
	Middlewares []MiddlewareFunc
}

FiberServerOptions provides options for the Fiber server.

type LFSErrorResponse

type LFSErrorResponse struct {
	DocumentationUrl *string `json:"documentation_url,omitempty"`
	Message          string  `json:"message"`
	RequestId        *string `json:"request_id,omitempty"`
}

LFSErrorResponse defines model for LFSErrorResponse.

type LfsBatch200ApplicationVndGitLfsPlusJSONResponse

type LfsBatch200ApplicationVndGitLfsPlusJSONResponse BatchResponse

func (LfsBatch200ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch200ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatch401ApplicationVndGitLfsPlusJSONResponse

type LfsBatch401ApplicationVndGitLfsPlusJSONResponse struct {
	Body    LFSErrorResponse
	Headers LfsBatch401ResponseHeaders
}

func (LfsBatch401ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch401ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatch401ResponseHeaders

type LfsBatch401ResponseHeaders struct {
	LFSAuthenticate string
}

type LfsBatch403ApplicationVndGitLfsPlusJSONResponse

type LfsBatch403ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsBatch403ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch403ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatch404ApplicationVndGitLfsPlusJSONResponse

type LfsBatch404ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsBatch404ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch404ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatch406ApplicationVndGitLfsPlusJSONResponse

type LfsBatch406ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsBatch406ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch406ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatch413ApplicationVndGitLfsPlusJSONResponse

type LfsBatch413ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsBatch413ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch413ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatch422ApplicationVndGitLfsPlusJSONResponse

type LfsBatch422ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsBatch422ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch422ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatch429ApplicationVndGitLfsPlusJSONResponse

type LfsBatch429ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsBatch429ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch429ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatch500ApplicationVndGitLfsPlusJSONResponse

type LfsBatch500ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsBatch500ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch500ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatch502ApplicationVndGitLfsPlusJSONResponse

type LfsBatch502ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsBatch502ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch502ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatch503ApplicationVndGitLfsPlusJSONResponse

type LfsBatch503ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsBatch503ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch503ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatch504ApplicationVndGitLfsPlusJSONResponse

type LfsBatch504ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsBatch504ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch504ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatch507ApplicationVndGitLfsPlusJSONResponse

type LfsBatch507ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsBatch507ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch507ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatch509ApplicationVndGitLfsPlusJSONResponse

type LfsBatch509ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsBatch509ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse

func (response LfsBatch509ApplicationVndGitLfsPlusJSONResponse) VisitLfsBatchResponse(ctx fiber.Ctx) error

type LfsBatchApplicationVndGitLfsPlusJSONRequestBody

type LfsBatchApplicationVndGitLfsPlusJSONRequestBody = BatchRequest

LfsBatchApplicationVndGitLfsPlusJSONRequestBody defines body for LfsBatch for application/vnd.git-lfs+json ContentType.

type LfsBatchRequestObject

type LfsBatchRequestObject struct {
	Body *LfsBatchApplicationVndGitLfsPlusJSONRequestBody
}

type LfsBatchResponseObject

type LfsBatchResponseObject interface {
	VisitLfsBatchResponse(ctx fiber.Ctx) error
}

type LfsStageMetadata200ApplicationVndGitLfsPlusJSONResponse

type LfsStageMetadata200ApplicationVndGitLfsPlusJSONResponse MetadataSubmitResponse

func (LfsStageMetadata200ApplicationVndGitLfsPlusJSONResponse) VisitLfsStageMetadataResponse

func (response LfsStageMetadata200ApplicationVndGitLfsPlusJSONResponse) VisitLfsStageMetadataResponse(ctx fiber.Ctx) error

type LfsStageMetadata200JSONResponse

type LfsStageMetadata200JSONResponse MetadataSubmitResponse

func (LfsStageMetadata200JSONResponse) VisitLfsStageMetadataResponse

func (response LfsStageMetadata200JSONResponse) VisitLfsStageMetadataResponse(ctx fiber.Ctx) error

type LfsStageMetadata400JSONResponse

type LfsStageMetadata400JSONResponse LFSErrorResponse

func (LfsStageMetadata400JSONResponse) VisitLfsStageMetadataResponse

func (response LfsStageMetadata400JSONResponse) VisitLfsStageMetadataResponse(ctx fiber.Ctx) error

type LfsStageMetadata401JSONResponse

type LfsStageMetadata401JSONResponse struct {
	Body    LFSErrorResponse
	Headers LfsStageMetadata401ResponseHeaders
}

func (LfsStageMetadata401JSONResponse) VisitLfsStageMetadataResponse

func (response LfsStageMetadata401JSONResponse) VisitLfsStageMetadataResponse(ctx fiber.Ctx) error

type LfsStageMetadata401ResponseHeaders

type LfsStageMetadata401ResponseHeaders struct {
	LFSAuthenticate string
}

type LfsStageMetadata403JSONResponse

type LfsStageMetadata403JSONResponse LFSErrorResponse

func (LfsStageMetadata403JSONResponse) VisitLfsStageMetadataResponse

func (response LfsStageMetadata403JSONResponse) VisitLfsStageMetadataResponse(ctx fiber.Ctx) error

type LfsStageMetadata500JSONResponse

type LfsStageMetadata500JSONResponse LFSErrorResponse

func (LfsStageMetadata500JSONResponse) VisitLfsStageMetadataResponse

func (response LfsStageMetadata500JSONResponse) VisitLfsStageMetadataResponse(ctx fiber.Ctx) error

type LfsStageMetadataApplicationVndGitLfsPlusJSONRequestBody

type LfsStageMetadataApplicationVndGitLfsPlusJSONRequestBody = MetadataSubmitRequest

LfsStageMetadataApplicationVndGitLfsPlusJSONRequestBody defines body for LfsStageMetadata for application/vnd.git-lfs+json ContentType.

type LfsStageMetadataJSONRequestBody

type LfsStageMetadataJSONRequestBody = MetadataSubmitRequest

LfsStageMetadataJSONRequestBody defines body for LfsStageMetadata for application/json ContentType.

type LfsStageMetadataRequestObject

type LfsStageMetadataRequestObject struct {
	JSONBody                         *LfsStageMetadataJSONRequestBody
	ApplicationVndGitLfsPlusJSONBody *LfsStageMetadataApplicationVndGitLfsPlusJSONRequestBody
}

type LfsStageMetadataResponseObject

type LfsStageMetadataResponseObject interface {
	VisitLfsStageMetadataResponse(ctx fiber.Ctx) error
}

type LfsUploadProxy200Response

type LfsUploadProxy200Response struct {
}

func (LfsUploadProxy200Response) VisitLfsUploadProxyResponse

func (response LfsUploadProxy200Response) VisitLfsUploadProxyResponse(ctx fiber.Ctx) error

type LfsUploadProxy400TextResponse

type LfsUploadProxy400TextResponse string

func (LfsUploadProxy400TextResponse) VisitLfsUploadProxyResponse

func (response LfsUploadProxy400TextResponse) VisitLfsUploadProxyResponse(ctx fiber.Ctx) error

type LfsUploadProxy401TextResponse

type LfsUploadProxy401TextResponse string

func (LfsUploadProxy401TextResponse) VisitLfsUploadProxyResponse

func (response LfsUploadProxy401TextResponse) VisitLfsUploadProxyResponse(ctx fiber.Ctx) error

type LfsUploadProxy403TextResponse

type LfsUploadProxy403TextResponse string

func (LfsUploadProxy403TextResponse) VisitLfsUploadProxyResponse

func (response LfsUploadProxy403TextResponse) VisitLfsUploadProxyResponse(ctx fiber.Ctx) error

type LfsUploadProxy500TextResponse

type LfsUploadProxy500TextResponse string

func (LfsUploadProxy500TextResponse) VisitLfsUploadProxyResponse

func (response LfsUploadProxy500TextResponse) VisitLfsUploadProxyResponse(ctx fiber.Ctx) error

type LfsUploadProxy502TextResponse

type LfsUploadProxy502TextResponse string

func (LfsUploadProxy502TextResponse) VisitLfsUploadProxyResponse

func (response LfsUploadProxy502TextResponse) VisitLfsUploadProxyResponse(ctx fiber.Ctx) error

type LfsUploadProxy507TextResponse

type LfsUploadProxy507TextResponse string

func (LfsUploadProxy507TextResponse) VisitLfsUploadProxyResponse

func (response LfsUploadProxy507TextResponse) VisitLfsUploadProxyResponse(ctx fiber.Ctx) error

type LfsUploadProxyRequestObject

type LfsUploadProxyRequestObject struct {
	Oid  string `json:"oid"`
	Body io.Reader
}

type LfsUploadProxyResponseObject

type LfsUploadProxyResponseObject interface {
	VisitLfsUploadProxyResponse(ctx fiber.Ctx) error
}

type LfsVerify200Response

type LfsVerify200Response struct {
}

func (LfsVerify200Response) VisitLfsVerifyResponse

func (response LfsVerify200Response) VisitLfsVerifyResponse(ctx fiber.Ctx) error

type LfsVerify400ApplicationVndGitLfsPlusJSONResponse

type LfsVerify400ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsVerify400ApplicationVndGitLfsPlusJSONResponse) VisitLfsVerifyResponse

func (response LfsVerify400ApplicationVndGitLfsPlusJSONResponse) VisitLfsVerifyResponse(ctx fiber.Ctx) error

type LfsVerify401ApplicationVndGitLfsPlusJSONResponse

type LfsVerify401ApplicationVndGitLfsPlusJSONResponse struct {
	Body    LFSErrorResponse
	Headers LfsVerify401ResponseHeaders
}

func (LfsVerify401ApplicationVndGitLfsPlusJSONResponse) VisitLfsVerifyResponse

func (response LfsVerify401ApplicationVndGitLfsPlusJSONResponse) VisitLfsVerifyResponse(ctx fiber.Ctx) error

type LfsVerify401ResponseHeaders

type LfsVerify401ResponseHeaders struct {
	LFSAuthenticate string
}

type LfsVerify403ApplicationVndGitLfsPlusJSONResponse

type LfsVerify403ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsVerify403ApplicationVndGitLfsPlusJSONResponse) VisitLfsVerifyResponse

func (response LfsVerify403ApplicationVndGitLfsPlusJSONResponse) VisitLfsVerifyResponse(ctx fiber.Ctx) error

type LfsVerify404ApplicationVndGitLfsPlusJSONResponse

type LfsVerify404ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsVerify404ApplicationVndGitLfsPlusJSONResponse) VisitLfsVerifyResponse

func (response LfsVerify404ApplicationVndGitLfsPlusJSONResponse) VisitLfsVerifyResponse(ctx fiber.Ctx) error

type LfsVerify500ApplicationVndGitLfsPlusJSONResponse

type LfsVerify500ApplicationVndGitLfsPlusJSONResponse LFSErrorResponse

func (LfsVerify500ApplicationVndGitLfsPlusJSONResponse) VisitLfsVerifyResponse

func (response LfsVerify500ApplicationVndGitLfsPlusJSONResponse) VisitLfsVerifyResponse(ctx fiber.Ctx) error

type LfsVerifyApplicationVndGitLfsPlusJSONRequestBody

type LfsVerifyApplicationVndGitLfsPlusJSONRequestBody = VerifyRequest

LfsVerifyApplicationVndGitLfsPlusJSONRequestBody defines body for LfsVerify for application/vnd.git-lfs+json ContentType.

type LfsVerifyRequestObject

type LfsVerifyRequestObject struct {
	Body *LfsVerifyApplicationVndGitLfsPlusJSONRequestBody
}

type LfsVerifyResponseObject

type LfsVerifyResponseObject interface {
	VisitLfsVerifyResponse(ctx fiber.Ctx) error
}

type MetadataSubmitRequest

type MetadataSubmitRequest struct {
	Candidates []DrsObjectCandidate `json:"candidates"`
	TtlSeconds *int64               `json:"ttl_seconds,omitempty"`
}

MetadataSubmitRequest defines model for MetadataSubmitRequest.

type MetadataSubmitResponse

type MetadataSubmitResponse struct {
	Staged int32 `json:"staged"`
}

MetadataSubmitResponse defines model for MetadataSubmitResponse.

type MiddlewareFunc

type MiddlewareFunc fiber.Handler

type ObjectError

type ObjectError struct {
	// Code Object-level error code (commonly HTTP-like status code)
	Code    int32  `json:"code"`
	Message string `json:"message"`
}

ObjectError defines model for ObjectError.

type RefSpec

type RefSpec struct {
	// Name Fully-qualified server refspec
	Name *string `json:"name,omitempty"`
}

RefSpec defines model for RefSpec.

type ServerInterface

type ServerInterface interface {
	// Git LFS Batch API
	// (POST /info/lfs/objects/batch)
	LfsBatch(c fiber.Ctx) error
	// Stage metadata for deferred object registration (drs-server extension)
	// (POST /info/lfs/objects/metadata)
	LfsStageMetadata(c fiber.Ctx) error
	// Upload object bytes via drs-server upload proxy (drs-server extension)
	// (PUT /info/lfs/objects/{oid})
	LfsUploadProxy(c fiber.Ctx, oid string) error
	// Git LFS Verify API
	// (POST /info/lfs/verify)
	LfsVerify(c fiber.Ctx) 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) LfsBatch

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

LfsBatch operation middleware

func (*ServerInterfaceWrapper) LfsStageMetadata

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

LfsStageMetadata operation middleware

func (*ServerInterfaceWrapper) LfsUploadProxy

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

LfsUploadProxy operation middleware

func (*ServerInterfaceWrapper) LfsVerify

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

LfsVerify 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 {
	// Git LFS Batch API
	// (POST /info/lfs/objects/batch)
	LfsBatch(ctx context.Context, request LfsBatchRequestObject) (LfsBatchResponseObject, error)
	// Stage metadata for deferred object registration (drs-server extension)
	// (POST /info/lfs/objects/metadata)
	LfsStageMetadata(ctx context.Context, request LfsStageMetadataRequestObject) (LfsStageMetadataResponseObject, error)
	// Upload object bytes via drs-server upload proxy (drs-server extension)
	// (PUT /info/lfs/objects/{oid})
	LfsUploadProxy(ctx context.Context, request LfsUploadProxyRequestObject) (LfsUploadProxyResponseObject, error)
	// Git LFS Verify API
	// (POST /info/lfs/verify)
	LfsVerify(ctx context.Context, request LfsVerifyRequestObject) (LfsVerifyResponseObject, error)
}

StrictServerInterface represents all server handlers.

type VerifyRequest

type VerifyRequest struct {
	Oid  string `json:"oid"`
	Size int64  `json:"size"`
}

VerifyRequest defines model for VerifyRequest.

Jump to

Keyboard shortcuts

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