Skip to content
This repository has been archived by the owner on Dec 25, 2022. It is now read-only.

Commit

Permalink
Merge pull request #74 from tubone24/openapi
Browse files Browse the repository at this point in the history
add version api
  • Loading branch information
tubone24 committed May 1, 2019
2 parents c6f878b + 79b3fbf commit 567a7a5
Show file tree
Hide file tree
Showing 20 changed files with 576 additions and 59 deletions.
2 changes: 2 additions & 0 deletions doc_src/_static/schema.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ components:
properties:
status:
type: string
version:
type: string
type: object
UploadIdResp:
properties:
Expand Down
22 changes: 22 additions & 0 deletions doc_src/ebook_homebrew.models.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
ebook\_homebrew.models package
==============================

Submodules
----------

ebook\_homebrew.models.models module
------------------------------------

.. automodule:: ebook_homebrew.models.models
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: ebook_homebrew.models
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions doc_src/ebook_homebrew.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Subpackages

.. toctree::

ebook_homebrew.models
ebook_homebrew.utils

Submodules
Expand Down
232 changes: 232 additions & 0 deletions docs/_modules/ebook_homebrew/models/models.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>ebook_homebrew.models.models &mdash; ebook_homebrew 1.0.0 documentation</title>








<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" />
</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" >



<a href="../../../index.html" class="icon icon-home"> ebook_homebrew



</a>




<div class="version">
1.0.0
</div>




<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>


</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">






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



</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" aria-label="top navigation">

<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">ebook_homebrew</a>

</nav>


<div class="wy-nav-content">

<div class="rst-content">

















<div role="navigation" aria-label="breadcrumbs navigation">

<ul class="wy-breadcrumbs">

<li><a href="../../../index.html">Docs</a> &raquo;</li>

<li><a href="../../index.html">Module code</a> &raquo;</li>

<li>ebook_homebrew.models.models</li>


<li class="wy-breadcrumbs-aside">

</li>

</ul>


<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<h1>Source code for ebook_homebrew.models.models</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;Provides Rest API models</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">datetime</span>


<div class="viewcode-block" id="StatusModel"><a class="viewcode-back" href="../../../ebook_homebrew.models.html#ebook_homebrew.models.models.StatusModel">[docs]</a><span class="k">class</span> <span class="nc">StatusModel</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Status Model&quot;&quot;&quot;</span>

<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">status</span><span class="p">,</span> <span class="n">version</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">status</span> <span class="o">=</span> <span class="n">status</span>
<span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o">=</span> <span class="n">version</span></div>


<div class="viewcode-block" id="UploadModel"><a class="viewcode-back" href="../../../ebook_homebrew.models.html#ebook_homebrew.models.models.UploadModel">[docs]</a><span class="k">class</span> <span class="nc">UploadModel</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Upload_id Model&quot;&quot;&quot;</span>

<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">upload_id</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">upload_id</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">upload_id</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">release_date</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span></div>


<div class="viewcode-block" id="ErrorModel"><a class="viewcode-back" href="../../../ebook_homebrew.models.html#ebook_homebrew.models.models.ErrorModel">[docs]</a><span class="k">class</span> <span class="nc">ErrorModel</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Error Model&quot;&quot;&quot;</span>

<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">error</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">error</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">error</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">errorDate</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span></div>


<div class="viewcode-block" id="FileNotFoundModel"><a class="viewcode-back" href="../../../ebook_homebrew.models.html#ebook_homebrew.models.models.FileNotFoundModel">[docs]</a><span class="k">class</span> <span class="nc">FileNotFoundModel</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;FileNotFound Model&quot;&quot;&quot;</span>

<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reason</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reason</span> <span class="o">=</span> <span class="n">reason</span>
<span class="bp">self</span><span class="o">.</span><span class="n">errorDate</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span></div>
</pre></div>

</div>

</div>
<footer>


<hr/>

<div role="contentinfo">
<p>
&copy; Copyright 2018, tubone

</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

</div>
</div>

</section>

</div>



<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>






</body>
</html>
31 changes: 4 additions & 27 deletions docs/_modules/ebook_homebrew/rest.html
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ <h1>Source code for ebook_homebrew.rest</h1><div class="highlight"><pre>

<span class="kn">from</span> <span class="nn">.convert</span> <span class="k">import</span> <span class="n">Image2PDF</span>
<span class="kn">from</span> <span class="nn">.utils.logging</span> <span class="k">import</span> <span class="n">get_logger</span>
<span class="kn">from</span> <span class="nn">.models.models</span> <span class="k">import</span> <span class="n">UploadModel</span><span class="p">,</span> <span class="n">ErrorModel</span><span class="p">,</span> <span class="n">FileNotFoundModel</span><span class="p">,</span> <span class="n">StatusModel</span>
<span class="kn">from</span> <span class="nn">.__init__</span> <span class="k">import</span> <span class="n">__version__</span>

