feat:Add GET endpoint for listing pipeline triggers with pagination and filtering

[HavenDV]

Summary by CodeRabbit

• New Features
  • Introduced a new endpoint to list pipeline triggers via GET /v1beta/metrics/vdp/pipeline/triggers.
  • Added support for pagination and filtering in the new endpoint.
  • Enhanced response structure with the ListPipelineTriggerRecordsResponse schema for improved data clarity.

[coderabbitai]

Walkthrough

The changes introduce a new endpoint to the Instill API's OpenAPI specification, specifically the GET /v1beta/metrics/vdp/pipeline/triggers endpoint. This endpoint enables users to list pipeline triggers with pagination and filtering options. Additionally, a new response schema, ListPipelineTriggerRecordsResponse, is defined in the components section to structure the data returned by this endpoint, including properties for pipeline trigger records, pagination, and total size.

Changes

File Path	Change Summary
src/libs/Instill/openapi.yaml	Added GET /v1beta/metrics/vdp/pipeline/triggers endpoint and ListPipelineTriggerRecordsResponse schema.

Poem

In the land of code where rabbits play,
A new endpoint hops in, brightening the day.
With triggers to list and metrics to see,
Our API grows, as happy as can be!
So let’s cheer for changes, both big and small,
For in the world of data, there’s room for us all! 🐇✨

---

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 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: 1

🧹 Outside diff range and nitpick comments (1)

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

981-985: Enhance pageToken parameter description.

The current description lacks details about the token's format, usage, and how to obtain it for pagination.

Consider adding more details to the description:

-          description: Page token.
+          description: "Token to retrieve the next page of results. This token is returned in the\nresponse when there are more results available. To get the next page, make the\nsame request with this token value. Leave this field empty to retrieve the first\npage."

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between aec0f6b and e0178b1.

⛔ Files ignored due to path filters (6)

• src/libs/Instill/Generated/Instill.IMetricClient.ListPipelineTriggerRecords.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.MetricClient.ListPipelineTriggerRecords.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.ListPipelineTriggerRecordsResponse.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.ListPipelineTriggerRecordsResponse2.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.Models.PipelineTriggerRecord.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🧰 Additional context used

🔇 Additional comments (1)

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

2313-2328: LGTM! Well-structured schema definitions.

The schema definitions for ListPipelineTriggerRecordsResponse and PipelineTriggerRecord are well-designed with:

• Clear property descriptions
• Appropriate use of readOnly fields
• Proper data types
• Good reuse of existing enums
• Standard pagination pattern

Also applies to: 2605-2643

[coderabbitai]

⚠️ Potential issue

Fix inconsistent pageSize limit in description.

The description states "at most 100 pipelines" but also mentions "any value above that will be coerced to 100", while the actual limit appears to be 1000 based on the text. Please clarify the correct limit and update the description accordingly.

Apply this diff to fix the description:

          description: "The maximum number of triggers to return. If this parameter is unspecified,\nat most 100 pipelines will be returned. The cap value for this parameter is\n1000 (i.e. any value above that will be coerced to 100)."
+          description: "The maximum number of triggers to return. If this parameter is unspecified,\nat most 100 pipelines will be returned. The cap value for this parameter is\n1000 (i.e. any value above that will be coerced to 1000)."

Committable suggestion was skipped due to low confidence.