Merge pull request #314 from AlexBondor/master

Add tags on openapi.yaml endpoints
This commit is contained in:
Julien Neuhart
2021-07-15 09:20:11 +02:00
committed by GitHub

View File

@@ -16,6 +16,8 @@ servers:
paths: paths:
/convert/html: /convert/html:
post: post:
tags:
- Gotenberg
summary: Convert a given HTML file to PDF summary: Convert a given HTML file to PDF
description: >- description: >-
Send an HTML file called `index.html` as a multipart form request, and Send an HTML file called `index.html` as a multipart form request, and
@@ -114,6 +116,8 @@ paths:
$ref: '#/components/responses/SuccessfulPDF' $ref: '#/components/responses/SuccessfulPDF'
/convert/url: /convert/url:
post: post:
tags:
- Gotenberg
summary: Convert the contents of a given URL to PDF summary: Convert the contents of a given URL to PDF
description: >- description: >-
Send a remote URL in your API request via the `remoteURL` parameter, and Send a remote URL in your API request via the `remoteURL` parameter, and
@@ -136,6 +140,8 @@ paths:
$ref: '#/components/responses/SuccessfulPDF' $ref: '#/components/responses/SuccessfulPDF'
/convert/markdown: /convert/markdown:
post: post:
tags:
- Gotenberg
summary: Convert a Markdown file to PDF summary: Convert a Markdown file to PDF
description: >- description: >-
Send an HTML file called `index.html` as a multipart form request and Send an HTML file called `index.html` as a multipart form request and
@@ -195,6 +201,8 @@ paths:
$ref: '#/components/responses/SuccessfulPDF' $ref: '#/components/responses/SuccessfulPDF'
/convert/office: /convert/office:
post: post:
tags:
- Gotenberg
summary: Convert an Office document to PDF summary: Convert an Office document to PDF
description: >- description: >-
Send one or more Office documents and get the resulting PDF file by Send one or more Office documents and get the resulting PDF file by
@@ -257,6 +265,8 @@ paths:
properties: {} properties: {}
/convert/merge: /convert/merge:
post: post:
tags:
- Gotenberg
summary: Merge multiple PDFs into a single PDF summary: Merge multiple PDFs into a single PDF
description: >- description: >-
You can send multiple PDF files to this endpoint, the API will merge You can send multiple PDF files to this endpoint, the API will merge
@@ -298,8 +308,9 @@ paths:
$ref: '#/components/responses/SuccessfulPDF' $ref: '#/components/responses/SuccessfulPDF'
/ping: /ping:
get: get:
tags:
- Gotenberg
summary: Your GET endpoint summary: Your GET endpoint
tags: []
responses: responses:
'200': '200':
description: The API is working fine. description: The API is working fine.