From 051562852707e14a76c38eb01d41506430d6d3f3 Mon Sep 17 00:00:00 2001
From: Animesh Kumar <kumaranimesh923@gmail.com>
Date: Sat, 8 Jun 2024 20:14:46 +0530
Subject: [PATCH] fix: add comment in asyncapi.md for validation

Changes:

- added comments in the file as suggested by Sergio here: https://github.com/asyncapi/spec/issues/957#issuecomment-2149497548
- more comments to be adjusted according to the json format
---
 spec/asyncapi.md | 96 ++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 93 insertions(+), 3 deletions(-)

diff --git a/spec/asyncapi.md b/spec/asyncapi.md
index 4611f3b9..b2f49899 100644
--- a/spec/asyncapi.md
+++ b/spec/asyncapi.md
@@ -273,6 +273,8 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 
 ##### Info Object Example
 
+
+<!-- asyncapi-example-tester:{"test":"Info Object","json_path":"$.info"} -->
 ```json
 {
   "title": "AsyncAPI Sample App",
@@ -333,8 +335,7 @@ Field Name | Type | Description
 
 This object MAY be extended with [Specification Extensions](#specificationExtensions).
 
-##### Contact Object Example
-
+<!-- asyncapi-example-tester:{"test":"Contact Object","json_path":"$.info.contact"} -->
 ```json
 {
   "name": "API Support",
@@ -343,6 +344,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Contact Object","json_path":"$.info.contact"} -->
 ```yaml
 name: API Support
 url: https://www.example.com/support
@@ -362,6 +364,7 @@ Field Name | Type | Description
 
 This object MAY be extended with [Specification Extensions](#specificationExtensions).
 
+<!-- asyncapi-example-tester:{"test":"License Object","json_path":"$.info.license"} -->
 ##### License Object Example
 
 ```json
@@ -371,6 +374,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"License Object","json_path":"$.info.license"} -->
 ```yaml
 name: Apache 2.0
 url: https://www.apache.org/licenses/LICENSE-2.0.html
@@ -388,6 +392,7 @@ Field Pattern | Type | Description
 
 ##### Servers Object Example
 
+<!-- asyncapi-example-tester:{"test":"Servers Object","json_path":"$.servers"} -->
 ```json
 {
   "development": {
@@ -429,6 +434,7 @@ Field Pattern | Type | Description
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Servers Object","json_path":"$.servers"} -->
 ```yaml
 development:
   host: localhost:5672
@@ -481,6 +487,7 @@ Field Name | Type | Description
 
 A single server would be described as:
 
+<!-- asyncapi-example-tester:{"test":"Server Object","json_path":"$.servers.production"} -->
 ```json
 {
   "host": "kafka.in.mycompany.com:9092",
@@ -490,6 +497,7 @@ A single server would be described as:
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Server Object","json_path":"$.servers.production"} -->
 ```yaml
 host: kafka.in.mycompany.com:9092
 description: Production Kafka broker.
@@ -499,6 +507,7 @@ protocolVersion: '3.2'
 
 An example of a server that has a `pathname`:
 
+<!-- asyncapi-example-tester:{"test":"Server Object with pathname","json_path":"$.servers.production"} -->
 ```json
 {
   "host": "rabbitmq.in.mycompany.com:5672",
@@ -508,6 +517,7 @@ An example of a server that has a `pathname`:
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Server Object with pathname","json_path":"$.servers.production"} -->
 ```yaml
 host: rabbitmq.in.mycompany.com:5672
 pathname: /production
@@ -532,6 +542,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 
 ##### Server Variable Object Example
 
+<!-- asyncapi-example-tester:{"test":"Server Object with Variable Object","json_path":"$.servers.production"} -->
 ```json
 {
   "host": "rabbitmq.in.mycompany.com:5672",
@@ -550,6 +561,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Server Object with Variable Object","json_path":"$.servers.production"} -->
 ```yaml
 host: 'rabbitmq.in.mycompany.com:5672'
 pathname: '/{env}'
@@ -571,12 +583,14 @@ In case a message can't be encoded/decoded using this value, schema parsers MUST
 
 ##### Default Content Type Example
 
+<!-- asyncapi-example-tester:{"test":"Default Content Type at root doc","json_path":"$"} -->
 ```json
 {
   "defaultContentType": "application/json"
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Default Content Type at root doc","json_path":"$"} -->
 ```yaml
 defaultContentType: application/json
 ```
@@ -593,6 +607,7 @@ Field Pattern | Type | Description
 
 ##### Channels Object Example
 
+<!-- asyncapi-example-tester:{"test":"Channels Object","json_path":"$.channels"} -->
 ```json
 {
   "userSignedUp": {
@@ -606,6 +621,7 @@ Field Pattern | Type | Description
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Channels Object","json_path":"$.channels"} -->
 ```yaml
 userSignedUp:
   address: 'user.signedup'
@@ -637,6 +653,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 
 ##### Channel Object Example
 
+<!-- asyncapi-example-tester:{"test":"Channel Object","json_path":"$.channels.user"} -->
 ```json
 {
   "address": "users.{userId}",
@@ -678,6 +695,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Channel Object","json_path":"$.channels.user"} -->
 ```yaml
 address: 'users.{userId}'
 title: Users channel
@@ -724,6 +742,7 @@ Field Pattern | Type | Description
 
 ##### Messages Object Example
 
+<!-- asyncapi-example-tester:{"test":"Messages Object","json_path":"$.channels.user.messages"} -->
 ```json
 {
   "userSignedUp": {
@@ -735,6 +754,7 @@ Field Pattern | Type | Description
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Messages Object","json_path":"$.channels.user.messages"} -->
 ```yaml
 userSignedUp:
   $ref: '#/components/messages/userSignedUp'
@@ -756,6 +776,7 @@ Field Pattern | Type | Description
 
 ##### Operations Object Example
 
+<!-- asyncapi-example-tester:{"test":"Operations Object","json_path":"$.operations"} -->
 ```json
 {
   "onUserSignUp": {
@@ -783,6 +804,8 @@ Field Pattern | Type | Description
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Operations Object","json_path":"$.operations"} -->
+
 ```yaml
 onUserSignUp:
   title: User sign up
@@ -825,6 +848,7 @@ Field Name | Type | Description
 
 This object MAY be extended with [Specification Extensions](#specificationExtensions).
 
+<!-- asyncapi-example-tester:{"test":"Operation Object","json_path":"$.operations.sendUserSignUp"} -->
 ##### Operation Object Example
 
 ```json
@@ -874,6 +898,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Operation Object","json_path":"$.operations.sendUserSignUp"} -->
 ```yaml
 title: User sign up
 summary: Action to sign a user up.
@@ -927,6 +952,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 
 ##### Operation Trait Object Example
 
+<!-- asyncapi-example-tester:{"test":"Operation Traits Object","json_path":"$.operations.sendUserSignUp.traits"} -->
 ```json
 {
   "bindings": {
@@ -937,6 +963,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Operation Traits Object","json_path":"$.operations.sendUserSignUp.traits"} -->
 ```yaml
 bindings:
   amqp:
@@ -974,6 +1001,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 
 ##### Examples
 
+<!-- asyncapi-example-tester:{"test":"Operation Reply Address Object","json_path":"$.operations.sendUserSignUp.reply.address"} -->
 ```json
 {
   "description": "Consumer inbox",
@@ -981,6 +1009,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Operation Reply Address Object","json_path":"$.operations.sendUserSignUp.reply.address"} -->
 ```yaml
 description: Consumer Inbox
 location: $message.header#/replyTo
@@ -1000,6 +1029,7 @@ Field Pattern | Type | Description
 
 ##### Parameters Object Example
 
+<!-- asyncapi-example-tester:{"test":"Channel Parameters Object","json_path":"$.channels.user"} -->
 ```json
 {
   "address": "user/{userId}/signedup",
@@ -1011,6 +1041,7 @@ Field Pattern | Type | Description
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Channel Parameters Object","json_path":"$.channels.user"} -->
 ```yaml
 address: user/{userId}/signedup
 parameters:
@@ -1036,6 +1067,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 
 ##### Parameter Object Example
 
+<!-- asyncapi-example-tester:{"test":"Channel Parameter Object","json_path":"$.channels.user"} -->
 ```json
 {
   "address": "user/{userId}/signedup",
@@ -1048,6 +1080,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Channel Parameter Object","json_path":"$.channels.user"} -->
 ```yaml
 address: user/{userId}/signedup
 parameters:
@@ -1200,6 +1233,7 @@ Field Name | Type | Description
 
 This object MAY be extended with [Specification Extensions](#specificationExtensions).
 
+<!-- asyncapi-example-tester:{"test":"Message Object","json_path":"$.components.messages.userSignedUp"} -->
 ##### Message Object Example
 
 ```json
@@ -1266,6 +1300,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{"test":"Message Object","json_path":"$.components.messages.userSignedUp"} -->
 ```yaml
 name: UserSignup
 title: User signup
@@ -1312,6 +1347,7 @@ examples:
 
 Example using Avro to define the payload:
 
+<!-- asyncapi-example-tester:{"test":"Message Object","json_path":"$.components.messages.userSignedUp"} -->
 ```json
 {
   "name": "UserSignup",
@@ -1332,6 +1368,7 @@ Example using Avro to define the payload:
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Message Object',json_path:'$.components.messages.userSignedUp'} -->
 ```yaml
 name: UserSignup
 title: User signup
@@ -1371,6 +1408,7 @@ Field Name | Type | Description
 
 This object MAY be extended with [Specification Extensions](#specificationExtensions).
 
+<!-- asyncapi-example-tester:{test:'Message Trait Object',json_path:'$.components.messageTraits.commonHeaders'} -->
 ##### Message Trait Object Example
 
 ```json
@@ -1379,6 +1417,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Message Trait Object',json_path:'$.components.messageTraits.commonHeaders'} -->
 ```yaml
 contentType: application/json
 ```
@@ -1400,6 +1439,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 
 ##### Message Example Object Example
 
+<!-- asyncapi-example-tester:{test:'Message Example Object',json_path:'$.components.messages.userSignUp.examples[0]'} -->
 ```json
 {
   "name": "SimpleSignup",
@@ -1419,6 +1459,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Message Example Object',json_path:'$.components.messages.userSignUp.examples[0]'} -->
 ```yaml
 name: SimpleSignup
 summary: A simple UserSignup example message
@@ -1452,6 +1493,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 
 ##### Tag Object Example
 
+<!-- asyncapi-example-tester:{test:'Tag Object',json_path:'$.components.tags.user'} -->
 ```json
 {
  "name": "user",
@@ -1459,6 +1501,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Tag Object',json_path:'$.components.tags.user'} -->
 ```yaml
 name: user
 description: User-related messages
@@ -1479,6 +1522,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 
 ##### External Documentation Object Example
 
+<!-- asyncapi-example-tester:{test:'External Docs Object',json_path:'$.components.externalDocs.infoDocs'} -->
 ```json
 {
   "description": "Find more info here",
@@ -1486,6 +1530,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'External Docs Object',json_path:'$.components.externalDocs.infoDocs'} -->
 ```yaml
 description: Find more info here
 url: https://example.com
@@ -1509,12 +1554,14 @@ This object cannot be extended with additional properties and any properties add
 
 ##### Reference Object Example
 
+<!-- asyncapi-example-tester:{test:'Reference Object',json_path:'$.components.messages.userSignUp.payload'} -->
 ```json
 {
   "$ref": "#/components/schemas/Pet"
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Reference Object',json_path:'$.components.messages.userSignUp.payload'} -->
 ```yaml
   $ref: '#/components/schemas/Pet'
 ```
@@ -1564,6 +1611,7 @@ my.org.User
 
 ##### Components Object Example
 
+<!-- asyncapi-example-tester:{test:'Components Object',json_path:'$.components'} -->
 ```json
 {
   "components": {
@@ -1697,6 +1745,7 @@ my.org.User
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Components Object',json_path:'$.components'} -->
 ```yaml
 components:
   schemas:
@@ -1818,6 +1867,7 @@ Name | Allowed values | Notes
 
 ###### Multi Format Schema Object Example with Avro
 
+<!-- asyncapi-example-tester:{test:'Muti Format Schema Object - Avro',json_path:'$.channels'} -->
 ```yaml
 channels:
   example:
@@ -1923,6 +1973,7 @@ As such, inline schema definitions, which do not have a given id, _cannot_ be us
 
 ###### Primitive Sample
 
+<!-- asyncapi-example-tester:{test:'Schema Object - Primitive',json_path:'$.components.schemas.Email'} -->
 ```json
 {
   "type": "string",
@@ -1930,11 +1981,13 @@ As such, inline schema definitions, which do not have a given id, _cannot_ be us
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Schema Object - Primitive',json_path:'$.components.schemas.Email'} -->
 ```yaml
 type: string
 format: email
 ```
 
+<!-- asyncapi-example-tester:{test:'Schema Object - Simple model',json_path:'$.components.schemas.Person'} -->
 ###### Simple Model
 
 ```json
@@ -1959,6 +2012,7 @@ format: email
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Schema Object - Simple model',json_path:'$.components.schemas.Person'} -->
 ```yaml
 type: object
 required:
@@ -1978,6 +2032,7 @@ properties:
 
 For a simple string to string mapping:
 
+<!-- asyncapi-example-tester:{test:'Schema Object - Map/Dictionary model',json_path:'$.components.schemas.Additional'} -->
 ```json
 {
   "type": "object",
@@ -1987,6 +2042,7 @@ For a simple string to string mapping:
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Schema Object - Map/Dictionary model',json_path:'$.components.schemas.Additional'} -->
 ```yaml
 type: object
 additionalProperties:
@@ -1995,6 +2051,7 @@ additionalProperties:
 
 For a string to model mapping:
 
+<!-- asyncapi-example-tester:{test:'Schema Object - Allowing Complex model',json_path:'$.components.schemas.WithComplex'} -->
 ```json
 {
   "type": "object",
@@ -2004,6 +2061,7 @@ For a string to model mapping:
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Schema Object - Allowing Complex model',json_path:'$.components.schemas.WithComplex'} -->
 ```yaml
 type: object
 additionalProperties:
@@ -2012,6 +2070,7 @@ additionalProperties:
 
 ###### Model with Example
 
+<!-- asyncapi-example-tester:{test:'Schema Object - With examples model',json_path:'$.components.schemas.WithExamples'} -->
 ```json
 {
   "type": "object",
@@ -2036,6 +2095,7 @@ additionalProperties:
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Schema Object - With examples model',json_path:'$.components.schemas.WithExamples'} -->
 ```yaml
 type: object
 properties:
@@ -2053,6 +2113,7 @@ examples:
 
 ###### Model with Boolean Schemas
 
+<!-- asyncapi-example-tester:{test:'Schema Object - With boolean model',json_path:'$.components.schemas.WithBoolean'} -->
 ```json
 {
   "type": "object",
@@ -2066,6 +2127,7 @@ examples:
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Schema Object - With boolean model',json_path:'$.components.schemas.WithBoolean'} -->
 ```yaml
 type: object
 required:
@@ -2077,6 +2139,7 @@ properties:
 
 ###### Models with Composition
 
+<!-- asyncapi-example-tester:{test:'Schema Object - With composition model',json_path:'$.components.schemas.WithComposition'} -->
 ```json
 {
   "schemas": {
@@ -2119,6 +2182,7 @@ properties:
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Schema Object - With composition model',json_path:'$.components.schemas.WithComposition'} -->
 ```yaml
 schemas:
   ErrorModel:
@@ -2146,6 +2210,7 @@ schemas:
 
 ###### Models with Polymorphism Support
 
+<!-- asyncapi-example-tester:{test:'Schema Object - With polymorphism model',json_path:'$.components.schemas.WithPolymorphism'} -->
 ```json
 {
   "schemas": {
@@ -2239,6 +2304,7 @@ schemas:
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Schema Object - With polymorphism model',json_path:'$.components.schemas.WithPolymorphism'} -->
 ```yaml
 schemas:
   Pet:
@@ -2336,18 +2402,21 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 
 ###### User/Password Authentication Sample
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - user/pass',json_path:'$.components.securitySchemes.oauth'} -->
 ```json
 {
   "type": "userPassword"
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - user/pass',json_path:'$.components.securitySchemes.oauth'} -->
 ```yaml
 type: userPassword
 ```
 
 ###### API Key Authentication Sample
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - API key auth',json_path:'$.components.securitySchemes.oauth'} -->
 ```json
 {
   "type": "apiKey",
@@ -2355,6 +2424,7 @@ type: userPassword
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - API key auth',json_path:'$.components.securitySchemes.oauth'} -->
 ```yaml
 type: apiKey
 in: user
@@ -2362,30 +2432,35 @@ in: user
 
 ###### X.509 Authentication Sample
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - X.509',json_path:'$.components.securitySchemes.oauth'} -->
 ```json
 {
   "type": "X509"
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - X.509',json_path:'$.components.securitySchemes.oauth'} -->
 ```yaml
 type: X509
 ```
 
 ###### End-to-end Encryption Authentication Sample
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - end to end encryption',json_path:'$.components.securitySchemes.oauth'} -->
 ```json
 {
   "type": "symmetricEncryption"
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - end to end encryption',json_path:'$.components.securitySchemes.oauth'} -->
 ```yaml
 type: symmetricEncryption
 ```
 
 ###### Basic Authentication Sample
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - basic',json_path:'$.components.securitySchemes.oauth'} -->
 ```json
 {
   "type": "http",
@@ -2393,6 +2468,7 @@ type: symmetricEncryption
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - basic',json_path:'$.components.securitySchemes.oauth'} -->
 ```yaml
 type: http
 scheme: basic
@@ -2400,6 +2476,7 @@ scheme: basic
 
 ###### API Key Sample
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - API key',json_path:'$.components.securitySchemes.oauth'} -->
 ```json
 {
   "type": "httpApiKey",
@@ -2408,6 +2485,7 @@ scheme: basic
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - API key',json_path:'$.components.securitySchemes.oauth'} -->
 ```yaml
 type: httpApiKey
 name: api_key
@@ -2416,6 +2494,7 @@ in: header
 
 ###### JWT Bearer Sample
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - JWT',json_path:'$.components.securitySchemes.oauth'} -->
 ```json
 {
   "type": "http",
@@ -2424,6 +2503,7 @@ in: header
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - JWT',json_path:'$.components.securitySchemes.oauth'} -->
 ```yaml
 type: http
 scheme: bearer
@@ -2432,6 +2512,7 @@ bearerFormat: JWT
 
 ###### Implicit OAuth2 Sample
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - implicity OAuth2',json_path:'$.components.securitySchemes.oauth'} -->
 ```json
 {
   "type": "oauth2",
@@ -2450,6 +2531,7 @@ bearerFormat: JWT
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - implicity OAuth2',json_path:'$.components.securitySchemes.oauth'} -->
 ```yaml
 type: oauth2
 flows:
@@ -2464,12 +2546,14 @@ scopes:
 
 ###### SASL Sample
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - SASL',json_path:'$.components.securitySchemes.oauth'} -->
 ```json
 {
   "type": "scramSha512"
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Security Scheme Object - SASL',json_path:'$.components.securitySchemes.oauth'} -->
 ```yaml
 type: scramSha512
 ```
@@ -2506,6 +2590,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 
 ##### OAuth Flow Object Examples
 
+<!-- asyncapi-example-tester:{test:'Security Scheme OAuth Flow Object',json_path:'$.components.securitySchemes.oauth.flows.clientCredentials'} -->
 ```JSON
 {
   "authorizationUrl": "https://example.com/api/oauth/dialog",
@@ -2517,6 +2602,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Security Scheme OAuth Flow Object',json_path:'$.components.securitySchemes.oauth.flows.clientCredentials'} -->
 ```YAML
 authorizationUrl: https://example.com/api/oauth/dialog
 tokenUrl: https://example.com/api/oauth/token
@@ -2542,6 +2628,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 
 ##### Examples
 
+<!-- asyncapi-example-tester:{test:'Message Correlation ID Object',json_path:'$.components.correlationIds.default'} -->
 ```json
 {
   "description": "Default Correlation ID",
@@ -2549,6 +2636,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
 }
 ```
 
+<!-- asyncapi-example-tester:{test:'Message Correlation ID Object',json_path:'$.components.correlationIds.default'} -->
 ```yaml
 description: Default Correlation ID
 location: $message.header#/correlationId
@@ -2588,6 +2676,7 @@ Traits MUST be merged with the target object using the [JSON Merge Patch](https:
 
 An object like the following:
 
+<!-- asyncapi-example-tester:{test:'Message Traits Object - merge mechanism',json_path:'$.components.messages.userSignUp'} -->
 ```yaml
 description: A longer description.
 traits:
@@ -2599,6 +2688,7 @@ traits:
 
 Would look like the following after applying traits:
 
+<!-- asyncapi-example-tester:{test:'Message Traits Object - merge mechanism',json_path:'$.components.messages.userSignUp'} -->
 ```yaml
 name: UserSignup
 description: A longer description.
@@ -2641,4 +2731,4 @@ binary | `string` | `binary` | any sequence of octets
 boolean | `boolean` | | |
 date | `string` | `date` | As defined by `full-date` - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339.html#section-5.6)
 dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339.html#section-5.6)
-password | `string` | `password` | Used to hint UIs the input needs to be obscured.
+password | `string` | `password` | Used to hint UIs the input needs to be obscured.
\ No newline at end of file