<span class="n">api</span> <span class="o">=</span> <span class="n">responder</span><span class="o">.</span><span class="n">API</span><span class="p">(</span>
Expand Down Expand Up @@ -195,7 +196,8 @@ <h1>Source code for ebook_homebrew.rest</h1><div class="highlight"><pre>

<div class="viewcode-block" id="HealthCheckSchema"><a class="viewcode-back" href="../../ebook_homebrew.html#ebook_homebrew.rest.HealthCheckSchema">[docs]</a><span class="nd">@api</span><span class="o">.</span><span class="n">schema</span><span class="p">(</span><span class="s2">&quot;HealthCheck&quot;</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">HealthCheckSchema</span><span class="p">(</span><span class="n">Schema</span><span class="p">):</span>
<span class="n">status</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Str</span><span class="p">()</span></div>
<span class="n">status</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Str</span><span class="p">()</span>
<span class="n">version</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Str</span><span class="p">()</span></div>


<div class="viewcode-block" id="UploadImagesReqSchema"><a class="viewcode-back" href="../../ebook_homebrew.html#ebook_homebrew.rest.UploadImagesReqSchema">[docs]</a><span class="nd">@api</span><span class="o">.</span><span class="n">schema</span><span class="p">(</span><span class="s2">&quot;UploadImagesReq&quot;</span><span class="p">)</span>
Expand All @@ -210,14 +212,6 @@ <h1>Source code for ebook_homebrew.rest</h1><div class="highlight"><pre>
<span class="n">release_date</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Date</span><span class="p">()</span></div>


<div class="viewcode-block" id="UploadModel"><a class="viewcode-back" href="../../ebook_homebrew.html#ebook_homebrew.rest.UploadModel">[docs]</a><span class="k">class</span> <span class="nc">UploadModel</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Upload_id Model&quot;&quot;&quot;</span>

<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">upload_id</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">upload_id</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">upload_id</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">release_date</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span></div>


<div class="viewcode-block" id="ConvertReqSchema"><a class="viewcode-back" href="../../ebook_homebrew.html#ebook_homebrew.rest.ConvertReqSchema">[docs]</a><span class="nd">@api</span><span class="o">.</span><span class="n">schema</span><span class="p">(</span><span class="s2">&quot;ConvertReq&quot;</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">ConvertReqSchema</span><span class="p">(</span><span class="n">Schema</span><span class="p">):</span>
<span class="n">uploadId</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Str</span><span class="p">(</span><span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
Expand All @@ -229,28 +223,12 @@ <h1>Source code for ebook_homebrew.rest</h1><div class="highlight"><pre>
<span class="n">uploadId</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Str</span><span class="p">(</span><span class="n">required</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div>


<div class="viewcode-block" id="ErrorModel"><a class="viewcode-back" href="../../ebook_homebrew.html#ebook_homebrew.rest.ErrorModel">[docs]</a><span class="k">class</span> <span class="nc">ErrorModel</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Error Model&quot;&quot;&quot;</span>

<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">error</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">error</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">error</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">errorDate</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span></div>


<div class="viewcode-block" id="ErrorRespSchema"><a class="viewcode-back" href="../../ebook_homebrew.html#ebook_homebrew.rest.ErrorRespSchema">[docs]</a><span class="nd">@api</span><span class="o">.</span><span class="n">schema</span><span class="p">(</span><span class="s2">&quot;ErrorResp&quot;</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">ErrorRespSchema</span><span class="p">(</span><span class="n">Schema</span><span class="p">):</span>
<span class="n">error</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Str</span><span class="p">()</span>
<span class="n">errorDate</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Date</span><span class="p">()</span></div>


<div class="viewcode-block" id="FileNotFoundModel"><a class="viewcode-back" href="../../ebook_homebrew.html#ebook_homebrew.rest.FileNotFoundModel">[docs]</a><span class="k">class</span> <span class="nc">FileNotFoundModel</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;FileNotFound Model&quot;&quot;&quot;</span>

<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reason</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reason</span> <span class="o">=</span> <span class="n">reason</span>
<span class="bp">self</span><span class="o">.</span><span class="n">errorDate</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span></div>


<div class="viewcode-block" id="FileNotFoundRespSchema"><a class="viewcode-back" href="../../ebook_homebrew.html#ebook_homebrew.rest.FileNotFoundRespSchema">[docs]</a><span class="nd">@api</span><span class="o">.</span><span class="n">schema</span><span class="p">(</span><span class="s2">&quot;FileNotFoundResp&quot;</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">FileNotFoundRespSchema</span><span class="p">(</span><span class="n">Schema</span><span class="p">):</span>
<span class="n">reason</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Str</span><span class="p">()</span>
Expand All @@ -275,8 +253,7 @@ <h1>Source code for ebook_homebrew.rest</h1><div class="highlight"><pre>
<span class="sd"> $ref: &quot;#/components/schemas/HealthCheck&quot;</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;health Check&quot;</span><span class="p">)</span>
<span class="n">Status</span> <span class="o">=</span> <span class="n">namedtuple</span><span class="p">(</span><span class="s2">&quot;Status&quot;</span><span class="p">,</span> <span class="p">[</span><span class="s2">&quot;status&quot;</span><span class="p">])</span>
<span class="n">resp</span><span class="o">.</span><span class="n">media</span> <span class="o">=</span> <span class="n">HealthCheckSchema</span><span class="p">()</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="n">Status</span><span class="p">(</span><span class="s2">&quot;ok&quot;</span><span class="p">))</span><span class="o">.</span><span class="n">data</span></div>
<span class="n">resp</span><span class="o">.</span><span class="n">media</span> <span class="o">=</span> <span class="n">HealthCheckSchema</span><span class="p">()</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="n">StatusModel</span><span class="p">(</span><span class="s2">&quot;ok&quot;</span><span class="p">,</span> <span class="n">__version__</span><span class="p">))</span><span class="o">.</span><span class="n">data</span></div>


<div class="viewcode-block" id="upload_image_file"><a class="viewcode-back" href="../../ebook_homebrew.html#ebook_homebrew.rest.upload_image_file">[docs]</a><span class="nd">@api</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">&quot;/data/upload&quot;</span><span class="p">)</span>
Expand Down

0 comments on commit 567a7a5

Please sign in to comment.