Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change /api/v1 to /api/v0 to show "unstable" status #494

Closed
jsimnz opened this issue Jun 2, 2022 · 0 comments · Fixed by #498
Closed

Change /api/v1 to /api/v0 to show "unstable" status #494

jsimnz opened this issue Jun 2, 2022 · 0 comments · Fixed by #498
Assignees
@fredcarle
Labels
area/api Related to the external API component feature New feature or request
Milestone
DefraDB v0.3

Comments

@jsimnz
Copy link
Member

jsimnz commented Jun 2, 2022

Currently the HTTP API is under the /api/v1 prefix, but I think we should move it to /api/v1 since there are still several elements that are in flux that might be changed or removed, etc.

So, we should signal the "unstable" status of the api by using v0 instead of v1 which might imply some level of SemVer based backwards compatability.
@jsimnz jsimnz added feature New feature or request area/api Related to the external API component labels Jun 2, 2022
@jsimnz jsimnz added this to the DefraDB v0.3 milestone Jun 2, 2022
@fredcarle fredcarle mentioned this issue Jun 2, 2022
Merged
7 tasks
fredcarle added a commit that referenced this issue Jun 8, 2022
@fredcarle
refactor: Change handler functions implementation and response format…
b8beabb 
…ting (#498)

RELEVANT ISSUE(S)
Resolves #384
Resolves #458
Resolves #494

DESCRIPTION
After the HTTP API refactor, we now focus on the refactoring of the handler functions themselves ensuring common response formats for both successful and error responses across the API.

This PR also changes the API version number to v0 from v1 to show "unstable" status and responds with the appropriate content-type with JSON payloads.
shahzadlone pushed a commit to shahzadlone/defradb that referenced this issue Feb 23, 2024
@fredcarle
refactor: Change handler functions implementation and response format…
644847f 
…ting (sourcenetwork#498)

RELEVANT ISSUE(S)
Resolves sourcenetwork#384
Resolves sourcenetwork#458
Resolves sourcenetwork#494

DESCRIPTION
After the HTTP API refactor, we now focus on the refactoring of the handler functions themselves ensuring common response formats for both successful and error responses across the API.

This PR also changes the API version number to v0 from v1 to show "unstable" status and responds with the appropriate content-type with JSON payloads.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fredcarle fredcarle

Labels
area/api Related to the external API component feature New feature or request
Projects
None yet
Milestone
DefraDB v0.3
Development

Successfully merging a pull request may close this issue.

refactor: Change handler functions implementation and response formatting sourcenetwork/defradb
2 participants
@jsimnz @fredcarle