This repository was archived by the owner on Jul 28, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 34
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1431 lines (1411 loc) · 49 KB
/
openapi.yaml
File metadata and controls
1431 lines (1411 loc) · 49 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
version: 1.0.0
title: Warg Registry API
description: |
[warg](https://warg.io/) is an open source protocol for WebAssembly component registries.
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
# The Warg APIs currently do not use an authentication scheme
# Publishing requires that entries are signed with an acceptable key
x-42c-no-authentication: true
# Ignore warnings regarding strings in responses not having a pattern or maximum length
x-42c-skipIssues:
- v3-schema-response-string-pattern
- v3-schema-response-string-maxlength
tags:
- name: fetch
description: API for fetching checkpoints, logs and package names from the registry.
- name: package
description: API for managing package logs in the registry.
- name: content
description: API for content sources in the registry.
- name: proof
description: API for proving the integrity of the registry.
- name: monitor
description: API for verifying registry checkpoints.
- name: ledger
description: API for fetching the ledger.
servers:
- url: http://localhost:8090/v1
description: Local development server
paths:
/fetch/names:
post:
summary: Fetch package names
operationId: fetchNames
security: []
tags:
- fetch
description: |
Fetch the package names for registry log IDs.
parameters:
- name: Warg-Registry
in: header
$ref: "#/components/headers/WargRegistryHeader"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/FetchPackageNamesRequest"
responses:
"200":
description: The package names were successfully fetched.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/FetchPackageNamesResponse"
"404":
description: A requested entity was not found.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- status
- type
- id
properties:
status:
type: integer
description: The HTTP status code for the error.
example: 404
type:
type: string
description: The type of entity that was not found.
enum: [log]
example: log
id:
type: string
description: The identifier of the entity that was not found.
example: sha256:b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
default:
description: An error occurred when processing the request.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/fetch/logs:
post:
summary: Fetch registry logs
operationId: fetchLogs
security: []
tags:
- fetch
description: |
Fetch the operator and packages logs from the registry.
parameters:
- name: Warg-Registry
in: header
$ref: "#/components/headers/WargRegistryHeader"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/FetchLogsRequest"
responses:
"200":
description: The logs were successfully fetched.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/FetchLogsResponse"
"404":
description: A requested entity was not found.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
oneOf:
- "$ref": "#/components/schemas/FetchLogsIDNotFoundError"
- "$ref": "#/components/schemas/FetchLogsLogLengthNotFoundError"
default:
description: An error occurred when processing the request.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/fetch/checkpoint:
get:
summary: Fetch latest registry checkpoint
operationId: getCheckpoint
security: []
tags:
- fetch
description: Fetch the latest checkpoint from the registry.
parameters:
- name: Warg-Registry
in: header
$ref: "#/components/headers/WargRegistryHeader"
responses:
"200":
description: The checkpoint was successfully fetched.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/SignedCheckpoint"
default:
description: An error occurred when processing the request.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/package/{logId}/record:
post:
summary: Publish package record
operationId: publishPackageRecord
security: []
tags:
- package
description: |
Attempts to publish a new record to a package log.
Publishing package records is an asynchronous operation.
The record must be signed by a key that is authorized to modify the package log.
parameters:
- name: logId
in: path
description: The package log identifier.
required: true
schema:
"$ref": "#/components/schemas/AnyHash"
- name: Warg-Registry
in: header
$ref: "#/components/headers/WargRegistryHeader"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/PublishPackageRecordRequest"
responses:
"202":
description: The package record was accepted.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
"$ref": "#/components/schemas/PackageRecord"
"401":
description: |
Unauthorized rejection from the registry.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: A requested entity was not found.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- status
- type
- id
properties:
status:
type: integer
description: The HTTP status code for the error.
example: 404
type:
type: string
description: The type of entity that was not found.
enum: [namespace]
example: namespace
id:
type: string
description: |
The identifier of the entity that was not found.
"409":
description: The requested package publish conflicts.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- status
- type
- id
properties:
status:
type: integer
description: The HTTP status code for the error.
example: 409
type:
type: string
description: The type of entity that was not found.
enum: [name, namespace, namespaceImport, record]
example: namespace
id:
type: string
description: |
The identifier of the entity that was not found.
"422":
description: |
The package was rejected by the registry.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"501":
description: |
The server does not support publishing package records with explicitly
specified content source locations.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
default:
description: An error occurred when processing the request.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/package/{logId}/record/{recordId}:
get:
summary: Get package record status
operationId: getPackageRecord
security: []
tags:
- package
description: |
Gets package record status from the registry.
A package record is in one of the following states:
* `sourcing`: The package record needs content sources.
* `processing`: The package record is being processed.
* `rejected`: The package record was rejected.
* `published`: The package record was published to the log.
parameters:
- name: logId
in: path
description: The package log identifier.
required: true
schema:
"$ref": "#/components/schemas/AnyHash"
- name: recordId
in: path
description: The record identifier.
required: true
schema:
"$ref": "#/components/schemas/AnyHash"
- name: Warg-Registry
in: header
$ref: "#/components/headers/WargRegistryHeader"
responses:
"200":
description: The package record.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
"$ref": "#/components/schemas/PackageRecord"
"404":
description: A requested entity was not found.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- status
- type
- id
properties:
status:
type: integer
description: The HTTP status code for the error.
example: 404
type:
type: string
description: The type of entity that was not found.
enum: [log, record]
example: log
id:
"$ref": "#/components/schemas/AnyHash"
description: |
The identifier of the entity that was not found.
default:
description: An error occurred when processing the request.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/content/{digest}:
get:
summary: Get content sources
operationId: getContentSources
security: []
tags:
- content
description: |
Gets a content sources for the given digest from the registry.
parameters:
- name: digest
in: path
description: The content digest.
required: true
schema:
"$ref": "#/components/schemas/AnyHash"
- name: Warg-Registry
in: header
$ref: "#/components/headers/WargRegistryHeader"
responses:
"200":
description: The content digest sources.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
"$ref": "#/components/schemas/ContentSourcesResponse"
"404":
description: A requested entity was not found.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- status
- type
- id
properties:
status:
type: integer
description: The HTTP status code for the error.
example: 404
type:
type: string
description: The type of entity that was not found.
enum: [contentDigest]
example: contentDigest
id:
"$ref": "#/components/schemas/AnyHash"
description: |
The identifier of the entity that was not found.
default:
description: An error occurred when processing the request.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/proof/consistency:
post:
summary: Prove registry checkpoint consistency
operationId: proveConsistency
security: []
tags:
- proof
description: |
Proves the consistency of the registry between two specified checkpoints.
parameters:
- name: Warg-Registry
in: header
$ref: "#/components/headers/WargRegistryHeader"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ProveConsistencyRequest"
responses:
"200":
description: The consistency proof was generated successfully.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/ProveConsistencyResponse"
"404":
description: A requested entity was not found.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- status
- type
- id
properties:
status:
type: integer
description: The HTTP status code for the error.
example: 404
type:
type: string
description: The type of entity that was not found.
enum: [logLength]
example: logLength
id:
type: integer
description: The identifier of the entity that was not found.
"422":
description: The proof bundle could not be generated.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
oneOf:
- "$ref": "#/components/schemas/BundleFailureError"
discriminator:
propertyName: reason
mapping:
failure: "#/components/schemas/BundleFailureError"
default:
description: An error occurred when processing the request.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/proof/inclusion:
post:
summary: Prove log leaf inclusion
operationId: proveInclusion
security: []
tags:
- proof
description: |
Proves that the given log leafs are present in the given registry checkpoint.
parameters:
- name: Warg-Registry
in: header
$ref: "#/components/headers/WargRegistryHeader"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ProveInclusionRequest"
responses:
"200":
description: The inclusion proof was generated successfully.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/ProveInclusionResponse"
"404":
description: A requested entity was not found.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- status
- type
- id
properties:
status:
type: integer
description: The HTTP status code for the error.
example: 404
type:
type: string
description: The type of entity that was not found.
enum: [logLength, leaf]
example: logLength
id:
type: integer
description: The identifier of the entity that was not found.
"422":
description: The proof bundle could not be generated.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
oneOf:
- "$ref": "#/components/schemas/PackageNotIncludedError"
- "$ref": "#/components/schemas/IncorrectProofError"
- "$ref": "#/components/schemas/BundleFailureError"
discriminator:
propertyName: reason
mapping:
packageNotIncluded: "#/components/schemas/PackageNotIncludedError"
incorrectProof: "#/components/schemas/IncorrectProofError"
failure: "#/components/schemas/BundleFailureError"
default:
description: An error occurred when processing the request.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/verify/checkpoint:
post:
summary: Verify registry checkpoint
operationId: verifyCheckpoint
security: []
tags:
- monitor
description: Verify checkpoint from the registry. The client must interpret the response body to determine the verification status.
parameters:
- name: Warg-Registry
in: header
$ref: "#/components/headers/WargRegistryHeader"
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SignedCheckpoint"
responses:
"200":
description: The checkpoint verification request was processed. The client must interpret the response body to determine the verification status.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/CheckpointVerificationResponse"
default:
description: An error occurred when processing the request.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
/ledger:
get:
summary: Fetch ledger sources
operationId: getLedgerSources
security: []
tags:
- ledger
description: Fetch the registry ledger download URL sources.
parameters:
- name: Warg-Registry
in: header
$ref: "#/components/headers/WargRegistryHeader"
responses:
"200":
description: The ledger sources was successfully fetched.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/LedgerSourcesResponse"
default:
description: An error occurred when processing the request.
headers:
Warg-Registry:
$ref: "#/components/headers/WargRegistryHeader"
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
components:
headers:
WargRegistryHeader:
name: Warg-Registry
in: header
description: If present and supported, this registry responds on behalf of the other registry specified in this header value.
required: false
schema:
type: string
example: registry.example.com
schemas:
Error:
type: object
description: A generic error response.
additionalProperties: false
required:
- status
- message
properties:
status:
type: integer
description: The HTTP status code for the error.
example: 406
message:
type: string
description: The error message.
example: the server cannot produce an acceptable response
AnyHash:
type: string
description: Represents a supported hash.
example: sha256:b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c
pattern: ^[a-z0-9-]+:[a-f0-9]+$
FetchPackageNamesRequest:
type: object
description: A request to fetch package names from the registry.
additionalProperties: false
required:
- packages
properties:
packages:
type: array
description: The log ID for each requested package.
example: ["sha256:7d865e959b2466918c9863afca942d0fb89d7c9ac0c99bafc3749504ded9773"]
minimum: 1
items:
$ref: "#/components/schemas/AnyHash"
description: The log ID for each package.
FetchPackageNamesResponse:
type: object
description: A response containing the requested package names.
additionalProperties: false
properties:
packages:
type: object
description: The map of log ID to package name.
patternProperties:
"^[a-z0-9-]+:[a-f0-9]+$":
type: string
nullable: true
description: The package name for each package. If `null`, the package name is not able to be provided for the log ID.
example:
"sha256:7d865e959b2466918c9863afca942d0fb89d7c9ac0c99bafc3749504ded9773": "example-namespace:package-name"
"sha256:b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c": null
FetchLogsRequest:
type: object
description: A request to fetch logs from the registry.
additionalProperties: false
required:
- logLength
properties:
logLength:
type: integer
description: The registry checkpoint log length to fetch from.
example: 101
minimum: 1
limit:
type: integer
description: The limit of operator and packages records to return for the fetch request.
example: 100
default: 100
minimum: 1
maximum: 1000
format: int16
operator:
$ref: "#/components/schemas/AnyHash"
description: The last known operator record fetch token.
packages:
type: object
description: |
The map of package log identifier to last known package record fetch token.
If the last package record identifier is null, records are returned from the start of the log.
patternProperties:
"^[a-z0-9-]+:[a-f0-9]+$":
$ref: "#/components/schemas/AnyHash"
description: The last known package record identifier.
nullable: true
example:
"sha256:7d865e959b2466918c9863afca942d0fb89d7c9ac0c99bafc3749504ded9773": "sha256:7d865e959b2466918c9863afca942d0fb89d7c9ac0c99bafc3749504ded97730"
"sha256:b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c": null
FetchLogsResponse:
type: object
description: A response containing the requested logs.
additionalProperties: false
properties:
more:
type: boolean
description: |
Whether there may be more records available.
This occurs when the number of records returned for a log reaches the requested limit.
If `true`, the client should make another request with the new last known record identifiers.
example: false
operator:
type: array
description: The operator log records for the given checkpoint since the last known record.
maxItems: 1000
items:
$ref: "#/components/schemas/PublishedRecordEnvelope"
warnings:
type: array
description: An optional list of warnings.
maxItems: 1000
items:
$ref: "#/components/schemas/FetchWarning"
packages:
type: object
description: The map of package log identifier to package records.
patternProperties:
"^[a-z0-9-]+:[a-f0-9]+$":
type: array
description: The package log records for the given checkpoint since the last known record.
maxItems: 1000
items:
$ref: "#/components/schemas/PublishedRecordEnvelope"
example:
? "sha256:7d865e959b2466918c9863afca942d0fb89d7c9ac0c99bafc3749504ded97730"
: - contentBytes: "ZXhhbXBsZQ=="
keyId: "sha256:7d865e959b2466918c9863afca942d0fb89d7c9ac0c99bafc3749504ded97730"
signature: "ecdsa-p256:MEUCIQCzWZBW6ux9LecP66Y+hjmLZTP/hZVz7puzlPTXcRT2wwIgQZO7nxP0nugtw18MwHZ26ROFWcJmgCtKOguK031Y1D0="
registryIndex: 101
fetchToken: "sha256:7d865e959b2466918c9863afca942d0fb89d7c9ac0c99bafc3749504ded97730"
- contentBytes: "ZXhhbXBsZQ=="
keyId: "sha256:7d865e959b2466918c9863afca942d0fb89d7c9ac0c99bafc3749504ded97730"
signature: "ecdsa-p256:MEUCIQCzWZBW6ux9LecP66Y+hjmLZTP/hZVz7puzlPTXcRT2wwIgQZO7nxP0nugtw18MwHZ26ROFWcJmgCtKOguK031Y1D0="
registryIndex: 305
fetchToken: "sha256:b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c"
? "sha256:b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c"
: - contentBytes: "ZXhhbXBsZQ=="
keyId: "sha256:7d865e959b2466918c9863afca942d0fb89d7c9ac0c99bafc3749504ded97730"
signature: "ecdsa-p256:MEUCIQCzWZBW6ux9LecP66Y+hjmLZTP/hZVz7puzlPTXcRT2wwIgQZO7nxP0nugtw18MwHZ26ROFWcJmgCtKOguK031Y1D0="
registryIndex: 732
fetchToken: "sha256:ygdb4e8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae00a8y"
PublishPackageRecordRequest:
type: object
description: A request to publish a record to a package log.
additionalProperties: false
required:
- packageName
- record
properties:
packageName:
type: string
description: The name of the package log being published to.
maxLength: 128
example: wasi:http
record:
"$ref": "#/components/schemas/EnvelopeBody"
description: The package record being published to the log.
contentSources:
"$ref": "#/components/schemas/ContentSourceMap"
description: |
The map of all content sources for the record.
A registry may not support specifying content sources for a record.
If a registry does not support content sources, a 501 will be returned
and content will need to be directly uploaded to the registry.
PackageRecord:
description: A package log record.
allOf:
- type: object
required:
- recordId
properties:
recordId:
"$ref": "#/components/schemas/AnyHash"
description: The record identifier.
- oneOf:
- "$ref": "#/components/schemas/SourcingRecord"
- "$ref": "#/components/schemas/ProcessingRecord"
- "$ref": "#/components/schemas/RejectedRecord"
- "$ref": "#/components/schemas/PublishedRecord"
discriminator:
propertyName: state
mapping:
sourcing: "#/components/schemas/SourcingRecord"
processing: "#/components/schemas/ProcessingRecord"
rejected: "#/components/schemas/RejectedRecord"
published: "#/components/schemas/PublishedRecord"
ProveConsistencyRequest:
type: object
description: A request to prove the consistency of the registry.
additionalProperties: false
required:
- from
- to
properties:
from:
type: integer
description: The starting log length.
minimum: 1
example: 42
to:
type: integer
description: The ending log length.
minimum: 1
example: 42
ProveConsistencyResponse:
type: object
description: A response containing the consistency proof bundle.
additionalProperties: false
required:
- proof
properties:
proof:
type: string
description: The consistency proof bundle.
format: byte
example: "ZXhhbXBsZQ=="
ProveInclusionRequest:
type: object
description: A request to prove the inclusion of log leafs in a checkpoint.
additionalProperties: false
required:
- logLength
- leafs
properties:
logLength:
type: integer
description: The checkpoint log length to prove the inclusion for.
leafs:
type: array
maxItems: 1000
description: The log leaf registry log index to prove the inclusion for.
items:
type: integer
ProveInclusionResponse:
type: object
description: A response containing the inclusion proof bundle.
additionalProperties: false
required:
- log
- map
properties:
log:
type: string
description: The log inclusion proof bundle.
format: byte
example: "ZXhhbXBsZQ=="
map:
type: string
description: The map inclusion proof bundle.
format: byte
example: "ZXhhbXBsZQ=="
SourcingRecord:
type: object
description: The package record is sourcing content.
required:
- state
- missingContent
properties:
state:
type: string
description: The state of the package record.
enum: [sourcing]
example: sourcing
missingContent:
"$ref": "#/components/schemas/MissingContentMap"
description: The missing content for the package record.
minProperties: 1
ProcessingRecord:
type: object
description: A record that is being processed.
required:
- state
properties:
state:
type: string
description: The state of the package record.
enum: [processing]
example: processing
RejectedRecord:
type: object
description: A rejected package record.
required:
- state
- reason
properties:
state:
type: string
description: The state of the package record.
enum: [rejected]
example: rejected
reason:
type: string
description: The reason the package record was rejected.