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 new API endpoint for last applied rule and update RuleLogSchema #115

Merged
merged 1 commit into from
Oct 30, 2024

Conversation

HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Oct 30, 2024

Summary by CodeRabbit

  • New Features
    • Introduced a new API endpoint to retrieve the last applied rule for specific rule IDs.
    • Added a new field to track the application time of rules in the logging schema.

Copy link

coderabbitai bot commented Oct 30, 2024

Walkthrough

The changes involve modifications to the openapi.yaml file for the LangSmith application. A new API endpoint /api/v1/runs/rules/{rule_id}/last_applied has been added to retrieve the last applied rule. Additionally, the RuleLogSchema has been updated to include a new field, application_time, which records the time a rule was applied.

Changes

File Change Summary
src/libs/LangSmith/openapi.yaml - Added endpoint /api/v1/runs/rules/{rule_id}/last_applied for retrieving the last applied rule.
- Added field application_time to RuleLogSchema to track the application time of rules.

Possibly related PRs

Suggested reviewers

  • github-actions

Poem

🐇 In the meadow where rules apply,
A new path opens, oh my, oh my!
With a timestamp to keep track,
The last rule's journey, no lack.
Hops of joy in the code we see,
A brighter future, hop along with me! 🌼


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 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 enabled auto-merge October 30, 2024 01:27
@github-actions github-actions bot merged commit 0fa8213 into main Oct 30, 2024
3 checks passed
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Add new API endpoint for last applied rule and update RuleLogSchema Oct 30, 2024
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 and nitpick comments (2)
src/libs/LangSmith/openapi.yaml (2)

3881-3882: Enhance endpoint documentation

The current description "Get the last applied rule" is too brief. Consider expanding it to include:

  • The purpose and use case of this endpoint
  • What "last applied" means in this context
  • Any important behavior details or side effects

16605-16609: Add documentation for the application_time field

While the field is properly typed, consider adding a description to clarify:

  • The exact meaning of "application time"
  • When this timestamp is set
  • Why it might be null

Example addition:

        application_time:
          title: Application Time
+         description: Timestamp when the rule was last applied to a run. Null if the rule hasn't been applied yet.
          type: string
          format: date-time
          nullable: true
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c1b84d3 and 4322ab9.

⛔ Files ignored due to path filters (6)
  • src/libs/LangSmith/Generated/LangSmith.DatasetsClient.UpdateDataset.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.IDatasetsClient.UpdateDataset.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.IRunClient.GetLastAppliedRule.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.DatasetUpdate.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.Models.RuleLogSchema.g.cs is excluded by !**/generated/**
  • src/libs/LangSmith/Generated/LangSmith.RunClient.GetLastAppliedRule.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/LangSmith/openapi.yaml (3 hunks)
🔇 Additional comments (2)
src/libs/LangSmith/openapi.yaml (2)

13010-13015: LGTM: Valid schema extension

The inputs_filters field is properly defined with clear typing and nullability.


3877-3908: LGTM: Well-structured endpoint definition

The endpoint is well-designed with:

  • Proper REST conventions
  • Comprehensive security controls
  • Appropriate parameter validation
  • Clear error responses

Let's verify the referenced schema exists:

✅ Verification successful

Schema verification complete - endpoint is correctly defined

The RuleLogSchema referenced in the endpoint is properly defined with all required fields (rule_id, run_id, start_time, end_time) and appropriate data types, including UUID formats for IDs and date-time formats for timestamps. The schema definition aligns perfectly with the endpoint's purpose of retrieving the last applied rule.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify that RuleLogSchema is properly defined
rg -A 10 "RuleLogSchema:" src/libs/LangSmith/openapi.yaml

Length of output: 273


Script:

#!/bin/bash
# Let's get the complete RuleLogSchema definition to verify all required properties
rg -A 20 "RuleLogSchema:" src/libs/LangSmith/openapi.yaml

Length of output: 497


Script:

#!/bin/bash
# Let's get even more lines to see the complete schema definition including start_time and end_time
rg -A 30 "RuleLogSchema:" src/libs/LangSmith/openapi.yaml

Length of output: 736


Script:

#!/bin/bash
# One final check with even more lines to see the complete schema including end_time
rg -A 40 "RuleLogSchema:" src/libs/LangSmith/openapi.yaml

Length of output: 993

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