-
Notifications
You must be signed in to change notification settings - Fork 189
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Automatically document the REST API with cornice.
fixes #1323 Signed-off-by: Randy Barlow <randy@electronsweatshop.com>
- Loading branch information
1 parent
f38b96d
commit 8212bdc
Showing
15 changed files
with
84 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,7 +15,7 @@ Contents: | |
man_pages/index | ||
python_bindings | ||
developer_docs | ||
services | ||
rest_api/index | ||
release_notes | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Builds | ||
====== | ||
|
||
.. cornice-autodoc:: | ||
:modules: bodhi.server.services.builds | ||
:services: build, builds |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Comments | ||
======== | ||
|
||
.. cornice-autodoc:: | ||
:modules: bodhi.server.services.comments | ||
:services: comment, comments, comments_rss |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
CSRF | ||
==== | ||
|
||
.. cornice-autodoc:: | ||
:modules: bodhi.server.services.csrf | ||
:services: csrf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
Bodhi REST API | ||
============== | ||
|
||
This section of the documentation describes Bodhi's REST API. You can read about the various | ||
sections of the API by following the links below: | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
builds | ||
comments | ||
csrf | ||
markdown | ||
overrides | ||
packages | ||
releases | ||
stacks | ||
updates | ||
users |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Markdown | ||
======== | ||
|
||
.. cornice-autodoc:: | ||
:modules: bodhi.server.services.markdown | ||
:services: markdowner |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
Overrides | ||
========= | ||
|
||
|
||
.. cornice-autodoc:: | ||
:modules: bodhi.server.services.overrides | ||
:services: override, overrides, overrides_rss |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Packages | ||
======== | ||
|
||
.. cornice-autodoc:: | ||
:modules: bodhi.server.services.packages | ||
:services: packages |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Releases | ||
======== | ||
|
||
.. cornice-autodoc:: | ||
:modules: bodhi.server.services.releases | ||
:services: release, releases |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Stacks | ||
====== | ||
|
||
.. cornice-autodoc:: | ||
:modules: bodhi.server.services.stacks | ||
:services: stack, stacks |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Updates | ||
======= | ||
|
||
.. cornice-autodoc:: | ||
:modules: bodhi.server.services.updates, bodhi.server.services.zz_redirects | ||
:services: bodhi1_update_redirect, update, update_edit, update_request, updates, updates_rss |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
Users | ||
===== | ||
|
||
.. cornice-autodoc:: | ||
:modules: bodhi.server.services.user | ||
:services: user, users, users_rss |
This file was deleted.
Oops, something went wrong.