alchemyplatform / alchemyplatform/docs
docs: correctly specifying which fields will be present in Webhook API responses
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
I was looking at the Get all webhooks API: https://www.alchemy.com/docs/data/webhooks/webhooks-api-endpoints/notify-api-endpoints/team-webhooks and noticed that all fields can be nullable.
Is this intented? Can we add required in OpenAPI spec, since in version v3.1.0 not adding required means it can be optional?
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 linked “Get all webhooks” API documentation and locate the corresponding OpenAPI response schema. Check which response fields are intended to be present rather than nullable, then update the documentation or schema so the required fields are represented accurately and verify the rendered API reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100