patternfly / patternfly/patternfly-doc-core
Reevaluate API return formats
Open
Nobody has claimed this yet.
PF Team
spike
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 11
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 1
Description
NEEDS REFINEMENT
Feedback received so far has suggested that our current common API return format of arrays of strings may not be ideal because of the number of requests needed for each task.
We should look at where we can return more info per request without significantly impacting context bloat.
Jira Issue: PF-3605
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 with the issue description and its linked Jira issue PF-3605; no source file, test, or entry point is identified. Clarify which API responses should include more information, define the accepted return format, and document what implementation and validation would count as done.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100