Skip to main content

Module api

Module api 

Source
Expand description

The server’s JSON documents, as its openapi.json defines them. Fields this client does not know are ignored, as the contract asks. Byte counts travel as strings, since item sizes are 64-bit.

Structs§

BeginUpload
beginUpload’s request.
Cleaned
cleanStaging’s answer.
Encryption
A workspace’s encryption, as the server says it is.
Item
An item’s envelope: what the server knows of it. meta is the client’s meta.json, as it sent it.
PutOutcome
beginUpload’s answer when the content is stored already, and commitUpload’s.
Resolved
resolveItem’s answer.
RewriteSession
An open migration or rotation.
ServerInfo
The server’s version and limits.
UploadTicket
beginUpload’s answer when content is to be sent.
Viewer
getViewer: the API key in use, and the server.
ViewerKey
The API key, as the server knows it.
Workspace
getWorkspace: the workspace the API key opens.

Enums§

EncryptionState
A workspace’s encryption state.
Role
What an API key may do.