From d6b004cd3fc281325d3e92aaecee3293bdca87a2 Mon Sep 17 00:00:00 2001 From: "jonas-lt@live.dk" Date: Tue, 13 Jun 2023 19:47:18 +0200 Subject: [PATCH 1/5] adapt readme --- http/README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/http/README.md b/http/README.md index fbdda833..0b7a4031 100644 --- a/http/README.md +++ b/http/README.md @@ -6,7 +6,7 @@ This document defines how to describe HTTP-specific information on AsyncAPI. ## Version -Current version is `0.1.0`. +Current version is `1.0.0`. @@ -33,7 +33,6 @@ This object MUST NOT contain any properties. Its name is reserved for future use Field Name | Type | Description ---|:---:|--- -`type` | string | **REQUIRED**. Type of operation. Its value MUST be either `request` or `response`. `method` | string | When `type` is `request`, this is the HTTP method, otherwise it MUST be ignored. Its value MUST be one of `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, `HEAD`, `OPTIONS`, `CONNECT`, and `TRACE`. `query` | [Schema Object][schemaObject] | A Schema object containing the definitions for each query parameter. This schema MUST be of type `object` and have a `properties` key. `bindingVersion` | string | The version of this binding. If omitted, "latest" MUST be assumed. @@ -60,7 +59,7 @@ channels: minimum: 1 description: The Id of the company. additionalProperties: false - bindingVersion: '0.1.0' + bindingVersion: '1.0.0' ``` @@ -93,7 +92,7 @@ channels: Content-Type: type: string enum: ['application/json'] - bindingVersion: '0.1.0' + bindingVersion: '1.0.0' ``` -[schemaObject]: https://www.asyncapi.com/docs/specifications/2.0.0/#schemaObject \ No newline at end of file +[schemaObject]: https://www.asyncapi.com/docs/specificationsv3.0.0-next-major-spec.12/#schemaObject \ No newline at end of file From 86a507a7a9e49b5afa0dfb5f195d5a8b28f13b20 Mon Sep 17 00:00:00 2001 From: "jonas-lt@live.dk" Date: Thu, 22 Jun 2023 15:21:41 +0200 Subject: [PATCH 2/5] finilize binding --- http/README.md | 60 ++++++++++++++++++++++++++------------------------ 1 file changed, 31 insertions(+), 29 deletions(-) diff --git a/http/README.md b/http/README.md index 0b7a4031..fbca9e11 100644 --- a/http/README.md +++ b/http/README.md @@ -6,7 +6,7 @@ This document defines how to describe HTTP-specific information on AsyncAPI. ## Version -Current version is `1.0.0`. +Current version is `0.2.0`. @@ -15,9 +15,6 @@ Current version is `1.0.0`. This object MUST NOT contain any properties. Its name is reserved for future use. - - - ## Channel Binding Object @@ -28,13 +25,13 @@ This object MUST NOT contain any properties. Its name is reserved for future use ## Operation Binding Object - + ##### Fixed Fields Field Name | Type | Description ---|:---:|--- -`method` | string | When `type` is `request`, this is the HTTP method, otherwise it MUST be ignored. Its value MUST be one of `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, `HEAD`, `OPTIONS`, `CONNECT`, and `TRACE`. -`query` | [Schema Object][schemaObject] | A Schema object containing the definitions for each query parameter. This schema MUST be of type `object` and have a `properties` key. +`method` | string | The HTTP method for the request. Its value MUST be one of `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, `HEAD`, `OPTIONS`, `CONNECT`, and `TRACE`. +`query` | [Parameters Object][parametersObject] | A Parameters object containing the definitions for each query parameter. `bindingVersion` | string | The version of this binding. If omitted, "latest" MUST be assumed. This object MUST contain only the properties defined above. @@ -43,23 +40,26 @@ This object MUST contain only the properties defined above. ```yaml channels: - /employees: - subscribe: - bindings: - http: - type: request - method: GET - query: - type: object - required: - - companyId - properties: - companyId: - type: number - minimum: 1 - description: The Id of the company. - additionalProperties: false - bindingVersion: '1.0.0' + employees: + address: /employees +operations: + employees: + action: send: + bindings: + http: + type: request + method: GET + query: + type: object + required: + - companyId + properties: + companyId: + type: number + minimum: 1 + description: The Id of the company. + additionalProperties: false + bindingVersion: '0.2.0' ``` @@ -73,7 +73,7 @@ This object contains information about the message representation in HTTP. Field Name | Type | Description ---|:---:|--- -`headers` | [Schema Object][schemaObject] | A Schema object containing the definitions for HTTP-specific headers. This schema MUST be of type `object` and have a `properties` key. +`headers` | [Parameters Object][parametersObject] | A Parameters object containing the definitions for HTTP-specific headers. `bindingVersion` | string | The version of this binding. If omitted, "latest" MUST be assumed. This object MUST contain only the properties defined above. @@ -82,8 +82,9 @@ This object MUST contain only the properties defined above. ```yaml channels: test: - publish: - message: + address: /test + messages: + testMessage: bindings: http: headers: @@ -92,7 +93,8 @@ channels: Content-Type: type: string enum: ['application/json'] - bindingVersion: '1.0.0' + bindingVersion: '0.2.0' ``` -[schemaObject]: https://www.asyncapi.com/docs/specificationsv3.0.0-next-major-spec.12/#schemaObject \ No newline at end of file +[schemaObject]: https://www.asyncapi.com/docs/specifications/latest/#schemaObject +[parametersObject]: https://www.asyncapi.com/docs/specifications/latest/#parametersObject \ No newline at end of file From d8c050f958367101ff53e478243d54f848b7bc51 Mon Sep 17 00:00:00 2001 From: Jonas Lagoni Date: Wed, 28 Jun 2023 14:33:55 +0200 Subject: [PATCH 3/5] Update http/README.md Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com> --- http/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/http/README.md b/http/README.md index fbca9e11..6709a966 100644 --- a/http/README.md +++ b/http/README.md @@ -47,7 +47,6 @@ operations: action: send: bindings: http: - type: request method: GET query: type: object From 2217b4bc326a3d41489c3da72620b5c5a158707b Mon Sep 17 00:00:00 2001 From: "jonas-lt@live.dk" Date: Wed, 28 Jun 2023 14:37:27 +0200 Subject: [PATCH 4/5] revert schema object --- http/README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/http/README.md b/http/README.md index 6709a966..4784ec3c 100644 --- a/http/README.md +++ b/http/README.md @@ -31,7 +31,7 @@ This object MUST NOT contain any properties. Its name is reserved for future use Field Name | Type | Description ---|:---:|--- `method` | string | The HTTP method for the request. Its value MUST be one of `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, `HEAD`, `OPTIONS`, `CONNECT`, and `TRACE`. -`query` | [Parameters Object][parametersObject] | A Parameters object containing the definitions for each query parameter. +`query` | [Schema Object][schemaObject] | A Schema object containing the definitions for each query parameter. This schema MUST be of type object and have a properties key. `bindingVersion` | string | The version of this binding. If omitted, "latest" MUST be assumed. This object MUST contain only the properties defined above. @@ -72,7 +72,7 @@ This object contains information about the message representation in HTTP. Field Name | Type | Description ---|:---:|--- -`headers` | [Parameters Object][parametersObject] | A Parameters object containing the definitions for HTTP-specific headers. +`headers` | [Schema Object][schemaObject] | A Schema object containing the definitions for HTTP-specific headers. This schema MUST be of type object and have a properties key. `bindingVersion` | string | The version of this binding. If omitted, "latest" MUST be assumed. This object MUST contain only the properties defined above. @@ -95,5 +95,4 @@ channels: bindingVersion: '0.2.0' ``` -[schemaObject]: https://www.asyncapi.com/docs/specifications/latest/#schemaObject -[parametersObject]: https://www.asyncapi.com/docs/specifications/latest/#parametersObject \ No newline at end of file +[schemaObject]: https://www.asyncapi.com/docs/specifications/latest/#schemaObject \ No newline at end of file From 84d05a77ba8751a436ae811476230571c2734acb Mon Sep 17 00:00:00 2001 From: Jonas Lagoni Date: Wed, 28 Jun 2023 14:53:14 +0200 Subject: [PATCH 5/5] Update http/README.md Co-authored-by: Lukasz Gornicki --- http/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/http/README.md b/http/README.md index 4784ec3c..7bb371d1 100644 --- a/http/README.md +++ b/http/README.md @@ -72,7 +72,7 @@ This object contains information about the message representation in HTTP. Field Name | Type | Description ---|:---:|--- -`headers` | [Schema Object][schemaObject] | A Schema object containing the definitions for HTTP-specific headers. This schema MUST be of type object and have a properties key. +`headers` | [Schema Object][schemaObject] | A Schema object containing the definitions for HTTP-specific headers. This schema MUST be of type `object` and have a `properties` key. `bindingVersion` | string | The version of this binding. If omitted, "latest" MUST be assumed. This object MUST contain only the properties defined above.