alchemyplatform / alchemyplatform/docs
GET all webhooks API has incorrect schema definition
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 8
- Forks
- 19
- Avg merge
- 23h 32m
- Merged PRs (30d)
- 49
Description
Request for updates in the documentation
- [ ] New Documentation
- [x] Updates to Existing Documentation
GET all webhooks API has incorrect schema definition
The documentation mentions it returns an Array: https://www.alchemy.com/docs/data/webhooks/webhooks-api-endpoints/notify-api-endpoints/team-webhooks
[
{
"data": [
{
"id": "foo",
"network": "ETH_MAINNET",
"webhook_type": "GRAPHQL",
"webhook_url": "foo",
"is_active": true,
"time_created": 42,
"addresses": [
"foo"
],
"version": "foo",
"signing_key": "foo"
}
]
}
]
However, calling it via Postman returns an object:
{
data: Array<...>
}
I think the documentation for this particular API is wrong.
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 at the linked team webhooks documentation page and compare its GET-all response example with the Postman response shown in the issue. Update the schema example so the top level is an object containing a data array; done when the page no longer depicts the response as an array.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- postman
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100