3Hren / 3Hren/cocaine-http-proxy

API versioning

Open
#9 0 comments 0 reactions 0 assignees View on GitHub
P: medium T: docs T: feature V: minor
Dominant language
Rust
Stars
5
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Since we're not a library it is required to notify our clients about API change.

For example a monitoring server API provides `/metrics` method, which returns a JSON. To be able to keep the proxy backward compatible we can add `/vN` prefix and it becomes `/v1/metrics`.

Moreover we should mention how we treat semantic versioning. Strictly, we should bump major version when:

- The config changes in backward-incompatible manner.
- We break URIs.

So, the tasks are:

- [ ] Wrap API paths with version prefix.
- [ ] Update README.md.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the proxy's API route definitions and the `/metrics` handler, then read README.md for the documented API and versioning conventions. Add a version prefix to API paths while preserving the intended proxy compatibility, and update README.md to explain the prefix and when a major version is required.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api, backend-api-design
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.