generated

package
v0.12.1 Latest Latest
Warning

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

Go to latest
Published: Sep 7, 2026 License: MIT Imports: 17 Imported by: 0

Documentation

Overview

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSpec

func GetSpec() (swagger *openapi3.T, err error)

GetSpec returns the OpenAPI specification corresponding to the generated code in this file. External references in the spec are resolved through PathToRawSpec; externally-referenced files must be embedded in their corresponding Go packages (via the import-mapping feature). URL-based external refs are not supported.

func GetSpecJSON

func GetSpecJSON() ([]byte, error)

GetSpecJSON returns the raw JSON bytes of the embedded OpenAPI specification: decompressed but not unmarshaled. External references are not resolved here; the bytes are the spec exactly as embedded by codegen. The result is cached at package init time, so repeated calls are cheap.

func GetSwagger deprecated

func GetSwagger() (*openapi3.T, error)

GetSwagger returns the OpenAPI specification corresponding to the generated code in this file.

Deprecated: GetSwagger predates kin-openapi renaming openapi3.Swagger to openapi3.T. Use GetSpec instead. This wrapper is retained for backwards compatibility.

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

func NewCreateDocumentRevisionRequestWithBody added in v0.11.0

func NewCreateDocumentRevisionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateDocumentRevisionRequestWithBody constructs an http.Request for the CreateDocumentRevision method, with any body, and a specified content type

func NewDeleteUploadRequest

func NewDeleteUploadRequest(server string, body DeleteUploadJSONRequestBody) (*http.Request, error)

NewDeleteUploadRequest calls the generic DeleteUpload builder with application/json body

func NewDeleteUploadRequestWithBody

func NewDeleteUploadRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewDeleteUploadRequestWithBody constructs an http.Request for the DeleteUpload method, with any body, and a specified content type

func NewExecuteBulkUpgradeRequest added in v0.8.0

func NewExecuteBulkUpgradeRequest(server string, body ExecuteBulkUpgradeJSONRequestBody) (*http.Request, error)

NewExecuteBulkUpgradeRequest calls the generic ExecuteBulkUpgrade builder with application/json body

func NewExecuteBulkUpgradeRequestWithBody added in v0.8.0

func NewExecuteBulkUpgradeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewExecuteBulkUpgradeRequestWithBody constructs an http.Request for the ExecuteBulkUpgrade method, with any body, and a specified content type

func NewExecuteDocumentUpgradeRequest added in v0.8.0

func NewExecuteDocumentUpgradeRequest(server string, body ExecuteDocumentUpgradeJSONRequestBody) (*http.Request, error)

NewExecuteDocumentUpgradeRequest calls the generic ExecuteDocumentUpgrade builder with application/json body

func NewExecuteDocumentUpgradeRequestWithBody added in v0.8.0

func NewExecuteDocumentUpgradeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewExecuteDocumentUpgradeRequestWithBody constructs an http.Request for the ExecuteDocumentUpgrade method, with any body, and a specified content type

func NewExecutePurgeRequest

func NewExecutePurgeRequest(server string, body ExecutePurgeJSONRequestBody) (*http.Request, error)

NewExecutePurgeRequest calls the generic ExecutePurge builder with application/json body

func NewExecutePurgeRequestWithBody

func NewExecutePurgeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewExecutePurgeRequestWithBody constructs an http.Request for the ExecutePurge method, with any body, and a specified content type

func NewGetCapabilitiesRequest

func NewGetCapabilitiesRequest(server string) (*http.Request, error)

NewGetCapabilitiesRequest constructs an http.Request for the GetCapabilities method

func NewGetOpenAPIRequest

func NewGetOpenAPIRequest(server string) (*http.Request, error)

NewGetOpenAPIRequest constructs an http.Request for the GetOpenAPI method

func NewGetUploadRequest

func NewGetUploadRequest(server string, body GetUploadJSONRequestBody) (*http.Request, error)

NewGetUploadRequest calls the generic GetUpload builder with application/json body

func NewGetUploadRequestWithBody

func NewGetUploadRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewGetUploadRequestWithBody constructs an http.Request for the GetUpload method, with any body, and a specified content type

func NewHealthRequest

func NewHealthRequest(server string) (*http.Request, error)

NewHealthRequest constructs an http.Request for the Health method

func NewInspectUploadRequest

func NewInspectUploadRequest(server string, body InspectUploadJSONRequestBody) (*http.Request, error)

NewInspectUploadRequest calls the generic InspectUpload builder with application/json body

func NewInspectUploadRequestWithBody

func NewInspectUploadRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewInspectUploadRequestWithBody constructs an http.Request for the InspectUpload method, with any body, and a specified content type

func NewListManifestUploadsRequest

func NewListManifestUploadsRequest(server string) (*http.Request, error)

NewListManifestUploadsRequest constructs an http.Request for the ListManifestUploads method

func NewListStorageUploadsRequest

func NewListStorageUploadsRequest(server string) (*http.Request, error)

NewListStorageUploadsRequest constructs an http.Request for the ListStorageUploads method

func NewPlanBulkUpgradeRequest added in v0.8.0

func NewPlanBulkUpgradeRequest(server string, body PlanBulkUpgradeJSONRequestBody) (*http.Request, error)

NewPlanBulkUpgradeRequest calls the generic PlanBulkUpgrade builder with application/json body

func NewPlanBulkUpgradeRequestWithBody added in v0.8.0

func NewPlanBulkUpgradeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPlanBulkUpgradeRequestWithBody constructs an http.Request for the PlanBulkUpgrade method, with any body, and a specified content type

func NewPlanDocumentUpgradeRequest added in v0.8.0

func NewPlanDocumentUpgradeRequest(server string, body PlanDocumentUpgradeJSONRequestBody) (*http.Request, error)

NewPlanDocumentUpgradeRequest calls the generic PlanDocumentUpgrade builder with application/json body

func NewPlanDocumentUpgradeRequestWithBody added in v0.8.0

func NewPlanDocumentUpgradeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPlanDocumentUpgradeRequestWithBody constructs an http.Request for the PlanDocumentUpgrade method, with any body, and a specified content type

func NewPreviewPurgeRequest

func NewPreviewPurgeRequest(server string, body PreviewPurgeJSONRequestBody) (*http.Request, error)

NewPreviewPurgeRequest calls the generic PreviewPurge builder with application/json body

func NewPreviewPurgeRequestWithBody

func NewPreviewPurgeRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPreviewPurgeRequestWithBody constructs an http.Request for the PreviewPurge method, with any body, and a specified content type

func NewProtectUploadRequest added in v0.7.0

func NewProtectUploadRequest(server string, body ProtectUploadJSONRequestBody) (*http.Request, error)

NewProtectUploadRequest calls the generic ProtectUpload builder with application/json body

func NewProtectUploadRequestWithBody added in v0.7.0

func NewProtectUploadRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewProtectUploadRequestWithBody constructs an http.Request for the ProtectUpload method, with any body, and a specified content type

func NewSyncManifestRequest

func NewSyncManifestRequest(server string, body SyncManifestJSONRequestBody) (*http.Request, error)

NewSyncManifestRequest calls the generic SyncManifest builder with application/json body

func NewSyncManifestRequestWithBody

func NewSyncManifestRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSyncManifestRequestWithBody constructs an http.Request for the SyncManifest method, with any body, and a specified content type

func NewUnprotectUploadRequest added in v0.7.0

func NewUnprotectUploadRequest(server string, body UnprotectUploadJSONRequestBody) (*http.Request, error)

NewUnprotectUploadRequest calls the generic UnprotectUpload builder with application/json body

func NewUnprotectUploadRequestWithBody added in v0.7.0

func NewUnprotectUploadRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUnprotectUploadRequestWithBody constructs an http.Request for the UnprotectUpload method, with any body, and a specified content type

func NewUpdateDocumentRequestWithBody added in v0.8.0

func NewUpdateDocumentRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateDocumentRequestWithBody constructs an http.Request for the UpdateDocument method, with any body, and a specified content type

func NewUploadCollectionRequestWithBody

func NewUploadCollectionRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUploadCollectionRequestWithBody constructs an http.Request for the UploadCollection method, with any body, and a specified content type

func NewUploadDocumentRequestWithBody

func NewUploadDocumentRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewUploadDocumentRequestWithBody constructs an http.Request for the UploadDocument method, with any body, and a specified content type

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type AssetResult added in v0.11.0

type AssetResult struct {
	Bytes       int64  `json:"bytes"`
	ContentType string `json:"content_type"`
	Key         string `json:"key"`
	Path        string `json:"path"`
	URL         string `json:"url"`
}

AssetResult defines model for AssetResult.

type BulkUpgradeItemResult added in v0.8.0

type BulkUpgradeItemResult struct {
	Error  string                 `json:"error,omitempty"`
	Plan   UpgradeDocumentPlan    `json:"plan"`
	Result *UpgradeDocumentResult `json:"result,omitempty"`
}

BulkUpgradeItemResult defines model for BulkUpgradeItemResult.

type BulkUpgradeOptions added in v0.8.0

type BulkUpgradeOptions struct {
	Concurrency int `json:"concurrency,omitempty"`
}

BulkUpgradeOptions defines model for BulkUpgradeOptions.

type BulkUpgradePlan added in v0.8.0

type BulkUpgradePlan struct {
	Counts   map[string]int        `json:"counts"`
	Items    []UpgradeDocumentPlan `json:"items"`
	Warnings []string              `json:"warnings,omitempty"`
}

BulkUpgradePlan defines model for BulkUpgradePlan.

type BulkUpgradeRequest added in v0.8.0

type BulkUpgradeRequest struct {
	Concurrency int                   `json:"concurrency,omitempty"`
	Items       []UpgradeDocumentPlan `json:"items"`
}

BulkUpgradeRequest defines model for BulkUpgradeRequest.

type BulkUpgradeResult added in v0.8.0

type BulkUpgradeResult struct {
	Failed   int                     `json:"failed"`
	Items    []BulkUpgradeItemResult `json:"items"`
	Upgraded int                     `json:"upgraded"`
}

BulkUpgradeResult defines model for BulkUpgradeResult.

type Capabilities

type Capabilities struct {
	APIVersion     CapabilitiesAPIVersion      `json:"api_version"`
	DocumentBundle *DocumentBundleCapabilities `json:"document_bundle,omitempty"`
	Limits         UploadLimits                `json:"limits"`
	MarkerVersions []int                       `json:"marker_versions"`
	Operations     []string                    `json:"operations"`
	ServerVersion  string                      `json:"server_version"`
	UploadFormats  []CapabilitiesUploadFormats `json:"upload_formats"`
}

Capabilities defines model for Capabilities.

type CapabilitiesAPIVersion

type CapabilitiesAPIVersion string

CapabilitiesAPIVersion defines model for Capabilities.APIVersion.

const (
	V1 CapabilitiesAPIVersion = "v1"
)

Defines values for CapabilitiesAPIVersion.

func (CapabilitiesAPIVersion) Valid

func (e CapabilitiesAPIVersion) Valid() bool

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

type CapabilitiesUploadFormats

type CapabilitiesUploadFormats string

CapabilitiesUploadFormats defines model for Capabilities.UploadFormats.

const (
	CapabilitiesUploadFormatsHTML CapabilitiesUploadFormats = "html"
	CapabilitiesUploadFormatsMd   CapabilitiesUploadFormats = "md"
	CapabilitiesUploadFormatsTxt  CapabilitiesUploadFormats = "txt"
)

Defines values for CapabilitiesUploadFormats.

func (CapabilitiesUploadFormats) Valid

func (e CapabilitiesUploadFormats) Valid() bool

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

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CreateDocumentRevisionWithBody added in v0.11.0

func (c *Client) CreateDocumentRevisionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateDocumentRevisionWithBody performs a POST /api/v1/uploads/documents/revisions (the `CreateDocumentRevision` operationId) request, with any type of body and a specified content type.

func (*Client) DeleteUpload

