Update documentation on 'WebSocket API'
Open
Nobody has claimed this yet.
Type/Bug
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Description
Hi team,
The documentation seems outdated for the ‘WebSocket’ [1]. For example, below are updated in the UI.
- ‘Create a Web Socket API’ option
- ‘Depoly’ option is not shown
Could you please update the documentation with the new UI options?
[1] https://apim.docs.wso2.com/en/latest/tutorials/create-and-publish-websocket-api/
Thanks,
Prabod.
Steps to Reproduce
N/A
Version
APIM 4.4.0
Environment Details (with versions)
No response
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
Start with the linked WebSocket API tutorial and compare its documented steps with the APIM 4.4.0 UI. Update the tutorial to reflect the current “Create a Web Socket API” option and remove the outdated “Depoly” option; done means the documentation matches the current 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
- Mostly clear
- Newbie friendliness
- 45/100