mirror of
https://github.com/workinghard/GuitarTeX2.git
synced 2025-12-14 19:02:10 +00:00
Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 692d1d3f03 | |||
| 4b5d25cb6e |
@@ -10,6 +10,9 @@ 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)
|
||||||
|
|||||||
69
server_openapi.yaml
Normal file
69
server_openapi.yaml
Normal 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
|
||||||
Reference in New Issue
Block a user