From 647f54037d6fd3adb650cbaf30dc291bed81fe34 Mon Sep 17 00:00:00 2001 From: Pedro Ramos Date: Wed, 17 Apr 2024 19:26:24 +0200 Subject: [PATCH] fix: incorrect operation messages in 'examples/http-test/asyncapi.yaml' (#805) --- examples/http-test/asyncapi.yaml | 4 +- examples/http-test/docs/asyncapi.md | 181 ++++++++++++++++++++++++++++ 2 files changed, 183 insertions(+), 2 deletions(-) diff --git a/examples/http-test/asyncapi.yaml b/examples/http-test/asyncapi.yaml index 1f090efc9..807a7a649 100644 --- a/examples/http-test/asyncapi.yaml +++ b/examples/http-test/asyncapi.yaml @@ -46,13 +46,13 @@ operations: channel: $ref: "#/channels/TRIGGER" messages: - - $ref: "#/components/messages/string" + - $ref: "#/channels/TRIGGER/messages/string" receiveTrigger: reply: channel: $ref: "#/channels/TRIGGER" messages: - - $ref: "#/components/messages/string" + - $ref: "#/channels/TRIGGER/messages/string" channel: $ref: '#/channels/TRIGGER' action: receive diff --git a/examples/http-test/docs/asyncapi.md b/examples/http-test/docs/asyncapi.md index 234c53fb8..8933e70dc 100644 --- a/examples/http-test/docs/asyncapi.md +++ b/examples/http-test/docs/asyncapi.md @@ -26,3 +26,184 @@ This app is a test app. it will send requests to httpbin.org to see if glee work ## Operations +### SEND `/` Operation + +* Operation ID: `sendTrigger` +* Available only on servers: [local-trigger](#local-trigger-server) + +#### Message `string` + +##### Payload + +| Name | Type | Description | Value | Constraints | Notes | +|---|---|---|---|---|---| +| (root) | string | - | - | - | - | + +> Examples of payload _(generated)_ + +```json +"string" +``` + + +#### `http` Message specific information + +| Name | Type | Description | Value | Constraints | Notes | +|---|---|---|---|---|---| +| headers | object | - | - | - | **additional properties are allowed** | +| headers.a | string | - | - | - | **required** | +| headers.b | string | - | - | - | **required** | + + +### REPLY `/` Operation + +* Operation ID: `receiveTrigger` +* Available only on servers: [local-trigger](#local-trigger-server) + +#### `http` Operation specific information + +| Name | Type | Description | Value | Constraints | Notes | +|---|---|---|---|---|---| +| method | - | - | `"POST"` | - | - | + +Request contains **one of** the following messages: + +#### Message `string` + +##### Payload + +| Name | Type | Description | Value | Constraints | Notes | +|---|---|---|---|---|---| +| (root) | string | - | - | - | - | + +> Examples of payload _(generated)_ + +```json +"string" +``` + + +#### `http` Message specific information + +| Name | Type | Description | Value | Constraints | Notes | +|---|---|---|---|---|---| +| headers | object | - | - | - | **additional properties are allowed** | +| headers.a | string | - | - | - | **required** | +| headers.b | string | - | - | - | **required** | + +#### Message `empty` + +##### Payload + +| Name | Type | Description | Value | Constraints | Notes | +|---|---|---|---|---|---| +| (root) | null | - | - | - | - | + +> Examples of payload _(generated)_ + +```json +"" +``` + + +#### Response information + +* should be done to channel: `/` + + +### SEND `/delete` Operation + +* Operation ID: `sendDELETE` +* Available only on servers: [httpbin.org](#httpbinorg-server) + +#### `http` Operation specific information + +| Name | Type | Description | Value | Constraints | Notes | +|---|---|---|---|---|---| +| method | - | - | `"DELETE"` | - | - | + + +### RECEIVE `/delete` Operation + +* Operation ID: `receiveDELETE` +* Available only on servers: [httpbin.org](#httpbinorg-server) + + +### SEND `/get` Operation + +* Operation ID: `sendGET` +* Available only on servers: [httpbin.org](#httpbinorg-server) + +#### `http` Operation specific information + +| Name | Type | Description | Value | Constraints | Notes | +|---|---|---|---|---|---| +| method | - | - | `"GET"` | - | - | + + +### RECEIVE `/get` Operation + +* Operation ID: `receiveGET` +* Available only on servers: [httpbin.org](#httpbinorg-server) + +#### `http` Operation specific information + +| Name | Type | Description | Value | Constraints | Notes | +|---|---|---|---|---|---| +| method | - | - | `"GET"` | - | - | + + +### SEND `/post` Operation + +* Operation ID: `sendPOST` +* Available only on servers: [httpbin.org](#httpbinorg-server) + +#### `http` Operation specific information + +| Name | Type | Description | Value | Constraints | Notes | +|---|---|---|---|---|---| +| method | - | - | `"POST"` | - | - | + + +### RECEIVE `/post` Operation + +* Operation ID: `receivePOST` +* Available only on servers: [httpbin.org](#httpbinorg-server) + + +### SEND `/patch` Operation + +* Operation ID: `sendPATCH` +* Available only on servers: [httpbin.org](#httpbinorg-server) + +#### `http` Operation specific information + +| Name | Type | Description | Value | Constraints | Notes | +|---|---|---|---|---|---| +| method | - | - | `"PATCH"` | - | - | + + +### RECEIVE `/patch` Operation + +* Operation ID: `receivePATCH` +* Available only on servers: [httpbin.org](#httpbinorg-server) + + +### SEND `/put` Operation + +* Operation ID: `sendPUT` +* Available only on servers: [httpbin.org](#httpbinorg-server) + +#### `http` Operation specific information + +| Name | Type | Description | Value | Constraints | Notes | +|---|---|---|---|---|---| +| method | - | - | `"PUT"` | - | - | + + +### RECEIVE `/put` Operation + +* Operation ID: `receivePUT` +* Available only on servers: [httpbin.org](#httpbinorg-server) + +