Skip to content

chore(api): update pinned OpenAPI spec - #1039

Merged
Abhijeet Prasad (AbhiPrasad) merged 4 commits into
mainfrom
auto/update-openapi-spec
Nov 2, 2026
Merged

Abhijeet Prasad (AbhiPrasad) merged 4 commits into
mainfrom
auto/update-openapi-spec

Conversation

@github-actions

@github-actions github-actions Bot commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Automated update of the pinned Braintrust OpenAPI specification.

  • Upstream commit: d9102b7592e8 → 3384e4be354e
  • Upstream spec diff
  • Reviewed generated surface: 157 selected operations, 246 reachable schemas → 152 selected operations, 241 reachable schemas
  • All upstream operations: 171 → 166
  • All upstream component schemas: 266 → 261

Operation changes

  • Removed: createSimulatedUser, deleteSimulatedUser, getSimulatedUser, listSimulatedUsers, patchSimulatedUser

Component schema changes

  • Removed: AppLimit, CreateSimulatedUser, PatchSimulatedUser, SimulatedUser, SimulatedUserVoiceConfig

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 Simulated users was removed upstream but still listed in endpoint_generator.generated_tags. Follow-up commits:

  • Removed Simulated users from generated_tags in openapi/config.json and regenerated the client and py/src/braintrust/api/README.md (deletes _generated/simulated_users.py and its models; drops AppLimit).
  • Removed hand-written references: the simulated_users property in api/client.py, the CreateSimulatedUser / ListSimulatedUsersResponse / PatchSimulatedUser / SimulatedUser re-exports in api/types/__init__.py, and the matching test references.

Breaking: client.simulated_users and the four types above 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
make -C py test-api-codegen success (66 passed)
make -C py test-core success (1122 passed)
cd py && nox -s test_types success (37 passed)
make -C py lint success

🤖 Generated with Claude Code

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-02T13:54:15.083689Z 4260043 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: af16b84832

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "Codex (@codex) review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "Codex (@codex) address that feedback".

Comment thread openapi/config.json Resolved
Upstream removed the Simulated users operations and schemas, so the
stale generated_tags entry made regeneration fail. Remove the tag,
regenerate the client and README, and drop the facade property, type
re-exports, and test references.

Also name OpenAPI update PR branches after the pinned upstream commit so
each automated update gets its own branch.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 4260043d7f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "Codex (@codex) review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "Codex (@codex) address that feedback".

Comment thread openapi/config.json
"Roles",
"ServiceTokens",
"Simulated users",
"SpanIframes",

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 👍 / 👎.

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.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@AbhiPrasad
Abhijeet Prasad (AbhiPrasad) merged commit a5572d1 into main Nov 2, 2026
98 checks passed
@AbhiPrasad
Abhijeet Prasad (AbhiPrasad) deleted the auto/update-openapi-spec branch November 2, 2026 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant