feat:Title: Update documentation for API endpoints and usage examples

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced a new query parameter chunkUids to the API, allowing users to include multiple chunk unique identifiers in requests for enhanced processing capabilities.

• Bug Fixes

  • No bug fixes included in this release.

• Documentation

  • Updated API documentation to reflect the new chunkUids parameter.

[coderabbitai]

Walkthrough

The changes introduce a new query parameter named chunkUids to the OpenAPI specification in the src/libs/Instill/openapi.yaml file. This parameter allows the API to accept an array of strings, enabling the inclusion of multiple chunk unique identifiers in requests. The API's response structure remains unchanged, continuing to return a status code of '200' for successful requests.

Changes

File	Change Summary
src/libs/Instill/openapi.yaml	Added new query parameter chunkUids to accept an array of strings.

Poem

In the land of code where rabbits play,
A new parameter hops in today!
With chunkUids to gather and share,
Multiple chunks, a joyful affair!
Hooray for the changes, let’s all cheer,
For smoother requests, the future is near! 🐇✨

---

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

🧹 Outside diff range and nitpick comments (1)

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

1439-1446: Approve with suggestions: New chunkUids parameter looks good, but could use some enhancements

The addition of the chunkUids query parameter is a good improvement to the API, allowing for more flexible querying of catalog chunks. However, consider the following suggestions to enhance its usability and documentation:

1. Expand the description to provide more context, e.g., "An array of chunk unique identifiers to filter the results."
2. Specify whether this parameter is required or optional.
3. Consider adding a maxItems property to limit the number of chunk UIDs that can be provided in a single request, if applicable.

Here's a suggested improvement for the parameter definition:

- name: chunkUids
  in: query
  description: "An array of chunk unique identifiers to filter the results. If provided, only chunks with matching UIDs will be returned."
  required: false
  schema:
    type: array
    items:
      type: string
    maxItems: 100  # Adjust this number as appropriate for your use case

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3c98860 and 734efad.

⛔ Files ignored due to path filters (2)

• src/libs/Instill/Generated/Instill.CatalogClient.ListChunks.g.cs is excluded by !**/generated/**
• src/libs/Instill/Generated/Instill.ICatalogClient.ListChunks.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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