Skip to content

Conversation

@shikhar
Copy link
Member

@shikhar shikhar commented Jan 26, 2026

No description provided.

/// Filter to streams whose names begin with this prefix.
#[cfg_attr(feature = "utoipa", param(value_type = String, default = "", required = false))]
pub prefix: Option<StreamNamePrefix>,
/// Filter to streams whose name begins with this prefix.
Copy link
Member Author

Choose a reason for hiding this comment

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

(this was wrong)

@shikhar shikhar marked this pull request as ready for review January 26, 2026 20:29
@greptile-apps
Copy link

greptile-apps bot commented Jan 26, 2026

Greptile Overview

Greptile Summary

This PR fixes documentation comments in the OpenAPI schema definitions to improve grammar and clarity:

  • Fixed plural agreement in ListAccessTokensRequest ("ID""IDs", "begins""begin")
  • Fixed plural agreement in ListStreamsRequest ("name""names")
  • Corrected the description of start_after field which previously duplicated the prefix description
  • Removed redundant documentation for the Header struct (the doc comment was weirdly repeated in the OpenAPI schema)

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • The changes are purely documentation fixes with no functional code changes, improving grammar and removing duplicate comments
  • No files require special attention

Important Files Changed

Filename Overview
api/src/v1/access.rs Fixed grammar in documentation comments: "ID" → "IDs" and "begins" → "begin" to match plural subjects
api/src/v1/stream/mod.rs Fixed grammar in documentation comments and removed duplicate/incorrect comment for start_after field; removed redundant doc comments for Header struct

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant OpenAPI as OpenAPI Generator
    participant Doc as API Documentation
    
    Dev->>OpenAPI: Update doc comments in access.rs
    Note over OpenAPI: Fix grammar: "ID" → "IDs"<br/>"begins" → "begin"
    OpenAPI->>Doc: Generate improved docs for<br/>ListAccessTokensRequest
    
    Dev->>OpenAPI: Update doc comments in stream/mod.rs
    Note over OpenAPI: Fix grammar: "name" → "names"<br/>Correct start_after description<br/>Remove redundant Header docs
    OpenAPI->>Doc: Generate improved docs for<br/>ListStreamsRequest & Header
    
    Doc-->>Dev: Clearer API documentation
Loading

@shikhar shikhar merged commit 337e4f9 into main Jan 26, 2026
9 checks passed
@shikhar shikhar deleted the list-api-docfix branch January 26, 2026 20:32
shikhar added a commit to s2-streamstore/s2-specs that referenced this pull request Jan 26, 2026
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