Plugins

Save a connector's mapping

Replaces a plugin connector's mapping, judged against the types as they stand. Send the version you read. Saving changes no item: the connector applies the mapping to what it writes next. Needs connectors.manage.

PUT
/plugins/{name}/connector/mapping

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Path parameters

name*string

The plugin's name.

Header parameters

X-Marfa-Instance-Id?string

The ID of the instance you expect, as GET / returns it. If another instance answers at this address, Marfa returns 409 instance_changed and doesn't write. Leave it out to send the request to whichever instance answers.

Match^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

application/json
  1. body

The mapping to store, replacing the one stored.

version*integer

The version you read.

Range0 <= value
kinds*

Each kind's entry, by name. A kind you leave out takes its default.

Response body

About errors

Returns the mapping as stored.

application/json
  1. response

A plugin connector's mapping.

version*integer

The mapping's version. 0 until a mapping is saved.

Range0 <= value
kinds*

Each kind the plugin's connector brings, by name.

rewrites*array<>

Each rewrite the owner asked for that the connector has not cleared, oldest first.

  • validation_error: the mapping's shape is wrong, or its target type refuses it: not registered or not writable by you, a required field unfilled, an unknown field, a from the kind's type lacks, a fixed value the field refuses, a template on a field that isn't text, or an unknown status word. details.errors names each path.
application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

forbidden: you don't have connectors.manage (details.required_scope).

application/json
  1. response

An error response.

error*

What went wrong.

  • plugin_not_found: no plugin of this name is installed.
  • plugin_connector_not_found: the plugin has no connector.
application/json
  1. response

An error response.

error*

What went wrong.

  • connector_mapping_stale: the mapping is at another version, which details.version holds. Read it again.
  • instance_changed: another instance answers at this address.
application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

request_too_large: the request body is larger than this instance accepts.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X PUT 'http://localhost:8600/plugins/string/connector/mapping' \  -H 'Content-Type: application/json' \  -d '{  "version": 2,  "kinds": {    "issue": {      "target_type": "common.ticket",      "fields": {        "title": {          "from": "title"        },        "reporter": {          "fixed": "tracker"        }      }    }  }}'
About errors
{  "version": 3,  "kinds": {    "issue": {      "enabled": true,      "target_type": "common.ticket",      "tier": "feed",      "status_overrides": {        "closed": "completed"      },      "fields": {        "title": {          "from": "title"        },        "reporter": {          "fixed": "tracker"        },        "body": {          "template": "{{ body }}"        }      }    }  },  "rewrites": []}