Skip to content

doc: adds max manifest consideration to manifest documentation #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
imdominicreed wants to merge 2 commits into
base: main
Choose a base branch
from
Open

doc: adds max manifest consideration to manifest documentation #61

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b74b8d
max manifest docs
imdominicreed Nov 20, 2025
eb9b248
Update schema/OpenTDF/manifest.md
imdominicreed Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion schema/OpenTDF/manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ The manifest object contains the following top-level properties:
| `encryptionInformation` | Object | Contains details about encryption, key access, integrity, and policy. See [Encryption Information Object](./encryption_information.md). | Yes |
| `assertions` | Array | Optional array of verifiable statements about the TDF or payload. See [Assertions Array](./assertion.md). | No |

### Manifest Size Considerations

For larger payloads, the number of entries in the `integrityInformation.segments` array directly determines the manifest size. As segment count increases, the `integrityInformation` length grows proportionally. With the default settings, a 1 TB TDF file with 1 MB segments will result in approximately one million segment entries in the manifest. Some SDKs impose maximum length limits on the manifest. To avoid problems with very large payloads, either configure your client to allow larger manifest sizes or to encrypt with larger segment lengths.

## Full Manifest Example

This example illustrates a complete `manifest.json` structure. Links point to detailed descriptions of each major section.
Expand Down Expand Up @@ -102,4 +106,4 @@ This example illustrates a complete `manifest.json` structure. Links point to de
}
}
]
}
}