Skip to content

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Jan 5, 2026

s2-protos Update

This PR updates the following submodules:

Remote Repository Submodule Path Change
s2-streamstore/s2-protos s2-protos fe043c4...287c536

This PR description was generated by sgoudham/update-git-submodules.

Changes

  • Updated s2-protos submodule
  • Regenerated proto TypeScript files
  • Regenerated OpenAPI TypeScript files

Commit: 287c53672d9d73ea81ebf59cc09aa6c08d24f253

@greptile-apps
Copy link

greptile-apps bot commented Jan 5, 2026

Greptile Summary

Updates s2-protos submodule and regenerates TypeScript types from updated OpenAPI specifications.

Key Changes:

  • Breaking Change: API.S2Format renamed to API.Format - external users will need to update imports
  • Removed s2-request-token header from CreateOrReconfigureBasinData and CreateOrReconfigureStreamData (PUT operations only; POST operations retain this header)
  • Changed RevokeAccessTokenResponses from 200: unknown to 204: void (more accurate HTTP semantics)
  • Added missing RevokeAccessTokenResponse type export
  • Documentation improvements: clarified basin name length is in bytes (not characters), reformatted multi-line comments

Impact Assessment:
The SDK's internal code uses createBasin and createStream (POST operations) which still have the s2-request-token header, so no internal breakage. The type rename is the primary breaking change for external users accessing the API namespace.

Confidence Score: 4/5

  • Safe to merge with awareness of breaking change for external API type consumers
  • The changes are auto-generated from proto updates and internally consistent. The breaking type rename (S2FormatFormat) is the main concern for external users who access types via the API namespace. Internal SDK code is unaffected as it doesn't use the renamed type. The header removals are intentional (only affect PUT operations, not POST) and won't break existing SDK functionality.
  • No files require special attention - this is a standard proto update with expected type changes

Important Files Changed

Filename Overview
packages/streamstore/src/generated/types.gen.ts Proto update with breaking type rename (S2FormatFormat), API response type improvements, and header removals for upsert operations
s2-protos Submodule pointer updated from fe043c4 to 287c536

Sequence Diagram

sequenceDiagram
    participant Bot as GitHub Actions Bot
    participant Repo as s2-sdk-typescript
    participant Proto as s2-protos Submodule
    participant Gen as Code Generator
    
    Bot->>Proto: Update submodule pointer
    Note over Proto: fe043c4 → 287c536
    Bot->>Gen: Trigger regeneration
    Gen->>Gen: Process OpenAPI specs
    Gen->>Repo: Update types.gen.ts
    Note over Repo: • Rename S2Format → Format<br/>• Remove s2-request-token from upsert ops<br/>• Change RevokeAccessToken 200→204<br/>• Update docs (characters→bytes)
Loading

@shikhar shikhar closed this Jan 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants