-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Proposal for a new user data type for profile-linked documents
- Loading branch information
Wes Biggs
committed
Jun 3, 2024
1 parent
f782332
commit d46a05f
Showing
5 changed files
with
55 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,7 @@ CalVer | |
CC0 | ||
Changelog | ||
changeType | ||
cid | ||
[Cc]odec('s)? | ||
contentHash | ||
cryptographic | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# CID | ||
|
||
A Content IDentifier is represented by the CID object type. | ||
|
||
## Serialization | ||
|
||
CID object serialization MUST conform to the following [Avro](https://avro.apache.org) schema: | ||
|
||
``` | ||
{ | ||
"namespace": "org.dsnp", | ||
"name": "CID", | ||
"type": "record", | ||
"doc": "Content IDentifier for external document", | ||
"fields": [ | ||
{ | ||
"name": "cid", | ||
"type": "string", | ||
"doc": "Content IDentifier of document" | ||
}, | ||
{ | ||
"name": "type", | ||
"type": "int", | ||
"doc": "Type of document" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
## Generation | ||
|
||
### cid | ||
|
||
- MUST be a valid value per the [Content IDentifier](https://github.com/multiformats/cid) specification. | ||
|
||
It should be possible to locate the content item associated with a CID on a content-addressed distributed file system. | ||
|
||
### type | ||
|
||
- MUST be a supported DSNP linked document type. | ||
|
||
#### Supported Linked Document Types | ||
|
||
| Value | Description | Specification | Content Type | DSNP Version Added | | ||
| --- | --- | --- | --- | | ||
| 1 | Activity Content Profile with DSNP extensions | [DSNP Profile](../../ActivityContent/Types/Profile.md) | `application/json` | 1.3 | | ||
|
||
All other document type values are reserved for future expansion. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters