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 created_after and created_before parameters to GET /predictions #69

Merged
merged 1 commit into from
Feb 5, 2025

Conversation

HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Feb 5, 2025

Summary by CodeRabbit

  • New Features
    • Enhanced predictions filtering: Users can now narrow down prediction results by specifying a start or end date in ISO 8601 format, allowing retrieval of predictions within a specific time frame.

Copy link

coderabbitai bot commented Feb 5, 2025

Walkthrough

The pull request updates the OpenAPI specification for the GET /predictions endpoint by introducing two new optional query parameters: created_after and created_before. Both parameters accept ISO 8601 date-time strings and enable clients to filter predictions based on their creation timestamps, without altering the existing functionality.

Changes

File Change Summary
src/.../openapi.yaml Added two optional query parameters (created_after and created_before) to the GET /predictions endpoint for filtering by creation timestamps.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant API as API Server
    participant DB as Database

    C->>API: GET /predictions?created_after=...&created_before=...
    API->>DB: Query predictions with time filters
    DB-->>API: Return filtered predictions
    API-->>C: Send predictions list
Loading

Possibly related PRs

Suggested reviewers

  • github-actions

Poem

I'm a little rabbit, hopping with cheer,
New filters in place, the solution is here.
Timestamps are sorted like carrots in a row,
Hopping through data, watch the improvements flow.
With a twitch of my nose and a joyful heart,
I celebrate these changes—a fresh API start!


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 enabled auto-merge February 5, 2025 12:26
@github-actions github-actions bot merged commit f55b679 into main Feb 5, 2025
3 of 4 checks passed
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Add created_after and created_before parameters to GET /predictions Feb 5, 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

🧹 Nitpick comments (1)
src/libs/Replicate/openapi.yaml (1)

738-752: New Optional Query Parameters for Filtering Predictions

You've successfully added the created_after and created_before query parameters to the GET /predictions endpoint. The descriptions and schema definitions are clear, and specifying the ISO 8601 format (via format: date-time) is correct.

  • Suggestion: Consider adding a regex pattern (using the pattern property) for additional format validation if you need stricter enforcement of the date-time string structure. This extra validation can help ensure client inputs conform exactly to the expected format.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dd3d9e0 and 6224ebb.

⛔ Files ignored due to path filters (3)
  • src/libs/Replicate/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**
  • src/libs/Replicate/Generated/Replicate.IReplicateApi.PredictionsList.g.cs is excluded by !**/generated/**
  • src/libs/Replicate/Generated/Replicate.ReplicateApi.PredictionsList.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/Replicate/openapi.yaml (1 hunks)

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