feat: apache Pulsar bindings

pulsar/README.md

@@ -0,0 +1,86 @@
+# Pulsar Bindings
+This document defines how to describe Apache Pulsar specific information with AsyncAPI.
+
+<a name="version"></a>
+
+## Version
+
+Current version is `0.1.0`.
+
+<a name="server"></a>
+## Server Binding Object
+
+This object contains information about the server representation in Pulsar.
+
+##### Fixed Fields
+
+Field Name | Type | Description | Applicability [default] |
+---|:---:|:---|:---|
+`tenant` | String | The pulsar tenant. If omitted, "public" MUST be assumed. | OPTIONAL [`public`] |
+`bindingVersion` | String | The version of this binding. If omitted, "latest" MUST be assumed. | OPTIONAL [`latest`] |
+
+##### Example
+
+```yaml
+servers:
+  production:
+    bindings:
+      pulsar:
+        tenant: contoso
+        bindingVersion: '0.1.0'
+```
+
+<a name="channel"></a>
+## Channel Binding Object
+This object contains information about the channel representation in Pulsar
+
+##### Fixed Fields
+
+Field Name | Type | Description | Applicability [default] |
+---|:---:|:---|:---|
+`namespace` | String |  The namespace the channel is associated with. | REQUIRED |
+`persistence` | String | Persistence of the topic in Pulsar. It MUST be either `persistent` or `non-persistent`. | REQUIRED |
+`compaction`| Integer | Topic compaction threshold given in Megabytes. | OPTIONAL |
+`geo-replication` | String[] | A list of clusters the topic is replicated to. | OPTIONAL |
+`retention` | [Retention Definition Object](#retention-definition-object) | Topic retention policy.  | OPTIONAL |
+`ttl` | Integer |  Message time-to-live in seconds. | OPTIONAL |
+`deduplication` | Boolean | Message deduplication. When true, it ensures that each message produced on Pulsar topics is persisted to disk only once. | OPTIONAL |
+`bindingVersion` | String | The version of this binding. If omitted, "latest" MUST be assumed. | OPTIONAL [`latest`] |
+
+<a name="retention-definition-object"></a>
+### Retention Definition Object
+The `Retention Definition Object` is used to describe the Pulsar [Retention](https://pulsar.apache.org/docs/cookbooks-retention-expiry/) policy. If retention is specified, both fields are mandatory.
+
+Field Name | Type | Description | Applicability [default] |
+---|:---:|:---|:---|
+`time`|Integer| Time given in Minutes. | OPTIONAL [`0`]
+`size`|Integer| Size given in MegaBytes. | OPTIONAL [`0`]
+
+##### Example
+
+```yaml
+channels:
+  user-signedup:
+    bindings:
+      pulsar:
+        namespace: 'staging'
+        persistence: 'persistent'
+        compaction: 1000
+        geo-replication:
+          - 'us-east1'
+          - 'us-west1'
+        retention:
+          time: 7
+          size: 1000
+        ttl: 360
+        deduplication: false
+        bindingVersion: '0.1.0'
+```
+
+<a name="operation"></a>
+## Operation binding fields
+This object MUST NOT contain any properties. Its name is reserved for future use.
+
+<a name="message"></a>
+## Message binding fields
+This object MUST NOT contain any properties. Its name is reserved for future use.

pulsar/json_schemas/channel.json

@@ -0,0 +1,91 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "http://asyncapi.com/bindings/pulsar/channel.json",
+    "title": "Channel Schema",
+    "description": "This object contains information about the channel representation in Pulsar, which covers namespace and topic level admin configuration. This object contains additional information not possible to represent within the core AsyncAPI specification.",
+    "type": "object",
+    "additionalProperties": false,
+    "patternProperties": {
+      "^x-[\\w\\d\\.\\-\\_]+$": {
+        "$ref": "https://raw.githubusercontent.com/asyncapi/spec-json-schemas/v4.0.0/schemas/2.5.0.json#/definitions/http://asyncapi.com/definitions/2.5.0/specificationExtension.json"
+      }
+    },
+    "required": [ "namespace", "persistence" ],
+    "properties": {
+      "namespace": {
+        "type": "string",
+        "description": "The namespace, the channel is associated with."
+      },
+      "persistence": {
+        "type": "string",
+        "enum": [
+          "persistent",
+          "non-persistent"
+        ],
+        "description": "persistence of the topic in Pulsar."
+      },
+      "compaction": {
+        "type": "integer",
+        "minimum": 0,
+        "description": "Topic compaction threshold given in MB"
+      },
+      "geo-replication": {
+        "type": "array",
+        "description": "A list of clusters the topic is replicated to.",
+        "items": {
+          "type": "string"
+        }
+      },
+      "retention": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "time": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Time given in Minutes. `0` = Disable message retention."
+          },
+          "size": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "Size given in MegaBytes. `0` = Disable message retention."
+          }
+        }
+      },
+      "ttl": {
+        "type": "integer",
+        "description": "TTL in seconds for the specified topic"
+      },
+      "deduplication": {
+        "type": "boolean",
+        "description": "Whether deduplication of events is enabled or not."
+      },
+      "bindingVersion": {
+        "type": "string",
+        "enum": [
+          "0.1.0"
+        ],
+        "description": "The version of this binding. If omitted, 'latest' MUST be assumed."
+      }
+
+    },
+    "examples": [
+      {
+        "namespace": "ns1",
+        "persistence": "persistent",
+        "compaction": 1000,
+        "retention": {
+          "time": 15,
+          "size": 1000
+        },
+        "ttl": 360,
+        "geo-replication": [
+          "us-west",
+          "us-east"
+        ],
+        "deduplication": true,
+        "bindingVersion": "0.1.0"
+      }
+    ]
+  }
+

pulsar/json_schemas/server.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://asyncapi.com/bindings/pulsar/server.json",
+  "title": "Server Schema",
+  "description": "This object contains server information of Pulsar broker, which covers cluster and tenant admin configuration. This object contains additional information not possible to represent within the core AsyncAPI specification.",
+  "type": "object",
+  "additionalProperties": false,
+  "patternProperties": {
+    "^x-[\\w\\d\\.\\-\\_]+$": {
+      "$ref": "https://raw.githubusercontent.com/asyncapi/spec-json-schemas/v2.14.0/schemas/2.4.0.json#/definitions/specificationExtension"
+    }
+  },
+  "properties": {
+    "tenant": {
+      "type": "string",
+      "description": "The pulsar tenant. If omitted, 'public' MUST be assumed."
+    },
+    "bindingVersion": {
+      "type": "string",
+      "enum": [
+        "0.1.0"
+      ],
+      "description": "The version of this binding. If omitted, 'latest' MUST be assumed."
+    }
+  },
+  "examples": [
+    {
+      "tenant": "contoso",
+      "bindingVersion": "0.1.0"
+    }
+  ]
+}