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

Commit ba4387a

Browse files
github-actions[bot]github-actions[bot]
committed
[bot]update openapi3 schema
1 parent 1bdd930 commit ba4387a

File tree

1 file changed

+40
-50
lines changed

1 file changed

+40
-50
lines changed

‎build/core-openapi3.yaml‎

Lines changed: 40 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
openapi: 3.0.0
1+
openapi: 3.1.0
22
info:
33
title: polyproto core APIs
44
license:
@@ -42,7 +42,6 @@ paths:
4242
type: array
4343
items:
4444
$ref: '#/components/schemas/polyproto.core.models.KeyTrialCompleted'
45-
style: simple
4645
responses:
4746
'204':
4847
description: '- `204`: Action executed'
@@ -76,7 +75,6 @@ paths:
7675
type: array
7776
items:
7877
$ref: '#/components/schemas/polyproto.core.models.KeyTrialCompleted'
79-
style: simple
8078
responses:
8179
'200':
8280
description: |-
@@ -134,8 +132,9 @@ paths:
134132
properties:
135133
id_cert:
136134
type: string
137-
example: ------BEGIN CERTIFICATE------...
138135
description: The generated [ID-Cert](/Protocol%20Specifications/core/#71-home-server-signed-certificates-for-public-client-identity-keys-id-cert) in PEM format.
136+
examples:
137+
- ------BEGIN CERTIFICATE------...
139138
token:
140139
type: string
141140
description: An authorization secret, called a "session token", valid for this `id_cert`/session.
@@ -148,7 +147,7 @@ paths:
148147
requestBody:
149148
required: true
150149
content:
151-
application/json:
150+
text/plain:
152151
schema:
153152
type: string
154153
security:
@@ -242,7 +241,7 @@ paths:
242241
'200':
243242
description: The servers' new ID-Cert, encoded as PEM
244243
content:
245-
application/json:
244+
text/plain:
246245
schema:
247246
type: string
248247
tags:
@@ -393,7 +392,6 @@ paths:
393392
type: array
394393
items:
395394
$ref: '#/components/schemas/polyproto.core.models.KeyTrialCompleted'
396-
style: simple
397395
responses:
398396
'200':
399397
description: The request has succeeded.
@@ -674,7 +672,6 @@ paths:
674672
type: array
675673
items:
676674
$ref: '#/components/schemas/polyproto.core.models.KeyTrialCompleted'
677-
style: simple
678675
responses:
679676
'200':
680677
description: |-
@@ -689,7 +686,7 @@ paths:
689686
requestBody:
690687
required: true
691688
content:
692-
application/json:
689+
text/plain:
693690
schema:
694691
type: string
695692
description: The FID of the actor, that this actor would like to be redirected to.
@@ -855,9 +852,9 @@ paths:
855852
- `403`: Server or resource not accessible for the actor making this request.
856853
- `404`: Resource not found.
857854
content:
858-
application/json:
855+
'*/*':
859856
schema:
860-
$ref: '#/components/schemas/TypeSpec.Http.File'
857+
contentMediaType: '*/*'
861858
'308':
862859
description: |-
863860
- `200`: File found and retrieved.
@@ -872,7 +869,7 @@ paths:
872869
type: string
873870
format: uri
874871
content:
875-
application/json:
872+
text/plain:
876873
schema:
877874
type: string
878875
enum:
@@ -885,7 +882,7 @@ paths:
885882
- `403`: Server or resource not accessible for the actor making this request.
886883
- `404`: Resource not found.
887884
content:
888-
application/json:
885+
text/plain:
889886
schema:
890887
type: string
891888
enum:
@@ -898,7 +895,7 @@ paths:
898895
- `403`: Server or resource not accessible for the actor making this request.
899896
- `404`: Resource not found.
900897
content:
901-
application/json:
898+
text/plain:
902899
schema:
903900
type: string
904901
enum:
@@ -911,7 +908,7 @@ paths:
911908
- `403`: Server or resource not accessible for the actor making this request.
912909
- `404`: Resource not found.
913910
content:
914-
application/json:
911+
text/plain:
915912
schema:
916913
type: string
917914
enum:
@@ -973,7 +970,7 @@ paths:
973970
- `413`: Resource too large.
974971
- `414`: RID too long.
975972
content:
976-
application/json:
973+
text/plain:
977974
schema:
978975
type: string
979976
enum:
@@ -987,7 +984,7 @@ paths:
987984
- `413`: Resource too large.
988985
- `414`: RID too long.
989986
content:
990-
application/json:
987+
text/plain:
991988
schema:
992989
type: string
993990
enum:
@@ -1001,7 +998,7 @@ paths:
1001998
- `413`: Resource too large.
1002999
- `414`: RID too long.
10031000
content:
1004-
application/json:
1001+
text/plain:
10051002
schema:
10061003
type: string
10071004
enum:
@@ -1058,9 +1055,9 @@ paths:
10581055
requestBody:
10591056
required: true
10601057
content:
1061-
application/json:
1058+
'*/*':
10621059
schema:
1063-
$ref: '#/components/schemas/TypeSpec.Http.File'
1060+
contentMediaType: '*/*'
10641061
description: ': The resource itself'
10651062
security:
10661063
- BearerAuth: []
@@ -1169,7 +1166,7 @@ paths:
11691166
type: string
11701167
format: uri
11711168
content:
1172-
application/json:
1169+
text/plain:
11731170
schema:
11741171
type: string
11751172
enum:
@@ -1182,7 +1179,7 @@ paths:
11821179
- `403`: Server or resource not accessible for the actor making this request.
11831180
- `404`: Resource not found.
11841181
content:
1185-
application/json:
1182+
text/plain:
11861183
schema:
11871184
type: string
11881185
enum:
@@ -1195,7 +1192,7 @@ paths:
11951192
- `403`: Server or resource not accessible for the actor making this request.
11961193
- `404`: Resource not found.
11971194
content:
1198-
application/json:
1195+
text/plain:
11991196
schema:
12001197
type: string
12011198
enum:
@@ -1208,7 +1205,7 @@ paths:
12081205
- `403`: Server or resource not accessible for the actor making this request.
12091206
- `404`: Resource not found.
12101207
content:
1211-
application/json:
1208+
text/plain:
12121209
schema:
12131210
type: string
12141211
enum:
@@ -1534,7 +1531,7 @@ paths:
15341531
'200':
15351532
description: The request has succeeded.
15361533
content:
1537-
application/json:
1534+
text/plain:
15381535
schema:
15391536
type: string
15401537
tags:
@@ -1564,7 +1561,7 @@ paths:
15641561
requestBody:
15651562
required: true
15661563
content:
1567-
application/json:
1564+
text/plain:
15681565
schema:
15691566
type: string
15701567
security:
@@ -1703,18 +1700,6 @@ paths:
17031700
- {}
17041701
components:
17051702
schemas:
1706-
TypeSpec.Http.File:
1707-
type: object
1708-
required:
1709-
- contents
1710-
properties:
1711-
contentType:
1712-
type: string
1713-
filename:
1714-
type: string
1715-
contents:
1716-
type: string
1717-
format: byte
17181703
Version:
17191704
type: string
17201705
enum:
@@ -1729,29 +1714,34 @@ components:
17291714
properties:
17301715
idCertPem:
17311716
type: string
1732-
example: ------BEGIN CERTIFICATE------...
17331717
description: The requested ID-Cert in ASCII PEM format.
1718+
examples:
1719+
- ------BEGIN CERTIFICATE------...
17341720
invalidatedAt:
17351721
type: integer
17361722
format: uint64
1737-
example: 1736610000
17381723
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.
1724+
examples:
1725+
- 1736610000
17391726
cacheNotValidBefore:
17401727
type: integer
17411728
format: uint64
1742-
example: 1736606402
17431729
description: UNIX timestamp that specifies the time from which this cache entry may be treated as valid.
1730+
examples:
1731+
- 1736606402
17441732
cacheNotValidAfter:
17451733
type: integer
17461734
format: uint64
1747-
example: 1736613602
17481735
description: UNIX timestamp that specifies a time until which this cache entry may be treated as valid.
1736+
examples:
1737+
- 1736613602
17491738
cacheSignature:
17501739
type: string
1751-
example: 7ab2bbde7fe43c7481a3a61031546bab16bc1a8735b2f0cdd519958c7f2f99f8
17521740
minLength: 32
17531741
maxLength: 32
17541742
description: Signature generated by the home server, encoded in [Hexadecimal](https://en.wikipedia.org/wiki/Hexadecimal) (base-16). 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, the `cacheValidNotAfter` timestamp, and the `invalidatedAt` timestamp, if present. Clients must reject certificates of which the `cacheSignature` can not be verified to be correct.
1743+
examples:
1744+
- 7ab2bbde7fe43c7481a3a61031546bab16bc1a8735b2f0cdd519958c7f2f99f8
17551745
description: A cacheable response to an ID-Cert request.
17561746
polyproto.core.models.EncryptedPKM:
17571747
type: object
@@ -1914,18 +1904,18 @@ components:
19141904
type: array
19151905
items:
19161906
type: string
1917-
example:
1918-
- [email protected]
1919-
- instance.example.com
19201907
description: A list of actors and/or instances allowed to access this resource.
1908+
examples:
1909+
- - [email protected]
1910+
- instance.example.com
19211911
denylist:
19221912
type: array
19231913
items:
19241914
type: string
1925-
example:
1926-
- [email protected]
1927-
- other_instance.example.com
19281915
description: A list of actors and/or instances who cannot have access to this resource.
1916+
examples:
1917+
- - [email protected]
1918+
- other_instance.example.com
19291919
description: |-
19301920
`ResourceAccessProperties` define which actors may access an uploaded resource. Actors and
19311921
entire instances can have access granted or revoked.
@@ -1969,7 +1959,7 @@ components:
19691959
securitySchemes:
19701960
BearerAuth:
19711961
type: http
1972-
scheme: bearer
1962+
scheme: Bearer
19731963
servers:
19741964
- url: https://example.com
19751965
description: Example endpoint

0 commit comments

Comments
 (0)