-
Notifications
You must be signed in to change notification settings - Fork 43
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
[RFE] Create OpenAPI Spec #193
Comments
Based on the discussion we had, I think you might want to take a look at this @p3ck |
Some generated documentation can be accessed on |
The goal is to get rid of XMLRPC and Turbogears, so tooling is not necessary in this case. |
But good point @mdujava, I updated the description to make that clear. |
Yeah, I would say when creating new REST api that would preserve functionality, would be easier and less problems would be introduced when existing API would be somehow defined (eg. list of all methods/endpoints). |
Is your feature request related to a problem? Please describe.
The Beaker Server and Beaker Labcontroller API are not properly documented.
Describe the solution you'd like
Create OpenAPI Spec for Beaker Server and Beaker Labcontroller.
This will be the source of truth for implementation.
Endpoints currently exposed via XMLRPC and/or TurboGears will be removed as part of the transition to Python 3. There is no need to document them at all. They will be reintroduced as REST (we will need them to paint the UI, communicate with client, etc..)
Describe alternatives you've considered
Avoid writing documentation, but I felt like people might not like it.
The text was updated successfully, but these errors were encountered: