You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: spec/asyncapi.md
-6Lines changed: 0 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1227,7 +1227,6 @@ Describes a message received on a given channel and operation.
1227
1227
1228
1228
Field Name | Type | Description
1229
1229
---|:---:|---
1230
-
<a name="messageObjectMessageId"></a>messageId | `string` | Unique string used to identify the message. The id MUST be unique among all messages described in the API. The messageId value is **case-sensitive**. Tools and libraries MAY use the messageId to uniquely identify a message, therefore, it is RECOMMENDED to follow common programming naming conventions.
1231
1230
<a name="messageObjectHeaders"></a>headers | [Multi Format Schema Object](#multiFormatSchemaObject) | [Schema Object](#schemaObject) | [Reference Object](#referenceObject) | Schema definition of the application headers. Schema MUST be a map of key-value pairs. It **MUST NOT** define the protocol headers. If this is a [Schema Object](#schemaObject), then the `schemaFormat` will be assumed to be "application/vnd.aai.asyncapi+json;version=`asyncapi`" where the version is equal to the [AsyncAPI Version String](#A2SVersionString).
1232
1231
<a name="messageObjectPayload"></a>payload | [Multi Format Schema Object](#multiFormatSchemaObject) | [Schema Object](#schemaObject) | [Reference Object](#referenceObject) | Definition of the message payload. If this is a [Schema Object](#schemaObject), then the `schemaFormat` will be assumed to be "application/vnd.aai.asyncapi+json;version=`asyncapi`" where the version is equal to the [AsyncAPI Version String](#A2SVersionString).
1233
1232
<a name="messageObjectCorrelationId"></a>correlationId | [Correlation ID Object](#correlationIdObject) | [Reference Object](#referenceObject) | Definition of the correlation ID used for message tracing or matching.
@@ -1248,7 +1247,6 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
1248
1247
1249
1248
```json
1250
1249
{
1251
-
"messageId": "userSignup",
1252
1250
"name": "UserSignup",
1253
1251
"title": "User signup",
1254
1252
"summary": "Action to sign a user up.",
@@ -1312,7 +1310,6 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
1312
1310
```
1313
1311
1314
1312
```yaml
1315
-
messageId: userSignup
1316
1313
name: UserSignup
1317
1314
title: User signup
1318
1315
summary: Action to sign a user up.
@@ -1360,7 +1357,6 @@ Example using Avro to define the payload:
1360
1357
1361
1358
```json
1362
1359
{
1363
-
"messageId": "userSignup",
1364
1360
"name": "UserSignup",
1365
1361
"title": "User signup",
1366
1362
"summary": "Action to sign a user up.",
@@ -1380,7 +1376,6 @@ Example using Avro to define the payload:
1380
1376
```
1381
1377
1382
1378
```yaml
1383
-
messageId: userSignup
1384
1379
name: UserSignup
1385
1380
title: User signup
1386
1381
summary: Action to sign a user up.
@@ -1411,7 +1406,6 @@ If you're looking to apply traits to an operation, see the [Operation Trait Obje
1411
1406
1412
1407
Field Name | Type | Description
1413
1408
---|:---:|---
1414
-
<a name="messageTraitObjectMessageId"></a>messageId | `string` | Unique string used to identify the message. The id MUST be unique among all messages described in the API. The messageId value is **case-sensitive**. Tools and libraries MAY use the messageId to uniquely identify a message, therefore, it is RECOMMENDED to follow common programming naming conventions.
1415
1409
<a name="messageTraitObjectHeaders"></a>headers | [Multi Format Schema Object](#multiFormatSchemaObject) | [Schema Object](#schemaObject) | [Reference Object](#referenceObject) | Schema definition of the application headers. Schema MUST be a map of key-value pairs. It **MUST NOT** define the protocol headers. If this is a [Schema Object](#schemaObject), then the `schemaFormat` will be assumed to be "application/vnd.aai.asyncapi+json;version=`asyncapi`" where the version is equal to the [AsyncAPI Version String](#A2SVersionString).
1416
1410
<a name="messageTraitObjectCorrelationId"></a>correlationId | [Correlation ID Object](#correlationIdObject) | [Reference Object](#referenceObject) | Definition of the correlation ID used for message tracing or matching.
1417
1411
<a name="messageTraitObjectContentType"></a>contentType | `string` | The content type to use when encoding/decoding a message's payload. The value MUST be a specific media type (e.g. `application/json`). When omitted, the value MUST be the one specified on the [defaultContentType](#defaultContentTypeString) field.
0 commit comments