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

Commit bbedc84

Browse files
[bot]update openapi3 schema
1 parent 35e5cbe commit bbedc84

File tree

1 file changed

+41
-49
lines changed

1 file changed

+41
-49
lines changed

api/build/core-openapi3.yaml

Lines changed: 41 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -210,25 +210,13 @@ paths:
210210
explode: false
211211
responses:
212212
'200':
213-
description: JSON-Array of Object(s), each object containing "id_cert" (PEM encoded ID-Cert) and "invalidated" (boolean). An ID-Cert is considered invalidated, if the server or actor choose to revoke the validity of the ID-Cert before the lifetime of the certificate was scheduled to end.
213+
description: JSON-Array of Object(s).
214214
content:
215215
application/json:
216216
schema:
217217
type: array
218218
items:
219-
type: object
220-
properties:
221-
id_cert:
222-
type: string
223-
example: ------BEGIN CERTIFICATE------...
224-
description: PEM encoded ID-Cert
225-
invalidated:
226-
type: boolean
227-
example: false
228-
description: Whether this specific id_cert has been marked as invalidated by the server. An ID-Cert is considered invalidated, if the server or actor choose to revoke the validity of the ID-Cert before the lifetime of the certificate was scheduled to end.
229-
required:
230-
- id_cert
231-
- invalidated
219+
$ref: '#/components/schemas/polyproto.core.models.CacheableIDCert'
232220
tags:
233221
- Federated Identity - Registration not required
234222
/.p2/core/v1/idcert/server:
@@ -255,7 +243,7 @@ paths:
255243
content:
256244
application/json:
257245
schema:
258-
type: string
246+
$ref: '#/components/schemas/polyproto.core.models.CacheableIDCert'
259247
tags:
260248
- Federated Identity - Registration not required
261249
/.p2/core/v1/key/server:
@@ -282,41 +270,9 @@ paths:
282270
- Sensitive Actions
283271
security:
284272
- BearerAuth: []
285-
get:
286-
operationId: Unregistered_serverKey
287-
summary: Get Server Public Key
288-
description: Request the server's public key.
289-
parameters:
290-
- name: timestamp
291-
in: query
292-
required: false
293-
description: |-
294-
An optional UNIX timestamp to retrieve the public key the server had at that
295-
point in time, instead of the current one.
296-
schema:
297-
type: object
298-
properties:
299-
timestamp:
300-
type: integer
301-
format: uint64
302-
required:
303-
- timestamp
304-
explode: false
305-
responses:
306-
'200':
307-
description: |-
308-
The current public key of the server, or, if specified, the public key the server had
309-
at the specified time. The public key is being returned as a PEM encoded X.509
310-
`SubjectPublicKeyInfo`.
311-
content:
312-
application/json:
313-
schema:
314-
type: string
315-
tags:
316-
- Federated Identity - Registration not required
317273
/.p2/core/v1/keytrial:
318274
post:
319-
operationId: Unregistered_keyTrialRedirectExtern
275+
operationId: Unregistered_completeKeyTrial
320276
summary: Complete key trial
321277
description: |-
322278
Complete a key trial. After the successful completion of the key trial, the action that
@@ -525,7 +481,9 @@ paths:
525481
get:
526482
operationId: Unregistered_getMessages
527483
summary: Fetch messages to-be-resigned
528-
description: Fetch messages to be re-signed.
484+
description: |-
485+
Fetch messages to be re-signed. Must only return messages where the signatures correlate to
486+
ID-Certs for which a key trial has been passed.
529487
parameters:
530488
- name: limit
531489
in: query
@@ -1658,6 +1616,40 @@ components:
16581616
type: string
16591617
enum:
16601618
- v1.0-alpha.1
1619+
polyproto.core.models.CacheableIDCert:
1620+
type: object
1621+
required:
1622+
- idCertPem
1623+
- cacheNotValidBefore
1624+
- cacheNotValidAfter
1625+
- cacheSignature
1626+
properties:
1627+
idCertPem:
1628+
type: string
1629+
example: ------BEGIN CERTIFICATE------...
1630+
description: The requested ID-Cert in ASCII PEM format.
1631+
invalidatedAt:
1632+
type: integer
1633+
format: uint64
1634+
example: 1736610000
1635+
description: UNIX timestamp that specifies when this specific id_cert has been marked as invalidated by the server. An ID-Cert is considered invalidated, if the server or actor choose to revoke the validity of the ID-Cert before the lifetime of the certificate was scheduled to end. If this property does not exist, the ID-Cert has not been invalidated.
1636+
cacheNotValidBefore:
1637+
type: integer
1638+
format: uint64
1639+
example: 1736606402
1640+
description: UNIX timestamp that specifies the time from which this cache entry may be treated as valid.
1641+
cacheNotValidAfter:
1642+
type: integer
1643+
format: uint64
1644+
example: 1736613602
1645+
description: UNIX timestamp that specifies a time until which this cache entry may be treated as valid.
1646+
cacheSignature:
1647+
type: string
1648+
example: 7ab2bbde7fe43c7481a3a61031546bab16bc1a8735b2f0cdd519958c7f2f99f8
1649+
minLength: 32
1650+
maxLength: 32
1651+
description: Signature generated by the home server. This signature can be verified using the home servers' public identity key. A server generates the `cacheSignature` by concatenating the serial number of the ID-Cert in question with the `cacheValidNotBefore` timestamp and the `cacheValidNotAfter` timestamp, then generating the signature of the resulting concatenated string using the private identity key of the server. Clients must reject certificates of which the `cacheSignature` can not be verified to be correct.
1652+
description: A cacheable response to an ID-Cert request.
16611653
polyproto.core.models.ChallengeStringResponse:
16621654
type: object
16631655
required:

0 commit comments

Comments
 (0)