Map a type

Map one of their types to one of yours. Relation is identity, subset, related, or disjoint (deliberately out of scope; target optional).

POST /v1/bridges/{id}/types

cURL

identity

curl --request POST \
  --url https://pnbr.io/v1/bridges/{id}/types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_path": "#/components/schemas/Customer",
  "to_type_name": "Person",
  "to_shape": "crm",
  "relation": "identity",
  "reasoning": "same referent"
}
'

200

{
  "content": [
    {
      "type": "text",
      "text": "Authored #/components/schemas/Customer -[identity]-> crm.Person.\n\nNext steps:\n  • mapType — 1 source type(s) still unmapped. Map them (use disjoint to declare a type unrelated)."
    }
  ],
  "structuredContent": {
    "ok": true,
    "mapping_id": "fe711e54-05e3-42d7-9e54-1a0527e5638c",
    "type_mapping": {
      "from": {
        "source_ir_id": "stripe@v1",
        "source_ir_version": "1",
        "path": "#/components/schemas/Customer"
      },
      "to": {
        "type_name": "Person",
        "shape": "crm",
        "version_hash": ""
      },
      "relation": "identity",
      "reasoning": "same referent"
    },
    "coverage": {
      "mapped": 1,
      "disjoint": 0,
      "unmapped": 1
    },
    "completeness": 0.5
  }
}

Authorizations

Authorization · string · header · required

A pnbr- API key. Project-scoped keys make project_id implicit; org-scoped keys require it.

Path Parameters

id · string · required

Body

application/json

from_path · string · required

Example:

"#/components/schemas/Customer"

relation · enum<string> · required

Available options: identity, subset, related, disjoint

to_type_name · string

to_shape · string

reasoning · string

Response

200 - application/json

The recorded type mapping.