ReviewVisualTarget
Released API schema for ReviewVisualTarget.
Fields and constraints
Section titled “Fields and constraints”| Field | Type | Required | Description |
|---|---|---|---|
surfaceKind |
"raster_image" · "svg" · "mermaid" |
Yes | |
surfaceId |
string | Yes | Maximum length: 256. |
occurrenceId |
string | Yes | Maximum length: 256. |
sourceKind |
"repository" · "draft" · "embedded" · "external" |
Yes | |
sourcePath |
string or null | No | Maximum length: 2048. |
sourceRef |
string or null | No | Maximum length: 512. |
sourceHash |
string or null | No | Maximum length: 256. |
sourceLanguage |
"binary" · "svg" · "mermaid" · "markdown" · "html" |
Yes | |
intrinsicWidth |
integer or null | No | |
intrinsicHeight |
integer or null | No | |
viewBox |
string or null | No | Maximum length: 128. |
region |
VisualRegion | Yes | |
hostArtifactKind |
"markdown" · "html" · "form" · "image" · "svg" · "mermaid" |
Yes | |
hostFilePath |
string | Yes | Maximum length: 2048. |
hostBlockId |
string | Yes | Maximum length: 256. |
sourceLineStart |
integer or null | No | |
sourceLineEnd |
integer or null | No | |
slideId |
string or null | No | Maximum length: 256. |
elementHint |
object or null | No | |
editable |
boolean | Yes |
Full schema
Section titled “Full schema”Download this schema or use the complete OpenAPI document to resolve all references.