Skip to content

Comments

feat: api versioning#53

Merged
jason-lynch merged 1 commit intomainfrom
feat/PLAT-86/api-versioning
Jun 16, 2025
Merged

feat: api versioning#53
jason-lynch merged 1 commit intomainfrom
feat/PLAT-86/api-versioning

Conversation

@jason-lynch
Copy link
Member

@jason-lynch jason-lynch commented Jun 12, 2025

This commit adds versioning to our API endpoints, with the current version as v1. Under this scheme, each API version lives under separate packages and is served under separate top-level prefixes, e.g. /v1 for the current version.

This necessitated a small refactor to make it easier to modularize the initialization logic.

NOTE: you will need to update your restish configuration to add the /v1 prefix to each server. See the development doc diffs for more details. Remember to run restish api control-plane-local-<1,2,3> sync after updating the restish config.

PLAT-86

@jason-lynch jason-lynch force-pushed the feat/PLAT-86/validations-in-openapi-spec branch from 7296140 to 0d9bf7d Compare June 12, 2025 21:02
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-versioning branch from d317905 to 9982dcb Compare June 12, 2025 21:03
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/validations-in-openapi-spec branch from 0d9bf7d to 507bfb2 Compare June 12, 2025 21:35
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-versioning branch from 9982dcb to 53581e5 Compare June 12, 2025 21:37
@jason-lynch jason-lynch requested review from mmols and tsivaprasad June 12, 2025 21:42
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-versioning branch from 53581e5 to 5b41bfb Compare June 12, 2025 21:50
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/validations-in-openapi-spec branch from 507bfb2 to b10d80f Compare June 12, 2025 21:55
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-versioning branch from 5b41bfb to 048573b Compare June 12, 2025 21:55
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/validations-in-openapi-spec branch from b10d80f to 9ca4728 Compare June 13, 2025 11:36
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-versioning branch 2 times, most recently from a02a22d to af80869 Compare June 13, 2025 12:04
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/validations-in-openapi-spec branch from 9ca4728 to 20fffd1 Compare June 13, 2025 17:20
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-versioning branch from af80869 to b819f4c Compare June 13, 2025 17:20
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/validations-in-openapi-spec branch from 20fffd1 to 8fe113d Compare June 13, 2025 19:34
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-versioning branch 2 times, most recently from dcdcc7c to 5fe392b Compare June 15, 2025 19:40
@jason-lynch jason-lynch requested a review from tsivaprasad June 16, 2025 14:19
Copy link
Contributor

@tsivaprasad tsivaprasad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified a few commands like list-databases, create-database, etc., and they are all correctly pointing to the v1 API and working as expected.

Base automatically changed from feat/PLAT-86/validations-in-openapi-spec to main June 16, 2025 18:50
This commit adds versioning to our API endpoints, with the current
version as `v1`. Under this scheme, each API version lives under
separate packages and is served under separate top-level prefixes, e.g.
`/v1` for the current version.

This necessitated a small refactor to make it easier to modularize the
initialization logic.

PLAT-86
@jason-lynch jason-lynch force-pushed the feat/PLAT-86/api-versioning branch from 5fe392b to 7c5d64c Compare June 16, 2025 18:50
@jason-lynch jason-lynch merged commit 6af3a6c into main Jun 16, 2025
2 checks passed
@jason-lynch jason-lynch deleted the feat/PLAT-86/api-versioning branch June 16, 2025 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants