]> git.corax.cc Git - toolbox/commitdiff
spec/ipc: Rename base message schema to ipc_message / ipc.message.json
authorMatthias Kruk <m@m10k.eu>
Fri, 18 Jun 2021 22:55:49 +0000 (07:55 +0900)
committerMatthias Kruk <m@m10k.eu>
Fri, 18 Jun 2021 22:55:49 +0000 (07:55 +0900)
IPC base messages are stored in the "message" field of an envelope,
and the schema for the latter is called ipc.envelope.json (and the
file is called ipc_envelope.schema.json). In keeping with that
convention, the schema for IPC base messages should be called
ipc.message.json (filename ipc_message.schema.json).
This commit makes sure the naming conventions are adhered to.

spec/ipc_data.schema.json [deleted file]
spec/ipc_message.schema.json [new file with mode: 0644]

diff --git a/spec/ipc_data.schema.json b/spec/ipc_data.schema.json
deleted file mode 100644 (file)
index fb5f0bb..0000000
+++ /dev/null
@@ -1,49 +0,0 @@
-{
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "$id": "https://m10k.eu/toolbox/ipc.msg.json",
-    "title": "Toolbox IPC Base message",
-    "description": "The base type for toolbox IPC messages",
-    "type": "object",
-
-    "properties": {
-       "version": {
-           "description": "The message format version",
-           "type": "integer"
-       },
-
-       "source": {
-           "description": "The endpoint that sent the message",
-           "type": "string"
-       },
-
-       "destination": {
-           "description": "The endpoint that the message is intended for",
-           "type": "string"
-       },
-
-       "timestamp": {
-           "description": "The UNIX timestamp when the message was sent",
-           "type": "integer"
-       },
-
-       "user": {
-           "description": "The login name of the sender",
-           "type": "string"
-       },
-
-       "data": {
-           "description": "The base64 encoded content of the message",
-           "type": "string",
-           "pattern": "^[0-9a-zA-Z+/]+[=]*$"
-       }
-    },
-
-    "required": [
-       "version",
-       "source",
-       "destination",
-       "timestamp",
-       "user",
-       "data"
-    ]
-}
diff --git a/spec/ipc_message.schema.json b/spec/ipc_message.schema.json
new file mode 100644 (file)
index 0000000..06379d6
--- /dev/null
@@ -0,0 +1,49 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://m10k.eu/toolbox/ipc.message.json",
+    "title": "Toolbox IPC Base message",
+    "description": "The base type for toolbox IPC messages",
+    "type": "object",
+
+    "properties": {
+       "version": {
+           "description": "The message format version",
+           "type": "integer"
+       },
+
+       "source": {
+           "description": "The endpoint that sent the message",
+           "type": "string"
+       },
+
+       "destination": {
+           "description": "The endpoint that the message is intended for",
+           "type": "string"
+       },
+
+       "timestamp": {
+           "description": "The UNIX timestamp when the message was sent",
+           "type": "integer"
+       },
+
+       "user": {
+           "description": "The login name of the sender",
+           "type": "string"
+       },
+
+       "data": {
+           "description": "The base64 encoded content of the message",
+           "type": "string",
+           "pattern": "^[0-9a-zA-Z+/]+[=]*$"
+       }
+    },
+
+    "required": [
+       "version",
+       "source",
+       "destination",
+       "timestamp",
+       "user",
+       "data"
+    ]
+}