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

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

use crate::{ReferenceOr, Schema};

/// Describes a parameter included in a channel name.
///
/// # Examples
///
/// ```json
/// {
///     "user/{userId}/signup": {
///         "parameters": {
///         "userId": {
///             "description": "Id of the user.",
///             "schema": {
///             "type": "string"
///             },
///             "location": "$message.payload#/user/id"
///         }
///         },
///         "subscribe": {
///         "$ref": "#/components/messages/userSignedUp"
///         }
///     }
/// }
/// ```
///
/// ```yaml
/// user/{userId}/signup:
///   parameters:
///     userId:
///       description: Id of the user.
///       schema:
///         type: string
///       location: $message.payload#/user/id
///   subscribe:
///     $ref: "#/components/messages/userSignedUp"
/// ```
#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Parameter {
    /// A verbose explanation of the parameter.
    /// [CommonMark syntax](https://spec.commonmark.org/)
    /// can be used for rich text representation.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Definition of the parameter.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub schema: Option<ReferenceOr<Schema>>,
    /// A [runtime expression](https://www.asyncapi.com/docs/specifications/v2.3.0#runtimeExpression)
    /// that specifies the location of the parameter value.
    /// Even when a definition for the target field exists,
    /// it MUST NOT be used to validate this parameter but,
    /// instead, the `schema` property MUST be used.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub location: Option<String>,
    /// 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>,
}