asyncapi 0.2.0

This crate aims to provide data structures that represent the AsyncAPI specification easily deserializable with serde.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234

use indexmap::IndexMap;
use serde::{Deserialize, Serialize};

use crate::{
    CorrelationId, Example, ExternalDocumentation, MessageBinding, ReferenceOr, Schema, Tag,
};

/// Describes a message received on a given channel and operation.
///
/// # Schema formats table
/// The following table contains a set of values that every implementation MUST support.
///
/// NAME | ALLOWED VALUES | NOTES
/// -----|----------------|--------
/// [AsyncAPI 2.3.0 Schema Object](https://www.asyncapi.com/docs/specifications/v2.3.0#schemaObject) | `application/vnd.aai.asyncapi;version=2.3.0`, `application/vnd.aai.asyncapi+json;version=2.3.0`, `application/vnd.aai.asyncapi+yaml;version=2.3.0` | This is the default when a `schemaFormat` is not provided.
/// [JSON Schema Draft 07](https://json-schema.org/specification-links.html#draft-7) | `application/schema+json;version=draft-07`, `application/schema+yaml;version=draft-07` |
///
/// The following table contains a set of values that every implementation is RECOMMENDED to support.
///
/// NAME | ALLOWED VALUES | NOTES
/// -----|----------------|--------
/// [Avro 1.9.0 schema](https://avro.apache.org/docs/1.9.0/spec.html#schemas) | `application/vnd.apache.avro;version=1.9.0`, `application/vnd.apache.avro+json;version=1.9.0`, `application/vnd.apache.avro+yaml;version=1.9.0` |
/// [OpenAPI 3.0.0 Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject) | `application/vnd.oai.openapi;version=3.0.0`, `application/vnd.oai.openapi+json;version=3.0.0`, `application/vnd.oai.openapi+yaml;version=3.0.0` |
/// [RAML 1.0 data type](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/) | `application/raml+yaml;version=1.0` |
///
/// # Examples
///
/// ```json
/// {
///     "name": "UserSignup",
///     "title": "User signup",
///     "summary": "Action to sign a user up.",
///     "description": "A longer description",
///     "contentType": "application/json",
///     "tags": [
///         { "name": "user" },
///         { "name": "signup" },
///         { "name": "register" }
///     ],
///     "headers": {
///         "type": "object",
///         "properties": {
///         "correlationId": {
///             "description": "Correlation ID set by application",
///             "type": "string"
///         },
///         "applicationInstanceId": {
///             "description": "Unique identifier for a given instance of the publishing application",
///             "type": "string"
///         }
///         }
///     },
///     "payload": {
///         "type": "object",
///         "properties": {
///         "user": {
///             "$ref": "#/components/schemas/userCreate"
///         },
///         "signup": {
///             "$ref": "#/components/schemas/signup"
///         }
///         }
///     },
///     "correlationId": {
///         "description": "Default Correlation ID",
///         "location": "$message.header#/correlationId"
///     },
///     "traits": [
///         { "$ref": "#/components/messageTraits/commonHeaders" }
///     ],
///     "examples": [
///         {
///         "name": "SimpleSignup",
///         "summary": "A simple UserSignup example message",
///         "headers": {
///             "correlationId": "my-correlation-id",
///             "applicationInstanceId": "myInstanceId"
///         },
///         "payload": {
///             "user": {
///             "someUserKey": "someUserValue"
///             },
///             "signup": {
///             "someSignupKey": "someSignupValue"
///             }
///         }
///         }
///     ]
/// }
/// ```
///
/// ```yaml
/// name: UserSignup
/// title: User signup
/// summary: Action to sign a user up.
/// description: A longer description
/// contentType: application/json
/// tags:
///   - name: user
///   - name: signup
///   - name: register
/// headers:
///   type: object
///   properties:
///     correlationId:
///       description: Correlation ID set by application
///       type: string
///     applicationInstanceId:
///       description: Unique identifier for a given instance of the publishing application
///       type: string
/// payload:
///   type: object
///   properties:
///     user:
///       $ref: "#/components/schemas/userCreate"
///     signup:
///       $ref: "#/components/schemas/signup"
/// correlationId:
///   description: Default Correlation ID
///   location: $message.header#/correlationId
/// traits:
///   - $ref: "#/components/messageTraits/commonHeaders"
/// examples:
///   - name: SimpleSignup
///     summary: A simple UserSignup example message
///     headers:
///       correlationId: my-correlation-id
///       applicationInstanceId: myInstanceId
///     payload:
///       user:
///         someUserKey: someUserValue
///       signup:
///         someSignupKey: someSignupValue
/// ```
///
/// Example using Avro to define the payload:
///
/// ```json
/// {
///     "name": "UserSignup",
///     "title": "User signup",
///     "summary": "Action to sign a user up.",
///     "description": "A longer description",
///     "tags": [
///         { "name": "user" },
///         { "name": "signup" },
///         { "name": "register" }
///     ],
///     "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0",
///     "payload": {
///         "$ref": "path/to/user-create.avsc#/UserCreate"
///     }
/// }
/// ```
///
/// ```yaml
/// name: UserSignup
/// title: User signup
/// summary: Action to sign a user up.
/// description: A longer description
/// tags:
///   - name: user
///   - name: signup
///   - name: register
/// schemaFormat: 'application/vnd.apache.avro+yaml;version=1.9.0'
/// payload:
///   $ref: 'path/to/user-create.avsc/#UserCreate'
/// ```
#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Message {
    /// Schema definition of the application headers.
    /// Schema MUST be of type "object". It **MUST NOT** define the protocol headers.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub headers: Option<ReferenceOr<Schema>>,
    /// Definition of the message payload. It can be of any type
    /// but defaults to [Schema object][crate::Schema]. It must match the schema format,
    /// including encoding type - e.g Avro should be inlined as either
    /// a YAML or JSON object NOT a string to be parsed as YAML or JSON.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub payload: Option<Payload>,
    /// Definition of the correlation ID used for message tracing or matching.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub correlation_id: Option<ReferenceOr<CorrelationId>>,
    /// A string containing the name of the schema
    /// format/language used to define the message payload.
    /// If omitted, implementations should parse the payload as a
    /// [Schema object][crate::Schema].
    #[serde(skip_serializing_if = "Option::is_none")]
    pub schema_format: Option<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 field.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub content_type: Option<String>,
    /// A machine-friendly name for the message.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// A human-friendly title for the message.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// A short summary of what the message is about.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub summary: Option<String>,
    /// A verbose explanation of the message.
    /// [CommonMark syntax](https://spec.commonmark.org/)
    /// can be used for rich text representation.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// A list of tags for API documentation control.
    /// Tags can be used for logical grouping of messages.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub tags: Vec<Tag>,
    /// Additional external documentation for this message.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub external_docs: Option<ExternalDocumentation>,
    /// A map where the keys describe the name of
    /// the protocol and the values describe protocol-specific definitions for the message.
    pub bindings: Option<ReferenceOr<MessageBinding>>,
    /// An array with examples of valid message objects.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub examples: Vec<Example>, // TODO try to parse better
    /// This object can be extended with
    /// [Specification Extensions](https://www.asyncapi.com/docs/specifications/v2.3.0#specificationExtensions).
    #[serde(flatten)]
    pub extensions: IndexMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(untagged)]
pub enum Payload {
    Schema(Schema),
    Any(serde_json::Value),
}