6 Commits

Author SHA1 Message Date
692d1d3f03 Update README.md 2024-07-06 18:33:18 +02:00
4b5d25cb6e Create server_openapi.yaml 2024-07-06 18:26:45 +02:00
f9cd93fd6e Update README.md 2024-07-06 17:25:48 +02:00
dfa7d3fca3 Merge pull request #5 from workinghard/newBuild
New GTX client due to server rework
2024-07-06 17:22:22 +02:00
71b48031f8 Update README.md 2022-01-10 21:46:26 +01:00
8c86111e8f Merge pull request #3 from workinghard/newBuild
Version 3.5.0
2022-01-10 21:40:42 +01:00
2 changed files with 76 additions and 3 deletions

View File

@@ -1,4 +1,5 @@
# Server online: guitartex2.nikolai-rinas.de - port 3121 # Breaking change in version 3.6! Server implementation has changed. Old server is no longer available. Please upgrade!
# Server online: https://latex2pdf.nikolai-rinas.de - port can be left blank
## Build ## Build
You can build it on your platform with maven. I'm using Visual Studio Code with maven an openjdk package to build the release versions. You can build it on your platform with maven. I'm using Visual Studio Code with maven an openjdk package to build the release versions.
@@ -9,13 +10,16 @@ Details can be found [here](https://guitartex2.nikolai-rinas.de/)
## Release Notes ## Release Notes
============= =============
### Version 3.6.0
* New server implemented. Http based and finally secured connection. Because of that the old communication method is no longer supported.
* New GTX client. If you want to build something similar yourself, feel free to use server_open.yaml as reference
### Version 3.5.0 ### Version 3.5.0
* New build pipeline with maven and VSC (optional) * New build pipeline with maven and VSC (optional)
* Code cleanup * Code cleanup
* Dropped standalone mac app support * Dropped standalone mac app support
* Standalone gtx converter available * Standalone gtx converter available
* Published build versions for Windows/Linux/Mac * Published build versions for Windows/Linux/Mac - x86
* Guitartab command is now dynamic \textwidth (thanks for contribution @e-dschungel) * Guitartab command is now dynamic \textwidth (thanks for contribution @e-dschungel)
* gtxtabs command changed. If you like the old version instead, please add following line to your song/book: * gtxtabs command changed. If you like the old version instead, please add following line to your song/book:

69
server_openapi.yaml Normal file
View File

@@ -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