Skip to content

[chore]: commit updated spec#2095

Merged
seanmcguire12 merged 1 commit intomainfrom
update-openapi-spec
May 7, 2026
Merged

[chore]: commit updated spec#2095
seanmcguire12 merged 1 commit intomainfrom
update-openapi-spec

Conversation

@seanmcguire12
Copy link
Copy Markdown
Member

@seanmcguire12 seanmcguire12 commented May 7, 2026

why

  • schema descriptions changed which means spec yaml files need to be regenerated
  • the regenerated yaml files were uncommitted

what changed

  • added the regenerated yaml files

Summary by cubic

Regenerated OpenAPI specs for packages/server-v3 and packages/server-v4 to align with schema description updates. In v4, the x-bb-project-id header and related projectId fields are now deprecated since API keys are project-scoped.

  • Migration
    • Stop sending the x-bb-project-id header.
    • Omit projectId in v4 session payloads and ignore it in responses.

Written for commit 8dd382e. Summary will update on new commits.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 7, 2026

⚠️ No Changeset found

Latest commit: 8dd382e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

✱ Stainless preview builds

This PR will update the stagehand SDKs with the following commit message.

feat: [chore]: commit updated spec
stagehand-go studio · code

Your SDK build had at least one "note" diagnostic.
generate ✅build ⏭️lint ✅test ✅

go get github.com/stainless-sdks/stagehand-go@03b5aea699bfc300fc172617fa46a8a60913c989
⚠️ stagehand-csharp studio · code

Your SDK build had at least one "warning" diagnostic.
generate ⚠️build ⏭️lint ⏭️test ✅

stagehand-kotlin studio · conflict

Your SDK build had at least one note diagnostic.

stagehand-openapi studio · code

Your SDK build had at least one "note" diagnostic.
generate ✅

⚠️ stagehand-python studio · code

Your SDK build had at least one "warning" diagnostic.
generate ⚠️build ⏭️lint ⏭️test ✅

stagehand-ruby studio · code

Your SDK build had at least one "note" diagnostic.
generate ✅build ⏭️lint ✅test ✅

stagehand-java studio · conflict

Your SDK build had at least one note diagnostic.

⚠️ stagehand-typescript studio · code

Your SDK build had at least one "warning" diagnostic.
generate ⚠️build ⏭️lint ⏭️test ✅

⚠️ stagehand-php studio · code

Your SDK build had at least one "warning" diagnostic.
generate ⚠️lint ✅test ✅


This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-05-07 17:47:55 UTC

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 2 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.
Architecture diagram
sequenceDiagram
    participant Client as API Client
    participant V3 as Server v3
    participant V4 as Server v4
    participant Schema as OpenAPI Spec Schema
    participant Variables as Variables Schema
    participant Auth as Auth Middleware
    participant APIKey as API Key Store

    Note over Client,APIKey: OpenAPI Schema Regeneration Flow

    Client->>V3: Request with variables parameter
    V3->>Schema: Validate against v3 spec
    alt variables schema
        Schema->>Variables: CHANGED: Description wraps to new line
        Variables-->>Schema: Validated
    end
    Schema-->>V3: Validation result
    V3-->>Client: Response

    Client->>V4: Request with projectId header
    V4->>Auth: Check authentication
    Auth->>APIKey: CHANGED: projectId no longer required
    Note over Auth,APIKey: API keys are now project-scoped
    APIKey-->>Auth: Project context from key
    Auth-->>V4: Authenticated
    V4->>Schema: Validate against v4 spec
    alt projectId in request body
        Schema->>Schema: CHANGED: projectId marked deprecated
    end
    alt projectId in response body
        Schema->>Schema: CHANGED: projectId marked deprecated
    end
    Schema-->>V4: Validation result
    V4-->>Client: Response with deprecated projectId fields

    Note over V3,V4: Both specs regenerated from updated schema descriptions
Loading

@seanmcguire12 seanmcguire12 merged commit 86d3ec0 into main May 7, 2026
32 of 33 checks passed
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.

2 participants