From 3784655eb9b79633b4e368a477fb06ffa333f9b2 Mon Sep 17 00:00:00 2001
From: TerminalMan <84923604+SecretiveShell@users.noreply.github.com>
Date: Mon, 4 Nov 2024 18:32:01 +0000
Subject: [PATCH] add serviceinfo openapi

---
 schemas/serviceinfo/openapi.json | 83 ++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 schemas/serviceinfo/openapi.json

diff --git a/schemas/serviceinfo/openapi.json b/schemas/serviceinfo/openapi.json
new file mode 100644
index 0000000..70e4c98
--- /dev/null
+++ b/schemas/serviceinfo/openapi.json
@@ -0,0 +1,83 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "version": "0.2",
+    "title": "Service Info API",
+    "description": "An API to provide service information including software details and API specifications."
+  },
+  "components": {
+    "schemas": {
+      "ServiceInfo": {
+        "type": "object",
+        "required": ["version", "software", "api"],
+        "properties": {
+          "version": {
+            "type": "string",
+            "description": "The version of the service info specification."
+          },
+          "software": {
+            "type": "object",
+            "required": ["name", "version", "repository", "homepage"],
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "The name of the software."
+              },
+              "version": {
+                "type": "string",
+                "description": "The version of the software."
+              },
+              "repository": {
+                "type": "string",
+                "format": "uri",
+                "description": "The URL of the software's source code repository."
+              },
+              "homepage": {
+                "type": "string",
+                "format": "uri",
+                "description": "The URL to the software's homepage."
+              },
+              "logo": {
+                "type": "string",
+                "format": "uri",
+                "description": "A URL to an image of the software logo.",
+                "nullable": true
+              }
+            }
+          },
+          "api": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "object",
+              "required": ["name", "version", "rel_url", "documentation"],
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "description": "The name of the software API."
+                },
+                "version": {
+                  "type": "string",
+                  "description": "The version of the API implemented by the software."
+                },
+                "base_url": {
+                  "type": "string",
+                  "format": "uri",
+                  "description": "The absolute URL to the API base.",
+                  "nullable": true
+                },
+                "rel_url": {
+                  "type": "string",
+                  "description": "A relative URL to the API base."
+                },
+                "documentation": {
+                  "type": "string",
+                  "description": "A relative or absolute URL to the API documentation."
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}