DATABASEDocumentation menu
Request & result schemas
Inspect the complete generated type catalog and download the machine-readable schema.
On this page
Schema catalog
Expand a type to inspect its complete JSON Schema. References resolve against the $defs in the downloadable catalog. Structural validity does not grant permission or guarantee a domain-valid transaction.
ApiError
| Field | Type | Required |
|---|---|---|
code | string | Yes |
message | string | Yes |
requestId | string | null | No |
retryable | boolean | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"requestId": {
"type": [
"string",
"null"
]
},
"retryable": {
"type": "boolean"
}
},
"required": [
"code",
"message",
"retryable"
],
"type": "object"
}BeginUpload
| Field | Type | Required |
|---|---|---|
contentType | string | Yes |
name | string | Yes |
requestId | string | Yes |
totalSize | integer | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"contentType": {
"type": "string"
},
"name": {
"type": "string"
},
"requestId": {
"type": "string"
},
"totalSize": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"requestId",
"name",
"totalSize",
"contentType"
],
"type": "object"
}CollectionSummary
| Field | Type | Required |
|---|---|---|
count | integer | Yes |
indexes | Array<IndexSummary> | Yes |
name | string | Yes |
schema | JSON | Yes |
View complete schema
{
"properties": {
"count": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"indexes": {
"items": {
"$ref": "#/$defs/IndexSummary"
},
"type": "array"
},
"name": {
"type": "string"
},
"schema": true
},
"required": [
"name",
"count",
"schema",
"indexes"
],
"type": "object"
}Collections
| Field | Type | Required |
|---|---|---|
collections | Array<CollectionSummary> | Yes |
revision | string | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"collections": {
"items": {
"$ref": "#/$defs/CollectionSummary"
},
"type": "array"
},
"revision": {
"type": "string"
}
},
"required": [
"collections",
"revision"
],
"type": "object"
}DatabaseInfo
| Field | Type | Required |
|---|---|---|
instanceId | string | Yes |
inventory | DatabaseInventory | Yes |
limits | DatabaseLimits | Yes |
runtime | RuntimeInfo | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"instanceId": {
"type": "string"
},
"inventory": {
"$ref": "#/$defs/DatabaseInventory"
},
"limits": {
"$ref": "#/$defs/DatabaseLimits"
},
"runtime": {
"$ref": "#/$defs/RuntimeInfo"
}
},
"required": [
"instanceId",
"inventory",
"limits",
"runtime"
],
"type": "object"
}DatabaseInventory
| Field | Type | Required |
|---|---|---|
collections | integer | Yes |
committedPageBytesAuthenticated committed page prefix, excluding WAL and object files. | string | null | Yes |
encryptionAtRest | boolean | Yes |
indexesUser indexes plus schema-owned constraints; primary keys are separate. | integer | Yes |
logicalBytesEngine logical admission accounting, not process RAM or disk allocation. | integer | Yes |
objects | integer | Yes |
receipts | integer | Yes |
records | integer | Yes |
sequenceDecimal commit sequence; all inventory fields describe this snapshot. | string | Yes |
storage | StorageLayout | Yes |
uploadsIncludes completed and aborted upload histories. | integer | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"collections": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"committedPageBytes": {
"description": "Authenticated committed page prefix, excluding WAL and object files.",
"type": [
"string",
"null"
]
},
"encryptionAtRest": {
"type": "boolean"
},
"indexes": {
"description": "User indexes plus schema-owned constraints; primary keys are separate.",
"format": "uint",
"minimum": 0,
"type": "integer"
},
"logicalBytes": {
"description": "Engine logical admission accounting, not process RAM or disk allocation.",
"format": "uint",
"minimum": 0,
"type": "integer"
},
"objects": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"receipts": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"records": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"sequence": {
"description": "Decimal commit sequence; all inventory fields describe this snapshot.",
"type": "string"
},
"storage": {
"$ref": "#/$defs/StorageLayout"
},
"uploads": {
"description": "Includes completed and aborted upload histories.",
"format": "uint",
"minimum": 0,
"type": "integer"
}
},
"required": [
"sequence",
"storage",
"encryptionAtRest",
"logicalBytes",
"collections",
"records",
"indexes",
"receipts",
"objects",
"uploads",
"committedPageBytes"
],
"type": "object"
}DatabaseLimits
| Field | Type | Required |
|---|---|---|
collections | integer | Yes |
logicalBytes | integer | Yes |
operations | integer | Yes |
receipts | integer | Yes |
recordBytes | integer | Yes |
requestBytes | integer | Yes |
resultBytes | integer | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"collections": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"logicalBytes": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"operations": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"receipts": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"recordBytes": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"requestBytes": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"resultBytes": {
"format": "uint",
"minimum": 0,
"type": "integer"
}
},
"required": [
"logicalBytes",
"collections",
"receipts",
"recordBytes",
"requestBytes",
"resultBytes",
"operations"
],
"type": "object"
}DatabaseState
View complete schema
{
"enum": [
"uninitialized",
"locked",
"ready",
"recovery_required"
],
"type": "string"
}EmptyRequest
View complete schema
{
"additionalProperties": false,
"type": "object"
}Envelope
View complete schema
{
"anyOf": [
{
"additionalProperties": false,
"properties": {
"data": true,
"ok": {
"$ref": "#/$defs/True"
}
},
"required": [
"ok",
"data"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"error": {
"$ref": "#/$defs/ApiError"
},
"ok": {
"$ref": "#/$defs/False"
}
},
"required": [
"ok",
"error"
],
"type": "object"
}
]
}False
View complete schema
{
"const": false,
"type": "boolean"
}IndexSummary
| Field | Type | Required |
|---|---|---|
expireAfter | integer | null | No |
fields | Array<string> | Yes |
name | string | null | No |
sparse | boolean | Yes |
unique | boolean | Yes |
View complete schema
{
"properties": {
"expireAfter": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"fields": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": [
"string",
"null"
]
},
"sparse": {
"type": "boolean"
},
"unique": {
"type": "boolean"
}
},
"required": [
"fields",
"unique",
"sparse"
],
"type": "object"
}InstanceMode
View complete schema
{
"enum": [
"standalone"
],
"type": "string"
}KeyProvider
View complete schema
{
"enum": [
"native",
"external"
],
"type": "string"
}Login
| Field | Type | Required |
|---|---|---|
token | string | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"token": {
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
}ObjectReference
| Field | Type | Required |
|---|---|---|
contentType | string | Yes |
name | string | Yes |
objectId | string | Yes |
partCount | integer | Yes |
partSize | integer | Yes |
sha256 | string | Yes |
size | integer | Yes |
version | string | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"contentType": {
"type": "string"
},
"name": {
"type": "string"
},
"objectId": {
"type": "string"
},
"partCount": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"partSize": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"sha256": {
"type": "string"
},
"size": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"version": {
"type": "string"
}
},
"required": [
"objectId",
"version",
"name",
"size",
"contentType",
"sha256",
"partSize",
"partCount"
],
"type": "object"
}Objects
| Field | Type | Required |
|---|---|---|
objects | Array<ObjectReference> | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"objects": {
"items": {
"$ref": "#/$defs/ObjectReference"
},
"type": "array"
}
},
"required": [
"objects"
],
"type": "object"
}Operation
View complete schema
{
"oneOf": [
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"op": {
"const": "create_collection",
"type": "string"
},
"schema": {
"default": null
},
"unique": {
"default": [],
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "array"
}
},
"required": [
"op",
"name"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"collection": {
"type": "string"
},
"fields": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"op": {
"const": "create_index",
"type": "string"
},
"sparse": {
"type": "boolean"
},
"unique": {
"type": "boolean"
}
},
"required": [
"op",
"collection",
"name",
"fields"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"collection": {
"type": "string"
},
"expireAfter": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"field": {
"type": "string"
},
"name": {
"type": "string"
},
"op": {
"const": "create_ttl_index",
"type": "string"
}
},
"required": [
"op",
"collection",
"name",
"field",
"expireAfter"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"collection": {
"type": "string"
},
"name": {
"type": "string"
},
"op": {
"const": "drop_index",
"type": "string"
}
},
"required": [
"op",
"collection",
"name"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"after": {
"default": null,
"type": [
"string",
"null"
]
},
"collection": {
"type": "string"
},
"limit": {
"default": null,
"format": "uint",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"op": {
"const": "list_records",
"type": "string"
}
},
"required": [
"op",
"collection"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"collection": {
"type": "string"
},
"key": {
"type": "string"
},
"op": {
"const": "get",
"type": "string"
}
},
"required": [
"op",
"collection",
"key"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"collection": {
"type": "string"
},
"key": {
"default": null,
"type": [
"string",
"null"
]
},
"op": {
"const": "insert",
"type": "string"
},
"value": {
"additionalProperties": true,
"type": "object"
}
},
"required": [
"op",
"collection",
"value"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Administrator-only insertion preserving an external opaque revision.\nExisting keys are never replaced. Native revisions use verified restore.",
"properties": {
"collection": {
"type": "string"
},
"op": {
"const": "import_record",
"type": "string"
},
"record": {
"$ref": "#/$defs/StoredRecord"
}
},
"required": [
"op",
"collection",
"record"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"collection": {
"type": "string"
},
"key": {
"type": "string"
},
"op": {
"const": "replace",
"type": "string"
},
"revision": {
"type": "string"
},
"value": {
"additionalProperties": true,
"type": "object"
}
},
"required": [
"op",
"collection",
"key",
"revision",
"value"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"collection": {
"type": "string"
},
"key": {
"type": "string"
},
"op": {
"const": "delete",
"type": "string"
},
"revision": {
"type": "string"
}
},
"required": [
"op",
"collection",
"key",
"revision"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"contentType": {
"type": "string"
},
"name": {
"type": "string"
},
"op": {
"const": "begin_upload",
"type": "string"
},
"totalSize": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"op",
"name",
"totalSize",
"contentType"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"key": {
"default": null,
"type": [
"string",
"null"
]
},
"op": {
"const": "complete_upload",
"type": "string"
},
"uploadId": {
"type": "string"
}
},
"required": [
"op",
"uploadId"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"bindings": {
"additionalProperties": true,
"default": {},
"type": "object"
},
"expectedCount": {
"description": "Require this many returned/affected rows or roll back the entire\ntransaction. SELECT counts its result after LIMIT, not all matches.",
"format": "uint",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"op": {
"const": "query",
"type": "string"
},
"qql": {
"type": "string"
}
},
"required": [
"op",
"qql"
],
"type": "object"
}
]
}OperationResult
View complete schema
{
"oneOf": [
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"op": {
"const": "create_collection",
"type": "string"
}
},
"required": [
"op",
"name"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"op": {
"const": "create_index",
"type": "string"
}
},
"required": [
"op",
"name"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"op": {
"const": "create_ttl_index",
"type": "string"
}
},
"required": [
"op",
"name"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"op": {
"const": "drop_index",
"type": "string"
}
},
"required": [
"op",
"name"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"nextCursor": {
"type": [
"string",
"null"
]
},
"op": {
"const": "list_records",
"type": "string"
},
"records": {
"items": {
"$ref": "#/$defs/StoredRecord"
},
"type": "array"
}
},
"required": [
"op",
"records"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"op": {
"const": "get",
"type": "string"
},
"record": {
"anyOf": [
{
"$ref": "#/$defs/StoredRecord"
},
{
"type": "null"
}
]
}
},
"required": [
"op",
"record"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"op": {
"const": "insert",
"type": "string"
},
"record": {
"$ref": "#/$defs/StoredRecord"
}
},
"required": [
"op",
"record"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"op": {
"const": "import_record",
"type": "string"
},
"record": {
"$ref": "#/$defs/StoredRecord"
}
},
"required": [
"op",
"record"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"op": {
"const": "replace",
"type": "string"
},
"record": {
"$ref": "#/$defs/StoredRecord"
}
},
"required": [
"op",
"record"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"count": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"op": {
"const": "delete",
"type": "string"
}
},
"required": [
"op",
"count"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"op": {
"const": "begin_upload",
"type": "string"
},
"upload": {
"$ref": "#/$defs/UploadStatus"
}
},
"required": [
"op",
"upload"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"object": {
"$ref": "#/$defs/ObjectReference"
},
"op": {
"const": "complete_upload",
"type": "string"
}
},
"required": [
"op",
"object"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"count": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"op": {
"const": "query",
"type": "string"
},
"records": {
"items": {
"$ref": "#/$defs/StoredRecord"
},
"type": "array"
}
},
"required": [
"op",
"records",
"count"
],
"type": "object"
}
]
}Principal
| Field | Type | Required |
|---|---|---|
id | string | Yes |
name | string | Yes |
role | Role | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"$ref": "#/$defs/Role"
}
},
"required": [
"id",
"name",
"role"
],
"type": "object"
}Role
View complete schema
{
"enum": [
"owner",
"admin",
"reader",
"writer"
],
"type": "string"
}RuntimeInfo
| Field | Type | Required |
|---|---|---|
activeJobs | integer | Yes |
cpuPercent | integer | Yes |
maxConnections | integer | Yes |
maxRequests | integer | Yes |
queueCapacity | integer | Yes |
queuedJobs | integer | Yes |
targetWorkers | integer | Yes |
threadPolicy | string | Yes |
workers | integer | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"activeJobs": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"cpuPercent": {
"format": "uint8",
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"maxConnections": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"maxRequests": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"queueCapacity": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"queuedJobs": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"targetWorkers": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"threadPolicy": {
"type": "string"
},
"workers": {
"format": "uint",
"minimum": 0,
"type": "integer"
}
},
"required": [
"threadPolicy",
"workers",
"targetWorkers",
"activeJobs",
"queuedJobs",
"queueCapacity",
"cpuPercent",
"maxRequests",
"maxConnections"
],
"type": "object"
}Session
View complete schema
{
"anyOf": [
{
"additionalProperties": false,
"properties": {
"authenticated": {
"$ref": "#/$defs/True"
},
"principal": {
"$ref": "#/$defs/Principal"
}
},
"required": [
"authenticated",
"principal"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"authenticated": {
"$ref": "#/$defs/False"
}
},
"required": [
"authenticated"
],
"type": "object"
}
]
}Status
| Field | Type | Required |
|---|---|---|
capabilities | Array<string> | Yes |
keyProvider | KeyProvider | Yes |
mode | InstanceMode | Yes |
name | string | Yes |
state | DatabaseState | Yes |
version | string | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"capabilities": {
"items": {
"type": "string"
},
"type": "array"
},
"keyProvider": {
"$ref": "#/$defs/KeyProvider"
},
"mode": {
"$ref": "#/$defs/InstanceMode"
},
"name": {
"type": "string"
},
"state": {
"$ref": "#/$defs/DatabaseState"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version",
"state",
"mode",
"keyProvider",
"capabilities"
],
"type": "object"
}StorageLayout
View complete schema
{
"enum": [
"logical",
"physical"
],
"type": "string"
}StoredRecord
| Field | Type | Required |
|---|---|---|
key | string | Yes |
revision | string | Yes |
value | object | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"revision": {
"type": "string"
},
"value": {
"additionalProperties": true,
"type": "object"
}
},
"required": [
"key",
"revision",
"value"
],
"type": "object"
}TransactionRequest
| Field | Type | Required |
|---|---|---|
operations | Array<Operation> | Yes |
requestId | string | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"operations": {
"items": {
"$ref": "#/$defs/Operation"
},
"type": "array"
},
"requestId": {
"type": "string"
}
},
"required": [
"requestId",
"operations"
],
"type": "object"
}TransactionResponse
| Field | Type | Required |
|---|---|---|
replayed | boolean | Yes |
results | Array<OperationResult> | Yes |
revision | string | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"replayed": {
"type": "boolean"
},
"results": {
"items": {
"$ref": "#/$defs/OperationResult"
},
"type": "array"
},
"revision": {
"type": "string"
}
},
"required": [
"revision",
"results",
"replayed"
],
"type": "object"
}True
View complete schema
{
"const": true,
"type": "boolean"
}Unlock
| Field | Type | Required |
|---|---|---|
password | string | No |
View complete schema
{
"additionalProperties": false,
"properties": {
"password": {
"default": "",
"type": "string"
}
},
"type": "object"
}UploadStatus
| Field | Type | Required |
|---|---|---|
contentType | string | Yes |
name | string | Yes |
object | ObjectReference | null | No |
objectId | string | Yes |
partCount | integer | Yes |
partSize | integer | Yes |
parts | Array<UploadedPart> | Yes |
state | string | Yes |
totalSize | integer | Yes |
uploadId | string | Yes |
uploadedBytes | integer | Yes |
uploadedParts | integer | Yes |
View complete schema
{
"properties": {
"contentType": {
"type": "string"
},
"name": {
"type": "string"
},
"object": {
"anyOf": [
{
"$ref": "#/$defs/ObjectReference"
},
{
"type": "null"
}
]
},
"objectId": {
"type": "string"
},
"partCount": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"partSize": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"parts": {
"items": {
"$ref": "#/$defs/UploadedPart"
},
"type": "array"
},
"state": {
"type": "string"
},
"totalSize": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"uploadId": {
"type": "string"
},
"uploadedBytes": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"uploadedParts": {
"format": "uint",
"minimum": 0,
"type": "integer"
}
},
"required": [
"uploadId",
"objectId",
"name",
"totalSize",
"contentType",
"partSize",
"partCount",
"uploadedParts",
"uploadedBytes",
"state",
"parts"
],
"type": "object"
}UploadSummary
| Field | Type | Required |
|---|---|---|
contentType | string | Yes |
name | string | Yes |
objectId | string | Yes |
partCount | integer | Yes |
partSize | integer | Yes |
state | string | Yes |
totalSize | integer | Yes |
uploadId | string | Yes |
uploadedBytes | integer | Yes |
uploadedParts | integer | Yes |
View complete schema
{
"properties": {
"contentType": {
"type": "string"
},
"name": {
"type": "string"
},
"objectId": {
"type": "string"
},
"partCount": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"partSize": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"state": {
"type": "string"
},
"totalSize": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"uploadId": {
"type": "string"
},
"uploadedBytes": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"uploadedParts": {
"format": "uint",
"minimum": 0,
"type": "integer"
}
},
"required": [
"uploadId",
"objectId",
"name",
"totalSize",
"contentType",
"partSize",
"partCount",
"uploadedParts",
"uploadedBytes",
"state"
],
"type": "object"
}UploadedPart
| Field | Type | Required |
|---|---|---|
index | integer | Yes |
sha256 | string | Yes |
size | integer | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"index": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"sha256": {
"type": "string"
},
"size": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"index",
"size",
"sha256"
],
"type": "object"
}Uploads
| Field | Type | Required |
|---|---|---|
uploads | Array<UploadSummary> | Yes |
View complete schema
{
"additionalProperties": false,
"properties": {
"uploads": {
"items": {
"$ref": "#/$defs/UploadSummary"
},
"type": "array"
}
},
"required": [
"uploads"
],
"type": "object"
}