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

Commit a40506c

Browse files
[bot]update openapi3 schema
1 parent 24706ab commit a40506c

File tree

1 file changed

+30
-34
lines changed

1 file changed

+30
-34
lines changed

api/build/core-openapi3.yaml

Lines changed: 30 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ paths:
1919
/.p2/core/v1/data:
2020
delete:
2121
operationId: Unregistered_deleteData
22-
summary: Delete own actor data from the sever
22+
summary: Delete own actor data from the server
2323
description: |-
2424
Delete all data associated with you from the server. Only deletes data associated with the
2525
keys for which the `KeyTrial` has been passed.
@@ -37,9 +37,12 @@ paths:
3737
- name: X-P2-core-keytrial
3838
in: header
3939
required: true
40-
description: A completed `KeyTrial`.
40+
description: A list of completed `KeyTrial`s.
4141
schema:
42-
$ref: '#/components/schemas/polyproto.core.models.KeyTrialCompleted'
42+
type: array
43+
items:
44+
$ref: '#/components/schemas/polyproto.core.models.KeyTrialCompleted'
45+
style: simple
4346
responses:
4447
'204':
4548
description: '- `204`: Action executed'
@@ -373,14 +376,19 @@ paths:
373376
post:
374377
operationId: Unregistered_requestAllowResigning
375378
summary: Request message re-signing
376-
description: Request allowing message re-signing. To fulfill this action, a key trial must be passed.
379+
description: |-
380+
Request allowing message re-signing. To fulfill this action, a key trial must be passed.
381+
Unlocks message re-signing for messages signed with keys for which a key trial has been passed.
377382
parameters:
378383
- name: X-P2-core-keytrial
379384
in: header
380385
required: true
381-
description: A completed `KeyTrial`.
386+
description: A list of completed `KeyTrial`s.
382387
schema:
383-
$ref: '#/components/schemas/polyproto.core.models.KeyTrialCompleted'
388+
type: array
389+
items:
390+
$ref: '#/components/schemas/polyproto.core.models.KeyTrialCompleted'
391+
style: simple
384392
responses:
385393
'200':
386394
description: The request has succeeded.
@@ -654,16 +662,19 @@ paths:
654662
This specific route is called by the "old" actor, notifying the server about their intent
655663
to move to another home server. To fulfill this action,
656664
657-
1. A key trial must be passed
658-
// TODO: Must it? If yes, specify for which cert(s) ^
665+
1. A key trial must be passed for all keys with which the actor has sent messages with
666+
on this server.
659667
2. The "new" actor named in this request must confirm setting up this redirect.
660668
parameters:
661669
- name: X-P2-core-keytrial
662670
in: header
663671
required: true
664-
description: A completed `KeyTrial`.
672+
description: A list of completed `KeyTrial`s.
665673
schema:
666-
$ref: '#/components/schemas/polyproto.core.models.KeyTrialCompleted'
674+
type: array
675+
items:
676+
$ref: '#/components/schemas/polyproto.core.models.KeyTrialCompleted'
677+
style: simple
667678
responses:
668679
'200':
669680
description: |-
@@ -687,9 +698,7 @@ paths:
687698
delete:
688699
operationId: Registered_removeRedirect
689700
summary: Remove a redirect for migrating identities
690-
description: |-
691-
Stop an in-progress or existing redirection process. Requires a completed key trial.
692-
// TODO: Does it? ^ If yes, specify for which cert(s)
701+
description: Stop an in-progress or existing redirection process.
693702
parameters:
694703
- name: removeActorFid
695704
in: query
@@ -698,19 +707,16 @@ paths:
698707
schema:
699708
type: string
700709
explode: false
701-
- name: X-P2-core-keytrial
702-
in: header
703-
required: true
704-
description: A completed `KeyTrial`.
705-
schema:
706-
$ref: '#/components/schemas/polyproto.core.models.KeyTrialCompleted'
707710
responses:
708-
'200':
709-
description: The request has succeeded.
710-
content:
711-
application/json:
711+
'204':
712+
description: 'There is no content to send for this request, but the headers may be useful. '
713+
headers:
714+
Content-Length:
715+
required: true
712716
schema:
713-
$ref: '#/components/schemas/polyproto.core.models.KeyTrial'
717+
type: number
718+
enum:
719+
- 0
714720
'400':
715721
description: The server could not understand the request due to invalid syntax.
716722
tags:
@@ -1691,19 +1697,13 @@ components:
16911697
type: object
16921698
required:
16931699
- trial
1694-
- id
16951700
- expires
16961701
properties:
16971702
trial:
16981703
type: string
16991704
minLength: 32
17001705
maxLength: 256
17011706
description: The key trial, which the client should sign with their private identity key.
1702-
id:
1703-
type: string
1704-
minLength: 1
1705-
maxLength: 256
1706-
description: A unique identifying string to differentiate this specific key trial from other key trials that may be open at the same time.
17071707
expires:
17081708
type: integer
17091709
format: uint64
@@ -1717,15 +1717,11 @@ components:
17171717
type: object
17181718
required:
17191719
- signature
1720-
- id
17211720
- serial_number
17221721
properties:
17231722
signature:
17241723
type: string
17251724
description: The signature produced by signing the key trial string using a private identity key.
1726-
id:
1727-
type: string
1728-
description: The unique identifying string, differentiating this specific key trial from other key trials that may be open at the same time.
17291725
serial_number:
17301726
type: integer
17311727
format: uint64

0 commit comments

Comments
 (0)