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

[RFE] Create OpenAPI Spec #193

Open
StykMartin opened this issue Dec 21, 2023 · 5 comments
Open

[RFE] Create OpenAPI Spec #193

StykMartin opened this issue Dec 21, 2023 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@StykMartin
Copy link
Contributor

StykMartin commented Dec 21, 2023

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.

@StykMartin StykMartin added the enhancement New feature or request label Dec 21, 2023
@StykMartin
Copy link
Contributor Author

Based on the discussion we had, I think you might want to take a look at this @p3ck

@mdujava
Copy link
Member

mdujava commented Dec 21, 2023

Some generated documentation can be accessed on http://lab-controller-fqdn:8000/server.
It would be ideal to get openapi spec generated from xmlrpc/turbogears directly, but few minutes searching on web did not reveal any out-of-the-box tool for it.

@StykMartin
Copy link
Contributor Author

The goal is to get rid of XMLRPC and Turbogears, so tooling is not necessary in this case.

@StykMartin
Copy link
Contributor Author

But good point @mdujava, I updated the description to make that clear.

@mdujava
Copy link
Member

mdujava commented Dec 21, 2023

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).

mdujava added a commit to mdujava/beaker that referenced this issue Dec 21, 2023
@p3ck p3ck self-assigned this Dec 21, 2023
mdujava added a commit to mdujava/beaker that referenced this issue Dec 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants