feat:Update OpenAPI Specification for Jina Embedding API with ID Changes and Deprecation #45
Conversation
WalkthroughThe pull request involves updates to the OpenAPI specification for the Jina Embedding Serving API, specifically modifying example values for Changes
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
src/libs/Jina/openapi.yaml (2)
Line range hint
1-1: Ensure proper documentation for deprecated endpoint.The
/v1/multi-embeddingsendpoint has been marked as deprecated in the OpenAPI specification. While the functionality remains unchanged, this is a significant change that may affect API consumers.Consider the following suggestions:
- Add a deprecation notice in the endpoint's description, explaining the reason for deprecation.
- Provide information about the recommended alternative endpoint or method to use instead.
- If not already done, update the API documentation to reflect this deprecation and provide migration guidelines for users.
Line range hint
1-1192: Summary of changes in the OpenAPI specification.
Example ID updates: The example ID has been consistently updated from
50336949b5bd1f1ed97f3085d76258a1to5b469b33e5ea59cd6442950009e892afacross all relevant schemas. This change is cosmetic and doesn't affect the API's functionality.Endpoint deprecation: The
/v1/multi-embeddingsendpoint has been marked as deprecated. While the functionality remains unchanged, this is a significant change that may affect API consumers.These changes align with the provided summary and maintain the overall structure and security scheme of the API.
To ensure a smooth transition for API consumers:
- Consider adding a deprecation timeline for the
/v1/multi-embeddingsendpoint.- If not already planned, create a migration guide for users of the deprecated endpoint.
- In future API versions, consider removing the deprecated endpoint entirely to maintain a clean API surface.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (7)
src/libs/Jina/Generated/Jina.Models.ApiSchemasClassificationImageDoc.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.ApiSchemasClassificationTextDoc.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.ApiSchemasEmbeddingImageDoc.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.ApiSchemasEmbeddingTextDoc.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.ApiSchemasRankTextDoc.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.ImageExampleDoc.g.csis excluded by!**/generated/**src/libs/Jina/Generated/Jina.Models.TextExampleDoc.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
- src/libs/Jina/openapi.yaml (7 hunks)
🧰 Additional context used
🔇 Additional comments (7)
src/libs/Jina/openapi.yaml (7)
948-948: LGTM: Example ID updated consistently.The example ID for the
TextExampleDocschema has been updated, maintaining consistency with theImageExampleDocschema and aligning with the summary provided.
1066-1066: LGTM: Example ID updated consistently.The example ID for the
api_schemas__classification__ImageDocschema has been updated, maintaining consistency with the other schemas and aligning with the summary provided.
1100-1100: LGTM: Example ID updated consistently.The example ID for the
api_schemas__classification__TextDocschema has been updated, maintaining consistency with the other schemas and aligning with the summary provided.
1128-1128: LGTM: Example ID updated consistently.The example ID for the
api_schemas__embedding__ImageDocschema has been updated, maintaining consistency with the other schemas and aligning with the summary provided.
1162-1162: LGTM: Example ID updated consistently.The example ID for the
api_schemas__embedding__TextDocschema has been updated, maintaining consistency with the other schemas and aligning with the summary provided.
1192-1192: LGTM: Example ID updated consistently across all schemas.The example ID for the
api_schemas__rank__TextDocschema has been updated, maintaining consistency with all other schemas in the file. This change, along with the previous ones, ensures that all example IDs have been uniformly updated from50336949b5bd1f1ed97f3085d76258a1to5b469b33e5ea59cd6442950009e892afthroughout the OpenAPI specification.
581-581: LGTM: Example ID updated consistently.The example ID for the
ImageExampleDocschema has been updated. This change aligns with the summary provided and doesn't affect the API's functionality.To ensure consistency across all schemas, let's verify the ID update in other schemas:
✅ Verification successful
LGTM: Example ID updated consistently across all schemas.
All instances of the example ID have been successfully updated to
5b469b33e5ea59cd6442950009e892af, and there are no remaining occurrences of the old ID.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check for consistent ID example updates across all schemas # Test: Search for the old and new ID examples echo "Occurrences of old ID (should be 0):" rg --type yaml "50336949b5bd1f1ed97f3085d76258a1" src/libs/Jina/openapi.yaml | wc -l echo "Occurrences of new ID (should match the number of schemas with ID fields):" rg --type yaml "5b469b33e5ea59cd6442950009e892af" src/libs/Jina/openapi.yaml | wc -lLength of output: 415
Summary by CodeRabbit
New Features
idfields in various schemas to enhance clarity and accuracy./v1/multi-embeddingsendpoint as deprecated while maintaining its functionality.Bug Fixes