Channel vs Context Field When Creating WebSocket API
Open
Beginner friendly
Nobody has claimed this yet.
API-M 4.2.0
API-M-4.0.0
API-M-4.1.0
API-M-4.3.0
API-M-4.4.0
API-M-Master
Type/Docs
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Description:
In [1], under Step 3, there is a description regarding a field called Context in the table, but in the UI, the field is Channel. Hence, better to make Context as Channel with a proper description.
The change should be made to 4.x.x doc versions
Contributor guide
No contributing guide indexed for this repository
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
Open the linked WebSocket streaming API documentation and inspect Step 3, especially the field table. Update the field name from Context to Channel and provide the proper description in the 4.x.x documentation versions. Done means the affected 4.x.x pages consistently match the UI.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100