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.

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

Document bookkeeper REST API #50

Open
gothub opened this issue Jul 7, 2020 · 4 comments
Open

Document bookkeeper REST API #50

gothub opened this issue Jul 7, 2020 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@gothub
Copy link
Collaborator

gothub commented Jul 7, 2020

Create a Swagger API definition for the bookkeeper REST API.

@gothub
Copy link
Collaborator Author

gothub commented Jul 12, 2020

@csjx I started a Swagger.io api description for bookkeeper, with '/quotas' and '/usages' almost complete. Should this be added to the bookkeeper documentation? The Swagger definition can be exported to html and other formats.
The definition is temporarily located at https://app.swaggerhub.com/apis/gothub/bookkeeper/1.0.0, until a newer location is determined.

@csjx
Copy link
Member

csjx commented Jul 13, 2020

@gothub - I think this is great. As we discussed earlier, developing the API on Swaggerhub with a DataONE account would be great for shared development. And yes, it should be referenced into the documentation, so I'll think about how to incorporate it into the RST files, or just reference it externally.

@csjx csjx self-assigned this Sep 27, 2020
@csjx csjx added the documentation Improvements or additions to documentation label Sep 27, 2020
@csjx csjx added this to the 1.0.0 release milestone Sep 27, 2020
@csjx
Copy link
Member

csjx commented Sep 27, 2020

I've worked on proposed changes from @gothub 's initial documentation and temporarily added them here: https://app.swaggerhub.com/apis/csjx/dataone-bookkeeper/v1#/ . Once reviewed, I'll move this to the dataoneorg account on Swaggerhub.

@mbjones
Copy link
Member

mbjones commented Apr 11, 2023

I've moved this to https://app.swaggerhub.com/apis/mbjones/dataone-bookkeeper/v1#/ for further editing in prep of the release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants