Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/sdk/clients/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -772,7 +772,7 @@ const { data } = await client.queryEvents(

### `createBundleUploadUrl`

Generate a presigned URL for uploading app bundle to /``<app-id>``/bundle.js path
Generate a presigned URL for uploading app bundle to /`<app-id>`/bundle.js path

`POST /v1/app-configurations/{appId}/bundle`

Expand Down Expand Up @@ -810,7 +810,7 @@ const { data } = await client.createBundleUploadUrl(

### `createZipUploadUrl`

Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /``<app-id>``/ path
Generate a presigned URL to upload a zip file with artifacts that will be unpacked in a new directory under the /`<app-id>`/ path

`POST /v1/app-configurations/{appId}/zip`

Expand Down Expand Up @@ -849,7 +849,7 @@ const { data } = await client.createZipUploadUrl(

### `createLogoUploadUrl`

Generate a presigned URL for uploading app logo to /``<app-id>``/logo.png path
Generate a presigned URL for uploading app logo to /`<app-id>`/logo.png path

`POST /v1/app-configurations/{appId}/logo`

Expand Down Expand Up @@ -885,7 +885,7 @@ const { data } = await client.createLogoUploadUrl(

### `deleteLogo`

Delete the app logo from /``<app-id>``/logo.png path
Delete the app logo from /`<app-id>`/logo.png path

`DELETE /v1/app-configurations/{appId}/logo`

Expand Down Expand Up @@ -3913,7 +3913,7 @@ type ContextRequirement = {

### `EntityContextRequirement`

The consumer supplies the bound entities of `schema` under `Context.`<schema>``.
The consumer supplies the bound entities of `schema` under `Context.<schema>`.

```ts
type EntityContextRequirement = {
Expand All @@ -3924,7 +3924,7 @@ type EntityContextRequirement = {

### `ValueContextRequirement`

The consumer supplies one scalar value under `Context.`<name>``, e.g. a date the customer entered in a journey block. A value input is optional: the consumer sends it when it has a value and omits it otherwise, so the hook's templates must cope with its absence, e.g. `{{ Context.reading_date | default
The consumer supplies one scalar value under `Context.<name>`, e.g. a date the customer entered in a journey block. A value input is optional: the consumer sends it when it has a value and omits it otherwise, so the hook's templates must cope with its absence, e.g. `{{ Context.reading_date | default

```ts
type ValueContextRequirement = {
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/clients/blueprint-manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6227,7 +6227,7 @@ type BlueprintTestInterpretationStarted = {

### `BlueprintInterpretedCheck`

An engine-verified check. Code-assigned id (p<i> or p<i>c`<n>`); the sentence is a key, never model text.
An engine-verified check. Code-assigned id (p`<i>` or p`<i>`c`<n>`); the sentence is a key, never model text.

```ts
type BlueprintInterpretedCheck = {
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/clients/configuration-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -3015,7 +3015,7 @@ type SyncJobCounts = {
### `SyncJobEvent`

Activity-log entry surfaced to the frontend. Backed by the append-only
job event log, or by the op-log rows (`SYNC#`<jobId>`#OP#`<seq>``) for jobs
job event log, or by the op-log rows (`SYNC#<jobId>#OP#<seq>`) for jobs
that predate it. Key events by `id` when present.


Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/clients/entity.md
Original file line number Diff line number Diff line change
Expand Up @@ -4450,7 +4450,7 @@ const { data } = await client.listTaxonomyClassificationsForSchema({
### `getTaxonomyBulkActionJobs`

Gets bulk actions jobs by job status:
- ``<undefined>`` = all active jobs
- `<undefined>` = all active jobs
- PENDING = all active jobs
- FAILED = all failed jobs
- COMPLETED = all completed jobs
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/clients/environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ const { data } = await client.deleteEnvironmentVariable({
The structure a variable's value holds. `SecretString` is encrypted at rest and
its value is never returned. Every other type
may be served to browser-facing consumers. A `List` inherits this from its element
type: a `List`<SecretString>`` is never served.
type: a `List<SecretString>` is never served.


```ts
Expand Down
4 changes: 2 additions & 2 deletions docs/sdk/clients/external-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ type ContextRequirement = {

### `EntityContextRequirement`

The consumer supplies the bound entities of `schema` under `Context.`<schema>``, e.g. a hook
The consumer supplies the bound entities of `schema` under `Context.<schema>`, e.g. a hook
interpolating `{{ Context.contract[0].external_id }}` declares
`{ type: entity, schema: contract }`.

Expand All @@ -365,7 +365,7 @@ type EntityContextRequirement = {
### `ValueContextRequirement`

An optional scalar input. When the consumer has a value it supplies it under
`Context.`<name>`` (dates as ISO 8601 strings, `YYYY-MM-DD` or a date-time); otherwise the
`Context.<name>` (dates as ISO 8601 strings, `YYYY-MM-DD` or a date-time); otherwise the
key is absent, so the hook template must provide a fallback, e.g.
`{{ Context.reading_date | default: "now" | date: "%Y-%m-%d" }}` dec

Expand Down
8 changes: 4 additions & 4 deletions docs/sdk/clients/journey.md
Original file line number Diff line number Diff line change
Expand Up @@ -841,7 +841,7 @@ const { data } = await client.resolveJourneyExternalValues(

### `getJourneyEnvironmentVariables`

List the organization's client-safe environment variables a journey may use: Map and List``<Link>`` as an options source; Text, Number, Boolean and lists of them in logic conditions. Only variables that c
List the organization's client-safe environment variables a journey may use: Map and List`<Link>` as an options source; Text, Number, Boolean and lists of them in logic conditions. Only variables that c

`GET /v1/journey/environment-variables`

Expand Down Expand Up @@ -2503,7 +2503,7 @@ type EnvironmentLink = {

### `EnvironmentLinkList`

A list of links, served under this service's own `List`<Link>`` type
A list of links, served under this service's own `List<Link>` type
token. environments-api types the variable `List` and declares the
element type inside the value; journey-api composes the two so a
consumer needs only one discriminant.
Expand All @@ -2523,8 +2523,8 @@ type EnvironmentLinkList = {

### `EnvironmentScalarList`

A list of scalars, served under this service's own `List`<Text>``,
`List`<Number>`` or `List`<Boolean>`` token (ER-5455). Read by logic
A list of scalars, served under this service's own `List<Text>`,
`List<Number>` or `List<Boolean>` token (ER-5455). Read by logic
conditions; flattened to `items` by the journey runtime.


Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/clients/phone-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -1814,7 +1814,7 @@ type AgentPresenceChange = {
### `Skill`

A skill as the phone system holds it (Babelforce: an agent tag). epilot's convention for skills is
`<skill category>:`<label>`` (e.g. `language:german`), which the control center shows as
`<skill category>:<label>` (e.g. `language:german`), which the control center shows as
"Category · Label"; a skill without a colon has no category.
Skills are case-insensitive and stored lowercased, in

Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/clients/sandbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ type OrgId = string

Unique identifier for a pipeline.

The format for a pipeline is: ``<sandbox_org>`::`<production_org>``
The format for a pipeline is: `<sandbox_org>::<production_org>`


```ts
Expand Down
8 changes: 7 additions & 1 deletion scripts/update-sdk-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,20 @@ for line in sys.stdin:
if line.startswith('\`\`\`'):
in_code = not in_code
if not in_code:
# Repair generator output where a <placeholder> was split out of its
# inline code span: `List`<T>`` -> `List<T>`, `A`<b>`c`<d>`` -> `A<b>c<d>`
prev_fix = None
while prev_fix != line:
prev_fix = line
line = re.sub(r'\`(<[a-zA-Z][^<>\`\n]*>)\`', r'\1', line)
# Escape <word> patterns that are not valid HTML tags and not in backticks
# Run multiple passes to handle adjacent matches on the same line
prev = None
while prev != line:
prev = line
line = re.sub(
r'(?<!\`)<([a-zA-Z][a-zA-Z0-9_-]*)>(?!\`)',
lambda m: m.group(0) if m.group(1).lower() in HTML_TAGS else '\`<' + m.group(1) + '>\`',
lambda m: m.group(0) if m.string[:m.start()].count('\`') % 2 == 1 or m.group(1).lower() in HTML_TAGS and (len(m.group(1)) > 1 or '</' + m.group(1) in m.string) else '\`<' + m.group(1) + '>\`',
line
)
print(line)
Expand Down
Loading