Merge pull request #71 from tubone24/openapi

Openapi
tubone24 · Apr 30, 2019 · 584ffef · 584ffef
2 parents df426b5 + f2ffaa8
commit 584ffef
Show file tree

Hide file tree

Showing 69 changed files with 13,105 additions and 4,925 deletions.
diff --git a/doc_src/_static/schema.yml b/doc_src/_static/schema.yml
@@ -0,0 +1,117 @@
+components:
+  schemas:
+    ConvertReq:
+      properties:
+        contentType:
+          type: string
+        uploadId:
+          type: string
+      required:
+      - contentType
+      - uploadId
+      type: object
+    DownloadReq:
+      properties:
+        uploadId:
+          type: string
+      required:
+      - uploadId
+      type: object
+    HealthCheck:
+      properties:
+        status:
+          type: string
+      type: object
+    UploadIdResp:
+      properties:
+        release_date:
+          format: date
+          type: string
+        upload_id:
+          type: string
+      type: object
+    UploadImagesReq:
+      properties:
+        contentType:
+          type: string
+        images:
+          items:
+            type: string
+          type: array
+      required:
+      - contentType
+      type: object
+info:
+  contact:
+    email: tubo.yyyuuu@gmail.com
+    name: tubone24
+    url: https://tubone-project24.xyz
+  description: Make PDF file taken in some image files such as jpeg, png and gif.
+  license:
+    name: MIT
+    url: https://opensource.org/licenses/MIT
+  title: Ebook-homebrew
+  version: 2.0.3
+openapi: 3.0.2
+paths:
+  /status:
+    get:
+      description: Get Status
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HealthCheck'
+          description: OK
+  /data/upload:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UploadImagesReq'
+        description: base64 encoded Images in images Array
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UploadIdResp'
+          description: OK
+      summary: Base64 encoded Images
+  /convert/pdf:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ConvertReq'
+        description: Upload Id and ContentType
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UploadIdResp'
+          description: OK
+      summary: Upload Id witch get upload images and ContentType
+  /convert/pdf/download:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DownloadReq'
+        description: Upload Id
+      responses:
+        '200':
+          content:
+            application/pdf:
+              schema:
+                format: binary
+                type: string
+          description: OK
+        '404':
+          description: FileNotFound
+      summary: Upload Id witch get upload images
diff --git a/doc_src/conf.py b/doc_src/conf.py
@@ -43,6 +43,7 @@
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
     'sphinx.ext.napoleon',
+    'sphinxcontrib.openapi',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/doc_src/index.rst b/doc_src/index.rst
@@ -106,16 +106,13 @@ Badges:
    :target: https://cloud.docker.com/repository/docker/tubone24/ebook-homebrew
    :alt: dockerhub
 
-.. image:: https://www.herokucdn.com/deploy/button.png
-   :target: https://heroku.com/deploy
-   :alt: Deploy to Heroku
-
 .. toctree::
    :maxdepth: 2
 
    installation.rst
    overview.rst
    howtouse.rst
+   restapi.rst
    deploy2heroku.rst
    releasenotes/index.rst
 

diff --git a/doc_src/restapi.rst b/doc_src/restapi.rst
@@ -0,0 +1,9 @@
+Rest API Reference
+==================
+
+API Reference
+
+.. openapi:: _static/schema.yml
+
+
+
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 65da6e1ee764ffd87bf57ba2266e1ec3
+config: b9f30851ea6eb7d563c7d22154d7efea
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_modules/ebook_homebrew/archive.html b/docs/_modules/ebook_homebrew/archive.html
@@ -17,32 +17,34 @@
 
 
 
-
-
+  <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
 
 
+      <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+        <script type="text/javascript" src="../../_static/jquery.js"></script>
+        <script type="text/javascript" src="../../_static/underscore.js"></script>
+        <script type="text/javascript" src="../../_static/doctools.js"></script>
+        <script type="text/javascript" src="../../_static/language_data.js"></script>
+
+    <script type="text/javascript" src="../../_static/js/theme.js"></script>
 
-
+    
 
+
   <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" /> 
-
-
-  <script src="../../_static/js/modernizr.min.js"></script>
-
 </head>
 
 <body class="wy-body-for-nav">
 
 
   <div class="wy-grid-for-nav">
-
 
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
-        <div class="wy-side-nav-search">
+        <div class="wy-side-nav-search" >
 
 
 
@@ -84,6 +86,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../overview.html">Overview</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../howtouse.html">How to use</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../restapi.html">Rest API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../deploy2heroku.html">Deploy to Heroku</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../releasenotes/index.html">Release Notes</a></li>
 </ul>
@@ -260,26 +263,16 @@ <h1>Source code for ebook_homebrew.archive</h1><div class="highlight"><pre>
 
 
 
-
-
-
-
-      <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
-        <script type="text/javascript" src="../../_static/jquery.js"></script>
-        <script type="text/javascript" src="../../_static/underscore.js"></script>
-        <script type="text/javascript" src="../../_static/doctools.js"></script>
-        <script type="text/javascript" src="../../_static/language_data.js"></script>
-
-
-
-
-  <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
+
+
+
+
+
 
 </body>
 </html>
diff --git a/docs/_modules/ebook_homebrew/cli.html b/docs/_modules/ebook_homebrew/cli.html
@@ -17,32 +17,34 @@
 
 
 
-
-
+  <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
 
 
+      <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+        <script type="text/javascript" src="../../_static/jquery.js"></script>
+        <script type="text/javascript" src="../../_static/underscore.js"></script>
+        <script type="text/javascript" src="../../_static/doctools.js"></script>
+        <script type="text/javascript" src="../../_static/language_data.js"></script>
+
+    <script type="text/javascript" src="../../_static/js/theme.js"></script>
 
-
+    
 
+
   <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" /> 
-
-
-  <script src="../../_static/js/modernizr.min.js"></script>
-
 </head>
 
 <body class="wy-body-for-nav">
 
 
   <div class="wy-grid-for-nav">
-
 
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
-        <div class="wy-side-nav-search">
+        <div class="wy-side-nav-search" >
 
 
 
@@ -84,6 +86,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../overview.html">Overview</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../howtouse.html">How to use</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../restapi.html">Rest API Reference</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../deploy2heroku.html">Deploy to Heroku</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../releasenotes/index.html">Release Notes</a></li>
 </ul>
@@ -388,26 +391,16 @@ <h1>Source code for ebook_homebrew.cli</h1><div class="highlight"><pre>
 
 
 
-
-
-
-
-      <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
-        <script type="text/javascript" src="../../_static/jquery.js"></script>
-        <script type="text/javascript" src="../../_static/underscore.js"></script>
-        <script type="text/javascript" src="../../_static/doctools.js"></script>
-        <script type="text/javascript" src="../../_static/language_data.js"></script>
-
-
-
-
-  <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script> 
+  </script>
+
+
+
+
+
 
 </body>
 </html>