Skip to content

Specify accepted types for UpsertRows values #33668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
api-clients-generation-pipeline merged 1 commit into from
Jan 9, 2026
Merged

Specify accepted types for UpsertRows values #33668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions content/en/api/v2/reference-tables/examples.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -665,15 +665,18 @@
{
"attributes": {
"values": {
"<any-key>": "undefined"
"<any-key>": {
"example": "undefined",
"type": "undefined"
}
}
},
"id": "primary_key_value",
"type": "row"
}
]
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row table-row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">[object]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div data-parent-field=\"data\" class=\"row table-row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">object</p></div>\n <div class=\"col-6 column\"><p class=\"table-cell\">Attributes containing row data values for row creation or update operations.</p></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div data-parent-field=\"attributes\" class=\"row table-row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> values&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">object</p></div>\n <div class=\"col-6 column\"><p class=\"table-cell\">Key-value pairs representing row data, where keys are field names from the schema.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div data-parent-field=\"additionalProperties\" class=\"row table-row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\">&lt;any-key&gt;</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\"></p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div data-parent-field=\"data\" class=\"row table-row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\">id&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">string</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div data-parent-field=\"data\" class=\"row table-row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\">type&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">enum</p></div>\n <div class=\"col-6 column\"><p class=\"table-cell\">Row resource type. \nAllowed enum values: <code>row</code></p><p>default: <code>row</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row table-row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">[object]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div data-parent-field=\"data\" class=\"row table-row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">object</p></div>\n <div class=\"col-6 column\"><p class=\"table-cell\">Attributes containing row data values for row creation or update operations.</p></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div data-parent-field=\"attributes\" class=\"row table-row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> values&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">object</p></div>\n <div class=\"col-6 column\"><p class=\"table-cell\">Key-value pairs representing row data, where keys are schema field names and values match the corresponding column types.</p></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div data-parent-field=\"additionalProperties\" class=\"row table-row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> &lt;any-key&gt;</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">&nbsp;&lt;oneOf&gt;</p></div>\n <div class=\"col-6 column\"><p class=\"table-cell\">Types allowed for Reference Table row values.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div data-parent-field=\"&lt;any-key&gt;\" class=\"row table-row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\">Option 1</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">string</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div data-parent-field=\"&lt;any-key&gt;\" class=\"row table-row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\">Option 2</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">int32</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div>\n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div data-parent-field=\"data\" class=\"row table-row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\">id&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">string</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div data-parent-field=\"data\" class=\"row table-row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key table-cell\">type&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p class=\"table-cell\">enum</p></div>\n <div class=\"col-6 column\"><p class=\"table-cell\">Row resource type. \nAllowed enum values: <code>row</code></p><p>default: <code>row</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
}
},
"CreateReferenceTableUpload": {
Expand Down
32 changes: 26 additions & 6 deletions data/api/v2/full_spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7061,19 +7061,27 @@ components:
BatchUpsertRowsRequestDataAttributes:
description: Attributes containing row data values for row creation or update
operations.
example:
values: {}
properties:
values:
additionalProperties:
x-required-field: true
description: Key-value pairs representing row data, where keys are field
names from the schema.
example:
example_key_value: primary_key_value
name: row_name
$ref: '#/components/schemas/BatchUpsertRowsRequestDataAttributesValue'
description: Key-value pairs representing row data, where keys are schema
field names and values match the corresponding column types.
type: object
required:
- values
type: object
BatchUpsertRowsRequestDataAttributesValue:
description: Types allowed for Reference Table row values.
oneOf:
- example: row_name
type: string
- example: 25
format: int32
maximum: 2147483647
type: integer
BillConfig:
description: Bill config.
properties:
Expand Down Expand Up @@ -79856,6 +79864,18 @@ paths:
requestBody:
content:
application/json:
examples:
happy_path:
summary: Upsert a row with mixed string and int values
value:
data:
- attributes:
values:
age: 25
example_key_value: primary_key_value
name: row_name
id: primary_key_value
type: row
schema:
$ref: '#/components/schemas/BatchUpsertRowsRequestArray'
required: true
Expand Down
Loading