je4.github.io

gocfl / ocfl / extensions

View My GitHub Profile

Deutsch

The Inventory (inventory.json)

The heart of every OCFL object is the inventory.json. It contains all the metadata necessary to fully reconstruct the state of the object and its versions.

Note: The complete inventory is available here: Full Inventory

Excerpts from the Inventory

1. Header

{
  "id": "urn:nbn:de:gbv:42-test1",
  "type": "https://ocfl.io/1.1/spec/#inventory",
  "digestAlgorithm": "sha512",
  "head": "v1",
  "contentDirectory": "content"
}

Explanation:

2. Manifest (excerpt)

{
  "manifest": {
    "1082b5603213...": [
      "v1/content/data/image/IMG_6914.jpg"
    ],
    "6f6a6418e726...": [
      "v1/content/README.md"
    ],
    "87c82e1a5b55...": [
      "v1/content/metadata/info.json"
    ]
  }
}

Explanation:

3. Versions (excerpt v1)

{
  "versions": {
    "v1": {
      "created": "2026-03-15T15:04:33Z",
      "message": "initial commit",
      "state": {
        "1082b5603213...": [ "data/image/IMG_6914.jpg" ],
        "6f6a6418e726...": [ "README.md" ],
        "87c82e1a5b55...": [ "metadata/info.json" ]
      },
      "user": {
        "name": "User OCFL",
        "address": "mailto:ocfl.user@unibas.ch"
      }
    }
  }
}

Explanation:

4. Fixity (excerpt)

{
  "fixity": {
    "blake2b-384": {
      "a3ea374ca4db...": [ "v1/content/README.md" ]
    },
    "md5": {
      "2ecbccede07a...": [ "v1/content/README.md" ]
    }
  }
}

Explanation:


For the full JSON please see: Full Inventory

Navigation: Back to Object Structure Table of Contents Next: Update Object