Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the REST API #1323

Closed
bowlofeggs opened this issue Mar 3, 2017 · 0 comments
Closed

Document the REST API #1323

bowlofeggs opened this issue Mar 3, 2017 · 0 comments
Assignees
@bowlofeggs
Labels
Docs Issues pertaining to Bodhi's documentation High priority These issues are higher priority than normal
Milestone
Modularity support

Comments

@bowlofeggs
Copy link
Contributor

We need to document the REST API. The API had been automatically documented at some point in the past, but that stopped working and was removed (so that the docs could be built):

b3f80b1

We should either figure out how to get Cornice working again, find another automatic solution for documenting the REST API, or at least basically document it by hand as a last resort.

This is high priority as it will be needed for converting Bodhi to have multiple content types.
@bowlofeggs bowlofeggs added Docs Issues pertaining to Bodhi's documentation High priority These issues are higher priority than normal labels Mar 3, 2017
@lmacken lmacken mentioned this issue Mar 3, 2017
Closed
10 tasks
@bowlofeggs bowlofeggs added this to the Multi-type support (Bodhi 3.0.0?) milestone Mar 3, 2017
@bowlofeggs bowlofeggs self-assigned this Mar 7, 2017
bowlofeggs added a commit that referenced this issue Mar 8, 2017
@bowlofeggs
Automatically document the REST API with cornice.
8212bdc 
fixes #1323

Signed-off-by: Randy Barlow <randy@electronsweatshop.com>
bowlofeggs added a commit that referenced this issue Mar 8, 2017
@bowlofeggs
Automatically document the REST API with cornice.
72c9895 
fixes #1323

Signed-off-by: Randy Barlow <randy@electronsweatshop.com>
bowlofeggs added a commit to bowlofeggs/bodhi that referenced this issue Mar 8, 2017
@bowlofeggs
Automatically document the REST API with cornice.
638ba32 
fixes fedora-infra#1323

Signed-off-by: Randy Barlow <randy@electronsweatshop.com>
@bowlofeggs bowlofeggs mentioned this issue Mar 8, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bowlofeggs bowlofeggs

Labels
Docs Issues pertaining to Bodhi's documentation High priority These issues are higher priority than normal
Projects
None yet
Milestone
Modularity support
Development

Successfully merging a pull request may close this issue.

Documentation improvements fedora-infra/bodhi
1 participant
@bowlofeggs