feat:Update OpenAPI Specification for Jina Embedding Serving API to v0.1.89

[HavenDV]

Summary by CodeRabbit

• New Features
  • Updated OpenAPI specification for the Jina Embedding Serving API.
  • Clarified descriptions for several API endpoints to enhance user understanding.
  • Deprecated the /v1/multi-embeddings endpoint to signal a design shift.
• Version Update
  • API version incremented from 0.1.87 to 0.1.89.

[coderabbitai]

Walkthrough

The pull request includes updates to the OpenAPI specification for the Jina Embedding Serving API. The version has been incremented from 0.1.87 to 0.1.89. The /v1/multi-embeddings endpoint is now marked as deprecated, while descriptions for the /v1/embeddings, /v1/bulk-embeddings, and /v1/multi-vector endpoints have been clarified. The security scheme remains unchanged, and response schemas have had their descriptions refined for clarity without altering their structure.

Changes

File Path	Change Summary
src/libs/Jina/openapi.yaml	- Version updated from 0.1.87 to 0.1.89
	- Endpoint /v1/multi-embeddings marked as deprecated
	- Descriptions updated for /v1/embeddings, /v1/bulk-embeddings, and /v1/multi-vector endpoints
	- Security scheme remains HTTP Bearer authentication
	- Response schemas descriptions refined for BulkEmbeddingJobResponse, ModelEmbeddingOutput, and RankingOutput

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Auth

    Client->>Auth: Request Bearer Token
    Auth-->>Client: Return Bearer Token
    Client->>API: Call /v1/embeddings with Token
    API-->>Client: Return Embedding Response

Loading

🐇 In the meadow, changes bloom,
New version hops, dispelling gloom.
Endpoints shift, descriptions clear,
A deprecation, we now revere.
With every call, our paths align,
In Jina's garden, all will be fine! 🌼

---

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/Jina/openapi.yaml (1)

Line range hint 32-38: Add migration guidance for deprecated endpoint.

While the /v1/multi-embeddings endpoint is correctly marked as deprecated, it would be helpful to add migration guidance in the description to help users transition to the /v1/multi-vector endpoint.

  description: Create multiple vector representations of the given input texts. One vector representation for each token in the input text.
+ description: |
+   DEPRECATED: This endpoint is deprecated and will be removed in a future version.
+   Please migrate to the `/v1/multi-vector` endpoint which provides identical functionality.
+   
+   Create multiple vector representations of the given input texts. One vector representation for each token in the input text.

Also applies to: 279-321

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 918a50f and 7ea7f91.

📒 Files selected for processing (1)

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

🔇 Additional comments (3)

src/libs/Jina/openapi.yaml (3)

5-5: LGTM: Version increment is appropriate.

The version has been correctly incremented from 0.1.87 to 0.1.89.

---

Line range hint 322-1037: LGTM: Well-structured schema definitions.

The schema definitions are comprehensive and follow OpenAPI best practices:

• Proper validation rules are in place
• Detailed model descriptions with parameter sizes and dimensions
• Clear input/output schemas with examples

---

Line range hint 1038-1042: LGTM: Proper security implementation.

The API consistently implements HTTP Bearer authentication across all endpoints, following security best practices.