-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmanifest.json
More file actions
1457 lines (1457 loc) · 62.6 KB
/
Copy pathmanifest.json
File metadata and controls
1457 lines (1457 loc) · 62.6 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
{
"okfVersion": "0.1",
"apiVersion": "1.8.0",
"generated": "2026-06-29T00:00:00Z",
"conceptCount": 207,
"concepts": [
{
"path": "overview.md",
"type": "Reference",
"title": "OpenDPP Integration API — overview",
"description": "What the OpenDPP Integration API does, how it is organised, and where to start.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "guides/authentication.md",
"type": "Playbook",
"title": "Authentication & tenancy",
"description": "Authenticate with a tenant API key as a Bearer token; tenant identity is token-bound.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "guides/errors.md",
"type": "Reference",
"title": "Error model",
"description": "Error envelopes returned by the API, including the richer ESPR validation-failure shape.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "guides/rate-limits.md",
"type": "Reference",
"title": "Rate limits",
"description": "Per-IP request limits and the response headers that advertise them.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "guides/public-access-tiers.md",
"type": "Reference",
"title": "Public access tiers",
"description": "How one resolution URL serves tiered views via capability tokens (Battery Reg. Art. 77(9)).",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "guides/sealing-and-verification.md",
"type": "Playbook",
"title": "Sealing & verification",
"description": "Apply an eIDAS advanced electronic seal and verify it offline from the redacted document.",
"resource": "https://opendpp-node.eu/security"
},
{
"path": "guides/interop-aas-untp.md",
"type": "Reference",
"title": "Interop: AAS & UNTP credentials",
"description": "The standards-conformant projections OpenDPP serves alongside JSON-LD, and where to validate them.",
"resource": "https://github.com/OpenDPP/opendpp-interop"
},
{
"path": "guides/conformance.md",
"type": "Reference",
"title": "Conformance honesty",
"description": "What OpenDPP's output conforms to today, what is partial, and what is on the roadmap.",
"resource": "https://github.com/OpenDPP/opendpp-interop"
},
{
"path": "tags/passports.md",
"type": "Reference",
"title": "Passports",
"description": "Create, validate, read, update, seal and manage the lifecycle of Digital Product Passports.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "tags/economic-operators.md",
"type": "Reference",
"title": "Economic Operators",
"description": "Register and manage the economic operators (manufacturers/brands, identified by EORI or national registry id) that passports are issued on behalf of.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "tags/battery-units.md",
"type": "Reference",
"title": "Battery Units",
"description": "Per-unit battery serialization (real serials, GS1 AI 21) under a SKU-level passport, plus append-only telemetry events (state of health, charge cycles, status changes) per the EU Battery Regulation.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "tags/facilities.md",
"type": "Reference",
"title": "Facilities",
"description": "Manufacturing facility master data, identified by GS1 GLN-13 (the Unique Facility Identifier).",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "tags/access-grants.md",
"type": "Reference",
"title": "Access Grants",
"description": "Capability tokens implementing tiered access (Battery Regulation Art.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "tags/webhooks.md",
"type": "Reference",
"title": "Webhooks",
"description": "Subscribe HTTPS endpoints to passport lifecycle events.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "tags/traceability-audit.md",
"type": "Reference",
"title": "Traceability & Audit",
"description": "UNTP/EPCIS supply-chain traceability events, lineage queries, and the public seal verifier.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "tags/public-resolution.md",
"type": "Reference",
"title": "Public Resolution",
"description": "Unauthenticated, content-negotiated passport resolution: GS1 Digital Link paths, passport and unit pages.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "tags/verifiable-credentials.md",
"type": "Reference",
"title": "Verifiable Credentials",
"description": "Issuer trust endpoints that back the UNTP Verifiable Credential representations: the workspace's did:web DID document (public keys only) and its W3C Bitstring Status List for revocation.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "tags/schemas-vocabulary.md",
"type": "Reference",
"title": "Schemas & Vocabulary",
"description": "Machine-readable contracts: per-category ESPR JSON Schemas, the W3C JSON-LD context, and the curated materials vocabulary.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "tags/qr-codes.md",
"type": "Reference",
"title": "QR Codes",
"description": "Export GS1-Digital-Link QR codes (PNG/SVG, 128–2048 px, GS1 quiet zone) for passports and battery units.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "tags/eidas-keys.md",
"type": "Reference",
"title": "eIDAS Keys",
"description": "Tenant signing-key management.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "tags/account.md",
"type": "Reference",
"title": "Account",
"description": "Identity of the authenticated API key / session: workspace, role, permissions, operator scope, and passport usage against the tier quota — the integration-facing counterpart to the console's profile endpoints.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "tags/service.md",
"type": "Reference",
"title": "Service",
"description": "Service metadata and liveness.",
"resource": "https://opendpp-node.eu/api-reference"
},
{
"path": "operations/whoami.md",
"type": "API Endpoint",
"title": "Identity of the authenticated key / session",
"description": "Identity of the authenticated key / session",
"resource": "https://opendpp-node.eu/api/v1/whoami"
},
{
"path": "operations/validateBatteryUnits.md",
"type": "API Endpoint",
"title": "Pre-flight: validate battery-unit identifiers without persisting (#263)",
"description": "Pre-flight: validate battery-unit identifiers without persisting (#263)",
"resource": "https://opendpp-node.eu/api/v1/passports/{passportId}/units/validate"
},
{
"path": "operations/listBatteryUnits.md",
"type": "API Endpoint",
"title": "List serialised battery units under a passport",
"description": "List serialised battery units under a passport",
"resource": "https://opendpp-node.eu/api/v1/passports/{passportId}/units"
},
{
"path": "operations/serializeBatteryUnits.md",
"type": "API Endpoint",
"title": "Serialise individual battery units under a passport (bulk, up to 200)",
"description": "Serialise individual battery units under a passport (bulk, up to 200)",
"resource": "https://opendpp-node.eu/api/v1/passports/{passportId}/units"
},
{
"path": "operations/getBatteryUnit.md",
"type": "API Endpoint",
"title": "Get one battery unit as JSON-LD with its dynamic-data history",
"description": "Get one battery unit as JSON-LD with its dynamic-data history",
"resource": "https://opendpp-node.eu/api/v1/units/{id}"
},
{
"path": "operations/deleteBatteryUnit.md",
"type": "API Endpoint",
"title": "Permanently delete a battery unit and its telemetry",
"description": "Permanently delete a battery unit and its telemetry",
"resource": "https://opendpp-node.eu/api/v1/units/{id}"
},
{
"path": "operations/listBatteryUnitEvents.md",
"type": "API Endpoint",
"title": "List a battery unit's telemetry history (newest first, max 500)",
"description": "List a battery unit's telemetry history (newest first, max 500)",
"resource": "https://opendpp-node.eu/api/v1/units/{id}/events"
},
{
"path": "operations/recordBatteryUnitEvent.md",
"type": "API Endpoint",
"title": "Append an immutable telemetry event to a battery unit",
"description": "Append an immutable telemetry event to a battery unit",
"resource": "https://opendpp-node.eu/api/v1/units/{id}/events"
},
{
"path": "operations/listFacilities.md",
"type": "API Endpoint",
"title": "List facilities in the tenant workspace",
"description": "List facilities in the tenant workspace",
"resource": "https://opendpp-node.eu/api/v1/facilities"
},
{
"path": "operations/createFacility.md",
"type": "API Endpoint",
"title": "Register a facility (GS1 GLN)",
"description": "Register a facility (GS1 GLN)",
"resource": "https://opendpp-node.eu/api/v1/facilities"
},
{
"path": "operations/getFacility.md",
"type": "API Endpoint",
"title": "Get a single facility",
"description": "Get a single facility",
"resource": "https://opendpp-node.eu/api/v1/facilities/{id}"
},
{
"path": "operations/updateFacility.md",
"type": "API Endpoint",
"title": "Update facility master data (GLN is immutable)",
"description": "Update facility master data (GLN is immutable)",
"resource": "https://opendpp-node.eu/api/v1/facilities/{id}"
},
{
"path": "operations/deleteFacility.md",
"type": "API Endpoint",
"title": "Delete a facility (passports are unlinked, never deleted)",
"description": "Delete a facility (passports are unlinked, never deleted)",
"resource": "https://opendpp-node.eu/api/v1/facilities/{id}"
},
{
"path": "operations/listGrants.md",
"type": "API Endpoint",
"title": "List access grants and pending access requests",
"description": "List access grants and pending access requests",
"resource": "https://opendpp-node.eu/api/v1/grants"
},
{
"path": "operations/createGrant.md",
"type": "API Endpoint",
"title": "Issue a legitimate-interest access grant directly",
"description": "Issue a legitimate-interest access grant directly",
"resource": "https://opendpp-node.eu/api/v1/grants"
},
{
"path": "operations/approveGrantRequest.md",
"type": "API Endpoint",
"title": "Approve a pending access request and mint its token",
"description": "Approve a pending access request and mint its token",
"resource": "https://opendpp-node.eu/api/v1/grants/{id}/approve"
},
{
"path": "operations/denyGrantRequest.md",
"type": "API Endpoint",
"title": "Deny a pending access request",
"description": "Deny a pending access request",
"resource": "https://opendpp-node.eu/api/v1/grants/{id}/deny"
},
{
"path": "operations/revokeGrant.md",
"type": "API Endpoint",
"title": "Revoke an access grant (soft revocation)",
"description": "Revoke an access grant (soft revocation)",
"resource": "https://opendpp-node.eu/api/v1/grants/{id}"
},
{
"path": "operations/listOperators.md",
"type": "API Endpoint",
"title": "List economic operators bound to your workspace",
"description": "List economic operators bound to your workspace",
"resource": "https://opendpp-node.eu/api/v1/operators"
},
{
"path": "operations/registerOperator.md",
"type": "API Endpoint",
"title": "Register an economic operator and bind it to your workspace",
"description": "Register an economic operator and bind it to your workspace",
"resource": "https://opendpp-node.eu/api/v1/operators"
},
{
"path": "operations/getOperator.md",
"type": "API Endpoint",
"title": "Fetch a single bound economic operator",
"description": "Fetch a single bound economic operator",
"resource": "https://opendpp-node.eu/api/v1/operators/{id}"
},
{
"path": "operations/updateOperator.md",
"type": "API Endpoint",
"title": "Update an operator's name or role (regId is immutable)",
"description": "Update an operator's name or role (regId is immutable)",
"resource": "https://opendpp-node.eu/api/v1/operators/{id}"
},
{
"path": "operations/deleteOperator.md",
"type": "API Endpoint",
"title": "Remove an operator (archives if it has passports, else hard-deletes)",
"description": "Remove an operator (archives if it has passports, else hard-deletes)",
"resource": "https://opendpp-node.eu/api/v1/operators/{id}"
},
{
"path": "operations/restoreOperator.md",
"type": "API Endpoint",
"title": "Restore an archived operator and its archived passports",
"description": "Restore an archived operator and its archived passports",
"resource": "https://opendpp-node.eu/api/v1/operators/{id}/restore"
},
{
"path": "operations/rotateTenantKeys.md",
"type": "API Endpoint",
"title": "Rotate the tenant's eIDAS ECDSA signing key pair",
"description": "Rotate the tenant's eIDAS ECDSA signing key pair",
"resource": "https://opendpp-node.eu/api/v1/tenants/rotate-keys"
},
{
"path": "operations/listPassports.md",
"type": "API Endpoint",
"title": "List passports in your workspace (paginated JSON-LD)",
"description": "List passports in your workspace (paginated JSON-LD)",
"resource": "https://opendpp-node.eu/api/v1/passports"
},
{
"path": "operations/createPassport.md",
"type": "API Endpoint",
"title": "Create (ingest) a Digital Product Passport",
"description": "Create (ingest) a Digital Product Passport",
"resource": "https://opendpp-node.eu/api/v1/passports"
},
{
"path": "operations/validatePassport.md",
"type": "API Endpoint",
"title": "Dry-run ESPR validation of passport metadata (nothing is stored)",
"description": "Dry-run ESPR validation of passport metadata (nothing is stored)",
"resource": "https://opendpp-node.eu/api/v1/passports/validate-only"
},
{
"path": "operations/validatePassportPublic.md",
"type": "API Endpoint",
"title": "Public dry-run ESPR metadata validation (strictly rate-limited)",
"description": "Public dry-run ESPR metadata validation (strictly rate-limited)",
"resource": "https://opendpp-node.eu/api/v1/passports/validate-only-public"
},
{
"path": "operations/bulkIngestPassports.md",
"type": "API Endpoint",
"title": "Bulk-ingest up to 200 passports with per-row error reporting",
"description": "Bulk-ingest up to 200 passports with per-row error reporting",
"resource": "https://opendpp-node.eu/api/v1/passports/bulk"
},
{
"path": "operations/ingestPassportFromAas.md",
"type": "API Endpoint",
"title": "Ingest a passport from an AAS JSON Environment (seal-verified)",
"description": "Ingest a passport from an AAS JSON Environment (seal-verified)",
"resource": "https://opendpp-node.eu/api/v1/passports/aas/ingest"
},
{
"path": "operations/getPassport.md",
"type": "API Endpoint",
"title": "Fetch a single passport (content-negotiated JSON-LD / AAS / HTML)",
"description": "Fetch a single passport (content-negotiated JSON-LD / AAS / HTML)",
"resource": "https://opendpp-node.eu/api/v1/passports/{id}"
},
{
"path": "operations/updatePassport.md",
"type": "API Endpoint",
"title": "Update passport metadata (versioned to history)",
"description": "Update passport metadata (versioned to history)",
"resource": "https://opendpp-node.eu/api/v1/passports/{id}"
},
{
"path": "operations/deleteDraftPassport.md",
"type": "API Endpoint",
"title": "Permanently delete a DRAFT passport",
"description": "Permanently delete a DRAFT passport",
"resource": "https://opendpp-node.eu/api/v1/passports/{id}"
},
{
"path": "operations/sealPassport.md",
"type": "API Endpoint",
"title": "Apply the tenant's eIDAS advanced electronic seal",
"description": "Apply the tenant's eIDAS advanced electronic seal",
"resource": "https://opendpp-node.eu/api/v1/passports/{id}/seal"
},
{
"path": "operations/updatePassportStatus.md",
"type": "API Endpoint",
"title": "Transition passport lifecycle status (recall / decommission / reactivate)",
"description": "Transition passport lifecycle status (recall / decommission / reactivate)",
"resource": "https://opendpp-node.eu/api/v1/passports/{id}/status"
},
{
"path": "operations/resolvePublicPassport.md",
"type": "API Endpoint",
"title": "Resolve a passport by UUID (JSON-LD / AAS / HTML)",
"description": "Resolve a passport by UUID (JSON-LD / AAS / HTML)",
"resource": "https://opendpp-node.eu/passport/{id}"
},
{
"path": "operations/resolveGs1Gtin.md",
"type": "API Endpoint",
"title": "GS1 Digital Link resolution by GTIN-14 (AI 01)",
"description": "GS1 Digital Link resolution by GTIN-14 (AI 01)",
"resource": "https://opendpp-node.eu/01/{gtin14}"
},
{
"path": "operations/resolveGs1GtinSerial.md",
"type": "API Endpoint",
"title": "GS1 Digital Link serialised-item redirect (AI 01 + AI 21)",
"description": "GS1 Digital Link serialised-item redirect (AI 01 + AI 21)",
"resource": "https://opendpp-node.eu/01/{gtin14}/21/{serial}"
},
{
"path": "operations/resolveGs1Grai.md",
"type": "API Endpoint",
"title": "GS1 Digital Link resolution by GRAI (AI 8003)",
"description": "GS1 Digital Link resolution by GRAI (AI 8003)",
"resource": "https://opendpp-node.eu/8003/{grai}"
},
{
"path": "operations/resolvePublicBatteryUnit.md",
"type": "API Endpoint",
"title": "Resolve an individual serialised battery unit",
"description": "Resolve an individual serialised battery unit",
"resource": "https://opendpp-node.eu/unit/{id}"
},
{
"path": "operations/getSealCaCertificate.md",
"type": "API Endpoint",
"title": "Download the platform seal-CA certificate (PEM)",
"description": "Download the platform seal-CA certificate (PEM)",
"resource": "https://opendpp-node.eu/.well-known/opendpp-seal-ca.pem"
},
{
"path": "operations/getSectorSchema.md",
"type": "API Endpoint",
"title": "Get the ESPR metadata schema for a product category",
"description": "Get the ESPR metadata schema for a product category",
"resource": "https://opendpp-node.eu/api/v1/schemas/{category}"
},
{
"path": "operations/getDppJsonLdContext.md",
"type": "API Endpoint",
"title": "Canonical resolvable JSON-LD context for passport & unit documents",
"description": "Canonical resolvable JSON-LD context for passport & unit documents",
"resource": "https://opendpp-node.eu/contexts/dpp/v1"
},
{
"path": "operations/getJsonLdContext.md",
"type": "API Endpoint",
"title": "W3C JSON-LD context document for passport terms (secondary, fixed term list)",
"description": "W3C JSON-LD context document for passport terms (secondary, fixed term list)",
"resource": "https://opendpp-node.eu/context/v1"
},
{
"path": "operations/getHealth.md",
"type": "API Endpoint",
"title": "Service health check",
"description": "Service health check",
"resource": "https://opendpp-node.eu/health"
},
{
"path": "operations/getApiVersion.md",
"type": "API Endpoint",
"title": "Running API contract version & build identity",
"description": "Running API contract version & build identity",
"resource": "https://opendpp-node.eu/api/v1/version"
},
{
"path": "operations/decodeGs1.md",
"type": "API Endpoint",
"title": "Decode GS1 scan data / element string / Digital Link into structured AIs + HRI",
"description": "Decode GS1 scan data / element string / Digital Link into structured AIs + HRI",
"resource": "https://opendpp-node.eu/api/v1/gs1/decode"
},
{
"path": "operations/decodeGs1Batch.md",
"type": "API Endpoint",
"title": "Batch-decode many GS1 scans / element strings / Digital Links in one request",
"description": "Batch-decode many GS1 scans / element strings / Digital Links in one request",
"resource": "https://opendpp-node.eu/api/v1/gs1/decode/batch"
},
{
"path": "operations/getPassportQrCode.md",
"type": "API Endpoint",
"title": "Export a print-grade GS1 Digital Link QR code for a passport",
"description": "Export a print-grade GS1 Digital Link QR code for a passport",
"resource": "https://opendpp-node.eu/api/v1/passports/{id}/qr"
},
{
"path": "operations/bulkExportPassportLabels.md",
"type": "API Endpoint",
"title": "Bulk-export print-grade QR labels for many passports as a ZIP",
"description": "Bulk-export print-grade QR labels for many passports as a ZIP",
"resource": "https://opendpp-node.eu/api/v1/passports/labels"
},
{
"path": "operations/getBatteryUnitQrCode.md",
"type": "API Endpoint",
"title": "Export a print-grade QR code for an individual battery unit",
"description": "Export a print-grade QR code for an individual battery unit",
"resource": "https://opendpp-node.eu/api/v1/units/{id}/qr"
},
{
"path": "operations/listMaterials.md",
"type": "API Endpoint",
"title": "List the platform-curated material vocabulary",
"description": "List the platform-curated material vocabulary",
"resource": "https://opendpp-node.eu/api/v1/materials"
},
{
"path": "operations/registerTraceabilityEvent.md",
"type": "API Endpoint",
"title": "Register a UNTP/EPCIS 2.0 traceability event (VC-shaped)",
"description": "Register a UNTP/EPCIS 2.0 traceability event (VC-shaped)",
"resource": "https://opendpp-node.eu/api/v1/events"
},
{
"path": "operations/getEventLineage.md",
"type": "API Endpoint",
"title": "Retrieve the upstream pedigree of an event as a recursive lineage DAG",
"description": "Retrieve the upstream pedigree of an event as a recursive lineage DAG",
"resource": "https://opendpp-node.eu/api/v1/events/{id}/lineage"
},
{
"path": "operations/auditEventLineage.md",
"type": "API Endpoint",
"title": "Run heuristic UFLPA/EUDR compliance screening over an event's lineage",
"description": "Run heuristic UFLPA/EUDR compliance screening over an event's lineage",
"resource": "https://opendpp-node.eu/api/v1/events/{id}/audit"
},
{
"path": "operations/verifyPassportSeal.md",
"type": "API Endpoint",
"title": "Publicly verify a passport's eIDAS seal, certificate chain and timestamp",
"description": "Publicly verify a passport's eIDAS seal, certificate chain and timestamp",
"resource": "https://opendpp-node.eu/api/v1/audit/verify"
},
{
"path": "operations/getTenantDidDocument.md",
"type": "API Endpoint",
"title": "Resolve a tenant's did:web DID document",
"description": "Resolve a tenant's did:web DID document",
"resource": "https://opendpp-node.eu/tenants/{tenantId}/did.json"
},
{
"path": "operations/getTenantRevocationStatusList.md",
"type": "API Endpoint",
"title": "Tenant revocation status list (W3C Bitstring Status List)",
"description": "Tenant revocation status list (W3C Bitstring Status List)",
"resource": "https://opendpp-node.eu/tenants/{tenantId}/status/revocation"
},
{
"path": "operations/listWebhookSubscriptions.md",
"type": "API Endpoint",
"title": "List webhook subscriptions (signing secrets stripped)",
"description": "List webhook subscriptions (signing secrets stripped)",
"resource": "https://opendpp-node.eu/api/v1/webhooks/subscriptions"
},
{
"path": "operations/createWebhookSubscription.md",
"type": "API Endpoint",
"title": "Register a webhook subscription (signing secret returned once)",
"description": "Register a webhook subscription (signing secret returned once)",
"resource": "https://opendpp-node.eu/api/v1/webhooks/subscriptions"
},
{
"path": "operations/updateWebhookSubscription.md",
"type": "API Endpoint",
"title": "Update a webhook subscription (url / events / active)",
"description": "Update a webhook subscription (url / events / active)",
"resource": "https://opendpp-node.eu/api/v1/webhooks/subscriptions/{id}"
},
{
"path": "operations/deleteWebhookSubscription.md",
"type": "API Endpoint",
"title": "Delete a webhook subscription",
"description": "Delete a webhook subscription",
"resource": "https://opendpp-node.eu/api/v1/webhooks/subscriptions/{id}"
},
{
"path": "operations/rotateWebhookSecret.md",
"type": "API Endpoint",
"title": "Rotate a webhook subscription's signing secret",
"description": "Rotate a webhook subscription's signing secret",
"resource": "https://opendpp-node.eu/api/v1/webhooks/subscriptions/{id}/rotate-secret"
},
{
"path": "operations/listWebhookDeliveries.md",
"type": "API Endpoint",
"title": "List recent webhook delivery attempts (the outbox)",
"description": "List recent webhook delivery attempts (the outbox)",
"resource": "https://opendpp-node.eu/api/v1/webhooks/deliveries"
},
{
"path": "operations/testWebhookSubscription.md",
"type": "API Endpoint",
"title": "Send a signed test event to a subscription",
"description": "Send a signed test event to a subscription",
"resource": "https://opendpp-node.eu/api/v1/webhooks/subscriptions/{id}/test"
},
{
"path": "schemas/AasEnvironment.md",
"type": "Schema",
"title": "AasEnvironment",
"description": "An Asset Administration Shell (AAS) v3.0 environment export of the passport, served as application/aas+json.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/AasEnvironment"
},
{
"path": "schemas/AasEnvironmentInput.md",
"type": "Schema",
"title": "AasEnvironmentInput",
"description": "An Asset Administration Shell (AAS) JSON Environment — the format produced by OpenDPP's AAS export of a passport.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/AasEnvironmentInput"
},
{
"path": "schemas/AasIngestCreated.md",
"type": "Schema",
"title": "AasIngestCreated",
"description": "201 envelope of POST /api/v1/passports/aas/ingest.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/AasIngestCreated"
},
{
"path": "schemas/ApproveGrantRequest.md",
"type": "Schema",
"title": "ApproveGrantRequest",
"description": "Approval body — only the final expiry is supplied; everything else comes from the original request.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/ApproveGrantRequest"
},
{
"path": "schemas/BatteryUnitCreateItem.md",
"type": "Schema",
"title": "BatteryUnitCreateItem",
"description": "One unit to serialise.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitCreateItem"
},
{
"path": "schemas/BatteryUnitCurrentState.md",
"type": "Schema",
"title": "BatteryUnitCurrentState",
"description": "Latest recorded measurement of the unit (owner/grant tiers only).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitCurrentState"
},
{
"path": "schemas/BatteryUnitDeleteResponse.md",
"type": "Schema",
"title": "BatteryUnitDeleteResponse",
"description": "BatteryUnitDeleteResponse",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitDeleteResponse"
},
{
"path": "schemas/BatteryUnitDynamicDataEvent.md",
"type": "Schema",
"title": "BatteryUnitDynamicDataEvent",
"description": "One telemetry event in the JSON-LD dynamicData history (privileged view only).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitDynamicDataEvent"
},
{
"path": "schemas/BatteryUnitEventListResponse.md",
"type": "Schema",
"title": "BatteryUnitEventListResponse",
"description": "BatteryUnitEventListResponse",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitEventListResponse"
},
{
"path": "schemas/BatteryUnitEventNode.md",
"type": "Schema",
"title": "BatteryUnitEventNode",
"description": "One append-only telemetry event (owner/grant tiers only).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitEventNode"
},
{
"path": "schemas/BatteryUnitEventRow.md",
"type": "Schema",
"title": "BatteryUnitEventRow",
"description": "One immutable per-unit telemetry record (raw persisted row).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitEventRow"
},
{
"path": "schemas/BatteryUnitEventType.md",
"type": "Schema",
"title": "BatteryUnitEventType",
"description": "Per-unit dynamic-data event category (Annex XIII / Art.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitEventType"
},
{
"path": "schemas/BatteryUnitJsonLd.md",
"type": "Schema",
"title": "BatteryUnitJsonLd",
"description": "JSON-LD document for one serialised battery unit, privileged tenant view (isPrivileged=true): includes currentState + dynamicData telemetry (restricted to legitimate-interest holders/authorities on the public view, where a restrictedData m…",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitJsonLd"
},
{
"path": "schemas/BatteryUnitLineageRef.md",
"type": "Schema",
"title": "BatteryUnitLineageRef",
"description": "Public lineage pointer between battery units (Art.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitLineageRef"
},
{
"path": "schemas/BatteryUnitListResponse.md",
"type": "Schema",
"title": "BatteryUnitListResponse",
"description": "BatteryUnitListResponse",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitListResponse"
},
{
"path": "schemas/BatteryUnitRestrictedDataNotice.md",
"type": "Schema",
"title": "BatteryUnitRestrictedDataNotice",
"description": "Marker replacing per-unit telemetry in anonymous (public-tier) responses, with a pointer for requesting legitimate-interest access (Reg.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitRestrictedDataNotice"
},
{
"path": "schemas/BatteryUnitRow.md",
"type": "Schema",
"title": "BatteryUnitRow",
"description": "One physical serialised battery (raw persisted row — these routes declare no Fastify response schema, so all model fields are returned as-is).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitRow"
},
{
"path": "schemas/BatteryUnitSerialisationFailedError.md",
"type": "Schema",
"title": "BatteryUnitSerialisationFailedError",
"description": "400 body when every item in the serialisation batch failed.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitSerialisationFailedError"
},
{
"path": "schemas/BatteryUnitStatus.md",
"type": "Schema",
"title": "BatteryUnitStatus",
"description": "Annex XIII battery-status vocabulary (Battery Reg.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitStatus"
},
{
"path": "schemas/BatteryUnitTombstoneJsonLd.md",
"type": "Schema",
"title": "BatteryUnitTombstoneJsonLd",
"description": "Art.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/BatteryUnitTombstoneJsonLd"
},
{
"path": "schemas/CreateGrantRequest.md",
"type": "Schema",
"title": "CreateGrantRequest",
"description": "Direct-issuance body.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/CreateGrantRequest"
},
{
"path": "schemas/DeleteOperatorResponse.md",
"type": "Schema",
"title": "DeleteOperatorResponse",
"description": "DeleteOperatorResponse",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/DeleteOperatorResponse"
},
{
"path": "schemas/DidWebDocument.md",
"type": "Schema",
"title": "DidWebDocument",
"description": "A tenant's did:web DID document (public-key material only).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/DidWebDocument"
},
{
"path": "schemas/DppJsonLdContextDocument.md",
"type": "Schema",
"title": "DppJsonLdContextDocument",
"description": "The fixed W3C JSON-LD context document served by GET /context/v1: maps DigitalProductPassport, economicOperator, metadata, digitalSeal, signingPublicKey and proof to https://opendpp-node.eu/ns/dpp#… IRIs, and createdAt/updatedAt to schema.…",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/DppJsonLdContextDocument"
},
{
"path": "schemas/DppVocabContextDocument.md",
"type": "Schema",
"title": "DppVocabContextDocument",
"description": "The canonical resolvable JSON-LD context served by GET /contexts/dpp/v1 — the context every public passport and battery-unit document references in its @context.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/DppVocabContextDocument"
},
{
"path": "schemas/EconomicOperatorNode.md",
"type": "Schema",
"title": "EconomicOperatorNode",
"description": "Embedded economic-operator JSON-LD node (public in all tiers).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/EconomicOperatorNode"
},
{
"path": "schemas/Error.md",
"type": "Schema",
"title": "Error",
"description": "Standard error body.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/Error"
},
{
"path": "schemas/FacilityCreateRequest.md",
"type": "Schema",
"title": "FacilityCreateRequest",
"description": "FacilityCreateRequest",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/FacilityCreateRequest"
},
{
"path": "schemas/FacilityCreatedEnvelope.md",
"type": "Schema",
"title": "FacilityCreatedEnvelope",
"description": "FacilityCreatedEnvelope",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/FacilityCreatedEnvelope"
},
{
"path": "schemas/FacilityDeletedEnvelope.md",
"type": "Schema",
"title": "FacilityDeletedEnvelope",
"description": "FacilityDeletedEnvelope",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/FacilityDeletedEnvelope"
},
{
"path": "schemas/FacilityEnvelope.md",
"type": "Schema",
"title": "FacilityEnvelope",
"description": "FacilityEnvelope",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/FacilityEnvelope"
},
{
"path": "schemas/FacilityListEnvelope.md",
"type": "Schema",
"title": "FacilityListEnvelope",
"description": "FacilityListEnvelope",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/FacilityListEnvelope"
},
{
"path": "schemas/FacilityRow.md",
"type": "Schema",
"title": "FacilityRow",
"description": "A facility (GS1 GLN) master-data row, exactly as stored.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/FacilityRow"
},
{
"path": "schemas/FacilityUpdateRequest.md",
"type": "Schema",
"title": "FacilityUpdateRequest",
"description": "Partial update.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/FacilityUpdateRequest"
},
{
"path": "schemas/FastifyDefaultBadRequest.md",
"type": "Schema",
"title": "FastifyDefaultBadRequest",
"description": "Fastify's default 400 error body, returned when a syntactically malformed JSON request body is rejected by the framework before the handler runs (so none of the handler-built {success:false, ...} shapes apply).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/FastifyDefaultBadRequest"
},
{
"path": "schemas/GrantDecisionResponse.md",
"type": "Schema",
"title": "GrantDecisionResponse",
"description": "Returned by deny and revoke: the updated grant, no token.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/GrantDecisionResponse"
},
{
"path": "schemas/GrantIssuedResponse.md",
"type": "Schema",
"title": "GrantIssuedResponse",
"description": "Returned by direct issuance (201) and request approval (200).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/GrantIssuedResponse"
},
{
"path": "schemas/GrantListResponse.md",
"type": "Schema",
"title": "GrantListResponse",
"description": "List envelope for GET /api/v1/grants (paginated).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/GrantListResponse"
},
{
"path": "schemas/GrantRouteError.md",
"type": "Schema",
"title": "GrantRouteError",
"description": "Error body used by the grants endpoints' route-level errors (400/403/404/409).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/GrantRouteError"
},
{
"path": "schemas/GrantRow.md",
"type": "Schema",
"title": "GrantRow",
"description": "Tenant-facing projection of an access grant.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/GrantRow"
},
{
"path": "schemas/HealthStatus.md",
"type": "Schema",
"title": "HealthStatus",
"description": "Health-check body of GET /health.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/HealthStatus"
},
{
"path": "schemas/MaterialVocabularyListResponse.md",
"type": "Schema",
"title": "MaterialVocabularyListResponse",
"description": "Envelope of GET /api/v1/materials.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/MaterialVocabularyListResponse"
},
{
"path": "schemas/MaterialVocabularyRow.md",
"type": "Schema",
"title": "MaterialVocabularyRow",
"description": "One entry of the platform-curated material vocabulary.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/MaterialVocabularyRow"
},
{
"path": "schemas/MerkleTreeAttestationProof.md",
"type": "Schema",
"title": "MerkleTreeAttestationProof",
"description": "OpenDPP's own proof type — an eIDAS ADVANCED electronic seal: an ECDSA prime256v1 signature over a SHA-256 Merkle root of the key-sorted metadata (one leaf per top-level metadata key).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/MerkleTreeAttestationProof"
},
{
"path": "schemas/OperatorGetResponse.md",
"type": "Schema",
"title": "OperatorGetResponse",
"description": "OperatorGetResponse",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/OperatorGetResponse"
},
{
"path": "schemas/OperatorListResponse.md",
"type": "Schema",
"title": "OperatorListResponse",
"description": "OperatorListResponse",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/OperatorListResponse"
},
{
"path": "schemas/OperatorMinimalError.md",
"type": "Schema",
"title": "OperatorMinimalError",
"description": "Minimal error envelope used by the operator/key self-service handlers — note the standard error key is ABSENT (unlike the shared Error schema).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/OperatorMinimalError"
},
{
"path": "schemas/OperatorRow.md",
"type": "Schema",
"title": "OperatorRow",
"description": "An economic-operator record (EconomicOperator).",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/OperatorRow"
},
{
"path": "schemas/PassportAasEnvironment.md",
"type": "Schema",
"title": "PassportAasEnvironment",
"description": "IDTA Asset Administration Shell environment (returned when Accept contains application/aas+json), role-filtered for the caller's access tier.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/PassportAasEnvironment"
},
{
"path": "schemas/PassportBulkFailure.md",
"type": "Schema",
"title": "PassportBulkFailure",
"description": "400 body of POST /api/v1/passports/bulk when EVERY row failed.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/PassportBulkFailure"
},
{
"path": "schemas/PassportBulkRequest.md",
"type": "Schema",
"title": "PassportBulkRequest",
"description": "PassportBulkRequest",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/PassportBulkRequest"
},
{
"path": "schemas/PassportBulkResult.md",
"type": "Schema",
"title": "PassportBulkResult",
"description": "201 partial-success envelope of POST /api/v1/passports/bulk.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/PassportBulkResult"
},
{
"path": "schemas/PassportBulkRow.md",
"type": "Schema",
"title": "PassportBulkRow",
"description": "One bulk-ingestion row.",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/PassportBulkRow"
},
{
"path": "schemas/PassportCreateRequest.md",
"type": "Schema",
"title": "PassportCreateRequest",
"description": "PassportCreateRequest",
"resource": "https://opendpp-node.eu/openapi.json#/components/schemas/PassportCreateRequest"
},