wso2 / wso2/docs-apim

Update the `Create a WebSocket API` Documentation

Open
#10,253 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type/Bug
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description

The image should be updated in step 03 of the documentation[1] as the details about Display Name has not mentioned here. In the table also context should be renamed as channel and the Display Name should be added to the table.

[1]https://apim.docs.wso2.com/en/4.6.0/manage-apis/design/create-api/create-streaming-api/create-a-websocket-streaming-api/#step-1-design-a-websocket-api

Version(s)

4.x

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked “Create a WebSocket API” documentation page and inspect step 03, including its image and table. Update the image to show Display Name, rename the table’s context entry to channel, and add Display Name to the table; done means the published section reflects all three corrections.

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
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.