CompliancePackRead

Fields

15 fields

bytes · required

integer

file_count · required

integer

generated_at · required

string (date-time)

generated_by_user_id

string (uuid) or null

holds

array of HoldRefRead

id · required

string (uuid)

manifest_sha256 · required

string

metadata_snapshot

object or null

minio_key · required

string

notes

string or null

project_id · required

string (uuid)

release_id

string (uuid) or null

retention_expires_at · required

string (date-time)

signing_key_id

string or null

test_run_id

string (uuid) or null

Raw schema (JSON)

{
  "properties": {
    "bytes": {
      "title": "Bytes",
      "type": "integer"
    },
    "file_count": {
      "title": "File Count",
      "type": "integer"
    },
    "generated_at": {
      "format": "date-time",
      "title": "Generated At",
      "type": "string"
    },
    "generated_by_user_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Generated By User Id"
    },
    "holds": {
      "items": {
        "$ref": "#/components/schemas/HoldRefRead"
      },
      "title": "Holds",
      "type": "array"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "manifest_sha256": {
      "title": "Manifest Sha256",
      "type": "string"
    },
    "metadata_snapshot": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Metadata Snapshot"
    },
    "minio_key": {
      "title": "Minio Key",
      "type": "string"
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Notes"
    },
    "project_id": {
      "format": "uuid",
      "title": "Project Id",
      "type": "string"
    },
    "release_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Release Id"
    },
    "retention_expires_at": {
      "format": "date-time",
      "title": "Retention Expires At",
      "type": "string"
    },
    "signing_key_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Signing Key Id"
    },
    "test_run_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Test Run Id"
    }
  },
  "required": [
    "id",
    "project_id",
    "minio_key",
    "manifest_sha256",
    "file_count",
    "bytes",
    "retention_expires_at",
    "generated_at"
  ],
  "title": "CompliancePackRead",
  "type": "object"
}

Used by endpoints

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

• POST /api/v1/releases/{release_id}/compliance-pack — Generate Compliance Pack
• GET /api/v1/releases/{release_id}/compliance-packs — List Compliance Packs

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON