Skip to content
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.

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

[EPIC] New v0 metadata structure #1

Open
12 tasks
Zorlin opened this issue Aug 28, 2024 · 0 comments
Open
12 tasks

[EPIC] New v0 metadata structure #1

Zorlin opened this issue Aug 28, 2024 · 0 comments

Comments

@Zorlin
Copy link
Contributor

Zorlin commented Aug 28, 2024

This lays out a metadata structure we're going to call v0.

Tests are required for each and every task, even if they're super basic tests; just want to make sure we're not breaking these functions as we go

Support creating:

Support modifying/replacing:

Support moving:

Overall design - https://github.com/user-attachments/assets/a2bdfa31-5c4a-4637-96fd-be1e687280d0

Root document

The root document will simply be a document that looks like this:

Key Value Description
type "root" Root document type
directory documentID Document with root directory documentID

Directory document

The directory document will simply be a document that looks like this:

Key Value Description
type "directory" Directory document type
children documentID Document with children list document
name string Name of directory (without paths)
metadata documentID Document with metadata associated with this directory

Children document

Key Value Description
type "children" Children document type
fsdir-movies documentID Link to a directory document with "movies" dir in it
fsfile-RiP - A Remix Manifesto.mkv documentID Link to a file document with "RiP - A Remix Manifesto.mkv" file in it
metadata documentID Document with metadata associated with this directory

File document

Key Value Description
type "file" File document type
name string Name of file (without paths)
blob blobID Link to a blob with "RiP - A Remix Manifesto.mkv" file in it
metadata documentID Document with metadata associated with this directory

Blob document

<No format specified, it's just a plain Iroh blob>

@riffcc riffcc deleted a comment Aug 28, 2024
@Zorlin Zorlin changed the title New v0 metadata structure [EPIC] New v0 metadata structure Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant