feat:Update openapi.yaml: add session_id, start_time, and skip_prev_cursor

[HavenDV]

Summary by CodeRabbit

• New Features
  • Enhanced run queries with additional filtering options by session and start time.
  • Improved query efficiency by streamlining pagination, allowing smoother navigation through results.

[coderabbitai]

Walkthrough

This pull request updates the API specification in openapi.yaml by adding two new query parameters—session_id and start_time—to the GET /api/v1/runs/{run_id} endpoint, enabling more granular filtering. It also introduces a new field, skip_prev_cursor, to the BodyParamsForRunSchema used in the POST /api/v1/runs/query endpoint for managing pagination. These changes update the schema declarations and endpoint definitions, enhancing filtering capabilities.

Changes

File	Change Summary
src/libs/LangSmith/.../openapi.yaml	- Added session_id (nullable UUID) and start_time (nullable datetime) parameters to the GET /api/v1/runs/{run_id} endpoint. - Introduced skip_prev_cursor in BodyParamsForRunSchema used by the POST /api/v1/runs/query endpoint.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API_Server
    Client->>API_Server: GET /api/v1/runs/{run_id}?session_id=...&start_time=...
    API_Server-->>Client: Returns filtered run details

Loading

sequenceDiagram
    participant Client
    participant API_Server
    Client->>API_Server: POST /api/v1/runs/query (with skip_prev_cursor field)
    API_Server-->>Client: Returns queried runs with adjusted pagination

Loading

Possibly related PRs

• feat:Update openapi.yaml with new endpoints and schema modifications for LangSmith #113: Involves similar schema and endpoint updates in openapi.yaml, focusing on API parameter enhancements.
• feat:Update API Endpoints and Schemas for Tracer Sessions, Datasets, and Runs #122: Introduces query parameter modifications and schema changes related to querying runs.
• feat:Add new API endpoints for tracer sessions, datasets, runs, and feedback management #127: Enhances filtering capabilities for runs by updating query parameters and schema definitions.

Suggested reviewers

• github-actions

Poem

Hop, hop, in fields of code I play,
Filtering paths now bright as day!
Session and time, like streams they flow,
Skipping old cursors, onward we go.
With leaps of joy and bytes so light,
The API garden blooms just right!
– A coding rabbit in a tech delight.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/libs/LangSmith/openapi.yaml (1)

4324-4337: Review: Adding session_id and start_time Query Parameters

The new query parameters session_id and start_time are well-defined with clear type specifications, format validations, and nullable settings. This addition enhances the endpoint's filtering capabilities. As an improvement, consider including a brief description for each parameter to better guide API consumers.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3980df1 and 21030bd.

⛔ Files ignored due to path filters (7)

• src/libs/LangSmith/Generated/LangSmith.IPublicClient.QuerySharedDatasetRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IRunClient.QueryRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IRunClient.ReadRun.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.BodyParamsForRunSchema.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.PublicClient.QuerySharedDatasetRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.RunClient.QueryRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.RunClient.ReadRun.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/LangSmith/openapi.yaml (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Test / Build, test and publish

🔇 Additional comments (1)

src/libs/LangSmith/openapi.yaml (1)

12767-12770: Review: Inclusion of skip_prev_cursor in BodyParamsForRunSchema

The new field skip_prev_cursor is specified correctly as a boolean with a default value of false, which aligns with pagination improvements discussed. Optionally, adding a description field could clarify its intended behavior for API users.