You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 15, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: api/build/core-openapi3.yaml
+49-30Lines changed: 49 additions & 30 deletions
Original file line number
Diff line number
Diff line change
@@ -84,6 +84,18 @@ paths:
84
84
description: |-
85
85
- `202` and a key trial, if one still needs to be passed
86
86
- `200` and the appropriate data if the key trial has been passed and is not yet expired.
87
+
The data is a gzipped tarball (.tar.gz) named `[email protected]`, where
88
+
- `export[numbers]` is the word `export` with 20 random digits appended to it
89
+
- `user` is the actors' name
90
+
- `subdomain.example.com` is the FQDN of the server the actor is
91
+
This file archive contains a file `messages.json` which is a JSON `MessageBatch` of all
92
+
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).
93
+
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)
94
+
enabled, the file archive will contain a folder named `rawr`. This folder contains all
95
+
RawR-content uploaded by the actor to that server. The files in this folder are named after
96
+
the resource ID. File extensions are only added if they were known to the server. An
97
+
example file name might be `2c851bfb6daffa944fa1723c7bd4d362ffbc9defe292f2daaf05e895989d179b.jxl`,
98
+
referencing the file which was hosted at `<server_url>/.p2/core/resource/2c851bfb6daffa944fa1723c7bd4d362ffbc9defe292f2daaf05e895989d179b.jxl`.
87
99
- `204` if the server needs time to gather the data. A `Retry-After` header is included in
88
100
the response, indicating to the actor the point in time at which they should query this
89
101
endpoint again. If this point in time is after the expiry timestamp of the completed key trial,
@@ -92,40 +104,23 @@ paths:
92
104
content:
93
105
application/json:
94
106
schema:
95
-
type: array
96
-
items:
97
-
type: object
98
-
required:
99
-
- idCert
100
-
- messages
101
-
properties:
102
-
idCert:
103
-
type: string
104
-
description: The ID-Cert that the following messages' signatures correspond to.
105
-
messages:
106
-
type: array
107
-
items:
108
-
type: object
109
-
properties:
110
-
signature:
111
-
type: string
112
-
description: Signature of the whole message
113
-
content:
114
-
type: string
115
-
description: Arbitrary content `T`. This depends on the specific implementation or extension of the protocol.
116
-
required:
117
-
- signature
118
-
- content
119
-
description: The actual message.
120
-
description: |-
121
-
A message batch, as received from and sent to the server in the context of re-signing messages.
122
-
This type is generic over `T`, where `T` represents the content of the actual message. This
123
-
means, that the specific message content depends on the concrete implementation or extension
124
-
of the polyproto protocol.
107
+
$ref: '#/components/schemas/TypeSpec.Http.File'
125
108
'202':
126
109
description: |-
127
110
- `202` and a key trial, if one still needs to be passed
128
111
- `200` and the appropriate data if the key trial has been passed and is not yet expired.
112
+
The data is a gzipped tarball (.tar.gz) named `[email protected]`, where
113
+
- `export[numbers]` is the word `export` with 20 random digits appended to it
114
+
- `user` is the actors' name
115
+
- `subdomain.example.com` is the FQDN of the server the actor is
116
+
This file archive contains a file `messages.json` which is a JSON `MessageBatch` of all
117
+
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).
118
+
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)
119
+
enabled, the file archive will contain a folder named `rawr`. This folder contains all
120
+
RawR-content uploaded by the actor to that server. The files in this folder are named after
121
+
the resource ID. File extensions are only added if they were known to the server. An
122
+
example file name might be `2c851bfb6daffa944fa1723c7bd4d362ffbc9defe292f2daaf05e895989d179b.jxl`,
123
+
referencing the file which was hosted at `<server_url>/.p2/core/resource/2c851bfb6daffa944fa1723c7bd4d362ffbc9defe292f2daaf05e895989d179b.jxl`.
129
124
- `204` if the server needs time to gather the data. A `Retry-After` header is included in
130
125
the response, indicating to the actor the point in time at which they should query this
131
126
endpoint again. If this point in time is after the expiry timestamp of the completed key trial,
@@ -139,6 +134,18 @@ paths:
139
134
description: |-
140
135
- `202` and a key trial, if one still needs to be passed
141
136
- `200` and the appropriate data if the key trial has been passed and is not yet expired.
137
+
The data is a gzipped tarball (.tar.gz) named `[email protected]`, where
138
+
- `export[numbers]` is the word `export` with 20 random digits appended to it
139
+
- `user` is the actors' name
140
+
- `subdomain.example.com` is the FQDN of the server the actor is
141
+
This file archive contains a file `messages.json` which is a JSON `MessageBatch` of all
142
+
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).
143
+
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)
144
+
enabled, the file archive will contain a folder named `rawr`. This folder contains all
145
+
RawR-content uploaded by the actor to that server. The files in this folder are named after
146
+
the resource ID. File extensions are only added if they were known to the server. An
147
+
example file name might be `2c851bfb6daffa944fa1723c7bd4d362ffbc9defe292f2daaf05e895989d179b.jxl`,
148
+
referencing the file which was hosted at `<server_url>/.p2/core/resource/2c851bfb6daffa944fa1723c7bd4d362ffbc9defe292f2daaf05e895989d179b.jxl`.
142
149
- `204` if the server needs time to gather the data. A `Retry-After` header is included in
143
150
the response, indicating to the actor the point in time at which they should query this
144
151
endpoint again. If this point in time is after the expiry timestamp of the completed key trial,
0 commit comments