ProjectTech4DevAI / ProjectTech4DevAI/kaapi-backend
Kaapi platform API Versioning
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 18
- フォーク
- 10
- 平均マージ
- 2日 20時間
- マージ済み PR(30日)
- 14
説明
Right now our API is effectively “latest-only.” That makes iterative changes risky and forces clients to upgrade immediately. We have situations where even though we need to evolve a feature's capabilities then we have to think of it in a way it does not affect our current users, this causes us to be limited with the changes we need to do in any module. To solve for this, we need a versioning strategy to:
-
Establish a clear, documented API versioning scheme
-
Stand up v1 as the first frozen version
-
Enable development of v2 (and beyond) without breaking v1
-
for example collection module creates an openai assistant from documents given to the module , but since assistants is going to be deprecated, we will make changes in the module by removing the assistant part and just keep the creation of vector store. although dalgo needs collection to create assitant that is why we will version the collection module where v1 will be the current version, and v2 will be when we will just be creating a vector store from the documents
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、collection モジュールの現在の API と Dalgo との統合を整理し、issue に記載されている OpenAI assistant と vector-store の動作に焦点を当てます。v1 に残す必要があるもの、v2 に移行するもの、そしてバージョニングスキームとドキュメントによって v1 の互換性を維持しつつ v2 で assistant の作成を削除することをどのように示すかを定義します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- api, backend
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100