kafbat/kafka-ui

BE: Nuke Messages v1 API

Open

#211 opened on Mar 15, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)TypeScript (363 forks)auto 404
area/messagesgood first issuehacktoberfestscope/backendscope/frontendstatus/pending-backendstatus/triage/completedtype/chore

Repository metrics

Stars
 (2,554 stars)
PR merge metrics
 (PR metrics pending)

Description

Ship after August 2024

After #47 is merged in the next release we can drop legacy v1 API

  1. BE: Drop messages v1 API (contracts) (only GET)
  2. BE: Rename /v2 endpoint, remove suffix
  3. Update the URL on FE
  4. Fix BE/FE tests

Contributor guide

Research direction
Investigate the messages API structure: find the backend contracts for v1 and v2, see how the frontend references them, and locate the tests. Understand the impact of dropping v1 and renaming v2, and check the status of issue #47.
Tech stack
typescript
Domain
backendfrontend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65