swaggerdocs

package
v0.6.0 Latest Latest
Warning

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

Go to latest
Published: Apr 14, 2024 License: AGPL-3.0 Imports: 4 Imported by: 0

Documentation

Overview

Package Virtualpaper API documentation.

Documentation for Virtualpaper API. Virtualpaper is a document storage optimized for searching documents.

Schemes: http, https

Version: 0.1.0

License: AGPL-v3

Host: localhost:8000

Consumes: - application/json

Produces: - application/json

Security:

api_key:

SecurityDefinitions: api_key:

type: apiKey
name: token
in: header

swagger:meta

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdminForceDocumentsProcessing

type AdminForceDocumentsProcessing struct {
	// in:body
	Body api.ForceDocumentProcessingRequest
}

Force processing documents swagger:parameters AdminForceDocumentProcessing ReqForceDocumentsProcessing

type AdminSystemInfo

type AdminSystemInfo struct {
	// in:body
	Body aggregates.SystemInfo
}

System information swagger:response RespAdminSystemInfo

type BulkEditDocuments

type BulkEditDocuments struct {
	// in:body
	Body aggregates.BulkEditDocumentsRequest
}

Bulk edit documents swagger:parameters BulkEditDocuments ReqBulkEditDocuments

type DocumentProcessingResp

type DocumentProcessingResp struct {
	// in:body
	Body []api.DocumentProcessStep
}

Documents and processing steps pending swagger:response RespDocumentProcessingSteps

type RespBadRequest

type RespBadRequest struct {
	// in:body
	Body struct {
		Error string `json:"error"`
	}
}

request validation failed swagger:response RespBadRequest

type RespFileTypes

type RespFileTypes struct {
	// in:body
	Body []api.MimeTypesSupportedResponse
}

Supported file types swagger:response RespFileTypes

type RespForbidden

type RespForbidden struct{}

action forbidden swagger:response RespForbidden

type RespInternalError

type RespInternalError struct{}

internal error occured and server was unable to complete operation swagger:response RespInternalError

type RespNotFound

type RespNotFound struct{}

resource not found swagger:response RespNotFound

type RespNotModified

type RespNotModified struct{}

Content already exists and has not been modified swagger:response RespNotModified

type RespOk

type RespOk struct{}

Request ok swagger:response RespOk

type RespUserInfo

type RespUserInfo struct {
	// in:body
	Body []models.UserInfo
}

User info swagger:response RespUserInfo

type RespVersion

type RespVersion struct {
	//in:body
	Body api.VersionResponse
}

Server version swagger:response RespVersion

type UploadFileRequest

type UploadFileRequest struct {
	// in:body
	Body multipart.FormData
}

Upload file swagger:parameters UploadFile ReqUploadFile

type UserDocumentStatistics

type UserDocumentStatistics struct {
	// in:body
	Body aggregates.UserDocumentStatistics
}

Document / usage statistics swagger:response RespDocumentStatistics

type UserPreferences

type UserPreferences struct {
	// in:body
	Body api.UserPreferences
}

User preferences swagger:response RespUserPreferences

Jump to

Keyboard shortcuts

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