Skip to content

Commit

Permalink
fix: fix more consistency issues for yaml examples
Browse files Browse the repository at this point in the history
  • Loading branch information
AnimeshKumar923 committed Jul 5, 2024
1 parent b24f71d commit b60d353
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions spec/asyncapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ operations:
onUserSignedUp:
action: receive
channel:
$ref: "#/channels/userSignedUp"
$ref: '#/channels/userSignedUp'
```
It means that the [application](#definitionsApplication) will receive messages from the `userSignedUp` [channel](#definitionsChannel).
Expand All @@ -42,7 +42,7 @@ operations:
description: Event received when a user signed up on the product.
action: receive
channel:
$ref: "#/channels/userSignedUp"
$ref: '#/channels/userSignedUp'
```

We can't automatically assume that an _opposite_ application exists by simply replacing `receive` with `send`:
Expand All @@ -54,7 +54,7 @@ operations:
description: Event received when a user signed up on the product. # <-- This doesn't make sense now. Should speak about sending an event, not receiving it.
action: send
channel:
$ref: "#/channels/userSignedUp"
$ref: '#/channels/userSignedUp'
```

Aside from the issues mentioned above, there may also be infrastructure configuration that is not represented here. For instance, a system may use a read-only channel for receiving messages, a different one for sending them, and an intermediary process that will forward messages from one channel to the other.
Expand Down Expand Up @@ -444,24 +444,24 @@ development:
protocol: amqp
protocolVersion: 0-9-1
tags:
- name: "env:development"
description: "This environment is meant for developers to run their own tests."
- name: 'env:development'
description: 'This environment is meant for developers to run their own tests.'
staging:
host: rabbitmq-staging.in.mycompany.com:5672
description: RabbitMQ broker for the staging environment.
protocol: amqp
protocolVersion: 0-9-1
tags:
- name: "env:staging"
description: "This environment is a replica of the production environment."
- name: 'env:staging'
description: 'This environment is a replica of the production environment.'
production:
host: rabbitmq.in.mycompany.com:5672
description: RabbitMQ broker for the production environment.
protocol: amqp
protocolVersion: 0-9-1
tags:
- name: "env:production"
description: "This environment is the live environment available for final users."
- name: 'env:production'
description: 'This environment is the live environment available for final users.'
```

#### <a name="serverObject"></a>Server Object
Expand Down Expand Up @@ -1347,14 +1347,14 @@ payload:
type: object
properties:
user:
$ref: "#/components/schemas/userCreate"
$ref: '#/components/schemas/userCreate'
signup:
$ref: "#/components/schemas/signup"
$ref: '#/components/schemas/signup'
correlationId:
description: Default Correlation ID
location: $message.header#/correlationId
traits:
- $ref: "#/components/messageTraits/commonHeaders"
- $ref: '#/components/messageTraits/commonHeaders'
examples:
- name: SimpleSignup
summary: A simple UserSignup example message
Expand Down Expand Up @@ -1794,7 +1794,7 @@ components:
$ref: './user-create.avsc'
servers:
development:
host: "{stage}.in.mycompany.com:{port}"
host: '{stage}.in.mycompany.com:{port}'
description: RabbitMQ broker
protocol: amqp
protocolVersion: 0-9-1
Expand Down

0 comments on commit b60d353

Please sign in to comment.