feat: add HTTP 0.3.0 bindings (#484)

asyncapi · Jan 30, 2024 · 0002c50 · 0002c50
1 parent 992c509
commit 0002c50
Show file tree

Hide file tree

Showing 4 changed files with 156 additions and 2 deletions.
diff --git a/bindings/http/0.3.0/message.json b/bindings/http/0.3.0/message.json
@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://asyncapi.com/bindings/http/0.3.0/message.json",
+  "title": "HTTP message bindings object",
+  "description": "This object contains information about the message representation in HTTP.",
+  "type": "object",
+  "additionalProperties": false,
+  "patternProperties": {
+    "^x-[\\w\\d\\.\\x2d_]+$": {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/specificationExtension.json"
+    }
+  },
+  "properties": {
+    "headers": {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/schema.json",
+      "description": "\tA Schema object containing the definitions for HTTP-specific headers. This schema MUST be of type 'object' and have a 'properties' key."
+    },
+    "statusCode": {
+      "type": "number",
+      "description": "The HTTP response status code according to [RFC 9110](https://httpwg.org/specs/rfc9110.html#overview.of.status.codes). `statusCode` is only relevant for messages referenced by the [Operation Reply Object](https://www.asyncapi.com/docs/reference/specification/v3.0.0#operationReplyObject), as it defines the status code for the response. In all other cases, this value can be safely ignored."
+    },
+    "bindingVersion": {
+      "type": "string",
+      "enum": [
+        "0.3.0"
+      ],
+      "description": "The version of this binding. If omitted, \"latest\" MUST be assumed."
+    }
+  },
+  "examples": [
+    {
+      "headers": {
+        "type": "object",
+        "properties": {
+          "Content-Type": {
+            "type": "string",
+            "enum": [
+              "application/json"
+            ]
+          }
+        }
+      },
+      "bindingVersion": "0.3.0"
+    }
+  ]
+}
diff --git a/bindings/http/0.3.0/operation.json b/bindings/http/0.3.0/operation.json
@@ -0,0 +1,82 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://asyncapi.com/bindings/http/0.3.0/operation.json",
+  "title": "HTTP operation bindings object",
+  "description": "This object contains information about the operation representation in HTTP.",
+  "type": "object",
+  "additionalProperties": false,
+  "patternProperties": {
+    "^x-[\\w\\d\\.\\x2d_]+$": {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/specificationExtension.json"
+    }
+  },
+  "properties": {
+    "method": {
+      "type": "string",
+      "enum": [
+        "GET",
+        "PUT",
+        "POST",
+        "PATCH",
+        "DELETE",
+        "HEAD",
+        "OPTIONS",
+        "CONNECT",
+        "TRACE"
+      ],
+      "description": "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": {
+      "$ref": "http://asyncapi.com/definitions/3.0.0/schema.json",
+      "description": "A Schema object containing the definitions for each query parameter. This schema MUST be of type 'object' and have a properties key."
+    },
+    "bindingVersion": {
+      "type": "string",
+      "enum": [
+        "0.3.0"
+      ],
+      "description": "The version of this binding. If omitted, 'latest' MUST be assumed."
+    }
+  },
+  "examples": [
+    {
+      "query": {
+        "type": "object",
+        "required": [
+          "companyId"
+        ],
+        "properties": {
+          "companyId": {
+            "type": "number",
+            "minimum": 1,
+            "description": "The Id of the company."
+          }
+        },
+        "additionalProperties": false
+      },
+      "bindingVersion": "0.3.0"
+    },
+    {
+      "method": "GET",
+      "query": {
+        "type": "object",
+        "required": [
+          "companyId"
+        ],
+        "properties": {
+          "companyId": {
+            "type": "number",
+            "minimum": 1,
+            "description": "The Id of the company."
+          }
+        },
+        "additionalProperties": false
+      },
+      "bindingVersion": "0.3.0"
+    }
+  ]
+}
+
+
+
+
diff --git a/definitions/3.0.0/messageBindingsObject.json b/definitions/3.0.0/messageBindingsObject.json
@@ -11,7 +11,7 @@
     "http": {
       "properties": {
         "bindingVersion": {
-          "enum": ["0.2.0"]
+          "enum": ["0.2.0", "0.3.0"]
         }
       },
       "allOf": [
@@ -40,6 +40,19 @@
           "then": {
             "$ref": "http://asyncapi.com/bindings/http/0.2.0/message.json"
           }
+        },
+        {
+          "if": {
+            "required": [ "bindingVersion" ],
+            "properties": {
+              "bindingVersion": {
+                "const": "0.3.0"
+              }
+            }
+          }, 
+          "then": {
+            "$ref": "http://asyncapi.com/bindings/http/0.3.0/message.json"
+          }
         }
       ]
     },

diff --git a/definitions/3.0.0/operationBindingsObject.json b/definitions/3.0.0/operationBindingsObject.json
@@ -11,7 +11,7 @@
     "http": {
       "properties": {
         "bindingVersion": {
-          "enum": ["0.2.0"]
+          "enum": ["0.2.0", "0.3.0"]
         }
       },
       "allOf": [
@@ -40,6 +40,19 @@
           "then": {
             "$ref": "http://asyncapi.com/bindings/http/0.2.0/operation.json"
           }
+        },
+        {
+          "if": {
+            "required": [ "bindingVersion" ],
+            "properties": {
+              "bindingVersion": {
+                "const": "0.3.0"
+              }
+            }
+          }, 
+          "then": {
+            "$ref": "http://asyncapi.com/bindings/http/0.3.0/operation.json"
+          }
         }
       ]
     },