2018-05-12 00:18:21 +00:00
<!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" >
2020-09-08 18:59:15 +00:00
< title > pylorax.api.server — Lorax 34.0 documentation< / title >
2018-05-12 00:18:21 +00:00
2019-03-27 23:44:14 +00:00
< script type = "text/javascript" src = "../../../_static/js/modernizr.min.js" > < / script >
2018-05-12 00:18:21 +00:00
2019-03-27 23:44:14 +00:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "../../../" src = "../../../_static/documentation_options.js" > < / script >
2020-09-08 18:59:15 +00:00
< script src = "../../../_static/jquery.js" > < / script >
< script src = "../../../_static/underscore.js" > < / script >
< script src = "../../../_static/doctools.js" > < / script >
< script src = "../../../_static/language_data.js" > < / script >
2019-03-27 23:44:14 +00:00
< script type = "text/javascript" src = "../../../_static/js/theme.js" > < / script >
2018-05-12 00:18:21 +00:00
2019-03-27 23:44:14 +00:00
2018-05-12 00:18:21 +00:00
2019-03-27 23:44:14 +00:00
2018-11-13 17:53:31 +00:00
< link rel = "stylesheet" href = "../../../_static/css/theme.css" type = "text/css" / >
2018-05-12 00:18:21 +00:00
< 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" >
2019-03-27 23:44:14 +00:00
< div class = "wy-side-nav-search" >
2018-05-12 00:18:21 +00:00
< a href = "../../../index.html" class = "icon icon-home" > Lorax
< / a >
< div class = "version" >
2020-09-08 18:59:15 +00:00
34.0
2018-05-12 00:18:21 +00:00
< / 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 = "../../../intro.html" > Introduction to Lorax< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../intro.html#before-lorax" > Before Lorax< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../lorax.html" > Lorax< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../livemedia-creator.html" > livemedia-creator< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../lorax-composer.html" > lorax-composer< / a > < / li >
2018-10-24 17:07:32 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../composer-cli.html" > composer-cli< / a > < / li >
2019-11-05 22:36:46 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../mkksiso.html" > mkksiso< / a > < / li >
2018-05-12 00:18:21 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../product-images.html" > Product and Updates Images< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../../modules.html" > src< / 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" > Lorax< / 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 > » < / li >
< li > < a href = "../../index.html" > Module code< / a > » < / li >
< li > < a href = "../../pylorax.html" > pylorax< / a > » < / li >
< li > pylorax.api.server< / 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 pylorax.api.server< / h1 > < div class = "highlight" > < pre >
< span > < / span > < span class = "c1" > #< / span >
2019-06-18 22:02:04 +00:00
< span class = "c1" > # Copyright (C) 2017-2019 Red Hat, Inc.< / span >
2018-05-12 00:18:21 +00:00
< span class = "c1" > #< / span >
< span class = "c1" > # This program is free software; you can redistribute it and/or modify< / span >
< span class = "c1" > # it under the terms of the GNU General Public License as published by< / span >
< span class = "c1" > # the Free Software Foundation; either version 2 of the License, or< / span >
< span class = "c1" > # (at your option) any later version.< / span >
< span class = "c1" > #< / span >
< span class = "c1" > # This program is distributed in the hope that it will be useful,< / span >
< span class = "c1" > # but WITHOUT ANY WARRANTY; without even the implied warranty of< / span >
< span class = "c1" > # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the< / span >
< span class = "c1" > # GNU General Public License for more details.< / span >
< span class = "c1" > #< / span >
< span class = "c1" > # You should have received a copy of the GNU General Public License< / span >
< span class = "c1" > # along with this program. If not, see < http://www.gnu.org/licenses/> .< / span >
< span class = "c1" > #< / span >
< span class = "kn" > import< / span > < span class = "nn" > logging< / span >
< span class = "n" > log< / span > < span class = "o" > =< / span > < span class = "n" > logging< / span > < span class = "o" > .< / span > < span class = "n" > getLogger< / span > < span class = "p" > (< / span > < span class = "s2" > " lorax-composer" < / span > < span class = "p" > )< / span >
2020-09-08 18:59:15 +00:00
< span class = "kn" > from< / span > < span class = "nn" > collections< / span > < span class = "kn" > import< / span > < span class = "n" > namedtuple< / span >
< span class = "kn" > from< / span > < span class = "nn" > flask< / span > < span class = "kn" > import< / span > < span class = "n" > Flask< / span > < span class = "p" > ,< / span > < span class = "n" > jsonify< / span > < span class = "p" > ,< / span > < span class = "n" > redirect< / span > < span class = "p" > ,< / span > < span class = "n" > send_from_directory< / span >
< span class = "kn" > from< / span > < span class = "nn" > glob< / span > < span class = "kn" > import< / span > < span class = "n" > glob< / span >
2018-05-12 00:18:21 +00:00
< span class = "kn" > import< / span > < span class = "nn" > os< / span >
2019-06-18 22:02:04 +00:00
< span class = "kn" > import< / span > < span class = "nn" > werkzeug< / span >
2018-05-12 00:18:21 +00:00
2020-09-08 18:59:15 +00:00
< span class = "kn" > from< / span > < span class = "nn" > pylorax< / span > < span class = "kn" > import< / span > < span class = "n" > vernum< / span >
< span class = "kn" > from< / span > < span class = "nn" > pylorax.api.errors< / span > < span class = "kn" > import< / span > < span class = "n" > HTTP_ERROR< / span >
< span class = "kn" > from< / span > < span class = "nn" > pylorax.api.v0< / span > < span class = "kn" > import< / span > < span class = "n" > v0_api< / span >
< span class = "kn" > from< / span > < span class = "nn" > pylorax.api.v1< / span > < span class = "kn" > import< / span > < span class = "n" > v1_api< / span >
< span class = "kn" > from< / span > < span class = "nn" > pylorax.sysutils< / span > < span class = "kn" > import< / span > < span class = "n" > joinpaths< / span >
2018-05-12 00:18:21 +00:00
< span class = "n" > GitLock< / span > < span class = "o" > =< / span > < span class = "n" > namedtuple< / span > < span class = "p" > (< / span > < span class = "s2" > " GitLock" < / span > < span class = "p" > ,< / span > < span class = "p" > [< / span > < span class = "s2" > " repo" < / span > < span class = "p" > ,< / span > < span class = "s2" > " lock" < / span > < span class = "p" > ,< / span > < span class = "s2" > " dir" < / span > < span class = "p" > ])< / span >
< span class = "n" > server< / span > < span class = "o" > =< / span > < span class = "n" > Flask< / span > < span class = "p" > (< / span > < span class = "vm" > __name__< / span > < span class = "p" > )< / span >
< span class = "n" > __all__< / span > < span class = "o" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " server" < / span > < span class = "p" > ,< / span > < span class = "s2" > " GitLock" < / span > < span class = "p" > ]< / span >
< span class = "nd" > @server< / span > < span class = "o" > .< / span > < span class = "n" > route< / span > < span class = "p" > (< / span > < span class = "s1" > ' /' < / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > server_root< / span > < span class = "p" > ():< / span >
< span class = "n" > redirect< / span > < span class = "p" > (< / span > < span class = "s2" > " /api/docs/" < / span > < span class = "p" > )< / span >
< span class = "nd" > @server< / span > < span class = "o" > .< / span > < span class = "n" > route< / span > < span class = "p" > (< / span > < span class = "s2" > " /api/docs/" < / span > < span class = "p" > )< / span >
< span class = "nd" > @server< / span > < span class = "o" > .< / span > < span class = "n" > route< / span > < span class = "p" > (< / span > < span class = "s2" > " /api/docs/< path:path> " < / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > api_docs< / span > < span class = "p" > (< / span > < span class = "n" > path< / span > < span class = "o" > =< / span > < span class = "kc" > None< / span > < span class = "p" > ):< / span >
< span class = "c1" > # Find the html docs< / span >
< span class = "k" > try< / span > < span class = "p" > :< / span >
< span class = "c1" > # This assumes it is running from the source tree< / span >
< span class = "n" > docs_path< / span > < span class = "o" > =< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > path< / span > < span class = "o" > .< / span > < span class = "n" > abspath< / span > < span class = "p" > (< / span > < span class = "n" > joinpaths< / span > < span class = "p" > (< / span > < span class = "n" > os< / span > < span class = "o" > .< / span > < span class = "n" > path< / span > < span class = "o" > .< / span > < span class = "n" > dirname< / span > < span class = "p" > (< / span > < span class = "vm" > __file__< / span > < span class = "p" > ),< / span > < span class = "s2" > " ../../../docs/html" < / span > < span class = "p" > ))< / span >
< span class = "k" > except< / span > < span class = "ne" > IndexError< / span > < span class = "p" > :< / span >
< span class = "n" > docs_path< / span > < span class = "o" > =< / span > < span class = "n" > glob< / span > < span class = "p" > (< / span > < span class = "s2" > " /usr/share/doc/lorax-*/html/" < / span > < span class = "p" > )[< / span > < span class = "mi" > 0< / span > < span class = "p" > ]< / span >
< span class = "k" > if< / span > < span class = "ow" > not< / span > < span class = "n" > path< / span > < span class = "p" > :< / span >
< span class = "n" > path< / span > < span class = "o" > =< / span > < span class = "s2" > " index.html" < / span >
< span class = "k" > return< / span > < span class = "n" > send_from_directory< / span > < span class = "p" > (< / span > < span class = "n" > docs_path< / span > < span class = "p" > ,< / span > < span class = "n" > path< / span > < span class = "p" > )< / span >
< span class = "nd" > @server< / span > < span class = "o" > .< / span > < span class = "n" > route< / span > < span class = "p" > (< / span > < span class = "s2" > " /api/status" < / span > < span class = "p" > )< / span >
2019-10-16 21:01:30 +00:00
< span class = "k" > def< / span > < span class = "nf" > api_status< / span > < span class = "p" > ():< / span >
2018-05-12 00:18:21 +00:00
< span class = "sd" > " " " < / span >
2019-10-16 21:01:30 +00:00
< span class = "sd" > `/api/status`< / span >
2018-05-12 00:18:21 +00:00
< span class = "sd" > ^^^^^^^^^^^^^^^^< / span >
< span class = "sd" > Return the status of the API Server::< / span >
< span class = "sd" > { " api" : " 0" ,< / span >
< span class = "sd" > " build" : " devel" ,< / span >
< span class = "sd" > " db_supported" : true,< / span >
< span class = "sd" > " db_version" : " 0" ,< / span >
< span class = "sd" > " schema_version" : " 0" ,< / span >
2018-07-20 22:51:06 +00:00
< span class = "sd" > " backend" : " lorax-composer" ,< / span >
< span class = "sd" > " msgs" : []}< / span >
< span class = "sd" > The ' msgs' field can be a list of strings describing startup problems or status that< / span >
< span class = "sd" > should be displayed to the user. eg. if the compose templates are not depsolving properly< / span >
< span class = "sd" > the errors will be in ' msgs' .< / span >
2018-05-12 00:18:21 +00:00
< span class = "sd" > " " " < / span >
< span class = "k" > return< / span > < span class = "n" > jsonify< / span > < span class = "p" > (< / span > < span class = "n" > backend< / span > < span class = "o" > =< / span > < span class = "s2" > " lorax-composer" < / span > < span class = "p" > ,< / span >
< span class = "n" > build< / span > < span class = "o" > =< / span > < span class = "n" > vernum< / span > < span class = "p" > ,< / span >
2019-10-16 21:01:30 +00:00
< span class = "n" > api< / span > < span class = "o" > =< / span > < span class = "s2" > " 1" < / span > < span class = "p" > ,< / span >
2018-05-12 00:18:21 +00:00
< span class = "n" > db_version< / span > < span class = "o" > =< / span > < span class = "s2" > " 0" < / span > < span class = "p" > ,< / span >
< span class = "n" > schema_version< / span > < span class = "o" > =< / span > < span class = "s2" > " 0" < / span > < span class = "p" > ,< / span >
2018-07-20 22:51:06 +00:00
< span class = "n" > db_supported< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > ,< / span >
< span class = "n" > msgs< / span > < span class = "o" > =< / span > < span class = "n" > server< / span > < span class = "o" > .< / span > < span class = "n" > config< / span > < span class = "p" > [< / span > < span class = "s2" > " TEMPLATE_ERRORS" < / span > < span class = "p" > ])< / span >
2018-05-12 00:18:21 +00:00
2019-06-18 22:02:04 +00:00
< span class = "nd" > @server< / span > < span class = "o" > .< / span > < span class = "n" > errorhandler< / span > < span class = "p" > (< / span > < span class = "n" > werkzeug< / span > < span class = "o" > .< / span > < span class = "n" > exceptions< / span > < span class = "o" > .< / span > < span class = "n" > HTTPException< / span > < span class = "p" > )< / span >
< span class = "k" > def< / span > < span class = "nf" > bad_request< / span > < span class = "p" > (< / span > < span class = "n" > error< / span > < span class = "p" > ):< / span >
< span class = "k" > return< / span > < span class = "n" > jsonify< / span > < span class = "p" > (< / span > < span class = "n" > status< / span > < span class = "o" > =< / span > < span class = "kc" > False< / span > < span class = "p" > ,< / span > < span class = "n" > errors< / span > < span class = "o" > =< / span > < span class = "p" > [{< / span > < span class = "s2" > " id" < / span > < span class = "p" > :< / span > < span class = "n" > HTTP_ERROR< / span > < span class = "p" > ,< / span > < span class = "s2" > " code" < / span > < span class = "p" > :< / span > < span class = "n" > error< / span > < span class = "o" > .< / span > < span class = "n" > code< / span > < span class = "p" > ,< / span > < span class = "s2" > " msg" < / span > < span class = "p" > :< / span > < span class = "n" > error< / span > < span class = "o" > .< / span > < span class = "n" > name< / span > < span class = "p" > }]),< / span > < span class = "n" > error< / span > < span class = "o" > .< / span > < span class = "n" > code< / span >
< span class = "c1" > # Register the v0 API on /api/v0/< / span >
< span class = "n" > server< / span > < span class = "o" > .< / span > < span class = "n" > register_blueprint< / span > < span class = "p" > (< / span > < span class = "n" > v0_api< / span > < span class = "p" > ,< / span > < span class = "n" > url_prefix< / span > < span class = "o" > =< / span > < span class = "s2" > " /api/v0/" < / span > < span class = "p" > )< / span >
2019-10-16 21:01:30 +00:00
< span class = "c1" > # Register the v1 API on /api/v1/< / span >
< span class = "c1" > # Use v0 routes by default< / span >
< span class = "n" > skip_rules< / span > < span class = "o" > =< / span > < span class = "p" > [< / span >
< span class = "s2" > " /compose" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " /compose/queue" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " /compose/finished" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " /compose/failed" < / span > < span class = "p" > ,< / span >
< span class = "s2" > " /compose/status/< uuids> " < / span > < span class = "p" > ,< / span >
< span class = "s2" > " /compose/info/< uuid> " < / span > < span class = "p" > ,< / span >
< span class = "s2" > " /projects/source/info/< source_names> " < / span > < span class = "p" > ,< / span >
< span class = "s2" > " /projects/source/new" < / span > < span class = "p" > ,< / span >
< span class = "p" > ]< / span >
< span class = "n" > server< / span > < span class = "o" > .< / span > < span class = "n" > register_blueprint< / span > < span class = "p" > (< / span > < span class = "n" > v0_api< / span > < span class = "p" > ,< / span > < span class = "n" > url_prefix< / span > < span class = "o" > =< / span > < span class = "s2" > " /api/v1/" < / span > < span class = "p" > ,< / span > < span class = "n" > skip_rules< / span > < span class = "o" > =< / span > < span class = "n" > skip_rules< / span > < span class = "p" > )< / span >
< span class = "n" > server< / span > < span class = "o" > .< / span > < span class = "n" > register_blueprint< / span > < span class = "p" > (< / span > < span class = "n" > v1_api< / span > < span class = "p" > ,< / span > < span class = "n" > url_prefix< / span > < span class = "o" > =< / span > < span class = "s2" > " /api/v1/" < / span > < span class = "p" > )< / span >
2018-05-12 00:18:21 +00:00
< / pre > < / div >
< / div >
< / div >
< footer >
< hr / >
< div role = "contentinfo" >
< p >
2018-11-13 17:53:31 +00:00
© Copyright 2018, Red Hat, Inc.
2018-05-12 00:18:21 +00:00
< / 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 () {
2018-06-04 23:27:56 +00:00
SphinxRtdTheme.Navigation.enable(true);
2018-05-12 00:18:21 +00:00
});
2019-03-27 23:44:14 +00:00
< / script >
2018-05-12 00:18:21 +00:00
< / body >
< / html >
