Skip to content
This repository was archived by the owner on Aug 15, 2025. It is now read-only.

Commit 9560db9

Browse files
committed
Update documentation of P2Export to match (newer) spec document
1 parent 0e17298 commit 9560db9

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

api/src/core/main.tsp

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -120,18 +120,21 @@ namespace models {
120120
* - `export[numbers]` is the word `export` with 20 random digits appended to it
121121
* - `user` is the actors' name
122122
* - `subdomain.example.com` is the FQDN of the server the actor is registered on.
123-
* This file archive contains a file `messages.json` which is a JSON `MessageBatch` of all
124-
* messages sent by the user. Note the [definition of the word "message" in polyproto](https://docs.polyphony.chat/Protocol%20Specifications/core/#:~:text=software%20for%20clients.-,message%2C%20messages,-%3A%20In%20the%20context).
125-
* If the server where the data export was requested from has [RawR](https://docs.polyphony.chat/Protocol%20Specifications/core/#731-resource-addressing-with-relative-roots)
126-
* enabled, the file archive will contain a folder named `rawr`. This folder contains all
127-
* RawR-content uploaded by the actor to that server. The files in this folder are named after
128-
* the resource ID. File extensions are only added if they were known to the server. An
129-
* example file name might be `2c851bfb6daffa944fa1723c7bd4d362ffbc9defe292f2daaf05e895989d179b.jxl`,
130-
* referencing the file which was hosted at `<server_url>/.p2/core/resource/2c851bfb6daffa944fa1723c7bd4d362ffbc9defe292f2daaf05e895989d179b.jxl`.
123+
* This file archive contains a file `messages.p2mb` which is a JSON file containing [message batches](https://docs.polyphony.chat/Protocol%20Specifications/core/#721-message-batches)
124+
* of all messages sent by the user. If the server where the data export was requested from has
125+
* [RawR](https://docs.polyphony.chat/Protocol%20Specifications/core/#731-resource-addressing-with-relative-roots) enabled, the file archive will contain a
126+
* folder named `rawr`. This folder contains all RawR content uploaded by the actor to that server.
127+
* The files in this folder are named after the resource ID given to the resource. File extensions are only
128+
* added if they were known to the server. An example file name might be
129+
* `2c851bfb6daffa944fa1723c7bd4d362ffbc9defe292f2daaf05e895989d179b.jxl`, referencing the file
130+
* which was hosted at `<server_url>/.p2/core/resource/2c851bfb6daffa944fa1723c7bd4d362ffbc9defe292f2daaf05e895989d179b.jxl`.
131131
* If the server where the data export was requested from is the actors' home server, the
132-
* archive will contain two folders `certs` and `crypt_certs`. `certs` will contain all ID-Certs
133-
* the server has stored of the actor. `crypt_certs` will contain all encrypted private key
134-
* material that the actor has uploaded to the server.
132+
* archive will contain a folder `certs` and a file `crypt_certs.p2epk`. `certs` will contain all ID-Certs
133+
* the server has stored of the actor. The ID-Certs will be stored in
134+
* [ASCII PEM format](https://web.archive.org/web/20250107131731/https://learn.microsoft.com/en-us/azure/iot-hub/reference-x509-certificates#:~:text=ASN.1%20encoding.-,ascii%20pem%20format,-A%20PEM%20certificate).
135+
* The file `crypt_certs.p2epk` contains all [encrypted private key material](https://docs.polyphony.chat/Protocol%20Specifications/core/#63-private-key-loss-prevention-and-private-key-recovery)
136+
* that the actor has uploaded to the server. Just like `messages.p2mb`, `crypt_certs.p2epk` is a standard
137+
* JSON file.
135138
*/
136139
model P2Export {}
137140
}

0 commit comments

Comments
 (0)