DocumentationAPI reference

Rust · 0.1.0

InstanceSetting_Storage

Application protocol schema. Field names and inherited descriptions are kept in their original language.

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

Referenced by these component schemas:

Shape and fields

object

Storage is a configured attachment storage instance.

FieldType / requirementDescription
idstringid is the stable identifier referenced by attachments.
namestringname is the human-readable storage name.
typestring (enum)
STORAGE_TYPE_UNSPECIFIED · DATABASE · LOCAL · S3
s3ConfigStorage_S3Config

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "id is the stable identifier referenced by attachments."
    },
    "name": {
      "type": "string",
      "description": "name is the human-readable storage name."
    },
    "type": {
      "enum": [
        "STORAGE_TYPE_UNSPECIFIED",
        "DATABASE",
        "LOCAL",
        "S3"
      ],
      "type": "string",
      "format": "enum"
    },
    "s3Config": {
      "$ref": "#/components/schemas/Storage_S3Config"
    }
  },
  "description": "Storage is a configured attachment storage instance."
}