Skip to content

Commit 85c3c91

Browse files
committed
fix: clean up
1 parent e8c7e94 commit 85c3c91

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

docs/asyncapi.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[AsyncAPI standard spec](https://www.asyncapi.com/docs/reference/specification/v2.6.0#asyncapi-specification) describes all the possible elements that a valid asyncAPI document can have.
44

5-
For the purposes of the existing setup and needs at Next Plc (Warehouse systems) we don't necessarily need all of them to be included in our bindings (either as annotation keys or model bindings to structs).
5+
Currently not all bindings are supported.
66

77
## Required
88

@@ -34,14 +34,14 @@ See [notes](./notes.md) for the relationship diagram and precedence hierarchy
3434
- `type`: Example
3535

3636
```cs
37-
//+gendoc id=PackingAreaEvent category=message type=example
37+
//+gendoc id=SomeEvent category=message type=example
3838
namespace domain.Packing.Services.PackArea.Contracts.Events;
3939

40-
public class PackingAreaEvent : domainMessage<PackingAreaEventPayload>
40+
public class SomeEvent : domainMessage<SomeEventPayload>
4141
{
42-
public PackingAreaEvent(PackingAreaEventPayload payload)
42+
public SomeEvent(SomeEventPayload payload)
4343
{
44-
MessageTypeName = nameof(PackingAreaEvent);
44+
MessageTypeName = nameof(SomeEvent);
4545
SourceSystem = PackAreaServiceConstants.Name;
4646
Guid = Guid.NewGuid();
4747
CreationDate = DateTime.UtcNow;
@@ -68,7 +68,7 @@ public class Bar
6868
}
6969

7070
/* below is an example of schema in code
71-
//+gendoc id=PackingAreaEvent category=message type=json_schema
71+
//+gendoc id=SomeEvent category=message type=json_schema
7272
{
7373
"$schema": "http://json-schema.org/draft-07/schema",
7474
"$id": "http://example.com/example.json",
@@ -100,11 +100,11 @@ public class Bar
100100

101101
```
102102

103-
> However, the recommended way is to keep your schema in a file named => `MESSAGE_NAME.schema.json` [see example](../src/test/domain.sample/src/schemas/PackingAreaEvent.schema.json)
103+
> However, the recommended way is to keep your schema in a file named => `MESSAGE_NAME.schema.json` [see example](../src/test/domain.sample/src/schemas/SomeEvent.schema.json)
104104
105105

106106
## Nice To Have
107107

108-
- `servers` keyword describes the technology providing the transport layer - e.g. Kafka/RabbitMQ or specifically in case of Next the `ServiceBus Namespace`
108+
- `servers` keyword describes the technology providing the transport layer - e.g. Kafka/RabbitMQ/AWS SQS/Azure ServiceBus
109109
- it may contain a map of multiple implementations - e.g. dev/preprod/prod
110110
- > in conjunction with a channel key a full URL can be constructed to use by the client(s) to either publish or subscribe to messages on that ServiceBus's Topic/Queue/Topic-Subscription

src/go/async-api-gen-doc/test/foo.sample/infra/sbus.tf

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ locals {
2121
This channel is used to convey subscriptions
2222
//-gendoc
2323
*/
24-
topic : azurerm_servicebus_topic.ItemSortation-waypointComplete-topic,
24+
topic : azurerm_servicebus_topic.SomeFoo-state-topic,
2525
//+gendoc category=channel id=foo-stuff-subscription type=nameId service_id=[foo.bar.app]
2626
//-gendoc
2727
name : "foo-stuff-subscription"
2828
},
2929
{
30-
topic : azurerm_servicebus_topic.ItemSortation-operationWaypointStarted-topic,
30+
topic : azurerm_servicebus_topic.SomeFoo-stateStarted-topic-topic,
3131
name : "foo-stuff-subscription"
3232
},
3333

0 commit comments

Comments
 (0)