ProjectTech4DevAI / ProjectTech4DevAI/kaapi-backend

Kaapi platform API Versioning

Open
#401 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
18
Forks
10
Avg merge
2d 20h
Merged PRs (30d)
14

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by mapping the collection module's current API and its integration with Dalgo, focusing on the OpenAI assistant and vector-store behavior described in the issue. Define what must remain in v1, what moves to v2, and how the versioning scheme and documentation will show that v1 remains compatible while v2 removes assistant creation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.