docs: add optional version to message object #1069
Conversation
IsmaelMartinez
requested review from
fmvilas,
derberg,
dalelane,
smoya,
char0n,
asyncapi-bot-eve and
GreenRover
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
|
FYI, I tried adding the RFC 0 label, but it is not clear where to do this. I assume this is for maintainers |
|
| @@ -1244,6 +1244,7 @@ Field Name | Type | Description | |||
| <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). | |||
| <a name="messageObjectCorrelationId"></a>correlationId | [Correlation ID Object](#correlationIdObject) | [Reference Object](#referenceObject) | Definition of the correlation ID used for message tracing or matching. | |||
| <a name="messageObjectContentType"></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. | |||
| <a name="messageObjectVersion"></a>version | `string` | A version for the message. | |||
There was a problem hiding this comment.
Would be great to add an example below. Not another one, just add version to an existing example.
|
Hey, left a comment in #1068 (comment) as there are more comments already, so better to continue there for now I guess |
title: "Add optional version to the message object"
Part of the #1068 RFC 0
Related issue(s): #1068