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 ¶
- type AdminForceDocumentsProcessing
- type AdminSystemInfo
- type BulkEditDocuments
- type DocumentProcessingResp
- type RespBadRequest
- type RespFileTypes
- type RespForbidden
- type RespInternalError
- type RespNotFound
- type RespNotModified
- type RespOk
- type RespUserInfo
- type RespVersion
- type UploadFileRequest
- type UserDocumentStatistics
- type UserPreferences
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 RespInternalError ¶
type RespInternalError struct{}
internal error occured and server was unable to complete operation swagger:response RespInternalError
type RespNotModified ¶
type RespNotModified struct{}
Content already exists and has not been modified swagger:response RespNotModified
type RespUserInfo ¶
User info swagger:response RespUserInfo
type RespVersion ¶
type RespVersion struct { //in:body Body api.VersionResponse }
Server version swagger:response RespVersion
type UploadFileRequest ¶
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