fix: run actions don't accept json-api resource request bodies #388
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.
Description
According to the docs and in practice, the run actions group of endpoints commonly accept a request body with a single "comment" attribute. This isn't a json-api resource document, and it shouldn't be encoded into a "data" → "attributes" nesting.
As far as I know, these are the only request bodies that aren't compliant, and it's not worthwhile to convert these endpoints from actions to resources.
Testing plan
I added an integration test for this in particular, but I also I wrote a simple program to POST a run apply to a service like requestb.in so you can see the request body:
External links