feat:Update OpenAPI YAML: Add tracer session and organization endpoints

[HavenDV]

Summary by CodeRabbit

• New Features
  • Introduced endpoints to retrieve session metadata and manage filter views for enhanced session analysis.
  • Added endpoints for streamlined organization management, including accessing dashboards, handling payment methods and plans, and managing roles.
  • Extended member management capabilities by providing options to add, update, and list both active and pending members, along with managing permissions and pending invites.

[coderabbitai]

Walkthrough

The changes update the OpenAPI specification in a single YAML file by adding multiple new API endpoints. The updates include endpoints for tracer session operations—retrieving session metadata and managing filter views—as well as endpoints for various organization-related operations such as accessing dashboards, managing payment methods and plans, handling roles and permissions, and administering members. All modifications are consolidated within the updated specification file.

Changes

File	Change Summary
src/.../openapi.yaml	Added new endpoints for tracer sessions (retrieve metadata, manage filter views: get, create, update, delete) and organization management (dashboard, payment method & plan updates, roles, permissions, pending invites, and member operations).

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API_Server as API Server
    participant Session_Service as Session Service
    Client->>API_Server: GET /api/v1/sessions/{session_id}/metadata
    API_Server->>Session_Service: Retrieve top K metadata values
    Session_Service-->>API_Server: Return metadata
    API_Server-->>Client: Response with metadata

Loading

sequenceDiagram
    participant Client
    participant API_Server as API Server
    participant Org_Service as Organization Service
    Client->>API_Server: POST /api/v1/orgs/current/members/basic/batch
    API_Server->>Org_Service: Process batch member addition
    Org_Service-->>API_Server: Confirmation
    API_Server-->>Client: Batch addition response

Loading

Possibly related PRs

• feat:Add API endpoints for managing tracer sessions, datasets, and examples #135: Introduced new tracer session endpoints, aligning closely with the session metadata functionality.
• feat:Add tracer session metadata and filter view endpoints to OpenAPI spec #178: Directly related to adding tracer session and filter view endpoints in the same OpenAPI specification.
• feat:Add API endpoints for managing tracer sessions and filter views #101: Implemented multiple API endpoints for session and organization management in the same file.

Suggested reviewers

• github-actions

Poem

I'm a little rabbit, code in my sight,
Hopping through endpoints from morning to night.
New sessions and roles in rows I see,
API carrots growing wild and free.
With a twitch of my nose and a joyful cheer,
I celebrate changes made so clear!

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 734105e and 4bad67b.

⛔ Files ignored due to path filters (10)

• src/libs/LangSmith/Generated/JsonConverters.QueryExampleSchemaWithRunsFormat.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/JsonConverters.QueryExampleSchemaWithRunsFormatNullable.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/JsonSerializerContext.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.DatasetsClient.ReadExamplesWithRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IDatasetsClient.ReadExamplesWithRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.IPublicClient.ReadSharedDatasetExamplesWithRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.QueryExampleSchemaWithRuns.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.Models.QueryExampleSchemaWithRunsFormat.g.cs is excluded by !**/generated/**
• src/libs/LangSmith/Generated/LangSmith.PublicClient.ReadSharedDatasetExamplesWithRuns.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

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

• GitHub Check: Test / Build, test and publish

🔇 Additional comments (3)

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

3264-3271: Clarify and Validate the New Query Parameter "format".
A new query parameter named "format" is introduced with a schema providing a title, type, and description. The description uses single-quote escaping (e.g., ''csv'') which is syntactically correct in YAML but could be slightly confusing at first glance. Please verify that this parameter’s intended usage is clearly documented in your API docs and that its formatting is consistent with other query parameters.

---

3289-3292: Confirm the Nullable Property on the Array Schema.
The addition of "nullable: true" directly following the "items" definition appears intended to allow the entire array to be null. Please confirm that this behavior is what you intended—if the design requires distinguishing between an empty array and a null value, this is fine. Otherwise, ensure that both your backend and client documentation reflect this nuance.

---

18033-18038: Review the "format" Property in the Schema Definition.
A new property "format" is added with a title, enum (with a single value "csv"), type, and marked as nullable. While this structure is correct, note that using "format" as a property name might cause some confusion with the JSON Schema keyword "format" that is generally used to validate data (e.g., date, uuid). If "format" here is meant to specify a response or file format, consider renaming it (e.g., "responseFormat") for improved clarity. If you choose to keep it as "format," ensure that the documentation makes the intended use clear.

---

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.