func (c *Client) DeleteUpload(ctx context.Context, body DeleteUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteUpload performs a POST /api/v1/uploads/delete (the `DeleteUpload` operationId) request. Takes a body of the `application/json` content type.

Permanently deletes one marker-managed upload. Payloads are deleted before the ownership marker and the manifest receives a tombstone. A purge-protected upload is refused unless force is true.

func (*Client) DeleteUploadWithBody

func (c *Client) DeleteUploadWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteUploadWithBody performs a POST /api/v1/uploads/delete (the `DeleteUpload` operationId) request, with any type of body and a specified content type.

Permanently deletes one marker-managed upload. Payloads are deleted before the ownership marker and the manifest receives a tombstone. A purge-protected upload is refused unless force is true.

func (*Client) ExecuteBulkUpgrade added in v0.8.0

func (c *Client) ExecuteBulkUpgrade(ctx context.Context, body ExecuteBulkUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ExecuteBulkUpgrade performs a POST /api/v1/upgrades (the `ExecuteBulkUpgrade` operationId) request. Takes a body of the `application/json` content type.

Applies only the exact upgradeable plans supplied by preview.

func (*Client) ExecuteBulkUpgradeWithBody added in v0.8.0

func (c *Client) ExecuteBulkUpgradeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ExecuteBulkUpgradeWithBody performs a POST /api/v1/upgrades (the `ExecuteBulkUpgrade` operationId) request, with any type of body and a specified content type.

Applies only the exact upgradeable plans supplied by preview.

func (*Client) ExecuteDocumentUpgrade added in v0.8.0

func (c *Client) ExecuteDocumentUpgrade(ctx context.Context, body ExecuteDocumentUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ExecuteDocumentUpgrade performs a POST /api/v1/upgrades/execute (the `ExecuteDocumentUpgrade` operationId) request. Takes a body of the `application/json` content type.

Replans live state, then applies a still-upgradeable exact plan after revalidating its ETags.

func (*Client) ExecuteDocumentUpgradeWithBody added in v0.8.0

func (c *Client) ExecuteDocumentUpgradeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ExecuteDocumentUpgradeWithBody performs a POST /api/v1/upgrades/execute (the `ExecuteDocumentUpgrade` operationId) request, with any type of body and a specified content type.

Replans live state, then applies a still-upgradeable exact plan after revalidating its ETags.

func (*Client) ExecutePurge

func (c *Client) ExecutePurge(ctx context.Context, body ExecutePurgeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ExecutePurge performs a POST /api/v1/purge (the `ExecutePurge` operationId) request. Takes a body of the `application/json` content type.

Permanently deletes the explicit upload IDs after revalidating every ownership marker. Later targets are attempted after an item failure.

func (*Client) ExecutePurgeWithBody

func (c *Client) ExecutePurgeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ExecutePurgeWithBody performs a POST /api/v1/purge (the `ExecutePurge` operationId) request, with any type of body and a specified content type.

Permanently deletes the explicit upload IDs after revalidating every ownership marker. Later targets are attempted after an item failure.

func (*Client) GetCapabilities

func (c *Client) GetCapabilities(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetCapabilities performs a GET /api/v1/capabilities (the `GetCapabilities` operationId) request.

func (*Client) GetOpenAPI

func (c *Client) GetOpenAPI(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

GetOpenAPI performs a GET /openapi.yaml (the `GetOpenAPI` operationId) request.

func (*Client) GetUpload

func (c *Client) GetUpload(ctx context.Context, body GetUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

GetUpload performs a POST /api/v1/uploads/get (the `GetUpload` operationId) request. Takes a body of the `application/json` content type.

func (*Client) GetUploadWithBody

func (c *Client) GetUploadWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

GetUploadWithBody performs a POST /api/v1/uploads/get (the `GetUpload` operationId) request, with any type of body and a specified content type.

func (*Client) Health

func (c *Client) Health(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

Health performs a GET /healthz (the `Health` operationId) request.

func (*Client) InspectUpload

func (c *Client) InspectUpload(ctx context.Context, body InspectUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

InspectUpload performs a POST /api/v1/uploads/inspect (the `InspectUpload` operationId) request. Takes a body of the `application/json` content type.

func (*Client) InspectUploadWithBody

func (c *Client) InspectUploadWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

InspectUploadWithBody performs a POST /api/v1/uploads/inspect (the `InspectUpload` operationId) request, with any type of body and a specified content type.

func (*Client) ListManifestUploads

func (c *Client) ListManifestUploads(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

ListManifestUploads performs a GET /api/v1/uploads (the `ListManifestUploads` operationId) request.

Reads the server manifest without contacting storage. Results are scoped to the server profile, bucket, and key prefix.

func (*Client) ListStorageUploads

func (c *Client) ListStorageUploads(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

ListStorageUploads performs a GET /api/v1/storage/uploads (the `ListStorageUploads` operationId) request.

Lists marker candidates from one direct storage snapshot.

func (*Client) PlanBulkUpgrade added in v0.8.0

func (c *Client) PlanBulkUpgrade(ctx context.Context, body PlanBulkUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PlanBulkUpgrade performs a POST /api/v1/upgrades/preview (the `PlanBulkUpgrade` operationId) request. Takes a body of the `application/json` content type.

Classifies active server-manifest records without writing.

func (*Client) PlanBulkUpgradeWithBody added in v0.8.0

func (c *Client) PlanBulkUpgradeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PlanBulkUpgradeWithBody performs a POST /api/v1/upgrades/preview (the `PlanBulkUpgrade` operationId) request, with any type of body and a specified content type.

Classifies active server-manifest records without writing.

func (*Client) PlanDocumentUpgrade added in v0.8.0

func (c *Client) PlanDocumentUpgrade(ctx context.Context, body PlanDocumentUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PlanDocumentUpgrade performs a POST /api/v1/upgrades/plan (the `PlanDocumentUpgrade` operationId) request. Takes a body of the `application/json` content type.

Classifies one source-backed Markdown upload without writing.

func (*Client) PlanDocumentUpgradeWithBody added in v0.8.0

func (c *Client) PlanDocumentUpgradeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PlanDocumentUpgradeWithBody performs a POST /api/v1/upgrades/plan (the `PlanDocumentUpgrade` operationId) request, with any type of body and a specified content type.

Classifies one source-backed Markdown upload without writing.

func (*Client) PreviewPurge

func (c *Client) PreviewPurge(ctx context.Context, body PreviewPurgeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PreviewPurge performs a POST /api/v1/purge/preview (the `PreviewPurge` operationId) request. Takes a body of the `application/json` content type.

Plans candidates without deleting anything.

func (*Client) PreviewPurgeWithBody

func (c *Client) PreviewPurgeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PreviewPurgeWithBody performs a POST /api/v1/purge/preview (the `PreviewPurge` operationId) request, with any type of body and a specified content type.

Plans candidates without deleting anything.

func (*Client) ProtectUpload added in v0.7.0

func (c *Client) ProtectUpload(ctx context.Context, body ProtectUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

ProtectUpload performs a POST /api/v1/uploads/protect (the `ProtectUpload` operationId) request. Takes a body of the `application/json` content type.

Marks one marker-managed upload as purge-protected by writing its protection sentinel object. Protecting an already protected upload succeeds and rewrites the sentinel.

func (*Client) ProtectUploadWithBody added in v0.7.0

func (c *Client) ProtectUploadWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

ProtectUploadWithBody performs a POST /api/v1/uploads/protect (the `ProtectUpload` operationId) request, with any type of body and a specified content type.

Marks one marker-managed upload as purge-protected by writing its protection sentinel object. Protecting an already protected upload succeeds and rewrites the sentinel.

func (*Client) SyncManifest

func (c *Client) SyncManifest(ctx context.Context, body SyncManifestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SyncManifest performs a POST /api/v1/sync (the `SyncManifest` operationId) request. Takes a body of the `application/json` content type.

func (*Client) SyncManifestWithBody

func (c *Client) SyncManifestWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SyncManifestWithBody performs a POST /api/v1/sync (the `SyncManifest` operationId) request, with any type of body and a specified content type.

func (*Client) UnprotectUpload added in v0.7.0

func (c *Client) UnprotectUpload(ctx context.Context, body UnprotectUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UnprotectUpload performs a POST /api/v1/uploads/unprotect (the `UnprotectUpload` operationId) request. Takes a body of the `application/json` content type.

Removes purge protection from one marker-managed upload by deleting its protection sentinel object. Unprotecting an unprotected upload succeeds.

func (*Client) UnprotectUploadWithBody added in v0.7.0

func (c *Client) UnprotectUploadWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UnprotectUploadWithBody performs a POST /api/v1/uploads/unprotect (the `UnprotectUpload` operationId) request, with any type of body and a specified content type.

Removes purge protection from one marker-managed upload by deleting its protection sentinel object. Unprotecting an unprotected upload succeeds.

func (*Client) UpdateDocumentWithBody added in v0.8.0

func (c *Client) UpdateDocumentWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateDocumentWithBody performs a POST /api/v1/uploads/documents/update (the `UpdateDocument` operationId) request, with any type of body and a specified content type. Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*Client) UploadCollectionWithBody

func (c *Client) UploadCollectionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UploadCollectionWithBody performs a POST /api/v1/uploads/collections (the `UploadCollection` operationId) request, with any type of body and a specified content type.

func (*Client) UploadDocumentWithBody

func (c *Client) UploadDocumentWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UploadDocumentWithBody performs a POST /api/v1/uploads/documents (the `UploadDocument` operationId) request, with any type of body and a specified content type.

type ClientInterface

type ClientInterface interface {

	// GetCapabilities performs a GET /api/v1/capabilities (the `GetCapabilities` operationId) request.
	GetCapabilities(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExecutePurgeWithBody performs a POST /api/v1/purge (the `ExecutePurge` operationId) request,
	// with any type of body and a specified content type.
	//
	// Permanently deletes the explicit upload IDs after revalidating every
	// ownership marker. Later targets are attempted after an item failure.
	ExecutePurgeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExecutePurge performs a POST /api/v1/purge (the `ExecutePurge` operationId) request.
	// Takes a body of the `application/json` content type.
	//
	// Permanently deletes the explicit upload IDs after revalidating every
	// ownership marker. Later targets are attempted after an item failure.
	ExecutePurge(ctx context.Context, body ExecutePurgeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PreviewPurgeWithBody performs a POST /api/v1/purge/preview (the `PreviewPurge` operationId) request,
	// with any type of body and a specified content type.
	//
	// Plans candidates without deleting anything.
	PreviewPurgeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PreviewPurge performs a POST /api/v1/purge/preview (the `PreviewPurge` operationId) request.
	// Takes a body of the `application/json` content type.
	//
	// Plans candidates without deleting anything.
	PreviewPurge(ctx context.Context, body PreviewPurgeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListStorageUploads performs a GET /api/v1/storage/uploads (the `ListStorageUploads` operationId) request.
	//
	// Lists marker candidates from one direct storage snapshot.
	ListStorageUploads(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SyncManifestWithBody performs a POST /api/v1/sync (the `SyncManifest` operationId) request,
	// with any type of body and a specified content type.
	SyncManifestWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SyncManifest performs a POST /api/v1/sync (the `SyncManifest` operationId) request.
	// Takes a body of the `application/json` content type.
	SyncManifest(ctx context.Context, body SyncManifestJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExecuteBulkUpgradeWithBody performs a POST /api/v1/upgrades (the `ExecuteBulkUpgrade` operationId) request,
	// with any type of body and a specified content type.
	//
	// Applies only the exact upgradeable plans supplied by preview.
	ExecuteBulkUpgradeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExecuteBulkUpgrade performs a POST /api/v1/upgrades (the `ExecuteBulkUpgrade` operationId) request.
	// Takes a body of the `application/json` content type.
	//
	// Applies only the exact upgradeable plans supplied by preview.
	ExecuteBulkUpgrade(ctx context.Context, body ExecuteBulkUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExecuteDocumentUpgradeWithBody performs a POST /api/v1/upgrades/execute (the `ExecuteDocumentUpgrade` operationId) request,
	// with any type of body and a specified content type.
	//
	// Replans live state, then applies a still-upgradeable exact plan after revalidating its ETags.
	ExecuteDocumentUpgradeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ExecuteDocumentUpgrade performs a POST /api/v1/upgrades/execute (the `ExecuteDocumentUpgrade` operationId) request.
	// Takes a body of the `application/json` content type.
	//
	// Replans live state, then applies a still-upgradeable exact plan after revalidating its ETags.
	ExecuteDocumentUpgrade(ctx context.Context, body ExecuteDocumentUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PlanDocumentUpgradeWithBody performs a POST /api/v1/upgrades/plan (the `PlanDocumentUpgrade` operationId) request,
	// with any type of body and a specified content type.
	//
	// Classifies one source-backed Markdown upload without writing.
	PlanDocumentUpgradeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PlanDocumentUpgrade performs a POST /api/v1/upgrades/plan (the `PlanDocumentUpgrade` operationId) request.
	// Takes a body of the `application/json` content type.
	//
	// Classifies one source-backed Markdown upload without writing.
	PlanDocumentUpgrade(ctx context.Context, body PlanDocumentUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PlanBulkUpgradeWithBody performs a POST /api/v1/upgrades/preview (the `PlanBulkUpgrade` operationId) request,
	// with any type of body and a specified content type.
	//
	// Classifies active server-manifest records without writing.
	PlanBulkUpgradeWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PlanBulkUpgrade performs a POST /api/v1/upgrades/preview (the `PlanBulkUpgrade` operationId) request.
	// Takes a body of the `application/json` content type.
	//
	// Classifies active server-manifest records without writing.
	PlanBulkUpgrade(ctx context.Context, body PlanBulkUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListManifestUploads performs a GET /api/v1/uploads (the `ListManifestUploads` operationId) request.
	//
	// Reads the server manifest without contacting storage. Results are
	// scoped to the server profile, bucket, and key prefix.
	ListManifestUploads(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UploadCollectionWithBody performs a POST /api/v1/uploads/collections (the `UploadCollection` operationId) request,
	// with any type of body and a specified content type.
	UploadCollectionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteUploadWithBody performs a POST /api/v1/uploads/delete (the `DeleteUpload` operationId) request,
	// with any type of body and a specified content type.
	//
	// Permanently deletes one marker-managed upload. Payloads are deleted
	// before the ownership marker and the manifest receives a tombstone.
	// A purge-protected upload is refused unless force is true.
	DeleteUploadWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteUpload performs a POST /api/v1/uploads/delete (the `DeleteUpload` operationId) request.
	// Takes a body of the `application/json` content type.
	//
	// Permanently deletes one marker-managed upload. Payloads are deleted
	// before the ownership marker and the manifest receives a tombstone.
	// A purge-protected upload is refused unless force is true.
	DeleteUpload(ctx context.Context, body DeleteUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UploadDocumentWithBody performs a POST /api/v1/uploads/documents (the `UploadDocument` operationId) request,
	// with any type of body and a specified content type.
	UploadDocumentWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateDocumentRevisionWithBody performs a POST /api/v1/uploads/documents/revisions (the `CreateDocumentRevision` operationId) request,
	// with any type of body and a specified content type.
	CreateDocumentRevisionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateDocumentWithBody performs a POST /api/v1/uploads/documents/update (the `UpdateDocument` operationId) request,
	// with any type of body and a specified content type.
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	UpdateDocumentWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetUploadWithBody performs a POST /api/v1/uploads/get (the `GetUpload` operationId) request,
	// with any type of body and a specified content type.
	GetUploadWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetUpload performs a POST /api/v1/uploads/get (the `GetUpload` operationId) request.
	// Takes a body of the `application/json` content type.
	GetUpload(ctx context.Context, body GetUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InspectUploadWithBody performs a POST /api/v1/uploads/inspect (the `InspectUpload` operationId) request,
	// with any type of body and a specified content type.
	InspectUploadWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// InspectUpload performs a POST /api/v1/uploads/inspect (the `InspectUpload` operationId) request.
	// Takes a body of the `application/json` content type.
	InspectUpload(ctx context.Context, body InspectUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ProtectUploadWithBody performs a POST /api/v1/uploads/protect (the `ProtectUpload` operationId) request,
	// with any type of body and a specified content type.
	//
	// Marks one marker-managed upload as purge-protected by writing its
	// protection sentinel object. Protecting an already protected upload
	// succeeds and rewrites the sentinel.
	ProtectUploadWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ProtectUpload performs a POST /api/v1/uploads/protect (the `ProtectUpload` operationId) request.
	// Takes a body of the `application/json` content type.
	//
	// Marks one marker-managed upload as purge-protected by writing its
	// protection sentinel object. Protecting an already protected upload
	// succeeds and rewrites the sentinel.
	ProtectUpload(ctx context.Context, body ProtectUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UnprotectUploadWithBody performs a POST /api/v1/uploads/unprotect (the `UnprotectUpload` operationId) request,
	// with any type of body and a specified content type.
	//
	// Removes purge protection from one marker-managed upload by deleting
	// its protection sentinel object. Unprotecting an unprotected upload
	// succeeds.
	UnprotectUploadWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UnprotectUpload performs a POST /api/v1/uploads/unprotect (the `UnprotectUpload` operationId) request.
	// Takes a body of the `application/json` content type.
	//
	// Removes purge protection from one marker-managed upload by deleting
	// its protection sentinel object. Unprotecting an unprotected upload
	// succeeds.
	UnprotectUpload(ctx context.Context, body UnprotectUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// Health performs a GET /healthz (the `Health` operationId) request.
	Health(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetOpenAPI performs a GET /openapi.yaml (the `GetOpenAPI` operationId) request.
	GetOpenAPI(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CreateDocumentRevisionWithBodyWithResponse added in v0.11.0

func (c *ClientWithResponses) CreateDocumentRevisionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDocumentRevisionResponse, error)

CreateDocumentRevisionWithBodyWithResponse performs a POST /api/v1/uploads/documents/revisions (the `CreateDocumentRevision` operationId) request, with any type of body and a specified content type.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) DeleteUploadWithBodyWithResponse

func (c *ClientWithResponses) DeleteUploadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteUploadResponse, error)

DeleteUploadWithBodyWithResponse performs a POST /api/v1/uploads/delete (the `DeleteUpload` operationId) request, with any type of body and a specified content type.

Permanently deletes one marker-managed upload. Payloads are deleted before the ownership marker and the manifest receives a tombstone. A purge-protected upload is refused unless force is true.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) DeleteUploadWithResponse

func (c *ClientWithResponses) DeleteUploadWithResponse(ctx context.Context, body DeleteUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteUploadResponse, error)

DeleteUploadWithResponse performs a POST /api/v1/uploads/delete (the `DeleteUpload` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Permanently deletes one marker-managed upload. Payloads are deleted before the ownership marker and the manifest receives a tombstone. A purge-protected upload is refused unless force is true.

func (*ClientWithResponses) ExecuteBulkUpgradeWithBodyWithResponse added in v0.8.0

func (c *ClientWithResponses) ExecuteBulkUpgradeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecuteBulkUpgradeResponse, error)

ExecuteBulkUpgradeWithBodyWithResponse performs a POST /api/v1/upgrades (the `ExecuteBulkUpgrade` operationId) request, with any type of body and a specified content type.

Applies only the exact upgradeable plans supplied by preview.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) ExecuteBulkUpgradeWithResponse added in v0.8.0

func (c *ClientWithResponses) ExecuteBulkUpgradeWithResponse(ctx context.Context, body ExecuteBulkUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteBulkUpgradeResponse, error)

ExecuteBulkUpgradeWithResponse performs a POST /api/v1/upgrades (the `ExecuteBulkUpgrade` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Applies only the exact upgradeable plans supplied by preview.

func (*ClientWithResponses) ExecuteDocumentUpgradeWithBodyWithResponse added in v0.8.0

func (c *ClientWithResponses) ExecuteDocumentUpgradeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecuteDocumentUpgradeResponse, error)

ExecuteDocumentUpgradeWithBodyWithResponse performs a POST /api/v1/upgrades/execute (the `ExecuteDocumentUpgrade` operationId) request, with any type of body and a specified content type.

Replans live state, then applies a still-upgradeable exact plan after revalidating its ETags.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) ExecuteDocumentUpgradeWithResponse added in v0.8.0

func (c *ClientWithResponses) ExecuteDocumentUpgradeWithResponse(ctx context.Context, body ExecuteDocumentUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteDocumentUpgradeResponse, error)

ExecuteDocumentUpgradeWithResponse performs a POST /api/v1/upgrades/execute (the `ExecuteDocumentUpgrade` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Replans live state, then applies a still-upgradeable exact plan after revalidating its ETags.

func (*ClientWithResponses) ExecutePurgeWithBodyWithResponse

func (c *ClientWithResponses) ExecutePurgeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecutePurgeResponse, error)

ExecutePurgeWithBodyWithResponse performs a POST /api/v1/purge (the `ExecutePurge` operationId) request, with any type of body and a specified content type.

Permanently deletes the explicit upload IDs after revalidating every ownership marker. Later targets are attempted after an item failure.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) ExecutePurgeWithResponse

func (c *ClientWithResponses) ExecutePurgeWithResponse(ctx context.Context, body ExecutePurgeJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecutePurgeResponse, error)

ExecutePurgeWithResponse performs a POST /api/v1/purge (the `ExecutePurge` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Permanently deletes the explicit upload IDs after revalidating every ownership marker. Later targets are attempted after an item failure.

func (*ClientWithResponses) GetCapabilitiesWithResponse

func (c *ClientWithResponses) GetCapabilitiesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCapabilitiesResponse, error)

GetCapabilitiesWithResponse performs a GET /api/v1/capabilities (the `GetCapabilities` operationId) request.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) GetOpenAPIWithResponse

func (c *ClientWithResponses) GetOpenAPIWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOpenAPIResponse, error)

GetOpenAPIWithResponse performs a GET /openapi.yaml (the `GetOpenAPI` operationId) request.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) GetUploadWithBodyWithResponse

func (c *ClientWithResponses) GetUploadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetUploadResponse, error)

GetUploadWithBodyWithResponse performs a POST /api/v1/uploads/get (the `GetUpload` operationId) request, with any type of body and a specified content type.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) GetUploadWithResponse

func (c *ClientWithResponses) GetUploadWithResponse(ctx context.Context, body GetUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*GetUploadResponse, error)

GetUploadWithResponse performs a POST /api/v1/uploads/get (the `GetUpload` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) HealthWithResponse

func (c *ClientWithResponses) HealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthResponse, error)

HealthWithResponse performs a GET /healthz (the `Health` operationId) request.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) InspectUploadWithBodyWithResponse

func (c *ClientWithResponses) InspectUploadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InspectUploadResponse, error)

InspectUploadWithBodyWithResponse performs a POST /api/v1/uploads/inspect (the `InspectUpload` operationId) request, with any type of body and a specified content type.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) InspectUploadWithResponse

func (c *ClientWithResponses) InspectUploadWithResponse(ctx context.Context, body InspectUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*InspectUploadResponse, error)

InspectUploadWithResponse performs a POST /api/v1/uploads/inspect (the `InspectUpload` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) ListManifestUploadsWithResponse

func (c *ClientWithResponses) ListManifestUploadsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListManifestUploadsResponse, error)

ListManifestUploadsWithResponse performs a GET /api/v1/uploads (the `ListManifestUploads` operationId) request.

Reads the server manifest without contacting storage. Results are scoped to the server profile, bucket, and key prefix.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) ListStorageUploadsWithResponse

func (c *ClientWithResponses) ListStorageUploadsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListStorageUploadsResponse, error)

ListStorageUploadsWithResponse performs a GET /api/v1/storage/uploads (the `ListStorageUploads` operationId) request.

Lists marker candidates from one direct storage snapshot.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) PlanBulkUpgradeWithBodyWithResponse added in v0.8.0

func (c *ClientWithResponses) PlanBulkUpgradeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PlanBulkUpgradeResponse, error)

PlanBulkUpgradeWithBodyWithResponse performs a POST /api/v1/upgrades/preview (the `PlanBulkUpgrade` operationId) request, with any type of body and a specified content type.

Classifies active server-manifest records without writing.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) PlanBulkUpgradeWithResponse added in v0.8.0

func (c *ClientWithResponses) PlanBulkUpgradeWithResponse(ctx context.Context, body PlanBulkUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*PlanBulkUpgradeResponse, error)

PlanBulkUpgradeWithResponse performs a POST /api/v1/upgrades/preview (the `PlanBulkUpgrade` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Classifies active server-manifest records without writing.

func (*ClientWithResponses) PlanDocumentUpgradeWithBodyWithResponse added in v0.8.0

func (c *ClientWithResponses) PlanDocumentUpgradeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PlanDocumentUpgradeResponse, error)

PlanDocumentUpgradeWithBodyWithResponse performs a POST /api/v1/upgrades/plan (the `PlanDocumentUpgrade` operationId) request, with any type of body and a specified content type.

Classifies one source-backed Markdown upload without writing.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) PlanDocumentUpgradeWithResponse added in v0.8.0

func (c *ClientWithResponses) PlanDocumentUpgradeWithResponse(ctx context.Context, body PlanDocumentUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*PlanDocumentUpgradeResponse, error)

PlanDocumentUpgradeWithResponse performs a POST /api/v1/upgrades/plan (the `PlanDocumentUpgrade` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Classifies one source-backed Markdown upload without writing.

func (*ClientWithResponses) PreviewPurgeWithBodyWithResponse

func (c *ClientWithResponses) PreviewPurgeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PreviewPurgeResponse, error)

PreviewPurgeWithBodyWithResponse performs a POST /api/v1/purge/preview (the `PreviewPurge` operationId) request, with any type of body and a specified content type.

Plans candidates without deleting anything.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) PreviewPurgeWithResponse

func (c *ClientWithResponses) PreviewPurgeWithResponse(ctx context.Context, body PreviewPurgeJSONRequestBody, reqEditors ...RequestEditorFn) (*PreviewPurgeResponse, error)

PreviewPurgeWithResponse performs a POST /api/v1/purge/preview (the `PreviewPurge` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Plans candidates without deleting anything.

func (*ClientWithResponses) ProtectUploadWithBodyWithResponse added in v0.7.0

func (c *ClientWithResponses) ProtectUploadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ProtectUploadResponse, error)

ProtectUploadWithBodyWithResponse performs a POST /api/v1/uploads/protect (the `ProtectUpload` operationId) request, with any type of body and a specified content type.

Marks one marker-managed upload as purge-protected by writing its protection sentinel object. Protecting an already protected upload succeeds and rewrites the sentinel.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) ProtectUploadWithResponse added in v0.7.0

func (c *ClientWithResponses) ProtectUploadWithResponse(ctx context.Context, body ProtectUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*ProtectUploadResponse, error)

ProtectUploadWithResponse performs a POST /api/v1/uploads/protect (the `ProtectUpload` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Marks one marker-managed upload as purge-protected by writing its protection sentinel object. Protecting an already protected upload succeeds and rewrites the sentinel.

func (*ClientWithResponses) SyncManifestWithBodyWithResponse

func (c *ClientWithResponses) SyncManifestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SyncManifestResponse, error)

SyncManifestWithBodyWithResponse performs a POST /api/v1/sync (the `SyncManifest` operationId) request, with any type of body and a specified content type.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) SyncManifestWithResponse

func (c *ClientWithResponses) SyncManifestWithResponse(ctx context.Context, body SyncManifestJSONRequestBody, reqEditors ...RequestEditorFn) (*SyncManifestResponse, error)

SyncManifestWithResponse performs a POST /api/v1/sync (the `SyncManifest` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) UnprotectUploadWithBodyWithResponse added in v0.7.0

func (c *ClientWithResponses) UnprotectUploadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UnprotectUploadResponse, error)

UnprotectUploadWithBodyWithResponse performs a POST /api/v1/uploads/unprotect (the `UnprotectUpload` operationId) request, with any type of body and a specified content type.

Removes purge protection from one marker-managed upload by deleting its protection sentinel object. Unprotecting an unprotected upload succeeds.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) UnprotectUploadWithResponse added in v0.7.0

func (c *ClientWithResponses) UnprotectUploadWithResponse(ctx context.Context, body UnprotectUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*UnprotectUploadResponse, error)

UnprotectUploadWithResponse performs a POST /api/v1/uploads/unprotect (the `UnprotectUpload` operationId) request. Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Removes purge protection from one marker-managed upload by deleting its protection sentinel object. Unprotecting an unprotected upload succeeds.

func (*ClientWithResponses) UpdateDocumentWithBodyWithResponse deprecated added in v0.8.0

func (c *ClientWithResponses) UpdateDocumentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDocumentResponse, error)

UpdateDocumentWithBodyWithResponse performs a POST /api/v1/uploads/documents/update (the `UpdateDocument` operationId) request, with any type of body and a specified content type.

Returns a wrapper object for the known response body format(s).

Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set

func (*ClientWithResponses) UploadCollectionWithBodyWithResponse

func (c *ClientWithResponses) UploadCollectionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadCollectionResponse, error)

UploadCollectionWithBodyWithResponse performs a POST /api/v1/uploads/collections (the `UploadCollection` operationId) request, with any type of body and a specified content type.

Returns a wrapper object for the known response body format(s).

func (*ClientWithResponses) UploadDocumentWithBodyWithResponse

func (c *ClientWithResponses) UploadDocumentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadDocumentResponse, error)

UploadDocumentWithBodyWithResponse performs a POST /api/v1/uploads/documents (the `UploadDocument` operationId) request, with any type of body and a specified content type.

Returns a wrapper object for the known response body format(s).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// GetCapabilitiesWithResponse performs a GET /api/v1/capabilities (the `GetCapabilities` operationId) request.
	//
	// Returns a wrapper object for the known response body format(s).
	GetCapabilitiesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCapabilitiesResponse, error)

	// ExecutePurgeWithBodyWithResponse performs a POST /api/v1/purge (the `ExecutePurge` operationId) request,
	// with any type of body and a specified content type.
	//
	// Permanently deletes the explicit upload IDs after revalidating every
	// ownership marker. Later targets are attempted after an item failure.
	//
	// Returns a wrapper object for the known response body format(s).
	ExecutePurgeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecutePurgeResponse, error)

	// ExecutePurgeWithResponse performs a POST /api/v1/purge (the `ExecutePurge` operationId) request.
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Permanently deletes the explicit upload IDs after revalidating every
	// ownership marker. Later targets are attempted after an item failure.
	ExecutePurgeWithResponse(ctx context.Context, body ExecutePurgeJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecutePurgeResponse, error)

	// PreviewPurgeWithBodyWithResponse performs a POST /api/v1/purge/preview (the `PreviewPurge` operationId) request,
	// with any type of body and a specified content type.
	//
	// Plans candidates without deleting anything.
	//
	// Returns a wrapper object for the known response body format(s).
	PreviewPurgeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PreviewPurgeResponse, error)

	// PreviewPurgeWithResponse performs a POST /api/v1/purge/preview (the `PreviewPurge` operationId) request.
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Plans candidates without deleting anything.
	PreviewPurgeWithResponse(ctx context.Context, body PreviewPurgeJSONRequestBody, reqEditors ...RequestEditorFn) (*PreviewPurgeResponse, error)

	// ListStorageUploadsWithResponse performs a GET /api/v1/storage/uploads (the `ListStorageUploads` operationId) request.
	//
	// Lists marker candidates from one direct storage snapshot.
	//
	// Returns a wrapper object for the known response body format(s).
	ListStorageUploadsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListStorageUploadsResponse, error)

	// SyncManifestWithBodyWithResponse performs a POST /api/v1/sync (the `SyncManifest` operationId) request,
	// with any type of body and a specified content type.
	//
	// Returns a wrapper object for the known response body format(s).
	SyncManifestWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SyncManifestResponse, error)

	// SyncManifestWithResponse performs a POST /api/v1/sync (the `SyncManifest` operationId) request.
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	SyncManifestWithResponse(ctx context.Context, body SyncManifestJSONRequestBody, reqEditors ...RequestEditorFn) (*SyncManifestResponse, error)

	// ExecuteBulkUpgradeWithBodyWithResponse performs a POST /api/v1/upgrades (the `ExecuteBulkUpgrade` operationId) request,
	// with any type of body and a specified content type.
	//
	// Applies only the exact upgradeable plans supplied by preview.
	//
	// Returns a wrapper object for the known response body format(s).
	ExecuteBulkUpgradeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecuteBulkUpgradeResponse, error)

	// ExecuteBulkUpgradeWithResponse performs a POST /api/v1/upgrades (the `ExecuteBulkUpgrade` operationId) request.
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Applies only the exact upgradeable plans supplied by preview.
	ExecuteBulkUpgradeWithResponse(ctx context.Context, body ExecuteBulkUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteBulkUpgradeResponse, error)

	// ExecuteDocumentUpgradeWithBodyWithResponse performs a POST /api/v1/upgrades/execute (the `ExecuteDocumentUpgrade` operationId) request,
	// with any type of body and a specified content type.
	//
	// Replans live state, then applies a still-upgradeable exact plan after revalidating its ETags.
	//
	// Returns a wrapper object for the known response body format(s).
	ExecuteDocumentUpgradeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ExecuteDocumentUpgradeResponse, error)

	// ExecuteDocumentUpgradeWithResponse performs a POST /api/v1/upgrades/execute (the `ExecuteDocumentUpgrade` operationId) request.
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Replans live state, then applies a still-upgradeable exact plan after revalidating its ETags.
	ExecuteDocumentUpgradeWithResponse(ctx context.Context, body ExecuteDocumentUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*ExecuteDocumentUpgradeResponse, error)

	// PlanDocumentUpgradeWithBodyWithResponse performs a POST /api/v1/upgrades/plan (the `PlanDocumentUpgrade` operationId) request,
	// with any type of body and a specified content type.
	//
	// Classifies one source-backed Markdown upload without writing.
	//
	// Returns a wrapper object for the known response body format(s).
	PlanDocumentUpgradeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PlanDocumentUpgradeResponse, error)

	// PlanDocumentUpgradeWithResponse performs a POST /api/v1/upgrades/plan (the `PlanDocumentUpgrade` operationId) request.
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Classifies one source-backed Markdown upload without writing.
	PlanDocumentUpgradeWithResponse(ctx context.Context, body PlanDocumentUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*PlanDocumentUpgradeResponse, error)

	// PlanBulkUpgradeWithBodyWithResponse performs a POST /api/v1/upgrades/preview (the `PlanBulkUpgrade` operationId) request,
	// with any type of body and a specified content type.
	//
	// Classifies active server-manifest records without writing.
	//
	// Returns a wrapper object for the known response body format(s).
	PlanBulkUpgradeWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PlanBulkUpgradeResponse, error)

	// PlanBulkUpgradeWithResponse performs a POST /api/v1/upgrades/preview (the `PlanBulkUpgrade` operationId) request.
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Classifies active server-manifest records without writing.
	PlanBulkUpgradeWithResponse(ctx context.Context, body PlanBulkUpgradeJSONRequestBody, reqEditors ...RequestEditorFn) (*PlanBulkUpgradeResponse, error)

	// ListManifestUploadsWithResponse performs a GET /api/v1/uploads (the `ListManifestUploads` operationId) request.
	//
	// Reads the server manifest without contacting storage. Results are
	// scoped to the server profile, bucket, and key prefix.
	//
	// Returns a wrapper object for the known response body format(s).
	ListManifestUploadsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListManifestUploadsResponse, error)

	// UploadCollectionWithBodyWithResponse performs a POST /api/v1/uploads/collections (the `UploadCollection` operationId) request,
	// with any type of body and a specified content type.
	//
	// Returns a wrapper object for the known response body format(s).
	UploadCollectionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadCollectionResponse, error)

	// DeleteUploadWithBodyWithResponse performs a POST /api/v1/uploads/delete (the `DeleteUpload` operationId) request,
	// with any type of body and a specified content type.
	//
	// Permanently deletes one marker-managed upload. Payloads are deleted
	// before the ownership marker and the manifest receives a tombstone.
	// A purge-protected upload is refused unless force is true.
	//
	// Returns a wrapper object for the known response body format(s).
	DeleteUploadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*DeleteUploadResponse, error)

	// DeleteUploadWithResponse performs a POST /api/v1/uploads/delete (the `DeleteUpload` operationId) request.
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Permanently deletes one marker-managed upload. Payloads are deleted
	// before the ownership marker and the manifest receives a tombstone.
	// A purge-protected upload is refused unless force is true.
	DeleteUploadWithResponse(ctx context.Context, body DeleteUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*DeleteUploadResponse, error)

	// UploadDocumentWithBodyWithResponse performs a POST /api/v1/uploads/documents (the `UploadDocument` operationId) request,
	// with any type of body and a specified content type.
	//
	// Returns a wrapper object for the known response body format(s).
	UploadDocumentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UploadDocumentResponse, error)

	// CreateDocumentRevisionWithBodyWithResponse performs a POST /api/v1/uploads/documents/revisions (the `CreateDocumentRevision` operationId) request,
	// with any type of body and a specified content type.
	//
	// Returns a wrapper object for the known response body format(s).
	CreateDocumentRevisionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateDocumentRevisionResponse, error)

	// UpdateDocumentWithBodyWithResponse performs a POST /api/v1/uploads/documents/update (the `UpdateDocument` operationId) request,
	// with any type of body and a specified content type.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	UpdateDocumentWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateDocumentResponse, error)

	// GetUploadWithBodyWithResponse performs a POST /api/v1/uploads/get (the `GetUpload` operationId) request,
	// with any type of body and a specified content type.
	//
	// Returns a wrapper object for the known response body format(s).
	GetUploadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*GetUploadResponse, error)

	// GetUploadWithResponse performs a POST /api/v1/uploads/get (the `GetUpload` operationId) request.
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	GetUploadWithResponse(ctx context.Context, body GetUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*GetUploadResponse, error)

	// InspectUploadWithBodyWithResponse performs a POST /api/v1/uploads/inspect (the `InspectUpload` operationId) request,
	// with any type of body and a specified content type.
	//
	// Returns a wrapper object for the known response body format(s).
	InspectUploadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*InspectUploadResponse, error)

	// InspectUploadWithResponse performs a POST /api/v1/uploads/inspect (the `InspectUpload` operationId) request.
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	InspectUploadWithResponse(ctx context.Context, body InspectUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*InspectUploadResponse, error)

	// ProtectUploadWithBodyWithResponse performs a POST /api/v1/uploads/protect (the `ProtectUpload` operationId) request,
	// with any type of body and a specified content type.
	//
	// Marks one marker-managed upload as purge-protected by writing its
	// protection sentinel object. Protecting an already protected upload
	// succeeds and rewrites the sentinel.
	//
	// Returns a wrapper object for the known response body format(s).
	ProtectUploadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ProtectUploadResponse, error)

	// ProtectUploadWithResponse performs a POST /api/v1/uploads/protect (the `ProtectUpload` operationId) request.
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Marks one marker-managed upload as purge-protected by writing its
	// protection sentinel object. Protecting an already protected upload
	// succeeds and rewrites the sentinel.
	ProtectUploadWithResponse(ctx context.Context, body ProtectUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*ProtectUploadResponse, error)

	// UnprotectUploadWithBodyWithResponse performs a POST /api/v1/uploads/unprotect (the `UnprotectUpload` operationId) request,
	// with any type of body and a specified content type.
	//
	// Removes purge protection from one marker-managed upload by deleting
	// its protection sentinel object. Unprotecting an unprotected upload
	// succeeds.
	//
	// Returns a wrapper object for the known response body format(s).
	UnprotectUploadWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UnprotectUploadResponse, error)

	// UnprotectUploadWithResponse performs a POST /api/v1/uploads/unprotect (the `UnprotectUpload` operationId) request.
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Removes purge protection from one marker-managed upload by deleting
	// its protection sentinel object. Unprotecting an unprotected upload
	// succeeds.
	UnprotectUploadWithResponse(ctx context.Context, body UnprotectUploadJSONRequestBody, reqEditors ...RequestEditorFn) (*UnprotectUploadResponse, error)

	// HealthWithResponse performs a GET /healthz (the `Health` operationId) request.
	//
	// Returns a wrapper object for the known response body format(s).
	HealthWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthResponse, error)

	// GetOpenAPIWithResponse performs a GET /openapi.yaml (the `GetOpenAPI` operationId) request.
	//
	// Returns a wrapper object for the known response body format(s).
	GetOpenAPIWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetOpenAPIResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CollectionMetadata

