Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Changelog

## [1.0.0] — initial release

The OpenDPP knowledge bundle: an **Open Knowledge Format (OKF)** projection of the public OpenDPP API
(`/api/v1`) — cross-linked Markdown "concepts" (one per operation, tag, schema, and webhook, plus a
curated `overview` + `guides`) for AI-agent ingestion. Mirrored from the OpenDPP backend's `okf/**`
and served live at `/okf`, `/okf/manifest.json`, `/okf/bundle.zip`, and `/llms.txt`.

Apache-2.0.
2 changes: 1 addition & 1 deletion guides/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:
- api keys
- tenancy
- security
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

Authenticate with a tenant **API key** sent as a Bearer token:
Expand Down
2 changes: 1 addition & 1 deletion guides/conformance.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
- conformance
- standards
- honesty
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

OpenDPP is deliberately precise about what it claims. In short:
Expand Down
2 changes: 1 addition & 1 deletion guides/errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
- errors
- validation
- troubleshooting
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

Authenticated endpoints return `{ success: false, error, message }` (some endpoints, and all
Expand Down
2 changes: 1 addition & 1 deletion guides/interop-aas-untp.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tags:
- IDTA
- UNTP
- data integrity
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

Public resolution is **content-negotiated**: one URL serves several representations, so a passport
Expand Down
2 changes: 1 addition & 1 deletion guides/public-access-tiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:
- tiers
- capability tokens
- legitimate interest
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

Public resolution endpoints serve **tiered** views of the same URL:
Expand Down
2 changes: 1 addition & 1 deletion guides/rate-limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tags:
- rate limits
- throttling
- headers
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

| Surface | Limit | Headers |
Expand Down
2 changes: 1 addition & 1 deletion guides/sealing-and-verification.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tags:
- eIDAS
- merkle
- RFC 3161
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

OpenDPP passport seals are **eIDAS advanced electronic seals**: an ECDSA P-256 signature over a
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ okf_version: "0.1"

# OpenDPP Integration API — Knowledge Bundle

> An OKF (Open Knowledge Format) projection of the public [OpenDPP Integration API](https://opendpp-node.eu/api-reference), for ingestion by AI agents and humans alike. Generated from [`/openapi.json`](https://opendpp-node.eu/openapi.json) (API v1.6.0).
> An OKF (Open Knowledge Format) projection of the public [OpenDPP Integration API](https://opendpp-node.eu/api-reference), for ingestion by AI agents and humans alike. Generated from [`/openapi.json`](https://opendpp-node.eu/openapi.json) (API v1.0.0).

# Concepts

Expand Down
4 changes: 2 additions & 2 deletions log.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Log

## 2026-06-20
## 2026-06-22

**Update** — Knowledge bundle generated for OpenDPP Integration API v1.6.0. For the full per-version API contract history see [`/openapi.json`](https://opendpp-node.eu/openapi.json) and the project CHANGELOG.
**Update** — Knowledge bundle generated for OpenDPP Integration API v1.0.0. For the full per-version API contract history see [`/openapi.json`](https://opendpp-node.eu/openapi.json) and the project CHANGELOG.
4 changes: 2 additions & 2 deletions manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"okfVersion": "0.1",
"apiVersion": "1.6.0",
"generated": "2026-06-20T00:00:00Z",
"apiVersion": "1.0.0",
"generated": "2026-06-22T00:00:00Z",
"conceptCount": 202,
"concepts": [
{
Expand Down
2 changes: 1 addition & 1 deletion operations/approveGrantRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/grants/{id}/approve
tags:
- POST
- access-grants
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`POST /api/v1/grants/{id}/approve`
Expand Down
4 changes: 2 additions & 2 deletions operations/auditEventLineage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/events/{id}/audit
tags:
- POST
- traceability-audit
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`POST /api/v1/events/{id}/audit`
Expand All @@ -25,7 +25,7 @@ These are geographic screening heuristics evaluated against the data registered

**Rate limit:** global limiter, 100 requests/min per IP (standard `x-ratelimit-*` headers).

When zero violations are found, the response embeds a `TraceabilityComplianceCertificate` object (status `VERIFIED_COMPLIANT`, standards `EUDR-2026` / `UFLPA-2026`); otherwise `certificate` is `null` and `errors` lists each violation as a human-readable string. ANY failure — unknown event id, other-tenant id, or even a circular lineage graph — is reported as the same generic 404 body.
When zero violations are found, the response embeds a `TraceabilityComplianceCertificate` object (status `SCREENED_NO_MATCHES`, screens `OpenDPP-EUDR-heuristic` / `OpenDPP-UFLPA-screen`); otherwise `certificate` is `null` and `errors` lists each violation as a human-readable string. ANY failure — unknown event id, other-tenant id, or even a circular lineage graph — is reported as the same generic 404 body.

## Parameters

Expand Down
2 changes: 1 addition & 1 deletion operations/bulkIngestPassports.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/passports/bulk
tags:
- POST
- passports
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`POST /api/v1/passports/bulk`
Expand Down
2 changes: 1 addition & 1 deletion operations/createFacility.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/facilities
tags:
- POST
- facilities
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`POST /api/v1/facilities`
Expand Down
2 changes: 1 addition & 1 deletion operations/createGrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/grants
tags:
- POST
- access-grants
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`POST /api/v1/grants`
Expand Down
2 changes: 1 addition & 1 deletion operations/createPassport.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/passports
tags:
- POST
- passports
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`POST /api/v1/passports`
Expand Down
2 changes: 1 addition & 1 deletion operations/createWebhookSubscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/webhooks/subscriptions
tags:
- POST
- webhooks
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`POST /api/v1/webhooks/subscriptions`
Expand Down
2 changes: 1 addition & 1 deletion operations/deleteBatteryUnit.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/units/{id}
tags:
- DELETE
- battery-units
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`DELETE /api/v1/units/{id}`
Expand Down
2 changes: 1 addition & 1 deletion operations/deleteDraftPassport.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/passports/{id}
tags:
- DELETE
- passports
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`DELETE /api/v1/passports/{id}`
Expand Down
2 changes: 1 addition & 1 deletion operations/deleteFacility.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/facilities/{id}
tags:
- DELETE
- facilities
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`DELETE /api/v1/facilities/{id}`
Expand Down
2 changes: 1 addition & 1 deletion operations/deleteOperator.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/operators/{id}
tags:
- DELETE
- economic-operators
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`DELETE /api/v1/operators/{id}`
Expand Down
2 changes: 1 addition & 1 deletion operations/deleteWebhookSubscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/webhooks/subscriptions/{id}
tags:
- DELETE
- webhooks
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`DELETE /api/v1/webhooks/subscriptions/{id}`
Expand Down
2 changes: 1 addition & 1 deletion operations/denyGrantRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/grants/{id}/deny
tags:
- POST
- access-grants
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`POST /api/v1/grants/{id}/deny`
Expand Down
2 changes: 1 addition & 1 deletion operations/getApiVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/version
tags:
- GET
- service
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /api/v1/version`
Expand Down
2 changes: 1 addition & 1 deletion operations/getBatteryUnit.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/units/{id}
tags:
- GET
- battery-units
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /api/v1/units/{id}`
Expand Down
2 changes: 1 addition & 1 deletion operations/getBatteryUnitQrCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/units/{id}/qr
tags:
- GET
- qr-codes
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /api/v1/units/{id}/qr`
Expand Down
2 changes: 1 addition & 1 deletion operations/getDppJsonLdContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/contexts/dpp/v1
tags:
- GET
- schemas-vocabulary
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /contexts/dpp/v1`
Expand Down
2 changes: 1 addition & 1 deletion operations/getEventLineage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/events/{id}/lineage
tags:
- GET
- traceability-audit
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /api/v1/events/{id}/lineage`
Expand Down
2 changes: 1 addition & 1 deletion operations/getFacility.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/facilities/{id}
tags:
- GET
- facilities
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /api/v1/facilities/{id}`
Expand Down
2 changes: 1 addition & 1 deletion operations/getHealth.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/health
tags:
- GET
- service
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /health`
Expand Down
2 changes: 1 addition & 1 deletion operations/getJsonLdContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/context/v1
tags:
- GET
- schemas-vocabulary
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /context/v1`
Expand Down
2 changes: 1 addition & 1 deletion operations/getOperator.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/operators/{id}
tags:
- GET
- economic-operators
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /api/v1/operators/{id}`
Expand Down
2 changes: 1 addition & 1 deletion operations/getPassport.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/passports/{id}
tags:
- GET
- passports
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /api/v1/passports/{id}`
Expand Down
2 changes: 1 addition & 1 deletion operations/getPassportQrCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/passports/{id}/qr
tags:
- GET
- qr-codes
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /api/v1/passports/{id}/qr`
Expand Down
2 changes: 1 addition & 1 deletion operations/getSealCaCertificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/.well-known/opendpp-seal-ca.pem
tags:
- GET
- eidas-keys
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /.well-known/opendpp-seal-ca.pem`
Expand Down
2 changes: 1 addition & 1 deletion operations/getSectorSchema.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/schemas/{category}
tags:
- GET
- schemas-vocabulary
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /api/v1/schemas/{category}`
Expand Down
2 changes: 1 addition & 1 deletion operations/getTenantDidDocument.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/tenants/{tenantId}/did.json
tags:
- GET
- verifiable-credentials
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /tenants/{tenantId}/did.json`
Expand Down
2 changes: 1 addition & 1 deletion operations/getTenantRevocationStatusList.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/tenants/{tenantId}/status/revocation
tags:
- GET
- verifiable-credentials
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /tenants/{tenantId}/status/revocation`
Expand Down
2 changes: 1 addition & 1 deletion operations/ingestPassportFromAas.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/passports/aas/ingest
tags:
- POST
- passports
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`POST /api/v1/passports/aas/ingest`
Expand Down
2 changes: 1 addition & 1 deletion operations/listBatteryUnitEvents.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/units/{id}/events
tags:
- GET
- battery-units
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /api/v1/units/{id}/events`
Expand Down
2 changes: 1 addition & 1 deletion operations/listBatteryUnits.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/passports/{passportId}/units
tags:
- GET
- battery-units
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /api/v1/passports/{passportId}/units`
Expand Down
2 changes: 1 addition & 1 deletion operations/listFacilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ resource: https://opendpp-node.eu/api/v1/facilities
tags:
- GET
- facilities
timestamp: 2026-06-20T00:00:00Z
timestamp: 2026-06-22T00:00:00Z
---

`GET /api/v1/facilities`
Expand Down
Loading
Loading