Skip to content

Commit

Permalink
fix: blog/websocket-part2 having rendering issues (#3163)
Browse files Browse the repository at this point in the history
Co-authored-by: V Thulisile Sibanda <[email protected]>%0ACo-authored-by: Akshat Nema <[email protected]>%0ACo-authored-by: asyncapi-bot <[email protected]>
  • Loading branch information
Saumya40-codes and asyncapi-bot authored Aug 30, 2024
1 parent b28b29b commit 0ff94e7
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions markdown/blog/websocket-part2.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Create two AsyncAPI documents. Treat those two servers as separate services that

You can use AsyncAPI also to describe the security of your API. You can describe in a machine-readable way the security mechanism that protects the server. Several [security schemes](https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#securitySchemeObject) are supported. In Kraken's case, I could not figure out what kind of security scheme they use from their docs. They seem to have a non-standard set up for getting the authorization token, which is why the only option was to put a human-readable-only description there.

```yaml
~~~yaml
servers:
public:
url: ws.kraken.com
Expand All @@ -166,16 +166,16 @@ servers:
The resulting token must be provided in the "token" field of any new private WebSocket feed subscription:
```
\{
{
"event": "subscribe",
"subscription":
\{
{
"name": "ownTrades",
"token": "WW91ciBhdXRoZW50aWNhdGlvbiB0b2tlbiBnb2VzIGhlcmUu"
}
}
```
```
~~~

### Endpoints aka Channels

Expand Down Expand Up @@ -436,7 +436,7 @@ For **automation** road described in section [Choosing the right road to Rome](#

> You can open this document directly in AsyncAPI Studio by clicking [this](https://studio.asyncapi.com?url=https://gist.githubusercontent.com/derberg/4e419d6ff5870c7c3f5f443e8bd30535/raw/5e9b733b80a0209ba5520e5f41ab18c2a112e0a9/asyncapi-websocket-kraken.yml) link. Compare it also with the [original documentation](https://docs.kraken.com/websockets/).

```yml
~~~yaml
asyncapi: 2.0.0

info:
Expand Down Expand Up @@ -474,10 +474,10 @@ servers:
The resulting token must be provided in the "token" field of any new private WebSocket feed subscription:
```
\{
{
"event": "subscribe",
"subscription":
\{
{
"name": "ownTrades",
"token": "WW91ciBhdXRoZW50aWNhdGlvbiB0b2tlbiBnb2VzIGhlcmUu"
}
Expand Down Expand Up @@ -809,6 +809,6 @@ components:
type: string
description: Format of each pair is "A/B", where A and B are ISO 4217-A3 for standardized assets and popular unique symbol if not standardized.
pattern: '[A-Z\s]+\/[A-Z\s]+'
```
~~~

Stay tuned for more articles around WebSocket and AsyncAPI. Share your feedback and connect with the AsyncAPI community in our [Slack workspace](https://www.asyncapi.com/slack-invite/).

0 comments on commit 0ff94e7

Please sign in to comment.