Portitor connector HTTP interface
HTTP interface of portitor-connector. The DSP endpoints follow the DSP 2025-1 HTTPS bindings; the message schemas are the official DSP 2025-1 JSON Schemas (copied unchanged in crates/portitor-dsp/tests/schemas). DSP itself publishes no OpenAPI file; this one is written by hand and a test checks that every path in it is served. As consumer, the connector sends callbackAddress = public URL + /dsp/2025-1/callback, so providers call the callback paths below. No authentication until 0.5 (DCP).
Machine-readable: openapi.json (OpenAPI 3.1.0), with the official DSP JSON Schemas next to it. Open it in any OpenAPI viewer.
| Method | Path | What it does | Responses |
|---|---|---|---|
GET | /.well-known/dspace-version | DSP versions this connector supports | 200 |
POST | /dsp/2025-1/catalog/request | Return the catalog | 200, 400 |
GET | /dsp/2025-1/catalog/datasets/{id} | Return one dataset | 200, 404 |
POST | /dsp/2025-1/negotiations/request | Start a negotiation | 201, 400 |
GET | /dsp/2025-1/negotiations/{providerPid} | State of a negotiation | 200, 404 |
POST | /dsp/2025-1/negotiations/{providerPid}/request | Counter-offer from the consumer | 200, 400, 404 |
POST | /dsp/2025-1/negotiations/{providerPid}/events | Consumer accepts the provider's offer | 200, 400, 404 |
POST | /dsp/2025-1/negotiations/{providerPid}/agreement/verification | Consumer verifies the agreement | 200, 400, 404 |
POST | /dsp/2025-1/negotiations/{providerPid}/termination | Consumer ends the negotiation | 200, 400, 404 |
GET | /dsp/2025-1/callback/negotiations/{consumerPid} | Return the state of a negotiation this connector started as consumer | 200, 404 |
POST | /dsp/2025-1/callback/negotiations/{consumerPid}/offers | Provider sends an offer | 200, 400, 404 |
POST | /dsp/2025-1/callback/negotiations/{consumerPid}/agreement | Provider sends the agreement | 200, 400, 404 |
POST | /dsp/2025-1/callback/negotiations/{consumerPid}/events | Provider finalizes the negotiation | 200, 400, 404 |
POST | /dsp/2025-1/callback/negotiations/{consumerPid}/termination | Provider ends the negotiation | 200, 400, 404 |
GET | /health | Liveness | 200 |