feat:Update OpenAPI specification for Jina Embedding Serving API to 0.1.79

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced new API endpoints for managing classifiers:
    • GET /v1/classifiers: List available classifiers.
    • DELETE /v1/classifiers/{classifier_id}: Delete a specific classifier.

• Improvements

  • Updated TrainingAPIInput schema: renamed visibility to access with unchanged enum values.
  • Standardized error handling across endpoints with a 422 response for validation errors.

• Version Update

  • API version updated from 0.1.76 to 0.1.79.

[coderabbitai]

Walkthrough

The OpenAPI specification for the Jina Embedding Serving API has been updated from version 0.1.76 to 0.1.79. This update introduces new endpoints for listing and deleting classifiers, modifies the TrainingAPIInput schema by renaming the visibility field to access, and standardizes error responses across several endpoints. The security requirements for all endpoints remain unchanged, ensuring consistent access control.

Changes

File	Change Summary
src/libs/Jina/openapi.yaml	Updated API version to 0.1.79; added endpoints GET /v1/classifiers and DELETE /v1/classifiers/{classifier_id}; renamed visibility to access in TrainingAPIInput; standardized responses to include 422 for validation errors.

Poem

In the meadow, changes bloom,
New endpoints chase away the gloom.
Classifiers now can dance and play,
With access clear, they find their way.
A hop, a skip, let’s celebrate,
API updates, oh, how great! 🐇✨

---

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)

201-215: New GET endpoint for listing classifiers added.

The new endpoint /v1/classifiers has been correctly implemented with appropriate tags and security requirements. However, the response schema is empty, which might not be informative for API consumers.

Consider adding a more detailed response schema that includes the structure of the classifier information to be returned.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0e1103d and 217a8f3.

⛔ Files ignored due to path filters (14)

• src/libs/Jina/Generated/Jina.ClassificationClient.DeleteClassifier.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.ClassificationClient.ListClassifier.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.ClassificationClient.Train.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.IClassificationClient.DeleteClassifier.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.IClassificationClient.ListClassifier.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.IClassificationClient.Train.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.DeleteClassifierV1ClassifiersClassifierIdDeleteResponse.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.ListClassifierV1ClassifiersGetResponse.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.TrainingAPIInput.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/Jina.Models.TrainingAPIInputAccess.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/JsonConverters.TrainingAPIInputAccess.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/JsonConverters.TrainingAPIInputAccessNullable.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/JsonSerializerContext.g.cs is excluded by !**/generated/**
• src/libs/Jina/Generated/JsonSerializerContextTypes.g.cs is excluded by !**/generated/**

📒 Files selected for processing (1)

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

🧰 Additional context used

🔇 Additional comments (3)

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

5-5: API version updated correctly.

The API version has been incremented from 0.1.76 to 0.1.79, which is consistent with the changes described in the summary.

---

216-243: New DELETE endpoint for removing classifiers added.

The new endpoint /v1/classifiers/{classifier_id} has been correctly implemented with appropriate tags, parameters, and security requirements. The addition of this endpoint enhances the API's functionality for classifier management.

---

1016-1022: TrainingAPIInput schema updated correctly.

The visibility field has been appropriately renamed to access in the TrainingAPIInput schema. The change is consistent in both the schema definition and the example provided. This modification improves clarity in describing the accessibility of the classifier.

Also applies to: 1044-1044