Repository navigation
Commit a166b9c
chore(api): update pinned OpenAPI spec (#1083)
Automated update of the pinned Braintrust OpenAPI specification.
- Upstream commit:
[`3384e4be354e`](braintrustdata/braintrust-openapi@3384e4b)
→
[`4cc061569451`](braintrustdata/braintrust-openapi@4cc0615)
- [Upstream spec
diff](braintrustdata/braintrust-openapi@3384e4b...4cc0615)
- Reviewed generated surface: 152 selected operations, 241 reachable
schemas → requires manual review (`OpenAPI spec contains unreviewed
OpenAPI tags: ['CustomColumns', 'Ingest keys']`)
- All upstream operations: 166 → 162
- All upstream component schemas: 261 → 256
### Operation changes
- Added: `createIngestKey`, `deleteCustomColumnId`, `deleteIngestKey`,
`getCustomColumn`, `listIngestKeys`, `patchCustomColumnId`,
`postCustomColumn`, `putCustomColumn`
- Removed: `deleteAgentId`, `deleteOrgAutomationId`, `getAgent`,
`getAgentId`, `getOrgAutomation`, `getOrgAutomationId`, `patchAgentId`,
`patchOrgAutomationId`, `postAgent`, `postOrgAutomation`, `putAgent`,
`putOrgAutomation`
### Component schema changes
- Added: `CreateCustomColumn`, `CustomColumn`, `CustomColumnVariant`,
`IngestKey`, `PatchCustomColumn`
- Removed: `Agent`, `AgentIdParam`, `AgentName`, `CreateAgent`,
`CreateOrgAutomation`, `OrgAutomation`, `OrgAutomationIdParam`,
`OrgAutomationName`, `PatchAgent`, `PatchOrgAutomation`
### Automated validation
The update workflow regenerates committed sources and public API
reference sections, then runs:
- `make -C py test-api-codegen`
- `make -C py test-core`
- `cd py && nox -s test_types`
This pull request is never auto-merged. Review the upstream and
generated diffs, retry-policy classifications, public type changes, and
any intentionally unsupported tags before merging.
### Manual fixes
The automated run failed regeneration because upstream added the
`CustomColumns` and `Ingest keys` tags (unreviewed) and removed the
`Agents` and `OrgAutomations` tags (still listed in
`endpoint_generator.generated_tags`). Follow-up commits:
- Removed `Agents` and `OrgAutomations` from `generated_tags` in
`openapi/config.json`.
- Added `CustomColumns` and `Ingest keys` to `unsupported_tags` (not yet
part of the reviewed public REST client surface), and documented them in
`openapi/README.md`. No client resources or types are generated for
them.
- Regenerated the client and `py/src/braintrust/api/README.md` (deletes
`_generated/agents.py`, `_generated/org_automations.py`, and their
models).
- Hand-written updates: removed the `agents` / `org_automations`
properties in `api/client.py` and the Agent / OrgAutomation re-exports
in `api/types/__init__.py`; updated `api/test_generated_models.py`,
`type_tests/test_api_client.py`, and the pinned unsupported-tag set in
`tests/api_codegen/test_generation.py`.
**Breaking:** `client.agents`, `client.org_automations`, and the types
`Agent`, `CreateAgent`, `PatchAgent`, `GetAgentResponse`,
`OrgAutomation`, `CreateOrgAutomation`, `PatchOrgAutomation`,
`GetOrgAutomationResponse` are no longer available, matching the
upstream removal.
### Workflow results
Original automated run:
| Check | Result |
| --- | --- |
| Regeneration | `failure` |
| Codegen tests | `failure` |
| Runtime tests | `success` |
| Type tests | `success` |
After manual fixes (run locally):
| Check | Result |
| --- | --- |
| `make -C py generate-api-client` | `success` (140 selected operations,
231 reachable schemas) |
| `make -C py check-api-client-codegen` | `success` |
| `make -C py test-api-codegen` | `success` (66 passed) |
| `make -C py test-core` | `success` (1131 passed) |
| `cd py && nox -s test_types` | `success` (37 passed) |
| `make -C py lint` | `success` |
---------
Co-authored-by: AbhiPrasad <18689448+AbhiPrasad@users.noreply.github.com>
Co-authored-by: Abhijeet Prasad <abhijeet@braintrustdata.com>1 parent caf8143 commit a166b9c
61 files changed
Lines changed: 468 additions & 1046 deletions
File tree
- openapi
- py
- src/braintrust
- api
- _generated
- models
- types
- type_tests
- tests/api_codegen
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | | - | |
29 | | - | |
| 28 | + | |
30 | 29 | | |
31 | 30 | | |
32 | 31 | | |
| |||
37 | 36 | | |
38 | 37 | | |
39 | 38 | | |
| 39 | + | |
| 40 | + | |
40 | 41 | | |
41 | 42 | | |
| 43 | + | |
| 44 | + | |
42 | 45 | | |
43 | 46 | | |
44 | 47 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
7 | | - | |
| 6 | + | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
40 | 39 | | |
41 | 40 | | |
42 | 41 | | |
43 | 42 | | |
44 | 43 | | |
45 | 44 | | |
46 | 45 | | |
47 | | - | |
48 | 46 | | |
49 | 47 | | |
50 | 48 | | |
| |||
58 | 56 | | |
59 | 57 | | |
60 | 58 | | |
| 59 | + | |
61 | 60 | | |
| 61 | + | |
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
88 | 88 | | |
89 | 89 | | |
90 | 90 | | |
91 | | - | |
92 | 91 | | |
93 | 92 | | |
94 | 93 | | |
95 | 94 | | |
96 | 95 | | |
97 | 96 | | |
98 | 97 | | |
99 | | - | |
100 | 98 | | |
101 | 99 | | |
102 | 100 | | |
| |||
132 | 130 | | |
133 | 131 | | |
134 | 132 | | |
135 | | - | |
136 | | - | |
137 | | - | |
138 | | - | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
139 | 136 | | |
140 | 137 | | |
141 | 138 | | |
| |||
145 | 142 | | |
146 | 143 | | |
147 | 144 | | |
148 | | - | |
149 | | - | |
150 | | - | |
151 | | - | |
152 | | - | |
153 | | - | |
154 | | - | |
155 | | - | |
156 | | - | |
157 | | - | |
158 | | - | |
159 | | - | |
160 | | - | |
161 | | - | |
162 | | - | |
163 | | - | |
164 | | - | |
165 | | - | |
166 | | - | |
167 | | - | |
168 | | - | |
169 | | - | |
170 | | - | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
171 | 167 | | |
172 | 168 | | |
173 | 169 | | |
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
0 commit comments