type CollectionMetadata struct {
	MaxSize       int64  `json:"max_size,omitempty"`
	MaxTotalSize  int64  `json:"max_total_size,omitempty"`
	RepositoryURL string `json:"repository_url,omitempty"`
	Title         string `json:"title,omitempty"`
}

CollectionMetadata defines model for CollectionMetadata.

type CreateDocumentRevision201JSONResponse added in v0.11.0

type CreateDocumentRevision201JSONResponse DocumentRevisionResult

func (CreateDocumentRevision201JSONResponse) VisitCreateDocumentRevisionResponse added in v0.11.0

func (response CreateDocumentRevision201JSONResponse) VisitCreateDocumentRevisionResponse(w http.ResponseWriter) error

type CreateDocumentRevisionMetadata added in v0.11.0

type CreateDocumentRevisionMetadata struct {
	Assets       []DocumentAssetDescriptor            `json:"assets,omitempty"`
	Format       CreateDocumentRevisionMetadataFormat `json:"format,omitempty"`
	Lang         string                               `json:"lang,omitempty"`
	MaxAssetSize int64                                `json:"max_asset_size,omitempty"`
	MaxPageSize  int64                                `json:"max_page_size,omitempty"`
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	MaxSize          int64                    `json:"max_size,omitempty"`
	MaxTotalPageSize int64                    `json:"max_total_page_size,omitempty"`
	MaxTotalSize     int64                    `json:"max_total_size,omitempty"`
	Name             string                   `json:"name,omitempty"`
	Pages            []DocumentPageDescriptor `json:"pages,omitempty"`
	RepositoryURL    string                   `json:"repository_url,omitempty"`
	Slug             string                   `json:"slug,omitempty"`
	Target           string                   `json:"target"`
	Title            string                   `json:"title,omitempty"`
}

