V2 API Conventions. update our convetnions based on last few migrations - #4826
Open
epugh wants to merge 1 commit into
Open
V2 API Conventions. update our convetnions based on last few migrations#4826epugh wants to merge 1 commit into
epugh wants to merge 1 commit into
Conversation
github-actions
Bot
added
the
documentation
Contributor
Author
|
The typos in my message are so you know this isn't AI generated ;-). |
Contributor
Author
Contributor
Author
|
We may want to document that these V2 APIs are Experimental, so feel free to change HTTP paths, we don't have any requirement to support old V2, but do need to not touch V1 paths. Jsut experienced this in migrationg the Package API. |
Contributor
Author
|
Do we need to document plural versus singular? /cluster/package was the plural, and I think it should be /cluster/packages or /packages for example. |
Contributor
Author
|
if soemthing is not found, it's 404 not 400. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document our conventions for the V2 APIs.
I'm trying to move towards a more mechanistic process of verifying the V1 -> V2 or V2 legacy to V2 Jax RS migrations and capture the knowledge.