feat:Update OpenAPI Specification for Jina Embedding Serving API to 0.1.76

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced a new endpoint: POST /v1/multi-vector for creating multiple vector representations of input texts.

• Deprecations

  • Marked the POST /v1/multi-embeddings endpoint as deprecated.

• Documentation Improvements

  • Enhanced descriptions for several endpoints and updated response schemas with detailed examples.

[coderabbitai]

Walkthrough

The pull request introduces significant updates to the OpenAPI specification of the Jina Embedding Serving API, incrementing the version to 0.1.76 and aligning with OpenAPI 3.0.1 standards. Key modifications include the deprecation of the /v1/multi-embeddings endpoint and the introduction of the new /v1/multi-vector endpoint. The documentation has been enhanced with refined descriptions, updated response schemas, and new example formats for identifiers, while maintaining security requirements for HTTP Bearer authentication.

Changes

File	Change Summary
src/libs/Jina/openapi.yaml	- Version incremented to 0.1.76. - Added endpoint: POST /v1/multi-vector. - Deprecated endpoint: POST /v1/multi-embeddings. - Updated id examples in multiple schemas. - Enhanced descriptions and response schemas. - Retained security section for HTTP Bearer authentication.

Poem

In the garden of code, where the endpoints play,
A new path blooms bright, while the old fades away.
With vectors now dancing, and examples that shine,
The Jina API grows, oh how divine!
So hop along, friends, to the updates we cheer,
For clarity and function, 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 (3)

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

Line range hint 232-262: Excellent addition of the /v1/multi-vector endpoint.

The new /v1/multi-vector endpoint enhances the API's capabilities by providing multiple vector representations for each token in the input text. This is a valuable feature for more granular text embedding tasks.

Consider updating the API documentation to highlight this new feature and provide usage examples for developers.

---

Line range hint 263-293: Appropriate deprecation of the /v1/multi-embeddings endpoint.

Marking the /v1/multi-embeddings endpoint as deprecated is a good practice for API evolution. This aligns with the introduction of the new /v1/multi-vector endpoint.

Consider adding a migration guide in the API documentation to help users transition from the deprecated /v1/multi-embeddings to the new /v1/multi-vector endpoint.

---

Line range hint 1-1226: Well-structured API evolution with new features and proper deprecation.

The changes to the OpenAPI specification are well-implemented, maintaining backwards compatibility while introducing new features. Key points:

1. The API version has been updated to 0.1.76.
2. A new /v1/multi-vector endpoint has been added, enhancing the API's capabilities.
3. The /v1/multi-embeddings endpoint has been properly deprecated.
4. Example IDs have been consistently updated throughout the file.
5. The overall structure and functionality of the API remain stable.

These changes demonstrate good API design practices, allowing for evolution while minimizing disruption to existing users.

As the API continues to evolve, consider the following:

1. Implement versioning in the URL (e.g., /v2/) for major changes in the future.
2. Provide a changelog in the API documentation to help users track changes across versions.
3. Consider setting up an API deprecation policy to communicate how long deprecated endpoints will be supported.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 90f7c25 and f1f2150.

⛔ Files ignored due to path filters (7)

• src/libs/Jina/Generated/Jina.Models.ApiSchemasClassificationImageDoc.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.ApiSchemasClassificationTextDoc.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.ApiSchemasEmbeddingImageDoc.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.ApiSchemasEmbeddingTextDoc.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.ApiSchemasRankTextDoc.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.ImageExampleDoc.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.TextExampleDoc.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🧰 Additional context used

🔇 Additional comments (2)

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

Line range hint 1-7: LGTM: Version update and general information.

The OpenAPI specification has been updated to version 0.1.76. The general information and server configuration look good.

---

581-581: Consistent update of example IDs.

The example IDs have been updated throughout the file to '638c3de241576a03c6d4226261d8e11a'. This change ensures consistency across the documentation.

To ensure all occurrences have been updated, please run the following command:

This will list all lines containing the new example ID, allowing you to verify that the update has been applied consistently throughout the file.

Also applies to: 948-948, 1066-1066, 1100-1100, 1128-1128, 1162-1162, 1192-1192

✅ Verification successful

Example ID Update Verified

All occurrences of the new example ID 638c3de241576a03c6d4226261d8e11a have been successfully updated in the following lines of src/libs/Jina/openapi.yaml:

• 581
• 948
• 1066
• 1100
• 1128
• 1162
• 1192

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify all occurrences of the new example ID
grep -n "638c3de241576a03c6d4226261d8e11a" src/libs/Jina/openapi.yaml

Length of output: 466