refactor: simplify webhook deployment api(breaking) #7545
Merged
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.
Summary
Currently, the Webhook Deployment API supports 2 ways of creating a deployment.
This might seem useful for different cases, but it also introduces ambiguity: For those who want to post multiple repos, they often get confused about the
repo_id
,repo_url
andcommit_sha
in the root node, including our core maintainer.So, we concluded it would be simpler for both users and maintainers if we supported only one format.
This PR would introduce the following breaking-changes:
snake_case
tocamelCase
to align with other API designs.The final API request would be: