From 4b5d25cb6e7ca7fe06b55a1351a546e86c3ff149 Mon Sep 17 00:00:00 2001
From: Nikolai <nrinas@cube4fun.net>
Date: Sat, 6 Jul 2024 18:26:45 +0200
Subject: [PATCH] Create server_openapi.yaml

---
 server_openapi.yaml | 69 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 server_openapi.yaml

diff --git a/server_openapi.yaml b/server_openapi.yaml
new file mode 100644
index 0000000..a386792
--- /dev/null
+++ b/server_openapi.yaml
@@ -0,0 +1,69 @@
+openapi: 3.0.0
+info:
+  title: GTXServer2 server
+  description: This is a server for the [GuitarTex2](https://guitartex2.nikolai-rinas.de) client. It's being used to generate pdf from latex.
+  version: 0.1.0
+servers:
+  - url: https://latex2pdf.nikolai-rinas.de/
+    description: Not monetarized server. For private use only!
+paths:
+  /ping:
+    get:
+      summary: Returns server status
+      responses:
+        '200':
+          description: Ok
+          content:
+            text/plain;charset=utf-8:
+              schema: 
+                type: string
+                example: Ok
+
+  /latex:
+    post:
+      summary: Send latex request
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              properties:
+                version: 
+                  type: string
+                  example: "1.0"
+                file:
+                  type: array
+                  items: {}
+      responses:
+        '200':
+          description: Detailed information about the process
+          content:
+            application/json: 
+              schema:
+                $ref: '#/components/schemas/latexResponse'
+                  
+                  
+  /download/{id}:
+    get:
+      summary: Used to download the file
+      responses:
+        '200':
+          description: File content
+    parameters:
+      - name: id
+        in: path
+        required: true
+        schema:
+          type: string
+        style: simple
+
+components:
+  schemas:
+    latexResponse:
+      type: object
+      properties:
+        cmd_rc:
+          type: integer
+        msg:
+          type: string
+        download_url:
+          type: string