Skip to content

Commit 838cb25

Browse files
thompson-tomosmith
andauthored
Implementation of review feedback
Co-authored-by: Nathan L Smith <[email protected]>
1 parent bd2c3e6 commit 838cb25

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/proposals/bundles.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ bundle:
1818
- name: server
1919
brief: Defines a server
2020
note:
21-
attributes
21+
attributes:
2222
- ref: sever.address
2323
- ref: sever.port
2424
```
@@ -28,9 +28,9 @@ Once it is defined, it can then be used on other signals to extend the definitio
2828
```
2929
span:
3030
- name: messaging.produced
31-
brief: Defines a span for sending a message via a message brooker such as rabbitmq
31+
brief: Defines a span for sending a message via a message broker such as RabbitMQ
3232
note:
33-
attributes
33+
attributes:
3434
- ref: message.system.name
3535
bundles:
3636
- ref: server
@@ -41,25 +41,25 @@ In terms of the resolved schema, these bundles are blended seamlessly in to the
4141
```
4242
span:
4343
- name: messaging.produced
44-
brief: Defines a span for sending a message via a message brooker such as rabbitmq
44+
brief: Defines a span for sending a message via a message broker such as RabbitMQ
4545
note:
46-
attributes
46+
attributes:
4747
- id: message.system.name
4848
....
49-
- id: sever.address
49+
- id: server.address
5050
....
51-
- id: sever.port
51+
- id: server.port
5252
....
5353
```
5454

5555
By adopting this approach we are improving the mantainability of the definitions,
56-
by reusing the definition rather than copy and pasting strucutures.
56+
by reusing the definition rather than copying and pasting structures.
5757

5858
### Extending signals
5959

6060
This use case is similiar to the previous except it is focussed on offering optional contextual extensions.
6161
An example of this extension would be Cloud Events which are only applicable if the application is using Cloud Events,
62-
hence the usage is contextual based upon cloud events being used.
62+
hence the usage is contextual based upon Cloud Events being used.
6363

6464
To indicate that a bundle is contextual, this can be done by defining this on the bundle, just like below for `cloud_events`:
6565

@@ -69,7 +69,7 @@ bundle:
6969
brief: For more information on the concepts, terminology and background of CloudEvents consult the CloudEvents Primer document.
7070
context: Can be used when a cloud event payload is being handled (sent/recieved).
7171
note:
72-
attributes
72+
attributes:
7373
- ref: cloudevents.event_id
7474
- ref: cloudevents.event_source
7575
......

0 commit comments

Comments
 (0)