Debugging mode
Open
Nobody has claimed this yet.
area:core
enhancement
exploration
- Dominant language
- TypeScript
- Stars
- 697
- Forks
- 31
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 10
Description
Discussed in https://github.com/readmeio/api/discussions/545
Originally posted by erunion October 25, 2022
Because a lot of the work that api does behind the scenes can be a bit magical it'd be nice if there was some sort of debugging mode that you could enable that would log out the HAR that we use in the backend with fetch-har.
const sdk = require('@api/petstore');
// leaf handling
sdk.debug();
sdk.operation().then(...)
const sdk = require('@api/petstore');
sdk.debug().operation().then(...)
Perhaps the chained mode should only apply the debug mode to the operation it's attached to.
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 reading the linked discussion and reviewing fetch-har to understand the proposed HAR logging behavior. Compare the leaf and chained sdk.debug() examples, then define how each mode should behave and how completion can be verified for generated SDK operations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100