Skip to content

Commit da59314

Browse files
committed
fix: remove internal Nova/Dash references from bundled OpenAPI
Replace Chart schema descriptions that leaked internal product names and type identifiers with public-facing copy that preserves the unknown mapping behavior.
1 parent 26e1ff0 commit da59314

2 files changed

Lines changed: 10 additions & 12 deletions

File tree

openapi/bundled/openapi.bundled.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2370,13 +2370,13 @@
23702370
"definition": {
23712371
"type": "object",
23722372
"additionalProperties": true,
2373-
"description": "Read-only chart definition. Returned only when `include_definition=true`\non GET chart. Shape is unstable and may change with Nova/Dash versions;\nnot intended for authoring.\n"
2373+
"description": "Read-only chart definition. Returned only when `include_definition=true`\non GET chart. Shape is unstable and may change over time; not intended\nfor authoring.\n"
23742374
}
23752375
}
23762376
},
23772377
"ChartType": {
23782378
"type": "string",
2379-
"description": "Public chart type discriminator (snake_case). Maps from internal Dash types\n(e.g. `eventsSegmentation` → `event_segmentation`). All values may appear on\nlist/get; query returns `422` (`unsupported_chart_type`) for types outside\nthe v1 supported matrix.\n\nInternal-only or deprecated Dash types (e.g. `asql`, `eventsLog`) are not\nexposed on the public wire; those charts surface as `unknown`.\n\nNew chart types may be added over time. An internal type the adapter cannot\nmap is surfaced as `unknown` rather than failing the response, so the wire\nvalue is always one of the members below. Clients should treat `unknown` as\n\"a chart type this API version does not model yet\".\n",
2379+
"description": "Public chart type discriminator (snake_case). All values may appear on\nlist/get; query returns `422` (`unsupported_chart_type`) for types outside\nthe v1 supported matrix.\n\nUnsupported chart types surface as `unknown` on the public wire.\n\nNew chart types may be added over time. A chart type this API version does not\nrecognize is surfaced as `unknown` rather than failing the response, so the wire\nvalue is always one of the members below. Clients should treat `unknown` as\n\"a chart type this API version does not model yet\".\n",
23802380
"enum": [
23812381
"event_segmentation",
23822382
"sessions",

openapi/bundled/openapi.bundled.yaml

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1833,23 +1833,21 @@ components:
18331833
additionalProperties: true
18341834
description: |
18351835
Read-only chart definition. Returned only when `include_definition=true`
1836-
on GET chart. Shape is unstable and may change with Nova/Dash versions;
1837-
not intended for authoring.
1836+
on GET chart. Shape is unstable and may change over time; not intended
1837+
for authoring.
18381838
ChartType:
18391839
type: string
18401840
description: |
1841-
Public chart type discriminator (snake_case). Maps from internal Dash types
1842-
(e.g. `eventsSegmentation` → `event_segmentation`). All values may appear on
1841+
Public chart type discriminator (snake_case). All values may appear on
18431842
list/get; query returns `422` (`unsupported_chart_type`) for types outside
18441843
the v1 supported matrix.
18451844
1846-
Internal-only or deprecated Dash types (e.g. `asql`, `eventsLog`) are not
1847-
exposed on the public wire; those charts surface as `unknown`.
1845+
Unsupported chart types surface as `unknown` on the public wire.
18481846
1849-
New chart types may be added over time. An internal type the adapter cannot
1850-
map is surfaced as `unknown` rather than failing the response, so the wire
1851-
value is always one of the members below. Clients should treat `unknown` as
1852-
"a chart type this API version does not model yet".
1847+
New chart types may be added over time. A chart type this API version does
1848+
not recognize is surfaced as `unknown` rather than failing the response, so
1849+
the wire value is always one of the members below. Clients should treat
1850+
`unknown` as "a chart type this API version does not model yet".
18531851
enum:
18541852
- event_segmentation
18551853
- sessions

0 commit comments

Comments
 (0)