CreateDocumentRevisionMetadata defines model for CreateDocumentRevisionMetadata.

type CreateDocumentRevisionMetadataFormat added in v0.11.0

type CreateDocumentRevisionMetadataFormat string

CreateDocumentRevisionMetadataFormat defines model for CreateDocumentRevisionMetadata.Format.

const (
	CreateDocumentRevisionMetadataFormatHTML CreateDocumentRevisionMetadataFormat = "html"
	CreateDocumentRevisionMetadataFormatMd   CreateDocumentRevisionMetadataFormat = "md"
	CreateDocumentRevisionMetadataFormatTxt  CreateDocumentRevisionMetadataFormat = "txt"
)

Defines values for CreateDocumentRevisionMetadataFormat.

func (CreateDocumentRevisionMetadataFormat) Valid added in v0.11.0

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

type CreateDocumentRevisionMultipartBody added in v0.11.0

type CreateDocumentRevisionMultipartBody struct {
	Assets   []openapi_types.File           `json:"assets,omitempty"`
	Document openapi_types.File             `json:"document"`
	Metadata CreateDocumentRevisionMetadata `json:"metadata"`
	Pages    []openapi_types.File           `json:"pages,omitempty"`
}

CreateDocumentRevisionMultipartBody defines parameters for CreateDocumentRevision.

type CreateDocumentRevisionMultipartRequestBody added in v0.11.0

type CreateDocumentRevisionMultipartRequestBody CreateDocumentRevisionMultipartBody

CreateDocumentRevisionMultipartRequestBody defines body for CreateDocumentRevision for multipart/form-data ContentType.

type CreateDocumentRevisionRequestObject added in v0.11.0

type CreateDocumentRevisionRequestObject struct {
	Body *multipart.Reader
}

type CreateDocumentRevisionResponse added in v0.11.0

type CreateDocumentRevisionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *DocumentRevisionResult
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseCreateDocumentRevisionResponse added in v0.11.0

func ParseCreateDocumentRevisionResponse(rsp *http.Response) (*CreateDocumentRevisionResponse, error)

ParseCreateDocumentRevisionResponse parses an HTTP response from a CreateDocumentRevisionWithResponse call

func (CreateDocumentRevisionResponse) ContentType added in v0.11.0

func (r CreateDocumentRevisionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateDocumentRevisionResponse) GetApplicationProblemJSONDefault added in v0.11.0

func (r CreateDocumentRevisionResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (CreateDocumentRevisionResponse) GetBody added in v0.11.0

func (r CreateDocumentRevisionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateDocumentRevisionResponse) GetJSON201 added in v0.11.0

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateDocumentRevisionResponse) Status added in v0.11.0

Status returns HTTPResponse.Status

func (CreateDocumentRevisionResponse) StatusCode added in v0.11.0

