Merge pull request #155 from kokovtsev/asyncapi-fix-message-examples

fix: AsyncAPI: update the `examples` codec according to the spec (closes #154)

Author: kokovtsev

package.json

@@ -52,7 +52,7 @@
     "eslint": "^6.7.2",
     "fast-check": "^1.17.0",
     "fp-ts": "^2.1.0",
-    "io-ts": "^2.0.1",
+    "io-ts": "^2.0.5",
     "io-ts-types": "^0.5.1",
     "jest": "^24.9.0",
     "nodemon": "^2.0.12",
@@ -62,7 +62,7 @@
   },
   "peerDependencies": {
     "fp-ts": "^2.1.0",
-    "io-ts": "^2.0.1",
+    "io-ts": "^2.0.5",
     "io-ts-types": "^0.5.1"
   },
   "jest": {

src/schema/asyncapi-2.0.0/message-object.ts

@@ -22,7 +22,7 @@ export interface MessageObject {
 	readonly description: Option<string>;
 	readonly tags: Option<TagsObject>;
 	readonly externalDocs: Option<ExternalDocumentationObject>;
-	readonly examples: Option<Record<string, unknown>>;
+	readonly examples: Option<Record<string, unknown>[]>;
 	readonly traits: Option<MessageTraitObject[]>;
 }
 
@@ -39,7 +39,7 @@ export const MessageObjectCodec: Codec<MessageObject> = type(
 		description: optionFromNullable(string),
 		tags: optionFromNullable(TagsObjectCodec),
 		externalDocs: optionFromNullable(ExternalDocumentationObjectCodec),
-		examples: optionFromNullable(record(string, unknown)),
+		examples: optionFromNullable(array(record(string, unknown))),
 		traits: optionFromNullable(array(MessageTraitObjectCodec)),
 	},
 	'MessageObject',

test/specs/asyncapi-2.0.0/channel-params.yml

@@ -20,6 +20,12 @@ channels:
             time:
               type: string
               format: date-time
+        examples:
+          - payload: |
+              ```
+              {"time": "2021-10-01T12:25:36Z", "text": "First message"}
+              ```
+          - {"time": "2021-10-01T12:25:43Z", "text": "Second message"}
     publish:
       message:
         description: Outgoing message

test/specs/asyncapi-2.0.0/streetlights-api.yml

@@ -68,6 +68,16 @@ components:
           $ref: '#/components/schemas/Lumens'
         sentAt:
           $ref: '#/components/schemas/SentAt'
+      examples:
+        - >
+          ```
+          {
+            "id": 123,
+            "lumens": 470,
+            "sentAt": "2021-10-04T08:42:25Z"
+          }
+          ```
+        - { "id": 123, "lumens": 470, "sentAt": "2021-10-04T08:42:25Z" }
     Id:
       type: integer
       minimum: 0

yarn.lock

@@ -2621,10 +2621,10 @@ io-ts-types@^0.5.1:
   resolved "https://registry.yarnpkg.com/io-ts-types/-/io-ts-types-0.5.1.tgz#55bedec94e3cce1413d60c014918091d0dffbbce"
   integrity sha512-wdlK7Gn9gBaI3BT44mpwU+Y54J3GTT5R3dkM7CYZoaPMKWDwp/jYZ1Bj8/RRfcwP2ElJjuGre06avjkHLvgl7w==
 
-io-ts@^2.0.1:
-  version "2.0.1"
-  resolved "https://registry.yarnpkg.com/io-ts/-/io-ts-2.0.1.tgz#1261c12f915c2f48d16393a36966636b48a45aa1"
-  integrity sha512-RezD+WcCfW4VkMkEcQWL/Nmy/nqsWTvTYg7oUmTGzglvSSV2P9h2z1PVeREPFf0GWNzruYleAt1XCMQZSg1xxQ==
+io-ts@^2.0.5:
+  version "2.0.5"
+  resolved "https://registry.yarnpkg.com/io-ts/-/io-ts-2.0.5.tgz#e6e3db9df8b047f9cbd6b69e7d2ad3e6437a0b13"
+  integrity sha512-pL7uUptryanI5Glv+GUv7xh+aLBjxGEDmLwmEYNSx0yOD3djK0Nw5Bt0N6BAkv9LadOUU7QKpRsLcqnTh3UlLA==
 
 is-accessor-descriptor@^0.1.6:
   version "0.1.6"