From e0c0317aa59dc752821fb6224b4ce91230616153 Mon Sep 17 00:00:00 2001 From: Fabrizio Lazzaretti Date: Mon, 12 Feb 2024 09:23:21 +0100 Subject: [PATCH 1/4] docs: explain Multi Format Schema Object option in Schema Object (#1018) --- spec/asyncapi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/asyncapi.md b/spec/asyncapi.md index 6f8fb5c3..bd7bada5 100644 --- a/spec/asyncapi.md +++ b/spec/asyncapi.md @@ -1874,7 +1874,7 @@ The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is a superset of the [JSON Schema Specification Draft 07](https://json-schema.org/). The empty schema (which allows any instance to validate) MAY be represented by the `boolean` value `true` and a schema which allows no instance to validate MAY be represented by the `boolean` value `false`. Further information about the properties can be found in [JSON Schema Core](https://tools.ietf.org/html/draft-handrews-json-schema-01) and [JSON Schema Validation](https://tools.ietf.org/html/draft-handrews-json-schema-validation-01). -Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here. +Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here. For other formats (e.g., Avro, RAML, etc) see [Multi Format Schema Object](#multiFormatSchemaObject). ##### Properties From af846ae7a5d3b6f7559bace44a24734f3c985ca7 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Mon, 12 Feb 2024 09:26:39 +0100 Subject: [PATCH 2/4] add Lazzaretti as a contributor for doc (#1029) --- .all-contributorsrc | 9 +++++++++ README.md | 1 + 2 files changed, 10 insertions(+) diff --git a/.all-contributorsrc b/.all-contributorsrc index 77990c0e..48635c73 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -474,6 +474,15 @@ "doc", "maintenance" ] + }, + { + "login": "Lazzaretti", + "name": "Fabrizio Lazzaretti", + "avatar_url": "https://avatars.githubusercontent.com/u/7142819?v=4", + "profile": "https://lazzaretti.me/", + "contributions": [ + "doc" + ] } ], "commitConvention": "none", diff --git a/README.md b/README.md index 6a3a258c..0b66d560 100644 --- a/README.md +++ b/README.md @@ -205,6 +205,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d nickshoe
nickshoe
🐛 📖 Ace
Ace
📋 🤔 🚧 📢 Animesh Kumar
Animesh Kumar
🖋 📖 🚧 + Fabrizio Lazzaretti
Fabrizio Lazzaretti
📖 From 5877caa8859904d730741b334f4df74535380d9e Mon Sep 17 00:00:00 2001 From: Fabrizio Lazzaretti Date: Fri, 16 Feb 2024 14:40:47 +0100 Subject: [PATCH 3/4] docs: add missing reference to Version 3.0.0 in README (#1033) --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b66d560..30160a14 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,8 @@ The latest draft specification can be found at [spec/asyncapi.md](./spec/asyncapi.md) which tracks the latest commit to the master branch in this repository. The human-readable markdown file is the source of truth for the specification. -- [Version 2.6.0](https://github.com/asyncapi/spec/blob/v2.6.0/spec/asyncapi.md) (latest) +- [Version 3.0.0](https://github.com/asyncapi/spec/blob/v3.0.0/spec/asyncapi.md) (latest) +- [Version 2.6.0](https://github.com/asyncapi/spec/blob/v2.6.0/spec/asyncapi.md) - [Version 2.5.0](https://github.com/asyncapi/spec/blob/v2.5.0/spec/asyncapi.md) - [Version 2.4.0](https://github.com/asyncapi/spec/blob/v2.4.0/spec/asyncapi.md) - [Version 2.3.0](https://github.com/asyncapi/spec/blob/v2.3.0/spec/asyncapi.md) From 0d34a48f4818617d591fe0dfe671c015d55bc954 Mon Sep 17 00:00:00 2001 From: Pavel Bodiachevskii Date: Fri, 16 Feb 2024 19:57:13 +0400 Subject: [PATCH 4/4] docs: fix adeo-kafka-request-reply-asyncapi.yml (#1034) Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com> --- .../adeo-kafka-request-reply-asyncapi.yml | 30 ++++++++++++------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/examples/adeo-kafka-request-reply-asyncapi.yml b/examples/adeo-kafka-request-reply-asyncapi.yml index 2a2c2e3e..623d2f56 100644 --- a/examples/adeo-kafka-request-reply-asyncapi.yml +++ b/examples/adeo-kafka-request-reply-asyncapi.yml @@ -206,36 +206,42 @@ components: RequesterId: type: string description: The Costing requester service account used to produce costing request. - example: svc-ecollect-app + examples: + - svc-ecollect-app RequesterCode: type: string description: >- The Costing requester code (generally the BU Code). The requester code is useful to get the dedicated context (tenant). - example: 1 + examples: + - 1 MessageId: type: string format: uuid description: A unique Message ID. - example: 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef + examples: + - 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef RequestId: type: string format: uuid description: >- A unique Request ID needed to define a `CORRELATION_ID` for exchanges, which will be sent back in the Costing Responses. - example: 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef + examples: + - 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef CorrelationId: type: string format: uuid description: >- A unique Correlation ID defined from the `REQUEST_ID` or the `MESSAGE_ID` provided in the Costing Request. - example: 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef + examples: + - 1fa6ef40-8f47-40a8-8cf6-f8607d0066ef BuCode: type: string description: The Business Unit code for which data are applicable. - example: 1 + examples: + - 1 ReplyTopic: type: string description: > @@ -243,22 +249,26 @@ components: the [Return Address EIP pattern](https://www.enterpriseintegrationpatterns.com/patterns/messaging/ReturnAddress.html). **You must grant WRITE access to our `svc-ccr-app` service account.** - example: adeo-case-study-COSTING-RESPONSE-V1 + examples: + - adeo-case-study-COSTING-RESPONSE-V1 ErrorStep: type: string description: | The woker that has thrown the error. - example: EXPOSE_RESULT + examples: + - EXPOSE_RESULT ErrorMessage: type: string description: | The error message describing the error. - example: Error message + examples: + - Error message ErrorCode: type: string description: | The error code. - example: CURRENCY_NOT_FOUND + examples: + - CURRENCY_NOT_FOUND parameters: Env: description: Adeo Kafka Environement for messages publications.