StoreFootprintResponse

Fields

One store's contribution to a project's storage footprint.

8 fields

bytes

integer or null

complete

boolean

estimate_basis

string or null

exact · required

boolean

items

integer or null

measured · required

boolean

store · required

string

unreachable_reason

string or null

Raw schema (JSON)

{
  "description": "One store's contribution to a project's storage footprint.\n\n``measured=False`` means the store could not be reached — ``bytes`` and\n``items`` are then ``None``, never ``0``. Zero and unreachable are opposite\nfindings and must not render alike.\n\n``exact=False`` means the byte figure is a proportional estimate over a\nstore shared with other projects; ``estimate_basis`` says how.",
  "properties": {
    "bytes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Bytes"
    },
    "complete": {
      "default": true,
      "title": "Complete",
      "type": "boolean"
    },
    "estimate_basis": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Estimate Basis"
    },
    "exact": {
      "title": "Exact",
      "type": "boolean"
    },
    "items": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Items"
    },
    "measured": {
      "title": "Measured",
      "type": "boolean"
    },
    "store": {
      "title": "Store",
      "type": "string"
    },
    "unreachable_reason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Unreachable Reason"
    }
  },
  "required": [
    "store",
    "measured",
    "exact"
  ],
  "title": "StoreFootprintResponse",
  "type": "object"
}

Used by endpoints

2 endpoints send or return this schema, on its own or inside another schema.

• GET /api/v1/admin/storage/deleted-projects — Get Deleted Project Storage
• GET /api/v1/projects/{project_id}/storage — Get Project Storage

Used by schemas

• ProjectStorageResponse

More details

• Specification: OpenAPI JSON