--- coprs_frontend/coprs/logic/coprs_logic.py | 6 ++++++ coprs_frontend/coprs/views/api_ns/api_general.py | 15 ++++++++++++--- 2 files changed, 18 insertions(+), 3 deletions(-)
diff --git a/coprs_frontend/coprs/logic/coprs_logic.py b/coprs_frontend/coprs/logic/coprs_logic.py index 77599c5..5129a82 100644 --- a/coprs_frontend/coprs/logic/coprs_logic.py +++ b/coprs_frontend/coprs/logic/coprs_logic.py @@ -41,6 +41,7 @@ class CoprsLogic(object): user_relation = kwargs.get('user_relation', None) username = kwargs.get('username', None) with_mock_chroots = kwargs.get('with_mock_chroots', None) + with_builds = kwargs.get('with_builds', None) incl_deleted = kwargs.get('incl_deleted', None) ids = kwargs.get('ids', None)
@@ -70,6 +71,11 @@ class CoprsLogic(object): order_by(models.MockChroot.os_version.asc()).\ order_by(models.MockChroot.arch.asc())
+ if with_builds: + query = query.outerjoin(models.Copr.builds).\ + options(db.contains_eager(models.Copr.builds)).\ + order_by(models.Build.submitted_on.desc()) + return query
@classmethod diff --git a/coprs_frontend/coprs/views/api_ns/api_general.py b/coprs_frontend/coprs/views/api_ns/api_general.py index 8d42745..97e4c03 100644 --- a/coprs_frontend/coprs/views/api_ns/api_general.py +++ b/coprs_frontend/coprs/views/api_ns/api_general.py @@ -3,6 +3,7 @@ import time
import base64 import flask +import urlparse
from coprs import db from coprs import exceptions @@ -116,12 +117,21 @@ def api_coprs_by_owner(username=None): httpcode = 200 if username: query = coprs_logic.CoprsLogic.get_multiple(flask.g.user, - user_relation='owned', username=username) + user_relation='owned', username=username, with_builds=True) repos = query.all() output = {'output': 'ok', 'repos': []} for repo in repos: + yum_repos = {} + for build in repo.builds: + if build.results: + for chroot in repo.active_mock_chroots: + release = '{chroot.os_release}-{chroot.os_version}-{chroot.arch}'.format(chroot=chroot) + yum_repos[release] = urlparse.urljoin(build.results, release + '/') + break + output['repos'].append({'name': repo.name, - 'repos': repo.repos, + 'additional_repos': repo.repos, + 'yum_repos': yum_repos, 'description': repo.description, 'instructions': repo.instructions}) else: @@ -132,7 +142,6 @@ def api_coprs_by_owner(username=None): jsonout.status_code = httpcode return jsonout
- @api_ns.route('/coprs/<username>/<coprname>/new_build/', methods=["POST"]) @api_login_required def copr_new_build(username, coprname):
--- coprs_frontend/coprs/templates/api.html | 137 +++++++++++++++++++++++--------- 1 file changed, 99 insertions(+), 38 deletions(-)
diff --git a/coprs_frontend/coprs/templates/api.html b/coprs_frontend/coprs/templates/api.html index 6501147..641a047 100644 --- a/coprs_frontend/coprs/templates/api.html +++ b/coprs_frontend/coprs/templates/api.html @@ -5,15 +5,15 @@ {% if error %}<p class="error"><strong>Error:</strong> {{ error }}</p>{% endif %}
<div> - <h2>Coprs API</h2> + <h1>Coprs API</h1>
- <h3> API Token </h3> + <h2> API Token </h2> <p>In order to access the API, you will need to provide an API token. This token is unique, specific to you and <span style="font-weight:bold;"> should not be shared!</span>. </p>
- <p>The API token is valid for {{ config['API_TOKEN_EXPIRATION'] }} days after you generated it. + <p>The API token is valid for {{ config['API_TOKEN_EXPIRATION'] }} days after it has been generated. </p>
{% if g.user %} @@ -28,52 +28,113 @@ <input type="button" value="Generate a new token" /> </a> {% else %} - <p style="font-style:italic">You need to be logged in to see you API token.</p> + <p style="font-style:italic">You need to be logged in to see your API token.</p> {% endif %}
- <h3>The API</h3> + <h2>The API</h2>
- <h4>List someone's copr</h4> + <p>To make an API call to Copr, make a request to URL corresponding to + given call (URLs are listed below). Parameters are denoted by angle + brackets. Result is represented as JSON map with "output": "ok" key-value + pair on success or "output": "notok" on failure. The rest of the map + represents result of the call and is described below for individual + calls.</p>
- <p>To list the coprs owned by someone one argument is required:</p> - <table> - <tr> - <th>name</th> <td>The name of the user you would to list the - copr of.</td> - </tr> - </table> - <p>URL is:</p> - <pre style="font-size:120%"> - /api/owned/<username>/ + <h3>List someone's coprs</h3> + + <h4>URL:</h4> + <pre style="font-size:120%">/api/coprs/<username>/</pre> + <div>or</div> + <pre style="font-size:120%">/api/coprs/?username="<username>"</pre> + + <h4>URL parameters:</h4> + <ul> + <li><b>username</b> – The name of the user whose coprs you'd like + to list</li> + </ul> + + <h4>Result:</h4> + <ul> + <li><b>"repos"</b> – List of coprs in given format: + <ul> + <li><b>"yum_repos"</b> – Map of chroots to yum repository + URLs. Chroots are in format + "<release>-<version>-<architecture>"</li> + <li><b>"additional_repos"</b> – List of additional + repositories that are required for this copr</li> + <li><b>"instructions"</b> – Installation instructions + provided by copr's owner </li> + <li><b>"name"</b> – Name of the copr</li> + <li><b>"description"</b> – Description provided by copr's + owner </li> + </ul> + </ul> + + <h4>Example call URL</h4> + <pre style="font-size:120%">http://copr-fe.cloud.fedoraproject.org/api/coprs/jdaniels/</pre> + + <h4>Example results</h4> + <pre> + { + "output": "ok", + "repos": [ + { + "yum_repos": { + "fedora-19-i686": "http://copr-be.cloud.fedoraproject.org/results/jdaniels/log4j/fedora-19-i686..." + "fedora-19-x86_64": "http://copr-be.cloud.fedoraproject.org/results/jdaniels/log4j/fedora-19-x86_..." + }, + "additional_repos": "", + "instructions": "", + "name": "log4j", + "description": "Java logging package" + } + ] + } </pre>
- <h4>Add a new copr</h4> + + <h3>Create new copr</h3>
<p><span style="font-style:italic">Login required</span></p>
- <p>To add a new copr some informations are required:</p> - <table> - <tr> - <th>name</th> <td>The name of the copr to create.</td> - </tr><tr> - <th>chroots</th> <td>A comma separated list of chroots to - use in the copr.</td> - </tr><tr> - <th>repos</th> <td>A comma separated list of repositories - that this new copr should have access to.</td> - </tr><tr> - <th>initial_pkgs</th> <td>A comma separated list of initial - packages to build in this new copr.</td> - </tr> - </table> - - <p>URL is:</p> - <pre style="font-size:120%"> - /api/copr/new/ - </pre> + <h4>URL:</h4> + <pre style="font-size:120%">/api/copr/<username>/new/</pre> + + <h4>URL parameters:</h4> + <ul> + <li><b>username</b> – The name of the user whose copr should be + created</li> + </ul> + + <h4>Parameters sent by POST:</h4> + <ul> + <li><b>name</b> – The name of the copr to be created</li> + <li><b>chroots</b> – A comma separated list of chroots to + use in the copr</li> + <li><b>repos</b> – A comma separated list of repositories + that this new copr should have access to</li> + <li><b>initial_pkgs</b> – A comma separated list of initial + packages to build in this new copr</li> + </ul> + + <h3>Add new build</h3> + + <p><span style="font-style:italic">Login required</span></p> + + <h4>URL:</h4> + <pre style="font-size:120%">/api/copr/<username>/<coprname>/new_build/</pre>
+ <h4>URL parameters:</h4> + <ul> + <li><b>username</b> – The name of given copr's owner</li> + <li><b>coprname</b> – The name of the copr in which the package + should be built</li> + </ul>
- <p>To come here, more information about the API itself.</p> + <h4>Parameters sent by POST:</h4> + <ul> + <li><b>pkgs</b> – Space separated list of package URLs (SRPMs) to be built</li> + </ul>
</div> {% endblock %}
copr-devel@lists.fedorahosted.org
-
Michael Šimáček