Response for POST APIs for creating new content in st2 should include more than just JSON representation of content
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6.5k
- Forks
- 787
- PR merge metrics
- No merged PRs in 30d
Description
Right now, POST /v1/API/aliases or anything similar blindly returns the JSON representation of content being created. This is not good enough for cases when we want to actually spit out warnings or include meta information along with the data.
We have to design our APIs to be flexible to include this case. An example use case is here - https://github.com/StackStorm/st2/issues/4372.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the POST /v1/API/aliases response behavior and the related use case in issue #4372. Determine the response contract needed for created content, warnings, and metadata, then document what API behavior and compatibility expectations would mark the design complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100