# HarnessCatalogService

> The HarnessCatalogService methods and their request and response messages.

Source: https://engramsfactory.com/docs/api/harness-catalog/

Generated from [`harness.proto`](https://github.com/cortexapps/engrams/blob/main/crates/engram-protocol/proto/engram/app/v1/harness.proto). Every method is
`POST /rpc/engram.app.v1.HarnessCatalogService/<Method>` with a JSON or protobuf body and an
`x-api-key` header.

## Methods

| Method | Request | Response |
|---|---|---|
| `RegisterHarness` | [`RegisterHarnessRequest`](#registerharnessrequest) | [`RegisterHarnessResponse`](#registerharnessresponse) |
| `ListHarnesses` | [`ListHarnessesRequest`](#listharnessesrequest) | [`ListHarnessesResponse`](#listharnessesresponse) |
| `GetHarness` | [`GetHarnessRequest`](#getharnessrequest) | [`GetHarnessResponse`](#getharnessresponse) |
| `DeleteHarness` | [`DeleteHarnessRequest`](#deleteharnessrequest) | [`DeleteHarnessResponse`](#deleteharnessresponse) |

## Messages

### DeleteHarnessRequest

| Field | Type |
|---|---|
| `name` | `string` |

### DeleteHarnessResponse

| Field | Type |
|---|---|
| `deleted` | `bool` |

### GetHarnessRequest

| Field | Type |
|---|---|
| `name` | `string` |

### GetHarnessResponse

| Field | Type |
|---|---|
| `harness` | [`HarnessSummary`](#harnesssummary) |

### HarnessAuth

| Field | Type |
|---|---|
| `org_env` | `string` (optional) |
| `user_env` | `string` (optional) |
| `org_env_hint` | `string` (optional) |
| `user_env_hint` | `string` (optional) |
| `user_oauth` | [`HarnessOAuth`](#harnessoauth) |

### HarnessDescriptor

| Field | Type |
|---|---|
| `name` | `string` |
| `label` | `string` (optional) |
| `auth` | [`HarnessAuth`](#harnessauth) |
| `models` | repeated [`HarnessOption`](#harnessoption) |
| `effort` | repeated [`HarnessOption`](#harnessoption) |
| `description` | `string` (optional) |
| `egress` | [`HarnessEgress`](#harnessegress) |
| `modes` | repeated [`HarnessMode`](#harnessmode) |
| `router_protocols` | repeated `string` |
| `native_egress` | [`HarnessEgress`](#harnessegress) |

### HarnessEgress

| Field | Type |
|---|---|
| `allow_hosts` | repeated `string` |
| `allow_host_patterns` | repeated `string` |

### HarnessMode

| Field | Type |
|---|---|
| `id` | `string` |
| `label` | `string` (optional) |
| `default` | `bool` |

### HarnessOAuth

| Field | Type |
|---|---|
| `provider` | `string` |
| `delivery` | [`OauthDelivery`](#oauthdelivery) |

### HarnessOption

| Field | Type |
|---|---|
| `id` | `string` |
| `label` | `string` (optional) |
| `default` | `bool` |
| `env` | `map<string, string>` |

### HarnessSummary

| Field | Type |
|---|---|
| `name` | `string` |
| `descriptor` | [`HarnessDescriptor`](#harnessdescriptor) |
| `built_in` | `bool` |

### ListHarnessesRequest

No fields.

### ListHarnessesResponse

| Field | Type |
|---|---|
| `harnesses` | repeated [`HarnessSummary`](#harnesssummary) |

### RegisterHarnessRequest

| Field | Type |
|---|---|
| `name` | `string` |
| `oci_ref` | `string` |
| `owner` | `string` |

### RegisterHarnessResponse

| Field | Type |
|---|---|
| `harness` | [`HarnessSummary`](#harnesssummary) |

## Enums

### OauthDelivery

| Value | Number |
|---|---|
| `OAUTH_DELIVERY_UNSPECIFIED` | 0 |
| `OAUTH_DELIVERY_OPAQUE_BUNDLE` | 1 |
