Skip to content

chore(api): update pinned OpenAPI spec #1039

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
Abhijeet Prasad (AbhiPrasad) merged 4 commits into from
Nov 2, 2026
+137 −535
Merged

chore(api): update pinned OpenAPI spec #1039

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
af16b84
chore(api): update pinned OpenAPI spec
AbhiPrasad Nov 2, 2026
ebf9696
fix(api): drop removed Simulated users endpoints from generated client
AbhiPrasad Nov 2, 2026
4260043
ci(api): keep fixed OpenAPI update branch name
AbhiPrasad Nov 2, 2026
f822548
docs(api): drop Simulated users from reviewed tag inventory
AbhiPrasad Nov 2, 2026
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
2 changes: 1 addition & 1 deletion openapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The reviewed generated surface includes these tags:
ApiKeys, and ServiceTokens;
- configuration resources: AiSecrets, EnvVars, Environments, and McpServers;
- project resources: Agents, ProjectAutomations, OrgAutomations, ProjectScores, ProjectTags,
Simulated users, SpanIframes, and Views; and
SpanIframes, and Views; and
- versioned data resources: DatasetSnapshots.

Each tag produces one resource and operation registry. Models used by one resource stay in that
Expand Down
5 changes: 2 additions & 3 deletions openapi/config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"spec": {
"repository": "braintrustdata/braintrust-openapi",
"path": "openapi/spec.json",
"commit": "d9102b7592e85d7da1e98771167ca013506a08c4",
"sha256": "8f5039399f7735a4fb96c161db8b926de659fda2448ed8ce1d66d93d4d9dd922"
"commit": "3384e4be354ec957292f986fcf3e3a4009907651",
"sha256": "cbb5046620f73b5bf4e1e73c0eb12542ab9cbd3393ec568eda3f1a20f0f90a44"
Comment thread
AbhiPrasad marked this conversation as resolved.
Resolved
},
"tools": {
"datamodel-code-generator": "0.81.0",
Expand Down Expand Up @@ -52,7 +52,6 @@
"ProjectTags",
"Roles",
"ServiceTokens",
"Simulated users",
"SpanIframes",

@chatgpt-codex-connector chatgpt-codex-connector Bot Nov 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove Simulated users from the reviewed-tag inventory

After this selection drops Simulated users and the generated client removes that resource, openapi/README.md lines 22–30 still lists it among the reviewed generated tags. This leaves the code-generation guide's explicit inventory inconsistent with config.json, so maintainers consulting it will believe the removed resource is still generated; update that inventory alongside the selection.

Useful? React with 👍 / 👎.

@AbhiPrasad Abhijeet Prasad (AbhiPrasad) Nov 2, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in f822548: removed Simulated users from the reviewed tag inventory in openapi/README.md.

"Users",
"Views"
Expand Down
57 changes: 27 additions & 30 deletions py/src/braintrust/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,6 @@ The table lists every reviewed generated method. Consult the method's Python sig
| `client.project_tags` | `post_project_tag` — `POST /v1/project_tag`<br>`put_project_tag` — `PUT /v1/project_tag`<br>`get_project_tag` — `GET /v1/project_tag`<br>`get_project_tag_id` — `GET /v1/project_tag/{project_tag_id}`<br>`patch_project_tag_id` — `PATCH /v1/project_tag/{project_tag_id}`<br>`delete_project_tag_id` — `DELETE /v1/project_tag/{project_tag_id}` |
| `client.roles` | `post_role` — `POST /v1/role`<br>`put_role` — `PUT /v1/role`<br>`get_role` — `GET /v1/role`<br>`get_role_id` — `GET /v1/role/{role_id}`<br>`patch_role_id` — `PATCH /v1/role/{role_id}`<br>`delete_role_id` — `DELETE /v1/role/{role_id}` |
| `client.service_tokens` | `post_service_token` — `POST /v1/service_token`<br>`put_service_token` — `PUT /v1/service_token`<br>`delete_service_token` — `DELETE /v1/service_token`<br>`get_service_token` — `GET /v1/service_token`<br>`get_service_token_id` — `GET /v1/service_token/{service_token_id}`<br>`delete_service_token_id` — `DELETE /v1/service_token/{service_token_id}` |
| `client.simulated_users` | `list_simulated_users` — `GET /v1/project/{project_id}/simulated_user`<br>`create_simulated_user` — `POST /v1/project/{project_id}/simulated_user`<br>`get_simulated_user` — `GET /v1/project/{project_id}/simulated_user/{id}`<br>`patch_simulated_user` — `PATCH /v1/project/{project_id}/simulated_user/{id}`<br>`delete_simulated_user` — `DELETE /v1/project/{project_id}/simulated_user/{id}` |
| `client.span_iframes` | `post_span_iframe` — `POST /v1/span_iframe`<br>`put_span_iframe` — `PUT /v1/span_iframe`<br>`get_span_iframe` — `GET /v1/span_iframe`<br>`get_span_iframe_id` — `GET /v1/span_iframe/{span_iframe_id}`<br>`patch_span_iframe_id` — `PATCH /v1/span_iframe/{span_iframe_id}`<br>`delete_span_iframe_id` — `DELETE /v1/span_iframe/{span_iframe_id}` |
| `client.users` | `get_user` — `GET /v1/user`<br>`get_user_id` — `GET /v1/user/{user_id}` |
| `client.views` | `post_view` — `POST /v1/view`<br>`put_view` — `PUT /v1/view`<br>`get_view` — `GET /v1/view`<br>`get_view_id` — `GET /v1/view/{view_id}`<br>`patch_view_id` — `PATCH /v1/view/{view_id}`<br>`delete_view_id` — `DELETE /v1/view/{view_id}` |
Expand Down Expand Up @@ -139,38 +138,36 @@ Only request and response models reachable directly from reviewed resource metho
| `CreateGroup` | `CreateMCPServer` | `CreateOrgAutomation` |
| `CreateProject` | `CreateProjectAutomation` | `CreateProjectGroup` |
| `CreateProjectScore` | `CreateProjectTag` | `CreatePrompt` |
| `CreateRole` | `CreateServiceTokenOutput` | `CreateSimulatedUser` |
| `CreateSpanIFrame` | `CreateView` | `Dataset` |
| `DatasetRestorePreviewResponse` | `DatasetRestoreRequest` | `DatasetRestoreResponse` |
| `DatasetSnapshot` | `DeleteAISecret` | `DeleteServiceToken` |
| `DeleteView` | `EnvVar` | `Environment` |
| `Experiment` | `FeedbackDatasetEventRequest` | `FeedbackExperimentEventRequest` |
| `FeedbackResponseSchema` | `FetchDatasetEventsResponse` | `FetchEventsRequest` |
| `FetchExperimentEventsResponse` | `Function` | `GetAclResponse` |
| `GetAgentResponse` | `GetAiSecretResponse` | `GetApiKeyResponse` |
| `GetDatasetResponse` | `GetDatasetSnapshotResponse` | `GetEnvVarResponse` |
| `GetExperimentResponse` | `GetFunctionResponse` | `GetGroupResponse` |
| `GetMcpServerResponse` | `GetOrgAutomationResponse` | `GetOrganizationApiKeysResponse` |
| `GetOrganizationResponse` | `GetProjectAutomationResponse` | `GetProjectGroupResponse` |
| `GetProjectResponse` | `GetProjectScoreResponse` | `GetProjectTagResponse` |
| `GetPromptResponse` | `GetRoleResponse` | `GetServiceTokenResponse` |
| `GetSpanIframeResponse` | `GetUserResponse` | `GetViewResponse` |
| `Group` | `InsertDatasetEventRequest` | `InsertEventsResponse` |
| `InsertExperimentEventRequest` | `ListEnvironmentsResponse` | `ListSimulatedUsersResponse` |
| `MCPServer` | `OrgAutomation` | `Organization` |
| `PatchAISecret` | `PatchAgent` | `PatchDataset` |
| `PatchDatasetSnapshot` | `PatchEnvironment` | `PatchExperiment` |
| `PatchFunction` | `PatchGroup` | `PatchMCPServer` |
| `PatchOrgAutomation` | `PatchOrganization` | `PatchOrganizationMembers` |
| `PatchOrganizationMembersOutput` | `PatchProject` | `PatchProjectAutomation` |
| `PatchProjectGroup` | `PatchProjectScore` | `PatchProjectTag` |
| `PatchPrompt` | `PatchRole` | `PatchSimulatedUser` |
| `CreateRole` | `CreateServiceTokenOutput` | `CreateSpanIFrame` |
| `CreateView` | `Dataset` | `DatasetRestorePreviewResponse` |
| `DatasetRestoreRequest` | `DatasetRestoreResponse` | `DatasetSnapshot` |
| `DeleteAISecret` | `DeleteServiceToken` | `DeleteView` |
| `EnvVar` | `Environment` | `Experiment` |
| `FeedbackDatasetEventRequest` | `FeedbackExperimentEventRequest` | `FeedbackResponseSchema` |
| `FetchDatasetEventsResponse` | `FetchEventsRequest` | `FetchExperimentEventsResponse` |
| `Function` | `GetAclResponse` | `GetAgentResponse` |
| `GetAiSecretResponse` | `GetApiKeyResponse` | `GetDatasetResponse` |
| `GetDatasetSnapshotResponse` | `GetEnvVarResponse` | `GetExperimentResponse` |
| `GetFunctionResponse` | `GetGroupResponse` | `GetMcpServerResponse` |
| `GetOrgAutomationResponse` | `GetOrganizationApiKeysResponse` | `GetOrganizationResponse` |
| `GetProjectAutomationResponse` | `GetProjectGroupResponse` | `GetProjectResponse` |
| `GetProjectScoreResponse` | `GetProjectTagResponse` | `GetPromptResponse` |
| `GetRoleResponse` | `GetServiceTokenResponse` | `GetSpanIframeResponse` |
| `GetUserResponse` | `GetViewResponse` | `Group` |
| `InsertDatasetEventRequest` | `InsertEventsResponse` | `InsertExperimentEventRequest` |
| `ListEnvironmentsResponse` | `MCPServer` | `OrgAutomation` |
| `Organization` | `PatchAISecret` | `PatchAgent` |
| `PatchDataset` | `PatchDatasetSnapshot` | `PatchEnvironment` |
| `PatchExperiment` | `PatchFunction` | `PatchGroup` |
| `PatchMCPServer` | `PatchOrgAutomation` | `PatchOrganization` |
| `PatchOrganizationMembers` | `PatchOrganizationMembersOutput` | `PatchProject` |
| `PatchProjectAutomation` | `PatchProjectGroup` | `PatchProjectScore` |
| `PatchProjectTag` | `PatchPrompt` | `PatchRole` |
| `PatchSpanIFrame` | `PatchView` | `Project` |
| `ProjectAutomation` | `ProjectGroup` | `ProjectScore` |
| `ProjectTag` | `Prompt` | `Role` |
| `ServiceToken` | `SimulatedUser` | `SpanIFrame` |
| `SummarizeDatasetResponse` | `SummarizeExperimentResponse` | `User` |
| `View` | | |
| `ServiceToken` | `SpanIFrame` | `SummarizeDatasetResponse` |
| `SummarizeExperimentResponse` | `User` | `View` |
<!-- END GENERATED REST TYPES -->

The reference sections above are synchronized with the Python surface by `make generate-api-client`; do not edit those sections manually.
4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/__init__.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/acls.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/agents.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/ai_secrets.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/api_keys.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/dataset_snapshots.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/datasets.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/env_vars.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/environments.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/experiments.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/functions.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/groups.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/mcp_servers.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 3 additions & 23 deletions py/src/braintrust/api/_generated/models/__init__.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/models/acls.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/models/agents.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/models/ai_secrets.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/models/api_keys.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/models/common.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions py/src/braintrust/api/_generated/models/dataset_snapshots.py
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading