# RendererDefinition

Fields, types, and constraints for RendererDefinition.

Canonical: https://commentary.dev/docs/reference/schemas/renderer-definition

Released API schema for `RendererDefinition`.

## Fields and constraints

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `key` | string | Yes | Minimum length: 1. Maximum length: 100. |
| `name` | string | Yes | Minimum length: 1. Maximum length: 200. |
| `kind` | `"hosted"` · `"external"` | Yes |  |
| `protocol` | `"commentary-tracker-v1"` | Yes |  |
| `operations` | array of `"getSchema"` · `"getPermissions"` · `"queryRecords"` · `"getRecord"` · `"createRecord"` · `"patchRecord"` · `"archiveRecord"` · `"bulk"` · `"reorder"` · `"listViews"` · `"getView"` · `"changes"` · `"openResource"` · `"openReview"` | Yes |  |
| `trackerId` | string | No | Minimum length: 1. Maximum length: 100. |
| `packageId` | string | No | Minimum length: 1. Maximum length: 100. |
| `packageRevisionId` | string | No | Minimum length: 1. Maximum length: 100. |
| `uploadId` | string | No | Minimum length: 1. Maximum length: 100. |
| `entry` | string | No | Maximum length: 1024. |
| `externalUrl` | string | No | Format: uri. Maximum length: 2048. |
| `anchors` | array of object | No |  |

## Full schema

[Download this schema](/docs/reference/schemas/renderer-definition.json) or use the [complete OpenAPI document](/docs/reference/openapi.json) to resolve all references.

## Related reference

[Browse API endpoints](/docs/reference/api-operations).