# dev.knotless.inviteRunner

> Published by [lexicons.knotless.dev](https://lexicon.garden/identity/did:plc:yqsg7znbbhfmj3a2nrpnaerk)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:yqsg7znbbhfmj3a2nrpnaerk/dev.knotless.inviteRunner)
- [Documentation](https://lexicon.garden/lexicon/did:plc:yqsg7znbbhfmj3a2nrpnaerk/dev.knotless.inviteRunner/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:yqsg7znbbhfmj3a2nrpnaerk/dev.knotless.inviteRunner/examples)

## Definitions

### `dev.knotless.inviteRunner`

**Type**: `procedure`

Tells a runner, through the appview, that the caller's private repository names it among its runners; or a triager, among its triagers. Nothing written in a space reaches the firehose, so a runner learns of a private repository only so, from dev.knotless.listRunnerInvites; it then reads the repository's record, as a member of its space, before running anything. Inviting it again moves the invite to the end of its list. Requires a service token from the caller's PDS, audience the appview's DID, for this method.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes | The repository's name: its record key in the caller's space. |
| `runner` | `string` (did) | Yes | The runner, or triager, invited. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Tells a runner, through the appview, that the caller's private repository names it among its runners; or a triager, among its triagers. Nothing written in a space reaches the firehose, so a runner learns of a private repository only so, from dev.knotless.listRunnerInvites; it then reads the repository's record, as a member of its space, before running anything. Inviting it again moves the invite to the end of its list. Requires a service token from the caller's PDS, audience the appview's DID, for this method.",
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "name": {
              "description": "The repository's name: its record key in the caller's space.",
              "maxLength": 100,
              "type": "string"
            },
            "runner": {
              "description": "The runner, or triager, invited.",
              "format": "did",
              "type": "string"
            }
          },
          "required": [
            "runner",
            "name"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {},
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "dev.knotless.inviteRunner",
  "lexicon": 1
}
```