From cbb7e6599b28053dd7ee866caa3e1135a1aad88d Mon Sep 17 00:00:00 2001 From: Burak Karakan Date: Sun, 22 Nov 2020 19:59:41 +0100 Subject: [PATCH] Add OpenAPI docs to the links section --- build/docs/content/15-links.md | 1 + docs/index.html | 401 +++++++++++++++++---------------- 2 files changed, 202 insertions(+), 200 deletions(-) diff --git a/build/docs/content/15-links.md b/build/docs/content/15-links.md index 442e718f..68a855e8 100644 --- a/build/docs/content/15-links.md +++ b/build/docs/content/15-links.md @@ -9,3 +9,4 @@ title: Links * Follow the progress on the [GitHub repository](https://github.com/thecodingmachine/gotenberg) * Follow [@gulnap](https://twitter.com/gulnap) on Twitter * Thanks to [@mafredri](https://github.com/mafredri) for his help and his wonderful [cdp](https://github.com/mafredri/cdp) library +* OpenAPI documentation for the API can be found [on GitHub](https://github.com/thecodingmachine/gotenberg/blob/master/docs/openapi.yaml) diff --git a/docs/index.html b/docs/index.html index 606e9133..c4cc6920 100755 --- a/docs/index.html +++ b/docs/index.html @@ -167,14 +167,14 @@ $ make publish GOTENBERG_USER_GID=You may also add it in your Docker Compose stack:

-
version: '3'
+
version: '3'
 
-services:
+services:
 
   # your other services
 
-  gotenberg:
-    image: thecodingmachine/gotenberg:6
+  gotenberg:
+    image: thecodingmachine/gotenberg:6
 

 
 

@@ -481,15 +481,15 @@ which will be converted to PDF.

 	
 PHP
 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\HTMLRequest;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
-$request = new HTMLRequest($index);
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
 
PHP

 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\HTMLRequest;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
-$header = DocumentFactory::makeFromPath('header.html', '/path/to/file');
-$footer = DocumentFactory::makeFromPath('footer.html', '/path/to/file');
-$request = new HTMLRequest($index);
-$request->setHeader($header);
-$request->setFooter($footer);
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$header = DocumentFactory::makeFromPath('header.html', '/path/to/file');
+$footer = DocumentFactory::makeFromPath('footer.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setHeader($header);
+$request->setFooter($footer);
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
 
fonts section.

 	
 PHP

 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\HTMLRequest;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
-$assets = [
-    DocumentFactory::makeFromPath('style.css', '/path/to/file'),
-    DocumentFactory::makeFromPath('img.png', '/path/to/file'),
-    DocumentFactory::makeFromPath('font.woff', '/path/to/file'),
-];
-$request = new HTMLRequest($index);
-$request->setAssets($assets);
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$assets = [
+    DocumentFactory::makeFromPath('style.css', '/path/to/file'),
+    DocumentFactory::makeFromPath('img.png', '/path/to/file'),
+    DocumentFactory::makeFromPath('font.woff', '/path/to/file'),
+];
+$request = new HTMLRequest($index);
+$request->setAssets($assets);
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
 
PHP

 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\HTMLRequest;
-use TheCodingMachine\Gotenberg\Request;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
+use TheCodingMachine\Gotenberg\Request;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
-$request = new HTMLRequest($index);
-$request->setPaperSize(Request::A4);
-$request->setMargins(Request::NO_MARGINS);
-$request->setLandscape(true);
-$request->setScale(0.75);
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setPaperSize(Request::A4);
+$request->setMargins(Request::NO_MARGINS);
+$request->setLandscape(true);
+$request->setScale(0.75);
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
 
PHP

 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\HTMLRequest;
-use TheCodingMachine\Gotenberg\Request;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
+use TheCodingMachine\Gotenberg\Request;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
-$request = new HTMLRequest($index);
-$request->setPageRanges('1-3,5');
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setPageRanges('1-3,5');
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
 
PHP

 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\HTMLRequest;
-use TheCodingMachine\Gotenberg\Request;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
+use TheCodingMachine\Gotenberg\Request;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
-$request = new HTMLRequest($index);
-$request->setWaitDelay(5.5);
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setWaitDelay(5.5);
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
 
PHP

 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\HTMLRequest;
-use TheCodingMachine\Gotenberg\Request;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
+use TheCodingMachine\Gotenberg\Request;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
-$request = new HTMLRequest($index);
-$request->setGoogleChromeRpccBufferSize(1048576);
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setGoogleChromeRpccBufferSize(1048576);
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
               
@@ -976,14 +976,14 @@ the resulting PDF will be blank. Make sure to rename your service to avoid this
 	
 PHP
 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\URLRequest;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\URLRequest;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$request = new URLRequest('https://google.com');
-$request->setMargins(Request::NO_MARGINS);
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$request = new URLRequest('https://google.com');
+$request->setMargins(Request::NO_MARGINS);
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
 
PHP

 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\URLRequest;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\URLRequest;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$request = new URLRequest('https://google.com');
-$request->addRemoteURLHTTPHeader('Your-Header', 'Foo')
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$request = new URLRequest('https://google.com');
+$request->addRemoteURLHTTPHeader('Your-Header', 'Foo')
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
               
@@ -1105,18 +1105,18 @@ in the file index.html. This function will convert a given markdown
 	
 PHP
 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\MarkdownRequest;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\MarkdownRequest;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
-$markdowns = [
-    DocumentFactory::makeFromPath('file.md', '/path/to/file'),
-];
-$request = new MarkdownRequest($index, $markdowns);
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$markdowns = [
+    DocumentFactory::makeFromPath('file.md', '/path/to/file'),
+];
+$request = new MarkdownRequest($index, $markdowns);
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
               
@@ -1186,18 +1186,18 @@ $client->store($request, $dest);
 	
 PHP
 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\OfficeRequest;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\OfficeRequest;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$files = [
-    DocumentFactory::makeFromPath('document.docx', '/path/to/file'),
-    DocumentFactory::makeFromPath('document2.docx', '/path/to/file'),
-];
-$request = new OfficeRequest($files);
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$files = [
+    DocumentFactory::makeFromPath('document.docx', '/path/to/file'),
+    DocumentFactory::makeFromPath('document2.docx', '/path/to/file'),
+];
+$request = new OfficeRequest($files);
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
 
PHP

 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\OfficeRequest;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\OfficeRequest;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$files = [
-    DocumentFactory::makeFromPath('document.docx', '/path/to/file'),
-];
-$request = new OfficeRequest($files);
-$request->setLandscape(true);
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$files = [
+    DocumentFactory::makeFromPath('document.docx', '/path/to/file'),
+];
+$request = new OfficeRequest($files);
+$request->setLandscape(true);
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
 
PHP

 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\OfficeRequest;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\OfficeRequest;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$files = [
-    DocumentFactory::makeFromPath('document.docx', '/path/to/file'),
-];
-$request = new OfficeRequest($files);
-$request->setPageRanges('1-3');
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$files = [
+    DocumentFactory::makeFromPath('document.docx', '/path/to/file'),
+];
+$request = new OfficeRequest($files);
+$request->setPageRanges('1-3');
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
               
@@ -1361,18 +1361,18 @@ will merge them and return the resulting PDF file.

 	
 PHP
 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\MergeRequest;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\MergeRequest;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$files = [
-    DocumentFactory::makeFromPath('file.pdf', '/path/to/file'),
-    DocumentFactory::makeFromPath('file2.pdf', '/path/to/file'),
-];
-$request = new MergeRequest($files);
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$files = [
+    DocumentFactory::makeFromPath('file.pdf', '/path/to/file'),
+    DocumentFactory::makeFromPath('file2.pdf', '/path/to/file'),
+];
+$request = new MergeRequest($files);
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
               
@@ -1424,17 +1424,17 @@ If unsucessful, it returns a 504 HTTP code.

 	
 PHP
 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\HTMLRequest;
-use TheCodingMachine\Gotenberg\Request;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
+use TheCodingMachine\Gotenberg\Request;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
-$request = new HTMLRequest($index);
-$request->setWaitTimeout(2.5);
-$dest = 'result.pdf';
-$client->store($request, $dest);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setWaitTimeout(2.5);
+$dest = 'result.pdf';
+$client->store($request, $dest);
 

 
               
@@ -1482,15 +1482,15 @@ to given URL.

 	
 PHP
 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\HTMLRequest;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
-$request = new HTMLRequest($index);
-$request->setWebhookURL('http://myapp.com/webhook/');
-$resp = $client->post($request);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setWebhookURL('http://myapp.com/webhook/');
+$resp = $client->post($request);
 

 
 
PHP

 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\HTMLRequest;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
-$request = new HTMLRequest($index);
-$request->setWebhookURL('http://myapp.com/webhook/');
-$request->setWebhookURLTimeout(2.5);
-$resp = $client->post($request);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setWebhookURL('http://myapp.com/webhook/');
+$request->setWebhookURLTimeout(2.5);
+$resp = $client->post($request);
 

 
 
PHP

 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\HTMLRequest;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
-$request = new HTMLRequest($index);
-$request->setWebhookURL('http://myapp.com/webhook/');
-$request->addWebhookURLHTTPHeader('Your-Header', 'Foo');
-$resp = $client->post($request);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setWebhookURL('http://myapp.com/webhook/');
+$request->addWebhookURLHTTPHeader('Your-Header', 'Foo');
+$resp = $client->post($request);
 

 
               
@@ -1655,16 +1655,16 @@ Otherwise a random filename is used.

 	
 PHP
 
-
use TheCodingMachine\Gotenberg\Client;
-use TheCodingMachine\Gotenberg\DocumentFactory;
-use TheCodingMachine\Gotenberg\HTMLRequest;
-use TheCodingMachine\Gotenberg\Request;
+
use TheCodingMachine\Gotenberg\Client;
+use TheCodingMachine\Gotenberg\DocumentFactory;
+use TheCodingMachine\Gotenberg\HTMLRequest;
+use TheCodingMachine\Gotenberg\Request;
 
-$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
-$request = new HTMLRequest($index);
-$request->setResultFilename('foo.pdf');
-$resp = $client->post($request);
+$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
+$request = new HTMLRequest($index);
+$request->setResultFilename('foo.pdf');
+$resp = $client->post($request);
 

 
               
@@ -1713,14 +1713,14 @@ if the API is under heavy load.

 
 
For instance, using the following Docker Compose file:

 
-
version: '3'
+
version: '3'
 
-services:
+services:
 
   # your other services
 
-  gotenberg:
-    image: thecodingmachine/gotenberg:6
+  gotenberg:
+    image: thecodingmachine/gotenberg:6
 

 
 
You may now launch your services using:

@@ -1778,7 +1778,8 @@ restart your Gotenberg instances from time to time to ensure a nominal behaviour