feat:Update OpenAPI Specification: Remove Answer Endpoint and Update Search Method

[HavenDV]

Summary by CodeRabbit

• New Features

  • Updated the /studio/v1/library/search endpoint to enhance document search capabilities.

• Bug Fixes

  • Removed the deprecated /studio/v1/library/answer endpoint to streamline API functionality.

• Documentation

  • Updated API specifications to reflect the changes in endpoint availability and schema definitions.

[coderabbitai]

Walkthrough

The pull request introduces significant changes to the OpenAPI specification for the AI21 Studio API. It removes the /studio/v1/library/answer endpoint and its associated request and response schemas. Additionally, the /studio/v1/library/search endpoint is updated to include a POST method while retaining its existing parameters, request body schema, and response structure. The components section sees the removal of schemas related to the answer functionality, streamlining the API while preserving search capabilities.

Changes

File	Change Summary
src/libs/AI21/openapi.yaml	Removed /studio/v1/library/answer endpoint (POST) and schemas LibraryAnswerRequest and LibraryAnswerResponse. Updated /studio/v1/library/search endpoint (POST) with preserved parameters and response structure.

Possibly related PRs

• feat:Remove enum members from ModelName and update openapi.yaml accordingly #30: This PR modifies the openapi.yaml file by removing enum values that are also referenced in the main PR, indicating a direct relationship in terms of changes to the OpenAPI specification.

🐰 In the meadow where ideas bloom,
A search was crafted, dispelling gloom.
The answer's path has faded away,
But searching still brings light to the day.
With schemas trimmed, the API's bright,
A rabbit's hop towards future's light! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 85c3f1c and 8ff57ce.

⛔ Files ignored due to path filters (16)

• src/libs/AI21/Generated/AI21.IRAGEngineClient.V1LibraryAnswer.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/AI21.Models.AnswerLength.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/AI21.Models.LibraryAnswerRequest.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/AI21.Models.LibraryAnswerRequestLabelsFilterMode.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/AI21.Models.LibraryAnswerResponse.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/AI21.Models.Mode.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/AI21.Models.SourceDocument.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/AI21.RAGEngineClient.V1LibraryAnswer.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/JsonConverters.AnswerLength.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/JsonConverters.AnswerLengthNullable.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/JsonConverters.LibraryAnswerRequestLabelsFilterMode.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/JsonConverters.LibraryAnswerRequestLabelsFilterModeNullable.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/JsonConverters.Mode.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/JsonConverters.ModeNullable.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/JsonSerializerContext.g.cs is excluded by !**/generated/**
• src/libs/AI21/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

• src/libs/AI21/openapi.yaml (0 hunks)

💤 Files with no reviewable changes (1)

• src/libs/AI21/openapi.yaml

---

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.