func (r CreateDocumentRevisionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateDocumentRevisionResponseObject added in v0.11.0

type CreateDocumentRevisionResponseObject interface {
	VisitCreateDocumentRevisionResponse(w http.ResponseWriter) error
}

type CreateDocumentRevisiondefaultApplicationProblemPlusJSONResponse added in v0.11.0

type CreateDocumentRevisiondefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (CreateDocumentRevisiondefaultApplicationProblemPlusJSONResponse) VisitCreateDocumentRevisionResponse added in v0.11.0

func (response CreateDocumentRevisiondefaultApplicationProblemPlusJSONResponse) VisitCreateDocumentRevisionResponse(w http.ResponseWriter) error

type DeleteRequest added in v0.7.0

type DeleteRequest struct {
	Force    bool   `json:"force,omitempty"`
	URLOrKey string `json:"url_or_key"`
}

DeleteRequest defines model for DeleteRequest.

type DeleteResult

type DeleteResult struct {
	ID        string           `json:"id"`
	Keys      []string         `json:"keys"`
	Kind      DeleteResultKind `json:"kind"`
	MarkerKey string           `json:"marker_key"`
	PageKey   string           `json:"page_key"`
	Warnings  []string         `json:"warnings"`
}

DeleteResult defines model for DeleteResult.

type DeleteResultKind

type DeleteResultKind string

DeleteResultKind defines model for DeleteResult.Kind.

const (
	DeleteResultKindCollection DeleteResultKind = "collection"
	DeleteResultKindDocument   DeleteResultKind = "document"
)

Defines values for DeleteResultKind.

func (DeleteResultKind) Valid

func (e DeleteResultKind) Valid() bool

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

type DeleteUpload200JSONResponse

type DeleteUpload200JSONResponse DeleteResult

func (DeleteUpload200JSONResponse) VisitDeleteUploadResponse

func (response DeleteUpload200JSONResponse) VisitDeleteUploadResponse(w http.ResponseWriter) error

type DeleteUploadJSONRequestBody

type DeleteUploadJSONRequestBody = DeleteRequest

DeleteUploadJSONRequestBody defines body for DeleteUpload for application/json ContentType.

type DeleteUploadRequestObject

type DeleteUploadRequestObject struct {
	Body *DeleteUploadJSONRequestBody
}

type DeleteUploadResponse

type DeleteUploadResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *DeleteResult
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseDeleteUploadResponse

func ParseDeleteUploadResponse(rsp *http.Response) (*DeleteUploadResponse, error)

ParseDeleteUploadResponse parses an HTTP response from a DeleteUploadWithResponse call

func (DeleteUploadResponse) ContentType

func (r DeleteUploadResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteUploadResponse) GetApplicationProblemJSONDefault

func (r DeleteUploadResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (DeleteUploadResponse) GetBody

func (r DeleteUploadResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteUploadResponse) GetJSON200

func (r DeleteUploadResponse) GetJSON200() *DeleteResult

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (DeleteUploadResponse) Status

func (r DeleteUploadResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteUploadResponse) StatusCode

func (r DeleteUploadResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteUploadResponseObject

type DeleteUploadResponseObject interface {
	VisitDeleteUploadResponse(w http.ResponseWriter) error
}

type DeleteUploaddefaultApplicationProblemPlusJSONResponse

type DeleteUploaddefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (DeleteUploaddefaultApplicationProblemPlusJSONResponse) VisitDeleteUploadResponse

type DocumentAssetDescriptor added in v0.11.0

type DocumentAssetDescriptor struct {
	ContentType string `json:"content_type,omitempty"`
	Path        string `json:"path"`
	Size        int64  `json:"size"`
}

DocumentAssetDescriptor defines model for DocumentAssetDescriptor.

type DocumentBundleCapabilities added in v0.11.0

type DocumentBundleCapabilities struct {
	Assets                 bool  `json:"assets"`
	CanonicalRevisionRoute bool  `json:"canonical_revision_route"`
	ManagedPages           bool  `json:"managed_pages"`
	MaxAssetBytes          int64 `json:"max_asset_bytes"`
	MaxGeneratedPageBytes  int64 `json:"max_generated_page_bytes"`
	MaxItems               int   `json:"max_items"`
	MaxMetadataBytes       int64 `json:"max_metadata_bytes"`
	MaxPageBytes           int64 `json:"max_page_bytes"`
	MaxRequestBytes        int64 `json:"max_request_bytes"`
	MaxTotalAssetBytes     int64 `json:"max_total_asset_bytes"`
	MaxTotalPageBytes      int64 `json:"max_total_page_bytes"`
}

DocumentBundleCapabilities defines model for DocumentBundleCapabilities.

type DocumentMetadata

type DocumentMetadata struct {
	Assets       []DocumentAssetDescriptor `json:"assets,omitempty"`
	Format       DocumentMetadataFormat    `json:"format,omitempty"`
	Lang         string                    `json:"lang,omitempty"`
	MaxAssetSize int64                     `json:"max_asset_size,omitempty"`
	MaxPageSize  int64                     `json:"max_page_size,omitempty"`
	// Deprecated: this property has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	MaxSize          int64                    `json:"max_size,omitempty"`
	MaxTotalPageSize int64                    `json:"max_total_page_size,omitempty"`
	MaxTotalSize     int64                    `json:"max_total_size,omitempty"`
	Name             string                   `json:"name,omitempty"`
	Pages            []DocumentPageDescriptor `json:"pages,omitempty"`
	RepositoryURL    string                   `json:"repository_url,omitempty"`
	Slug             string                   `json:"slug,omitempty"`
	Title            string                   `json:"title,omitempty"`
}

DocumentMetadata defines model for DocumentMetadata.

type DocumentMetadataFormat

type DocumentMetadataFormat string

DocumentMetadataFormat defines model for DocumentMetadata.Format.

const (
	DocumentMetadataFormatHTML DocumentMetadataFormat = "html"
	DocumentMetadataFormatMd   DocumentMetadataFormat = "md"
	DocumentMetadataFormatTxt  DocumentMetadataFormat = "txt"
)

Defines values for DocumentMetadataFormat.

func (DocumentMetadataFormat) Valid

func (e DocumentMetadataFormat) Valid() bool

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

type DocumentPageDescriptor added in v0.11.0

type DocumentPageDescriptor struct {
	Format DocumentPageDescriptorFormat `json:"format,omitempty"`
	Lang   string                       `json:"lang,omitempty"`
	Path   string                       `json:"path"`
	Title  string                       `json:"title,omitempty"`
}

DocumentPageDescriptor defines model for DocumentPageDescriptor.

type DocumentPageDescriptorFormat added in v0.11.0

type DocumentPageDescriptorFormat string

DocumentPageDescriptorFormat defines model for DocumentPageDescriptor.Format.

const (
	DocumentPageDescriptorFormatMd  DocumentPageDescriptorFormat = "md"
	DocumentPageDescriptorFormatTxt DocumentPageDescriptorFormat = "txt"
)

Defines values for DocumentPageDescriptorFormat.

func (DocumentPageDescriptorFormat) Valid added in v0.11.0

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

type DocumentRevisionResult added in v0.11.0

type DocumentRevisionResult struct {
	Assets          []AssetResult              `json:"assets,omitempty"`
	Bucket          string                     `json:"bucket"`
	Bytes           int64                      `json:"bytes"`
	ContentType     string                     `json:"content_type"`
	CreatedAt       time.Time                  `json:"created_at"`
	DiffURL         string                     `json:"diff_url,omitempty"`
	Files           []FileResult               `json:"files,omitempty"`
	Format          string                     `json:"format,omitempty"`
	ID              string                     `json:"id"`
	Key             string                     `json:"key"`
	Kind            DocumentRevisionResultKind `json:"kind"`
	LatestRevision  int                        `json:"latest_revision,omitempty"`
	MarkerKey       string                     `json:"marker_key"`
	MarkerVersion   int                        `json:"marker_version"`
	Pages           []PageResult               `json:"pages,omitempty"`
	PreviousURL     string                     `json:"previous_url,omitempty"`
	RepositoryURL   string                     `json:"repository_url,omitempty"`
	Revision        int                        `json:"revision,omitempty"`
	RevisionChainID string                     `json:"revision_chain_id,omitempty"`
	Slug            string                     `json:"slug,omitempty"`
	SourceKey       string                     `json:"source_key,omitempty"`
	SourceURL       string                     `json:"source_url,omitempty"`
	Title           string                     `json:"title,omitempty"`
	Unchanged       bool                       `json:"unchanged"`
	URL             string                     `json:"url"`
	Warnings        []string                   `json:"warnings"`
}

DocumentRevisionResult defines model for DocumentRevisionResult.

type DocumentRevisionResultKind added in v0.11.0

type DocumentRevisionResultKind string

DocumentRevisionResultKind defines model for DocumentRevisionResult.Kind.

const (
	DocumentRevisionResultKindCollection DocumentRevisionResultKind = "collection"
	DocumentRevisionResultKindDocument   DocumentRevisionResultKind = "document"
)

Defines values for DocumentRevisionResultKind.

func (DocumentRevisionResultKind) Valid added in v0.11.0

func (e DocumentRevisionResultKind) Valid() bool

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

type ExecuteBulkUpgrade200JSONResponse added in v0.8.0

type ExecuteBulkUpgrade200JSONResponse BulkUpgradeResult

func (ExecuteBulkUpgrade200JSONResponse) VisitExecuteBulkUpgradeResponse added in v0.8.0

func (response ExecuteBulkUpgrade200JSONResponse) VisitExecuteBulkUpgradeResponse(w http.ResponseWriter) error

type ExecuteBulkUpgradeJSONRequestBody added in v0.8.0

type ExecuteBulkUpgradeJSONRequestBody = BulkUpgradeRequest

ExecuteBulkUpgradeJSONRequestBody defines body for ExecuteBulkUpgrade for application/json ContentType.

type ExecuteBulkUpgradeRequestObject added in v0.8.0

type ExecuteBulkUpgradeRequestObject struct {
	Body *ExecuteBulkUpgradeJSONRequestBody
}

type ExecuteBulkUpgradeResponse added in v0.8.0

type ExecuteBulkUpgradeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *BulkUpgradeResult
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseExecuteBulkUpgradeResponse added in v0.8.0

func ParseExecuteBulkUpgradeResponse(rsp *http.Response) (*ExecuteBulkUpgradeResponse, error)

ParseExecuteBulkUpgradeResponse parses an HTTP response from a ExecuteBulkUpgradeWithResponse call

func (ExecuteBulkUpgradeResponse) ContentType added in v0.8.0

func (r ExecuteBulkUpgradeResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ExecuteBulkUpgradeResponse) GetApplicationProblemJSONDefault added in v0.8.0

func (r ExecuteBulkUpgradeResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ExecuteBulkUpgradeResponse) GetBody added in v0.8.0

func (r ExecuteBulkUpgradeResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ExecuteBulkUpgradeResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ExecuteBulkUpgradeResponse) Status added in v0.8.0

Status returns HTTPResponse.Status

func (ExecuteBulkUpgradeResponse) StatusCode added in v0.8.0

func (r ExecuteBulkUpgradeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ExecuteBulkUpgradeResponseObject added in v0.8.0

type ExecuteBulkUpgradeResponseObject interface {
	VisitExecuteBulkUpgradeResponse(w http.ResponseWriter) error
}

type ExecuteBulkUpgradedefaultApplicationProblemPlusJSONResponse added in v0.8.0

type ExecuteBulkUpgradedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (ExecuteBulkUpgradedefaultApplicationProblemPlusJSONResponse) VisitExecuteBulkUpgradeResponse added in v0.8.0

func (response ExecuteBulkUpgradedefaultApplicationProblemPlusJSONResponse) VisitExecuteBulkUpgradeResponse(w http.ResponseWriter) error

type ExecuteDocumentUpgrade200JSONResponse added in v0.8.0

type ExecuteDocumentUpgrade200JSONResponse UpgradeDocumentResult

func (ExecuteDocumentUpgrade200JSONResponse) VisitExecuteDocumentUpgradeResponse added in v0.8.0

func (response ExecuteDocumentUpgrade200JSONResponse) VisitExecuteDocumentUpgradeResponse(w http.ResponseWriter) error

type ExecuteDocumentUpgradeJSONRequestBody added in v0.8.0

type ExecuteDocumentUpgradeJSONRequestBody = UpgradeDocumentPlan

ExecuteDocumentUpgradeJSONRequestBody defines body for ExecuteDocumentUpgrade for application/json ContentType.

type ExecuteDocumentUpgradeRequestObject added in v0.8.0

type ExecuteDocumentUpgradeRequestObject struct {
	Body *ExecuteDocumentUpgradeJSONRequestBody
}

type ExecuteDocumentUpgradeResponse added in v0.8.0

type ExecuteDocumentUpgradeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *UpgradeDocumentResult
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseExecuteDocumentUpgradeResponse added in v0.8.0

func ParseExecuteDocumentUpgradeResponse(rsp *http.Response) (*ExecuteDocumentUpgradeResponse, error)

ParseExecuteDocumentUpgradeResponse parses an HTTP response from a ExecuteDocumentUpgradeWithResponse call

func (ExecuteDocumentUpgradeResponse) ContentType added in v0.8.0

func (r ExecuteDocumentUpgradeResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ExecuteDocumentUpgradeResponse) GetApplicationProblemJSONDefault added in v0.8.0

func (r ExecuteDocumentUpgradeResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ExecuteDocumentUpgradeResponse) GetBody added in v0.8.0

func (r ExecuteDocumentUpgradeResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ExecuteDocumentUpgradeResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ExecuteDocumentUpgradeResponse) Status added in v0.8.0

Status returns HTTPResponse.Status

func (ExecuteDocumentUpgradeResponse) StatusCode added in v0.8.0

func (r ExecuteDocumentUpgradeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ExecuteDocumentUpgradeResponseObject added in v0.8.0

type ExecuteDocumentUpgradeResponseObject interface {
	VisitExecuteDocumentUpgradeResponse(w http.ResponseWriter) error
}

type ExecuteDocumentUpgradedefaultApplicationProblemPlusJSONResponse added in v0.8.0

type ExecuteDocumentUpgradedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (ExecuteDocumentUpgradedefaultApplicationProblemPlusJSONResponse) VisitExecuteDocumentUpgradeResponse added in v0.8.0

func (response ExecuteDocumentUpgradedefaultApplicationProblemPlusJSONResponse) VisitExecuteDocumentUpgradeResponse(w http.ResponseWriter) error

type ExecutePurge200JSONResponse

type ExecutePurge200JSONResponse PurgeResult

func (ExecutePurge200JSONResponse) VisitExecutePurgeResponse

func (response ExecutePurge200JSONResponse) VisitExecutePurgeResponse(w http.ResponseWriter) error

type ExecutePurgeJSONRequestBody

type ExecutePurgeJSONRequestBody = PurgeRequest

ExecutePurgeJSONRequestBody defines body for ExecutePurge for application/json ContentType.

type ExecutePurgeRequestObject

type ExecutePurgeRequestObject struct {
	Body *ExecutePurgeJSONRequestBody
}

type ExecutePurgeResponse

type ExecutePurgeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PurgeResult
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseExecutePurgeResponse

func ParseExecutePurgeResponse(rsp *http.Response) (*ExecutePurgeResponse, error)

ParseExecutePurgeResponse parses an HTTP response from a ExecutePurgeWithResponse call

func (ExecutePurgeResponse) ContentType

func (r ExecutePurgeResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ExecutePurgeResponse) GetApplicationProblemJSONDefault

func (r ExecutePurgeResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ExecutePurgeResponse) GetBody

func (r ExecutePurgeResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ExecutePurgeResponse) GetJSON200

func (r ExecutePurgeResponse) GetJSON200() *PurgeResult

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ExecutePurgeResponse) Status

func (r ExecutePurgeResponse) Status() string

Status returns HTTPResponse.Status

func (ExecutePurgeResponse) StatusCode

func (r ExecutePurgeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ExecutePurgeResponseObject

type ExecutePurgeResponseObject interface {
	VisitExecutePurgeResponse(w http.ResponseWriter) error
}

type ExecutePurgedefaultApplicationProblemPlusJSONResponse

type ExecutePurgedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (ExecutePurgedefaultApplicationProblemPlusJSONResponse) VisitExecutePurgeResponse

type FileResult

type FileResult struct {
	Bytes       int64  `json:"bytes"`
	ContentType string `json:"content_type"`
	Key         string `json:"key"`
	Name        string `json:"name"`
	URL         string `json:"url"`
}

FileResult defines model for FileResult.

type GetCapabilities200JSONResponse

type GetCapabilities200JSONResponse Capabilities

func (GetCapabilities200JSONResponse) VisitGetCapabilitiesResponse

func (response GetCapabilities200JSONResponse) VisitGetCapabilitiesResponse(w http.ResponseWriter) error

type GetCapabilitiesRequestObject

type GetCapabilitiesRequestObject struct {
}

type GetCapabilitiesResponse

type GetCapabilitiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Capabilities
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseGetCapabilitiesResponse

func ParseGetCapabilitiesResponse(rsp *http.Response) (*GetCapabilitiesResponse, error)

ParseGetCapabilitiesResponse parses an HTTP response from a GetCapabilitiesWithResponse call

func (GetCapabilitiesResponse) ContentType

func (r GetCapabilitiesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetCapabilitiesResponse) GetApplicationProblemJSONDefault

func (r GetCapabilitiesResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (GetCapabilitiesResponse) GetBody

func (r GetCapabilitiesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetCapabilitiesResponse) GetJSON200

func (r GetCapabilitiesResponse) GetJSON200() *Capabilities

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetCapabilitiesResponse) Status

func (r GetCapabilitiesResponse) Status() string

Status returns HTTPResponse.Status

func (GetCapabilitiesResponse) StatusCode

func (r GetCapabilitiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCapabilitiesResponseObject

type GetCapabilitiesResponseObject interface {
	VisitGetCapabilitiesResponse(w http.ResponseWriter) error
}

type GetCapabilitiesdefaultApplicationProblemPlusJSONResponse

type GetCapabilitiesdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (GetCapabilitiesdefaultApplicationProblemPlusJSONResponse) VisitGetCapabilitiesResponse

func (response GetCapabilitiesdefaultApplicationProblemPlusJSONResponse) VisitGetCapabilitiesResponse(w http.ResponseWriter) error

type GetOpenAPI200ApplicationYamlResponse

type GetOpenAPI200ApplicationYamlResponse struct {
	Body          io.Reader
	ContentLength int64
}

func (GetOpenAPI200ApplicationYamlResponse) VisitGetOpenAPIResponse

func (response GetOpenAPI200ApplicationYamlResponse) VisitGetOpenAPIResponse(w http.ResponseWriter) error

type GetOpenAPIRequestObject

type GetOpenAPIRequestObject struct {
}

type GetOpenAPIResponse

type GetOpenAPIResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// YAML200 the response for an HTTP 200 `application/yaml` response
	YAML200 *string
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseGetOpenAPIResponse

func ParseGetOpenAPIResponse(rsp *http.Response) (*GetOpenAPIResponse, error)

ParseGetOpenAPIResponse parses an HTTP response from a GetOpenAPIWithResponse call

func (GetOpenAPIResponse) ContentType

func (r GetOpenAPIResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetOpenAPIResponse) GetApplicationProblemJSONDefault

func (r GetOpenAPIResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (GetOpenAPIResponse) GetBody

func (r GetOpenAPIResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetOpenAPIResponse) GetYAML200

func (r GetOpenAPIResponse) GetYAML200() *string

GetYAML200 returns the response for an HTTP 200 `application/yaml` response

func (GetOpenAPIResponse) Status

func (r GetOpenAPIResponse) Status() string

Status returns HTTPResponse.Status

func (GetOpenAPIResponse) StatusCode

func (r GetOpenAPIResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetOpenAPIResponseObject

type GetOpenAPIResponseObject interface {
	VisitGetOpenAPIResponse(w http.ResponseWriter) error
}

type GetOpenAPIdefaultApplicationProblemPlusJSONResponse

type GetOpenAPIdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (GetOpenAPIdefaultApplicationProblemPlusJSONResponse) VisitGetOpenAPIResponse

type GetUpload200ApplicationOctetStreamResponse

type GetUpload200ApplicationOctetStreamResponse struct {
	Body          io.Reader
	Headers       GetUpload200ResponseHeaders
	ContentLength int64
}

func (GetUpload200ApplicationOctetStreamResponse) VisitGetUploadResponse

func (response GetUpload200ApplicationOctetStreamResponse) VisitGetUploadResponse(w http.ResponseWriter) error

type GetUpload200ResponseHeaders

type GetUpload200ResponseHeaders struct {
	ContentDisposition string
	ContentType        string
	XAirplanObjectKey  string
}

type GetUploadJSONRequestBody

type GetUploadJSONRequestBody = GetUploadRequest

GetUploadJSONRequestBody defines body for GetUpload for application/json ContentType.

type GetUploadRequest

type GetUploadRequest struct {
	Asset    string `json:"asset,omitempty"`
	Diff     bool   `json:"diff,omitempty"`
	Page     string `json:"page,omitempty"`
	Source   bool   `json:"source,omitempty"`
	URLOrKey string `json:"url_or_key"`
}

GetUploadRequest defines model for GetUploadRequest.

type GetUploadRequestObject

type GetUploadRequestObject struct {
	Body *GetUploadJSONRequestBody
}

type GetUploadResponse

type GetUploadResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetUploadResponse200Headers
}

func ParseGetUploadResponse

func ParseGetUploadResponse(rsp *http.Response) (*GetUploadResponse, error)

ParseGetUploadResponse parses an HTTP response from a GetUploadWithResponse call

func (GetUploadResponse) ContentType

func (r GetUploadResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetUploadResponse) GetApplicationProblemJSONDefault

func (r GetUploadResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (GetUploadResponse) GetBody

func (r GetUploadResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetUploadResponse) Status

func (r GetUploadResponse) Status() string

Status returns HTTPResponse.Status

func (GetUploadResponse) StatusCode

func (r GetUploadResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetUploadResponse200Headers

type GetUploadResponse200Headers struct {
	ContentDisposition string
	ContentType        string
	XAirplanObjectKey  string
}

GetUploadResponse200Headers the declared response headers of an HTTP 200 response for GetUpload

type GetUploadResponseObject

type GetUploadResponseObject interface {
	VisitGetUploadResponse(w http.ResponseWriter) error
}

type GetUploaddefaultApplicationProblemPlusJSONResponse

type GetUploaddefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (GetUploaddefaultApplicationProblemPlusJSONResponse) VisitGetUploadResponse

type Health

type Health struct {
	Status HealthStatus `json:"status"`
}

Health defines model for Health.

type Health200JSONResponse

type Health200JSONResponse Health

func (Health200JSONResponse) VisitHealthResponse

func (response Health200JSONResponse) VisitHealthResponse(w http.ResponseWriter) error

type HealthRequestObject

type HealthRequestObject struct {
}

type HealthResponse

type HealthResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Health
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseHealthResponse

func ParseHealthResponse(rsp *http.Response) (*HealthResponse, error)

ParseHealthResponse parses an HTTP response from a HealthWithResponse call

func (HealthResponse) ContentType

func (r HealthResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (HealthResponse) GetApplicationProblemJSONDefault

func (r HealthResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (HealthResponse) GetBody

func (r HealthResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (HealthResponse) GetJSON200

func (r HealthResponse) GetJSON200() *Health

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (HealthResponse) Status

func (r HealthResponse) Status() string

Status returns HTTPResponse.Status

func (HealthResponse) StatusCode

func (r HealthResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HealthResponseObject

type HealthResponseObject interface {
	VisitHealthResponse(w http.ResponseWriter) error
}

type HealthStatus

type HealthStatus string

HealthStatus defines model for Health.Status.

const (
	Ok HealthStatus = "ok"
)

Defines values for HealthStatus.

func (HealthStatus) Valid

func (e HealthStatus) Valid() bool

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

type HealthdefaultApplicationProblemPlusJSONResponse

type HealthdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (HealthdefaultApplicationProblemPlusJSONResponse) VisitHealthResponse

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type InspectUpload200JSONResponse

type InspectUpload200JSONResponse UploadInspection

func (InspectUpload200JSONResponse) VisitInspectUploadResponse

func (response InspectUpload200JSONResponse) VisitInspectUploadResponse(w http.ResponseWriter) error

type InspectUploadJSONRequestBody

type InspectUploadJSONRequestBody = TargetRequest

InspectUploadJSONRequestBody defines body for InspectUpload for application/json ContentType.

type InspectUploadRequestObject

type InspectUploadRequestObject struct {
	Body *InspectUploadJSONRequestBody
}

type InspectUploadResponse

type InspectUploadResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *UploadInspection
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseInspectUploadResponse

func ParseInspectUploadResponse(rsp *http.Response) (*InspectUploadResponse, error)

ParseInspectUploadResponse parses an HTTP response from a InspectUploadWithResponse call

func (InspectUploadResponse) ContentType

func (r InspectUploadResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (InspectUploadResponse) GetApplicationProblemJSONDefault

func (r InspectUploadResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (InspectUploadResponse) GetBody

func (r InspectUploadResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (InspectUploadResponse) GetJSON200

func (r InspectUploadResponse) GetJSON200() *UploadInspection

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (InspectUploadResponse) Status

func (r InspectUploadResponse) Status() string

Status returns HTTPResponse.Status

func (InspectUploadResponse) StatusCode

func (r InspectUploadResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type InspectUploadResponseObject

type InspectUploadResponseObject interface {
	VisitInspectUploadResponse(w http.ResponseWriter) error
}

type InspectUploaddefaultApplicationProblemPlusJSONResponse

type InspectUploaddefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (InspectUploaddefaultApplicationProblemPlusJSONResponse) VisitInspectUploadResponse

type InspectedObject

type InspectedObject struct {
	Bytes          int64               `json:"bytes"`
	Exists         bool                `json:"exists"`
	ExpectedBytes  int64               `json:"expected_bytes"`
	ExpectedKnown  bool                `json:"expected_known"`
	ExpectedSha256 string              `json:"expected_sha256"`
	Key            string              `json:"key"`
	Name           string              `json:"name"`
	Role           InspectedObjectRole `json:"role"`
	Sha256         string              `json:"sha256"`
	URL            string              `json:"url,omitempty"`
}

InspectedObject defines model for InspectedObject.

type InspectedObjectRole added in v0.11.0

type InspectedObjectRole string

InspectedObjectRole defines model for InspectedObject.Role.

const (
	Asset  InspectedObjectRole = "asset"
	Diff   InspectedObjectRole = "diff"
	File   InspectedObjectRole = "file"
	Page   InspectedObjectRole = "page"
	Source InspectedObjectRole = "source"
)

Defines values for InspectedObjectRole.

func (InspectedObjectRole) Valid added in v0.11.0

func (e InspectedObjectRole) Valid() bool

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

type InspectedPage added in v0.11.0

type InspectedPage struct {
	Format string           `json:"format"`
	Lang   string           `json:"lang"`
	Page   InspectedObject  `json:"page"`
	Path   string           `json:"path"`
	Source *InspectedObject `json:"source,omitempty"`
	Title  string           `json:"title,omitempty"`
}

InspectedPage defines model for InspectedPage.

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 ListManifestUploads200JSONResponse

type ListManifestUploads200JSONResponse ManifestList

func (ListManifestUploads200JSONResponse) VisitListManifestUploadsResponse

func (response ListManifestUploads200JSONResponse) VisitListManifestUploadsResponse(w http.ResponseWriter) error

type ListManifestUploadsRequestObject

type ListManifestUploadsRequestObject struct {
}

type ListManifestUploadsResponse

type ListManifestUploadsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ManifestList
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseListManifestUploadsResponse

func ParseListManifestUploadsResponse(rsp *http.Response) (*ListManifestUploadsResponse, error)

ParseListManifestUploadsResponse parses an HTTP response from a ListManifestUploadsWithResponse call

func (ListManifestUploadsResponse) ContentType

func (r ListManifestUploadsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListManifestUploadsResponse) GetApplicationProblemJSONDefault

func (r ListManifestUploadsResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ListManifestUploadsResponse) GetBody

func (r ListManifestUploadsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListManifestUploadsResponse) GetJSON200

func (r ListManifestUploadsResponse) GetJSON200() *ManifestList

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListManifestUploadsResponse) Status

Status returns HTTPResponse.Status

func (ListManifestUploadsResponse) StatusCode

func (r ListManifestUploadsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListManifestUploadsResponseObject

type ListManifestUploadsResponseObject interface {
	VisitListManifestUploadsResponse(w http.ResponseWriter) error
}

type ListManifestUploadsdefaultApplicationProblemPlusJSONResponse

type ListManifestUploadsdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (ListManifestUploadsdefaultApplicationProblemPlusJSONResponse) VisitListManifestUploadsResponse

func (response ListManifestUploadsdefaultApplicationProblemPlusJSONResponse) VisitListManifestUploadsResponse(w http.ResponseWriter) error

type ListStorageUploads200JSONResponse

type ListStorageUploads200JSONResponse StorageList

func (ListStorageUploads200JSONResponse) VisitListStorageUploadsResponse

func (response ListStorageUploads200JSONResponse) VisitListStorageUploadsResponse(w http.ResponseWriter) error

type ListStorageUploadsRequestObject

type ListStorageUploadsRequestObject struct {
}

type ListStorageUploadsResponse

type ListStorageUploadsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *StorageList
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseListStorageUploadsResponse

func ParseListStorageUploadsResponse(rsp *http.Response) (*ListStorageUploadsResponse, error)

ParseListStorageUploadsResponse parses an HTTP response from a ListStorageUploadsWithResponse call

func (ListStorageUploadsResponse) ContentType

func (r ListStorageUploadsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListStorageUploadsResponse) GetApplicationProblemJSONDefault

func (r ListStorageUploadsResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ListStorageUploadsResponse) GetBody

func (r ListStorageUploadsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListStorageUploadsResponse) GetJSON200

func (r ListStorageUploadsResponse) GetJSON200() *StorageList

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListStorageUploadsResponse) Status

Status returns HTTPResponse.Status

func (ListStorageUploadsResponse) StatusCode

func (r ListStorageUploadsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListStorageUploadsResponseObject

type ListStorageUploadsResponseObject interface {
	VisitListStorageUploadsResponse(w http.ResponseWriter) error
}

type ListStorageUploadsdefaultApplicationProblemPlusJSONResponse

type ListStorageUploadsdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (ListStorageUploadsdefaultApplicationProblemPlusJSONResponse) VisitListStorageUploadsResponse

func (response ListStorageUploadsdefaultApplicationProblemPlusJSONResponse) VisitListStorageUploadsResponse(w http.ResponseWriter) error

type ManifestList

type ManifestList struct {
	Records  []ManifestRecord `json:"records"`
	Warnings []string         `json:"warnings"`
}

ManifestList defines model for ManifestList.

type ManifestRecord

type ManifestRecord struct {
	Bucket          string             `json:"bucket,omitempty"`
	Bytes           int64              `json:"bytes,omitempty"`
	CreatedAt       *time.Time         `json:"created_at,omitempty"`
	Format          string             `json:"format,omitempty"`
	Key             string             `json:"key"`
	Kind            ManifestRecordKind `json:"kind,omitempty"`
	LatestRevision  int                `json:"latest_revision,omitempty"`
	MarkerKey       string             `json:"marker_key,omitempty"`
	MarkerVersion   int                `json:"marker_version,omitempty"`
	Objects         int                `json:"objects,omitempty"`
	ProducerVersion string             `json:"producer_version,omitempty"`
	ProtectReason   string             `json:"protect_reason,omitempty"`
	Protected       bool               `json:"protected,omitempty"`
	ProtectedAt     *time.Time         `json:"protected_at,omitempty"`
	Reason          string             `json:"reason,omitempty"`
	RendererVersion int                `json:"renderer_version,omitempty"`
	RepositoryURL   string             `json:"repository_url,omitempty"`
	Revision        int                `json:"revision,omitempty"`
	RevisionChainID string             `json:"revision_chain_id,omitempty"`
	Slug            string             `json:"slug,omitempty"`
	SourceKey       string             `json:"source_key,omitempty"`
	Time            time.Time          `json:"time"`
	Title           string             `json:"title,omitempty"`
	TotalBytes      int64              `json:"total_bytes,omitempty"`
	Type            ManifestRecordType `json:"type"`
	URL             string             `json:"url,omitempty"`
}

ManifestRecord defines model for ManifestRecord.

type ManifestRecordKind

type ManifestRecordKind string

ManifestRecordKind defines model for ManifestRecord.Kind.

const (
	ManifestRecordKindCollection ManifestRecordKind = "collection"
	ManifestRecordKindDocument   ManifestRecordKind = "document"
)

Defines values for ManifestRecordKind.

func (ManifestRecordKind) Valid

func (e ManifestRecordKind) Valid() bool

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

type ManifestRecordType

type ManifestRecordType string

ManifestRecordType defines model for ManifestRecord.Type.

const (
	Delete    ManifestRecordType = "delete"
	Link      ManifestRecordType = "link"
	Protect   ManifestRecordType = "protect"
	Unprotect ManifestRecordType = "unprotect"
	Upgrade   ManifestRecordType = "upgrade"
	Upload    ManifestRecordType = "upload"
)

Defines values for ManifestRecordType.

func (ManifestRecordType) Valid

func (e ManifestRecordType) Valid() bool

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

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

type PageResult added in v0.11.0

type PageResult struct {
	Bytes       int64  `json:"bytes"`
	Format      string `json:"format"`
	Key         string `json:"key"`
	Path        string `json:"path"`
	SourceBytes int64  `json:"source_bytes,omitempty"`
	SourceKey   string `json:"source_key,omitempty"`
	SourceURL   string `json:"source_url,omitempty"`
	Title       string `json:"title,omitempty"`
	URL         string `json:"url"`
}

PageResult defines model for PageResult.

type PlanBulkUpgrade200JSONResponse added in v0.8.0

type PlanBulkUpgrade200JSONResponse BulkUpgradePlan

func (PlanBulkUpgrade200JSONResponse) VisitPlanBulkUpgradeResponse added in v0.8.0

func (response PlanBulkUpgrade200JSONResponse) VisitPlanBulkUpgradeResponse(w http.ResponseWriter) error

type PlanBulkUpgradeJSONRequestBody added in v0.8.0

type PlanBulkUpgradeJSONRequestBody = BulkUpgradeOptions

PlanBulkUpgradeJSONRequestBody defines body for PlanBulkUpgrade for application/json ContentType.

type PlanBulkUpgradeRequestObject added in v0.8.0

type PlanBulkUpgradeRequestObject struct {
	Body *PlanBulkUpgradeJSONRequestBody
}

type PlanBulkUpgradeResponse added in v0.8.0

type PlanBulkUpgradeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *BulkUpgradePlan
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParsePlanBulkUpgradeResponse added in v0.8.0

func ParsePlanBulkUpgradeResponse(rsp *http.Response) (*PlanBulkUpgradeResponse, error)

ParsePlanBulkUpgradeResponse parses an HTTP response from a PlanBulkUpgradeWithResponse call

func (PlanBulkUpgradeResponse) ContentType added in v0.8.0

func (r PlanBulkUpgradeResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PlanBulkUpgradeResponse) GetApplicationProblemJSONDefault added in v0.8.0

func (r PlanBulkUpgradeResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (PlanBulkUpgradeResponse) GetBody added in v0.8.0

func (r PlanBulkUpgradeResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PlanBulkUpgradeResponse) GetJSON200 added in v0.8.0

func (r PlanBulkUpgradeResponse) GetJSON200() *BulkUpgradePlan

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PlanBulkUpgradeResponse) Status added in v0.8.0

func (r PlanBulkUpgradeResponse) Status() string

Status returns HTTPResponse.Status

func (PlanBulkUpgradeResponse) StatusCode added in v0.8.0

func (r PlanBulkUpgradeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PlanBulkUpgradeResponseObject added in v0.8.0

type PlanBulkUpgradeResponseObject interface {
	VisitPlanBulkUpgradeResponse(w http.ResponseWriter) error
}

type PlanBulkUpgradedefaultApplicationProblemPlusJSONResponse added in v0.8.0

type PlanBulkUpgradedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (PlanBulkUpgradedefaultApplicationProblemPlusJSONResponse) VisitPlanBulkUpgradeResponse added in v0.8.0

func (response PlanBulkUpgradedefaultApplicationProblemPlusJSONResponse) VisitPlanBulkUpgradeResponse(w http.ResponseWriter) error

type PlanDocumentUpgrade200JSONResponse added in v0.8.0

type PlanDocumentUpgrade200JSONResponse UpgradeDocumentPlan

func (PlanDocumentUpgrade200JSONResponse) VisitPlanDocumentUpgradeResponse added in v0.8.0

func (response PlanDocumentUpgrade200JSONResponse) VisitPlanDocumentUpgradeResponse(w http.ResponseWriter) error

type PlanDocumentUpgradeJSONRequestBody added in v0.8.0

type PlanDocumentUpgradeJSONRequestBody = UpgradePlanRequest

PlanDocumentUpgradeJSONRequestBody defines body for PlanDocumentUpgrade for application/json ContentType.

type PlanDocumentUpgradeRequestObject added in v0.8.0

type PlanDocumentUpgradeRequestObject struct {
	Body *PlanDocumentUpgradeJSONRequestBody
}

type PlanDocumentUpgradeResponse added in v0.8.0

type PlanDocumentUpgradeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *UpgradeDocumentPlan
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParsePlanDocumentUpgradeResponse added in v0.8.0

func ParsePlanDocumentUpgradeResponse(rsp *http.Response) (*PlanDocumentUpgradeResponse, error)

ParsePlanDocumentUpgradeResponse parses an HTTP response from a PlanDocumentUpgradeWithResponse call

func (PlanDocumentUpgradeResponse) ContentType added in v0.8.0

func (r PlanDocumentUpgradeResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PlanDocumentUpgradeResponse) GetApplicationProblemJSONDefault added in v0.8.0

func (r PlanDocumentUpgradeResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (PlanDocumentUpgradeResponse) GetBody added in v0.8.0

func (r PlanDocumentUpgradeResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PlanDocumentUpgradeResponse) GetJSON200 added in v0.8.0

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PlanDocumentUpgradeResponse) Status added in v0.8.0

Status returns HTTPResponse.Status

func (PlanDocumentUpgradeResponse) StatusCode added in v0.8.0

func (r PlanDocumentUpgradeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PlanDocumentUpgradeResponseObject added in v0.8.0

type PlanDocumentUpgradeResponseObject interface {
	VisitPlanDocumentUpgradeResponse(w http.ResponseWriter) error
}

type PlanDocumentUpgradedefaultApplicationProblemPlusJSONResponse added in v0.8.0

type PlanDocumentUpgradedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (PlanDocumentUpgradedefaultApplicationProblemPlusJSONResponse) VisitPlanDocumentUpgradeResponse added in v0.8.0

func (response PlanDocumentUpgradedefaultApplicationProblemPlusJSONResponse) VisitPlanDocumentUpgradeResponse(w http.ResponseWriter) error

type PreviewPurge200JSONResponse

type PreviewPurge200JSONResponse PurgePreview

func (PreviewPurge200JSONResponse) VisitPreviewPurgeResponse

func (response PreviewPurge200JSONResponse) VisitPreviewPurgeResponse(w http.ResponseWriter) error

type PreviewPurgeJSONRequestBody

type PreviewPurgeJSONRequestBody = PurgePreviewRequest

PreviewPurgeJSONRequestBody defines body for PreviewPurge for application/json ContentType.

type PreviewPurgeRequestObject

type PreviewPurgeRequestObject struct {
	Body *PreviewPurgeJSONRequestBody
}

type PreviewPurgeResponse

type PreviewPurgeResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *PurgePreview
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParsePreviewPurgeResponse

func ParsePreviewPurgeResponse(rsp *http.Response) (*PreviewPurgeResponse, error)

ParsePreviewPurgeResponse parses an HTTP response from a PreviewPurgeWithResponse call

func (PreviewPurgeResponse) ContentType

func (r PreviewPurgeResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PreviewPurgeResponse) GetApplicationProblemJSONDefault

func (r PreviewPurgeResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (PreviewPurgeResponse) GetBody

func (r PreviewPurgeResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PreviewPurgeResponse) GetJSON200

func (r PreviewPurgeResponse) GetJSON200() *PurgePreview

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (PreviewPurgeResponse) Status

func (r PreviewPurgeResponse) Status() string

Status returns HTTPResponse.Status

func (PreviewPurgeResponse) StatusCode

func (r PreviewPurgeResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PreviewPurgeResponseObject

type PreviewPurgeResponseObject interface {
	VisitPreviewPurgeResponse(w http.ResponseWriter) error
}

type PreviewPurgedefaultApplicationProblemPlusJSONResponse

type PreviewPurgedefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (PreviewPurgedefaultApplicationProblemPlusJSONResponse) VisitPreviewPurgeResponse

type Problem

type Problem struct {
	Code     string `json:"code"`
	Detail   string `json:"detail,omitempty"`
	Instance string `json:"instance,omitempty"`

	// ProtectReason Advisory purge-protection reason accompanying the upload_protected code, when the sentinel body could be read.
	ProtectReason string `json:"protect_reason,omitempty"`
	RequestID     string `json:"request_id"`
	Status        int    `json:"status"`
	Title         string `json:"title"`
	Type          string `json:"type"`
}

Problem defines model for Problem.

type ProblemApplicationProblemPlusJSONResponse

type ProblemApplicationProblemPlusJSONResponse Problem

type ProtectRequest added in v0.7.0

type ProtectRequest struct {
	Reason   string `json:"reason,omitempty"`
	URLOrKey string `json:"url_or_key"`
}

ProtectRequest defines model for ProtectRequest.

type ProtectUpload200JSONResponse added in v0.7.0

type ProtectUpload200JSONResponse ProtectionResult

func (ProtectUpload200JSONResponse) VisitProtectUploadResponse added in v0.7.0

func (response ProtectUpload200JSONResponse) VisitProtectUploadResponse(w http.ResponseWriter) error

type ProtectUploadJSONRequestBody added in v0.7.0

type ProtectUploadJSONRequestBody = ProtectRequest

ProtectUploadJSONRequestBody defines body for ProtectUpload for application/json ContentType.

type ProtectUploadRequestObject added in v0.7.0

type ProtectUploadRequestObject struct {
	Body *ProtectUploadJSONRequestBody
}

type ProtectUploadResponse added in v0.7.0

type ProtectUploadResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ProtectionResult
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseProtectUploadResponse added in v0.7.0

func ParseProtectUploadResponse(rsp *http.Response) (*ProtectUploadResponse, error)

ParseProtectUploadResponse parses an HTTP response from a ProtectUploadWithResponse call

func (ProtectUploadResponse) ContentType added in v0.7.0

func (r ProtectUploadResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ProtectUploadResponse) GetApplicationProblemJSONDefault added in v0.7.0

func (r ProtectUploadResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (ProtectUploadResponse) GetBody added in v0.7.0

func (r ProtectUploadResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ProtectUploadResponse) GetJSON200 added in v0.7.0

func (r ProtectUploadResponse) GetJSON200() *ProtectionResult

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ProtectUploadResponse) Status added in v0.7.0

func (r ProtectUploadResponse) Status() string

Status returns HTTPResponse.Status

func (ProtectUploadResponse) StatusCode added in v0.7.0

func (r ProtectUploadResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ProtectUploadResponseObject added in v0.7.0

type ProtectUploadResponseObject interface {
	VisitProtectUploadResponse(w http.ResponseWriter) error
}

type ProtectUploaddefaultApplicationProblemPlusJSONResponse added in v0.7.0

type ProtectUploaddefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (ProtectUploaddefaultApplicationProblemPlusJSONResponse) VisitProtectUploadResponse added in v0.7.0

type ProtectionResult added in v0.7.0

type ProtectionResult struct {
	ID          string               `json:"id"`
	Kind        ProtectionResultKind `json:"kind"`
	MarkerKey   string               `json:"marker_key"`
	PageKey     string               `json:"page_key"`
	Protected   bool                 `json:"protected"`
	ProtectedAt *time.Time           `json:"protected_at,omitempty"`
	Reason      string               `json:"reason,omitempty"`
	SentinelKey string               `json:"sentinel_key"`
	Warnings    []string             `json:"warnings"`
}

ProtectionResult defines model for ProtectionResult.

type ProtectionResultKind added in v0.7.0

type ProtectionResultKind string

ProtectionResultKind defines model for ProtectionResult.Kind.

const (
	ProtectionResultKindCollection ProtectionResultKind = "collection"
	ProtectionResultKindDocument   ProtectionResultKind = "document"
)

Defines values for ProtectionResultKind.

func (ProtectionResultKind) Valid added in v0.7.0

func (e ProtectionResultKind) Valid() bool

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

type PurgeCandidate

type PurgeCandidate struct {
	Inspection *UploadInspection `json:"inspection,omitempty"`
	Record     ManifestRecord    `json:"record"`
	UploadID   string            `json:"upload_id"`
	Warnings   []string          `json:"warnings"`
}

PurgeCandidate defines model for PurgeCandidate.

type PurgeItemResult

type PurgeItemResult struct {
	Deleted   *DeleteResult `json:"deleted,omitempty"`
	Error     string        `json:"error,omitempty"`
	Protected bool          `json:"protected,omitempty"`
	UploadID  string        `json:"upload_id"`
	Versioned bool          `json:"versioned,omitempty"`
}

PurgeItemResult defines model for PurgeItemResult.

type PurgePreview

type PurgePreview struct {
	Candidates []PurgeCandidate `json:"candidates"`
	Invalid    int              `json:"invalid"`
	Protected  []PurgeCandidate `json:"protected"`
	Versioned  []PurgeCandidate `json:"versioned"`
	Warnings   []string         `json:"warnings"`
}

PurgePreview defines model for PurgePreview.

type PurgePreviewRequest

type PurgePreviewRequest struct {
	All              bool                      `json:"all,omitempty"`
	Concurrency      int                       `json:"concurrency,omitempty"`
	CreatedBefore    *time.Time                `json:"created_before,omitempty"`
	IncludeVersioned bool                      `json:"include_versioned,omitempty"`
	Slug             string                    `json:"slug,omitempty"`
	Source           PurgePreviewRequestSource `json:"source"`
}

PurgePreviewRequest defines model for PurgePreviewRequest.

type PurgePreviewRequestSource

type PurgePreviewRequestSource string

PurgePreviewRequestSource defines model for PurgePreviewRequest.Source.

const (
	Manifest PurgePreviewRequestSource = "manifest"
	Storage  PurgePreviewRequestSource = "storage"
)

Defines values for PurgePreviewRequestSource.

func (PurgePreviewRequestSource) Valid

func (e PurgePreviewRequestSource) Valid() bool

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

type PurgeRequest

type PurgeRequest struct {
	IncludeVersioned bool     `json:"include_versioned,omitempty"`
	UploadIds        []string `json:"upload_ids"`
}

PurgeRequest defines model for PurgeRequest.

type PurgeResult

type PurgeResult struct {
	Items []PurgeItemResult `json:"items"`
}

PurgeResult defines model for PurgeResult.

type RemoteUpload

type RemoteUpload struct {
	Bytes        int64            `json:"bytes"`
	Conflict     bool             `json:"conflict"`
	ID           string           `json:"id"`
	Key          string           `json:"key,omitempty"`
	Keys         []string         `json:"keys"`
	Kind         RemoteUploadKind `json:"kind"`
	LastModified time.Time        `json:"last_modified"`
	MarkerKey    string           `json:"marker_key"`
	Objects      int              `json:"objects"`
	Protected    bool             `json:"protected"`
	Slug         string           `json:"slug,omitempty"`
	URL          string           `json:"url,omitempty"`
}

RemoteUpload defines model for RemoteUpload.

type RemoteUploadKind

type RemoteUploadKind string

RemoteUploadKind defines model for RemoteUpload.Kind.

const (
	RemoteUploadKindCollection RemoteUploadKind = "collection"
	RemoteUploadKindDocument   RemoteUploadKind = "document"
)

Defines values for RemoteUploadKind.

func (RemoteUploadKind) Valid

func (e RemoteUploadKind) Valid() bool

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

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

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 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 {

	// (GET /api/v1/capabilities)
	GetCapabilities(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/purge)
	ExecutePurge(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/purge/preview)
	PreviewPurge(w http.ResponseWriter, r *http.Request)

	// (GET /api/v1/storage/uploads)
	ListStorageUploads(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/sync)
	SyncManifest(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/upgrades)
	ExecuteBulkUpgrade(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/upgrades/execute)
	ExecuteDocumentUpgrade(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/upgrades/plan)
	PlanDocumentUpgrade(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/upgrades/preview)
	PlanBulkUpgrade(w http.ResponseWriter, r *http.Request)

	// (GET /api/v1/uploads)
	ListManifestUploads(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/uploads/collections)
	UploadCollection(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/uploads/delete)
	DeleteUpload(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/uploads/documents)
	UploadDocument(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/uploads/documents/revisions)
	CreateDocumentRevision(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/uploads/documents/update)
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	UpdateDocument(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/uploads/get)
	GetUpload(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/uploads/inspect)
	InspectUpload(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/uploads/protect)
	ProtectUpload(w http.ResponseWriter, r *http.Request)

	// (POST /api/v1/uploads/unprotect)
	UnprotectUpload(w http.ResponseWriter, r *http.Request)

	// (GET /healthz)
	Health(w http.ResponseWriter, r *http.Request)

	// (GET /openapi.yaml)
	GetOpenAPI(w http.ResponseWriter, r *http.Request)
}

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) CreateDocumentRevision added in v0.11.0

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

CreateDocumentRevision operation middleware

func (*ServerInterfaceWrapper) DeleteUpload

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

DeleteUpload operation middleware

func (*ServerInterfaceWrapper) ExecuteBulkUpgrade added in v0.8.0

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

ExecuteBulkUpgrade operation middleware

func (*ServerInterfaceWrapper) ExecuteDocumentUpgrade added in v0.8.0

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

ExecuteDocumentUpgrade operation middleware

func (*ServerInterfaceWrapper) ExecutePurge

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

ExecutePurge operation middleware

func (*ServerInterfaceWrapper) GetCapabilities

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

GetCapabilities operation middleware

func (*ServerInterfaceWrapper) GetOpenAPI

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

GetOpenAPI operation middleware

func (*ServerInterfaceWrapper) GetUpload

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

GetUpload operation middleware

func (*ServerInterfaceWrapper) Health

Health operation middleware

func (*ServerInterfaceWrapper) InspectUpload

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

InspectUpload operation middleware

func (*ServerInterfaceWrapper) ListManifestUploads

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

ListManifestUploads operation middleware

func (*ServerInterfaceWrapper) ListStorageUploads

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

ListStorageUploads operation middleware

func (*ServerInterfaceWrapper) PlanBulkUpgrade added in v0.8.0

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

PlanBulkUpgrade operation middleware

func (*ServerInterfaceWrapper) PlanDocumentUpgrade added in v0.8.0

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

PlanDocumentUpgrade operation middleware

func (*ServerInterfaceWrapper) PreviewPurge

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

PreviewPurge operation middleware

func (*ServerInterfaceWrapper) ProtectUpload added in v0.7.0

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

ProtectUpload operation middleware

func (*ServerInterfaceWrapper) SyncManifest

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

SyncManifest operation middleware

func (*ServerInterfaceWrapper) UnprotectUpload added in v0.7.0

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

UnprotectUpload operation middleware

func (*ServerInterfaceWrapper) UpdateDocument added in v0.8.0

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

UpdateDocument operation middleware

func (*ServerInterfaceWrapper) UploadCollection

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

UploadCollection operation middleware

func (*ServerInterfaceWrapper) UploadDocument

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

UploadDocument operation middleware

type StdHTTPServerOptions

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

type StorageList

type StorageList struct {
	Uploads  []RemoteUpload `json:"uploads"`
	Warnings []string       `json:"warnings"`
}

StorageList defines model for StorageList.

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 {

	// (GET /api/v1/capabilities)
	GetCapabilities(ctx context.Context, request GetCapabilitiesRequestObject) (GetCapabilitiesResponseObject, error)

	// (POST /api/v1/purge)
	ExecutePurge(ctx context.Context, request ExecutePurgeRequestObject) (ExecutePurgeResponseObject, error)

	// (POST /api/v1/purge/preview)
	PreviewPurge(ctx context.Context, request PreviewPurgeRequestObject) (PreviewPurgeResponseObject, error)

	// (GET /api/v1/storage/uploads)
	ListStorageUploads(ctx context.Context, request ListStorageUploadsRequestObject) (ListStorageUploadsResponseObject, error)

	// (POST /api/v1/sync)
	SyncManifest(ctx context.Context, request SyncManifestRequestObject) (SyncManifestResponseObject, error)

	// (POST /api/v1/upgrades)
	ExecuteBulkUpgrade(ctx context.Context, request ExecuteBulkUpgradeRequestObject) (ExecuteBulkUpgradeResponseObject, error)

	// (POST /api/v1/upgrades/execute)
	ExecuteDocumentUpgrade(ctx context.Context, request ExecuteDocumentUpgradeRequestObject) (ExecuteDocumentUpgradeResponseObject, error)

	// (POST /api/v1/upgrades/plan)
	PlanDocumentUpgrade(ctx context.Context, request PlanDocumentUpgradeRequestObject) (PlanDocumentUpgradeResponseObject, error)

	// (POST /api/v1/upgrades/preview)
	PlanBulkUpgrade(ctx context.Context, request PlanBulkUpgradeRequestObject) (PlanBulkUpgradeResponseObject, error)

	// (GET /api/v1/uploads)
	ListManifestUploads(ctx context.Context, request ListManifestUploadsRequestObject) (ListManifestUploadsResponseObject, error)

	// (POST /api/v1/uploads/collections)
	UploadCollection(ctx context.Context, request UploadCollectionRequestObject) (UploadCollectionResponseObject, error)

	// (POST /api/v1/uploads/delete)
	DeleteUpload(ctx context.Context, request DeleteUploadRequestObject) (DeleteUploadResponseObject, error)

	// (POST /api/v1/uploads/documents)
	UploadDocument(ctx context.Context, request UploadDocumentRequestObject) (UploadDocumentResponseObject, error)

	// (POST /api/v1/uploads/documents/revisions)
	CreateDocumentRevision(ctx context.Context, request CreateDocumentRevisionRequestObject) (CreateDocumentRevisionResponseObject, error)

	// (POST /api/v1/uploads/documents/update)
	//
	// Deprecated: this operation has been marked as deprecated upstream, but no `x-deprecated-reason` was set
	UpdateDocument(ctx context.Context, request UpdateDocumentRequestObject) (UpdateDocumentResponseObject, error)

	// (POST /api/v1/uploads/get)
	GetUpload(ctx context.Context, request GetUploadRequestObject) (GetUploadResponseObject, error)

	// (POST /api/v1/uploads/inspect)
	InspectUpload(ctx context.Context, request InspectUploadRequestObject) (InspectUploadResponseObject, error)

	// (POST /api/v1/uploads/protect)
	ProtectUpload(ctx context.Context, request ProtectUploadRequestObject) (ProtectUploadResponseObject, error)

	// (POST /api/v1/uploads/unprotect)
	UnprotectUpload(ctx context.Context, request UnprotectUploadRequestObject) (UnprotectUploadResponseObject, error)

	// (GET /healthz)
	Health(ctx context.Context, request HealthRequestObject) (HealthResponseObject, error)

	// (GET /openapi.yaml)
	GetOpenAPI(ctx context.Context, request GetOpenAPIRequestObject) (GetOpenAPIResponseObject, error)
}

StrictServerInterface represents all server handlers.

type SyncFailure

type SyncFailure struct {
	Error     string               `json:"error"`
	MarkerKey string               `json:"marker_key"`
	Operation SyncFailureOperation `json:"operation"`
}

SyncFailure defines model for SyncFailure.

type SyncFailureOperation

type SyncFailureOperation string

SyncFailureOperation defines model for SyncFailure.Operation.

const (
	ConfirmAbsence SyncFailureOperation = "confirm_absence"
	Fetch          SyncFailureOperation = "fetch"
)

Defines values for SyncFailureOperation.

func (SyncFailureOperation) Valid

func (e SyncFailureOperation) Valid() bool

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

type SyncManifest200JSONResponse

type SyncManifest200JSONResponse SyncResult

func (SyncManifest200JSONResponse) VisitSyncManifestResponse

func (response SyncManifest200JSONResponse) VisitSyncManifestResponse(w http.ResponseWriter) error

type SyncManifestJSONRequestBody

type SyncManifestJSONRequestBody = SyncRequest

SyncManifestJSONRequestBody defines body for SyncManifest for application/json ContentType.

type SyncManifestRequestObject

type SyncManifestRequestObject struct {
	Body *SyncManifestJSONRequestBody
}

type SyncManifestResponse

type SyncManifestResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SyncResult
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseSyncManifestResponse

func ParseSyncManifestResponse(rsp *http.Response) (*SyncManifestResponse, error)

ParseSyncManifestResponse parses an HTTP response from a SyncManifestWithResponse call

func (SyncManifestResponse) ContentType

func (r SyncManifestResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SyncManifestResponse) GetApplicationProblemJSONDefault

func (r SyncManifestResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (SyncManifestResponse) GetBody

func (r SyncManifestResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SyncManifestResponse) GetJSON200

func (r SyncManifestResponse) GetJSON200() *SyncResult

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (SyncManifestResponse) Status

func (r SyncManifestResponse) Status() string

Status returns HTTPResponse.Status

func (SyncManifestResponse) StatusCode

func (r SyncManifestResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SyncManifestResponseObject

type SyncManifestResponseObject interface {
	VisitSyncManifestResponse(w http.ResponseWriter) error
}

type SyncManifestdefaultApplicationProblemPlusJSONResponse

type SyncManifestdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (SyncManifestdefaultApplicationProblemPlusJSONResponse) VisitSyncManifestResponse

type SyncRequest

type SyncRequest struct {
	Concurrency int  `json:"concurrency,omitempty"`
	DryRun      bool `json:"dry_run,omitempty"`
	Prune       bool `json:"prune,omitempty"`
}

SyncRequest defines model for SyncRequest.

type SyncResult

type SyncResult struct {
	AddedRecords      []ManifestRecord `json:"added_records"`
	Complete          bool             `json:"complete"`
	Deferred          int              `json:"deferred"`
	EnrichedRecords   []ManifestRecord `json:"enriched_records"`
	Failures          []SyncFailure    `json:"failures"`
	Incomplete        int              `json:"incomplete"`
	Invalid           int              `json:"invalid"`
	ProtectionRecords []ManifestRecord `json:"protection_records"`
	Retained          int              `json:"retained"`
	TombstoneRecords  []ManifestRecord `json:"tombstone_records"`
	Unchanged         int              `json:"unchanged"`
	Warnings          []string         `json:"warnings"`
}

SyncResult defines model for SyncResult.

type TargetRequest

type TargetRequest struct {
	URLOrKey string `json:"url_or_key"`
}

TargetRequest defines model for TargetRequest.

type TooManyValuesForParamError

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

func (*TooManyValuesForParamError) 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 UnprotectUpload200JSONResponse added in v0.7.0

type UnprotectUpload200JSONResponse ProtectionResult

func (UnprotectUpload200JSONResponse) VisitUnprotectUploadResponse added in v0.7.0

func (response UnprotectUpload200JSONResponse) VisitUnprotectUploadResponse(w http.ResponseWriter) error

type UnprotectUploadJSONRequestBody added in v0.7.0

type UnprotectUploadJSONRequestBody = TargetRequest

UnprotectUploadJSONRequestBody defines body for UnprotectUpload for application/json ContentType.

type UnprotectUploadRequestObject added in v0.7.0

type UnprotectUploadRequestObject struct {
	Body *UnprotectUploadJSONRequestBody
}

type UnprotectUploadResponse added in v0.7.0

type UnprotectUploadResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *ProtectionResult
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseUnprotectUploadResponse added in v0.7.0

func ParseUnprotectUploadResponse(rsp *http.Response) (*UnprotectUploadResponse, error)

ParseUnprotectUploadResponse parses an HTTP response from a UnprotectUploadWithResponse call

func (UnprotectUploadResponse) ContentType added in v0.7.0

func (r UnprotectUploadResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UnprotectUploadResponse) GetApplicationProblemJSONDefault added in v0.7.0

func (r UnprotectUploadResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (UnprotectUploadResponse) GetBody added in v0.7.0

func (r UnprotectUploadResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UnprotectUploadResponse) GetJSON200 added in v0.7.0

func (r UnprotectUploadResponse) GetJSON200() *ProtectionResult

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UnprotectUploadResponse) Status added in v0.7.0

func (r UnprotectUploadResponse) Status() string

Status returns HTTPResponse.Status

func (UnprotectUploadResponse) StatusCode added in v0.7.0

func (r UnprotectUploadResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UnprotectUploadResponseObject added in v0.7.0

type UnprotectUploadResponseObject interface {
	VisitUnprotectUploadResponse(w http.ResponseWriter) error
}

type UnprotectUploaddefaultApplicationProblemPlusJSONResponse added in v0.7.0

type UnprotectUploaddefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (UnprotectUploaddefaultApplicationProblemPlusJSONResponse) VisitUnprotectUploadResponse added in v0.7.0

func (response UnprotectUploaddefaultApplicationProblemPlusJSONResponse) VisitUnprotectUploadResponse(w http.ResponseWriter) error

type UpdateDocument201JSONResponse added in v0.8.0

type UpdateDocument201JSONResponse DocumentRevisionResult

func (UpdateDocument201JSONResponse) VisitUpdateDocumentResponse added in v0.8.0

func (response UpdateDocument201JSONResponse) VisitUpdateDocumentResponse(w http.ResponseWriter) error

type UpdateDocumentMultipartBody added in v0.8.0

type UpdateDocumentMultipartBody struct {
	Assets   []openapi_types.File           `json:"assets,omitempty"`
	Document openapi_types.File             `json:"document"`
	Metadata CreateDocumentRevisionMetadata `json:"metadata"`
	Pages    []openapi_types.File           `json:"pages,omitempty"`
}

UpdateDocumentMultipartBody defines parameters for UpdateDocument.

type UpdateDocumentMultipartRequestBody deprecated added in v0.8.0

type UpdateDocumentMultipartRequestBody UpdateDocumentMultipartBody

UpdateDocumentMultipartRequestBody defines body for UpdateDocument for multipart/form-data ContentType.

Deprecated: this type has been marked as deprecated upstream, but no `x-deprecated-reason` was set

type UpdateDocumentRequestObject added in v0.8.0

type UpdateDocumentRequestObject struct {
	Body *multipart.Reader
}

type UpdateDocumentResponse added in v0.8.0

type UpdateDocumentResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *DocumentRevisionResult
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseUpdateDocumentResponse added in v0.8.0

func ParseUpdateDocumentResponse(rsp *http.Response) (*UpdateDocumentResponse, error)

ParseUpdateDocumentResponse parses an HTTP response from a UpdateDocumentWithResponse call

func (UpdateDocumentResponse) ContentType added in v0.8.0

func (r UpdateDocumentResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateDocumentResponse) GetApplicationProblemJSONDefault added in v0.8.0

func (r UpdateDocumentResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (UpdateDocumentResponse) GetBody added in v0.8.0

func (r UpdateDocumentResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdateDocumentResponse) GetJSON201 added in v0.8.0

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (UpdateDocumentResponse) Status added in v0.8.0

func (r UpdateDocumentResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateDocumentResponse) StatusCode added in v0.8.0

func (r UpdateDocumentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateDocumentResponseObject added in v0.8.0

type UpdateDocumentResponseObject interface {
	VisitUpdateDocumentResponse(w http.ResponseWriter) error
}

type UpdateDocumentdefaultApplicationProblemPlusJSONResponse added in v0.8.0

type UpdateDocumentdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (UpdateDocumentdefaultApplicationProblemPlusJSONResponse) VisitUpdateDocumentResponse added in v0.8.0

func (response UpdateDocumentdefaultApplicationProblemPlusJSONResponse) VisitUpdateDocumentResponse(w http.ResponseWriter) error

type UpgradeDocumentPlan added in v0.8.0

type UpgradeDocumentPlan struct {
	Bucket                    string            `json:"bucket,omitempty"`
	CurrentMarkerVersion      int               `json:"current_marker_version,omitempty"`
	CurrentProducerVersion    string            `json:"current_producer_version,omitempty"`
	CurrentRendererGeneration int               `json:"current_renderer_generation,omitempty"`
	Force                     bool              `json:"force,omitempty"`
	MarkerEtag                string            `json:"marker_etag,omitempty"`
	MarkerKey                 string            `json:"marker_key,omitempty"`
	PageEtag                  string            `json:"page_etag,omitempty"`
	PageEtags                 map[string]string `json:"page_etags,omitempty"`
	PageKey                   string            `json:"page_key,omitempty"`
	Reason                    string            `json:"reason,omitempty"`
	SourceEtag                string            `json:"source_etag,omitempty"`
	SourceEtags               map[string]string `json:"source_etags,omitempty"`
	SourceKey                 string            `json:"source_key,omitempty"`
	State                     UpgradeState      `json:"state"`
	Target                    string            `json:"target"`
	TargetMarkerVersion       int               `json:"target_marker_version"`
	TargetProducerVersion     string            `json:"target_producer_version"`
	TargetRendererGeneration  int               `json:"target_renderer_generation"`
	URL                       string            `json:"url,omitempty"`
}

UpgradeDocumentPlan defines model for UpgradeDocumentPlan.

type UpgradeDocumentResult added in v0.8.0

type UpgradeDocumentResult struct {
	Reason   string       `json:"reason,omitempty"`
	Result   UploadResult `json:"result"`
	State    UpgradeState `json:"state"`
	Upgraded bool         `json:"upgraded"`
}

UpgradeDocumentResult defines model for UpgradeDocumentResult.

type UpgradePlanRequest added in v0.8.0

type UpgradePlanRequest struct {
	Force  bool   `json:"force,omitempty"`
	Target string `json:"target"`
}

UpgradePlanRequest defines model for UpgradePlanRequest.

type UpgradeState added in v0.8.0

type UpgradeState string

UpgradeState defines model for UpgradeState.

const (
	UpgradeStateCurrent     UpgradeState = "current"
	UpgradeStateIneligible  UpgradeState = "ineligible"
	UpgradeStateInvalid     UpgradeState = "invalid"
	UpgradeStateMissing     UpgradeState = "missing"
	UpgradeStateUpgradeable UpgradeState = "upgradeable"
)

Defines values for UpgradeState.

func (UpgradeState) Valid added in v0.8.0

func (e UpgradeState) Valid() bool

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

type UploadCollection201JSONResponse

type UploadCollection201JSONResponse UploadResult

func (UploadCollection201JSONResponse) VisitUploadCollectionResponse

func (response UploadCollection201JSONResponse) VisitUploadCollectionResponse(w http.ResponseWriter) error

type UploadCollectionMultipartBody

type UploadCollectionMultipartBody struct {
	Files    []openapi_types.File `json:"files"`
	Metadata CollectionMetadata   `json:"metadata"`
}

UploadCollectionMultipartBody defines parameters for UploadCollection.

type UploadCollectionMultipartRequestBody

type UploadCollectionMultipartRequestBody UploadCollectionMultipartBody

UploadCollectionMultipartRequestBody defines body for UploadCollection for multipart/form-data ContentType.

type UploadCollectionRequestObject

type UploadCollectionRequestObject struct {
	Body *multipart.Reader
}

type UploadCollectionResponse

type UploadCollectionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *UploadResult
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseUploadCollectionResponse

func ParseUploadCollectionResponse(rsp *http.Response) (*UploadCollectionResponse, error)

ParseUploadCollectionResponse parses an HTTP response from a UploadCollectionWithResponse call

func (UploadCollectionResponse) ContentType

func (r UploadCollectionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UploadCollectionResponse) GetApplicationProblemJSONDefault

func (r UploadCollectionResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (UploadCollectionResponse) GetBody

func (r UploadCollectionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UploadCollectionResponse) GetJSON201

func (r UploadCollectionResponse) GetJSON201() *UploadResult

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (UploadCollectionResponse) Status

func (r UploadCollectionResponse) Status() string

Status returns HTTPResponse.Status

func (UploadCollectionResponse) StatusCode

func (r UploadCollectionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UploadCollectionResponseObject

type UploadCollectionResponseObject interface {
	VisitUploadCollectionResponse(w http.ResponseWriter) error
}

type UploadCollectiondefaultApplicationProblemPlusJSONResponse

type UploadCollectiondefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (UploadCollectiondefaultApplicationProblemPlusJSONResponse) VisitUploadCollectionResponse

func (response UploadCollectiondefaultApplicationProblemPlusJSONResponse) VisitUploadCollectionResponse(w http.ResponseWriter) error

type UploadDocument201JSONResponse

type UploadDocument201JSONResponse UploadResult

func (UploadDocument201JSONResponse) VisitUploadDocumentResponse

func (response UploadDocument201JSONResponse) VisitUploadDocumentResponse(w http.ResponseWriter) error

type UploadDocumentMultipartBody

type UploadDocumentMultipartBody struct {
	Assets   []openapi_types.File `json:"assets,omitempty"`
	Document openapi_types.File   `json:"document"`
	Metadata DocumentMetadata     `json:"metadata"`
	Pages    []openapi_types.File `json:"pages,omitempty"`
}

UploadDocumentMultipartBody defines parameters for UploadDocument.

type UploadDocumentMultipartRequestBody

type UploadDocumentMultipartRequestBody UploadDocumentMultipartBody

UploadDocumentMultipartRequestBody defines body for UploadDocument for multipart/form-data ContentType.

type UploadDocumentRequestObject

type UploadDocumentRequestObject struct {
	Body *multipart.Reader
}

type UploadDocumentResponse

type UploadDocumentResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *UploadResult
	// ApplicationProblemJSONDefault the response for an HTTP default `application/problem+json` response
	ApplicationProblemJSONDefault *Problem
}

func ParseUploadDocumentResponse

func ParseUploadDocumentResponse(rsp *http.Response) (*UploadDocumentResponse, error)

ParseUploadDocumentResponse parses an HTTP response from a UploadDocumentWithResponse call

func (UploadDocumentResponse) ContentType

func (r UploadDocumentResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UploadDocumentResponse) GetApplicationProblemJSONDefault

func (r UploadDocumentResponse) GetApplicationProblemJSONDefault() *Problem

GetApplicationProblemJSONDefault returns the response for an HTTP default `application/problem+json` response

func (UploadDocumentResponse) GetBody

func (r UploadDocumentResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UploadDocumentResponse) GetJSON201

func (r UploadDocumentResponse) GetJSON201() *UploadResult

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (UploadDocumentResponse) Status

func (r UploadDocumentResponse) Status() string

Status returns HTTPResponse.Status

func (UploadDocumentResponse) StatusCode

func (r UploadDocumentResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UploadDocumentResponseObject

type UploadDocumentResponseObject interface {
	VisitUploadDocumentResponse(w http.ResponseWriter) error
}

type UploadDocumentdefaultApplicationProblemPlusJSONResponse

type UploadDocumentdefaultApplicationProblemPlusJSONResponse struct {
	Body       Problem
	StatusCode int
}

func (UploadDocumentdefaultApplicationProblemPlusJSONResponse) VisitUploadDocumentResponse

func (response UploadDocumentdefaultApplicationProblemPlusJSONResponse) VisitUploadDocumentResponse(w http.ResponseWriter) error

type UploadInspection

type UploadInspection struct {
	Assets          []InspectedObject     `json:"assets,omitempty"`
	Bytes           int64                 `json:"bytes"`
	CreatedAt       *time.Time            `json:"created_at,omitempty"`
	Diff            *InspectedObject      `json:"diff,omitempty"`
	Error           string                `json:"error,omitempty"`
	Files           []InspectedObject     `json:"files"`
	Format          string                `json:"format,omitempty"`
	ID              string                `json:"id"`
	Kind            UploadInspectionKind  `json:"kind,omitempty"`
	LatestRevision  int                   `json:"latest_revision,omitempty"`
	LatestURL       string                `json:"latest_url,omitempty"`
	MarkerKey       string                `json:"marker_key"`
	MarkerVersion   int                   `json:"marker_version,omitempty"`
	Objects         int                   `json:"objects"`
	Page            *InspectedObject      `json:"page,omitempty"`
	Pages           []InspectedPage       `json:"pages,omitempty"`
	ProducerVersion string                `json:"producer_version,omitempty"`
	ProtectReason   string                `json:"protect_reason,omitempty"`
	Protected       bool                  `json:"protected,omitempty"`
	ProtectedAt     *time.Time            `json:"protected_at,omitempty"`
	RendererVersion int                   `json:"renderer_version,omitempty"`
	RepositoryURL   string                `json:"repository_url,omitempty"`
	Revision        int                   `json:"revision,omitempty"`
	RevisionChainID string                `json:"revision_chain_id,omitempty"`
	RevisionError   string                `json:"revision_error,omitempty"`
	Source          *InspectedObject      `json:"source,omitempty"`
	State           UploadInspectionState `json:"state"`
	Title           string                `json:"title,omitempty"`
	Versions        *VersionsMetadata     `json:"versions,omitempty"`
	Warnings        []string              `json:"warnings"`
}

UploadInspection defines model for UploadInspection.

type UploadInspectionKind

type UploadInspectionKind string

UploadInspectionKind defines model for UploadInspection.Kind.

const (
	UploadInspectionKindCollection UploadInspectionKind = "collection"
	UploadInspectionKindDocument   UploadInspectionKind = "document"
)

Defines values for UploadInspectionKind.

func (UploadInspectionKind) Valid

func (e UploadInspectionKind) Valid() bool

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

type UploadInspectionState

type UploadInspectionState string

UploadInspectionState defines model for UploadInspection.State.

const (
	UploadInspectionStateComplete   UploadInspectionState = "complete"
	UploadInspectionStateIncomplete UploadInspectionState = "incomplete"
	UploadInspectionStateInvalid    UploadInspectionState = "invalid"
)

Defines values for UploadInspectionState.

func (UploadInspectionState) Valid

func (e UploadInspectionState) Valid() bool

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

type UploadLimits

type UploadLimits struct {
	CollectionFileBytes  int64 `json:"collection_file_bytes"`
	CollectionTotalBytes int64 `json:"collection_total_bytes"`
	DocumentBytes        int64 `json:"document_bytes"`
}

UploadLimits defines model for UploadLimits.

type UploadResult

type UploadResult struct {
	Assets          []AssetResult    `json:"assets,omitempty"`
	Bucket          string           `json:"bucket"`
	Bytes           int64            `json:"bytes"`
	ContentType     string           `json:"content_type"`
	CreatedAt       time.Time        `json:"created_at"`
	Files           []FileResult     `json:"files,omitempty"`
	Format          string           `json:"format,omitempty"`
	ID              string           `json:"id"`
	Key             string           `json:"key"`
	Kind            UploadResultKind `json:"kind"`
	LatestRevision  int              `json:"latest_revision,omitempty"`
	MarkerKey       string           `json:"marker_key"`
	MarkerVersion   int              `json:"marker_version"`
	Pages           []PageResult     `json:"pages,omitempty"`
	RepositoryURL   string           `json:"repository_url,omitempty"`
	Revision        int              `json:"revision,omitempty"`
	RevisionChainID string           `json:"revision_chain_id,omitempty"`
	Slug            string           `json:"slug,omitempty"`
	SourceKey       string           `json:"source_key,omitempty"`
	SourceURL       string           `json:"source_url,omitempty"`
	Title           string           `json:"title,omitempty"`
	URL             string           `json:"url"`
	Warnings        []string         `json:"warnings"`
}

UploadResult defines model for UploadResult.

type UploadResultKind

type UploadResultKind string

UploadResultKind defines model for UploadResult.Kind.

const (
	UploadResultKindCollection UploadResultKind = "collection"
	UploadResultKindDocument   UploadResultKind = "document"
)

Defines values for UploadResultKind.

func (UploadResultKind) Valid

func (e UploadResultKind) Valid() bool

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

type VersionsMetadata added in v0.8.0

type VersionsMetadata struct {
	ChainID              string                  `json:"chain_id"`
	CurrentRevision      int                     `json:"current_revision"`
	LastAssignedRevision int                     `json:"last_assigned_revision"`
	LatestRevision       int                     `json:"latest_revision"`
	Revisions            []VersionsRevision      `json:"revisions"`
	Schema               VersionsMetadataSchema  `json:"schema"`
	Version              VersionsMetadataVersion `json:"version"`
}

VersionsMetadata defines model for VersionsMetadata.

type VersionsMetadataSchema added in v0.8.0

type VersionsMetadataSchema string

VersionsMetadataSchema defines model for VersionsMetadata.Schema.

const (
	AirplanVersions VersionsMetadataSchema = "airplan-versions"
)

Defines values for VersionsMetadataSchema.

func (VersionsMetadataSchema) Valid added in v0.8.0

func (e VersionsMetadataSchema) Valid() bool

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

type VersionsMetadataVersion added in v0.8.0

type VersionsMetadataVersion int

VersionsMetadataVersion defines model for VersionsMetadata.Version.

const (
	N1 VersionsMetadataVersion = 1
)

Defines values for VersionsMetadataVersion.

func (VersionsMetadataVersion) Valid added in v0.8.0

func (e VersionsMetadataVersion) Valid() bool

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

type VersionsRevision added in v0.8.0

type VersionsRevision struct {
	CreatedAt *time.Time `json:"created_at,omitempty"`
	Deleted   bool       `json:"deleted,omitempty"`
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
	DiffURL   string     `json:"diff_url,omitempty"`
	Number    int        `json:"number"`
	URL       string     `json:"url,omitempty"`
}

VersionsRevision defines model for VersionsRevision.

Jump to

Keyboard shortcuts

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