Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat:Add CRUD endpoints for tracer sessions and filter views in LangSmith API #168

Merged
merged 1 commit into from
Jan 9, 2025

Conversation

HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Jan 9, 2025

Summary by CodeRabbit

  • New Features
    • Enhanced tracer session management with new API endpoints for reading, updating, and deleting sessions
    • Added support for creating, reading, updating, and deleting custom filter views for tracer sessions

Copy link

coderabbitai bot commented Jan 9, 2025

Walkthrough

The changes involve expanding the API capabilities for tracer sessions and filter views in the LangSmith OpenAPI specification. New endpoints have been added to provide comprehensive CRUD (Create, Read, Update, Delete) functionality for both tracer sessions and filter views, enabling more flexible management and interaction with tracing and filtering data within the system.

Changes

File Change Summary
src/libs/LangSmith/openapi.yaml - Added methods for reading, updating, and deleting tracer sessions
- Added methods for managing filter views (create, read, update, delete)

Poem

🐰 Hop, hop, through the API lanes,
Tracing sessions, filter views in refrains,
CRUD magic with a rabbit's delight,
Endpoints dancing, shining bright!
LangSmith's power, now unleashed with glee 🚀

Finishing Touches

  • 📝 Generate Docstrings

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
🪧 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.

@github-actions github-actions bot merged commit 9db5e5d into main Jan 9, 2025
2 of 4 checks passed
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Add CRUD endpoints for tracer sessions and filter views in LangSmith API Jan 9, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🔭 Outside diff range comments (1)
src/libs/LangSmith/openapi.yaml (1)

Line range hint 2442-2452: Ensure sensitive data handling in BasicAuthResponse schema.

The BasicAuthResponse schema contains an access token. Consider adding format and pattern validations for the access_token field to ensure it meets security requirements.

    BasicAuthResponse:
      title: BasicAuthResponse
      required:
        - access_token
      type: object
      properties:
        access_token:
          title: Access Token
          type: string
+         format: jwt
+         pattern: '^[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.?[A-Za-z0-9-_.+/=]*$'
+         description: JWT access token with specific format requirements
🧹 Nitpick comments (2)
src/libs/LangSmith/openapi.yaml (2)

6362-6409: Security schemes are well-defined but consider enhancing security descriptions.

The security schemes are properly configured, but consider adding more detailed descriptions for the ApiKey, TenantId, and OrganizationId schemes similar to the BearerAuth scheme's description.

    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
+     description: API keys are used for authenticating API requests. Required for most endpoints.
    TenantId:
      type: apiKey
      name: X-Tenant-Id
      in: header
+     description: Tenant ID header required for workspace-scoped operations.
    OrganizationId:
      type: apiKey
      name: X-Organization-Id
      in: header
+     description: Organization ID header required for organization-scoped operations.

Line range hint 6075-6089: Consider adding rate limiting headers to the API specification.

While usage tracking is implemented, consider adding standard rate limiting headers to the API responses.

  responses:
    '200':
      description: Successful Response
      headers:
+       X-RateLimit-Limit:
+         description: Request limit per hour
+         schema:
+           type: integer
+       X-RateLimit-Remaining:
+         description: Remaining requests for the hour
+         schema:
+           type: integer
+       X-RateLimit-Reset:
+         description: Time until rate limit reset in UTC epoch seconds
+         schema:
+           type: integer
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fd2cc17 and 6bc61e0.

⛔ Files ignored due to path filters (3)
  • src/libs/LangSmith/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.AnnotationQueuesClient.GetRunsFromAnnotationQueue.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.IAnnotationQueuesClient.GetRunsFromAnnotationQueue.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/LangSmith/openapi.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Test / Build, test and publish
🔇 Additional comments (2)
src/libs/LangSmith/openapi.yaml (2)

Line range hint 1-7: LGTM! API version and server configuration look good.

The OpenAPI specification version 3.0.4 is appropriate, and the server URL is correctly defined.


Line range hint 3182-3195: LGTM! Error handling schema is well-defined.

The HTTPValidationError schema provides a good structure for validation errors with detailed location information.

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.

1 participant