WIP: swagger yaml defination #209
Conversation
|
@p3ck This looks cool. Thanks! Only thought I have is that at some point it would be good to add some CI to test this. |
Absolutely! You notice that I have the beginnings of tests in this PR. We will enable them in github when we switch over. Lot more work to be done before then though. |
Using openapi 3.0 specification to define the restAPI for beaker backend. skeleton api with some dummy methods to allow for testing the test framework. Once this is fleshed out we can start migrating the model code over and then create the actual rest methods.
There was a problem hiding this comment.
I took a look at a spec in a Swagger Editor and it reported few errors, commented on the affected lines.
| description: "Successfully deleted system problem report entry" | ||
| '400': | ||
| $ref: '#/components/responses/400Error' | ||
| /systems/{fqdn}/problem-reports/{id}: |
| description: "Successfully returned Job set's details" | ||
| '400': | ||
| $ref: '#/components/responses/400Error' | ||
| /jobs/{jID}/sets/{sID}/recipes/{rID}: |
| put: | ||
| tags: | ||
| - Systems | ||
| description: "Update a System" |
There was a problem hiding this comment.
I was not sure at first if PUT is the right choice.
PUT is defined as request method creates a new resource or replaces a representation of the target resource as used in this endpoint.
Maybe adding PATCH would make it complete. (e.g. for simple change of only state)
Using openapi 3.0 specification to define the restAPI for beaker backend.
skeleton api with some dummy methods to allow for testing the test framework.
Once this is fleshed out we can start migrating the model code over and then create the actual rest methods.
Created a test_systems unittest to make sure I understood how this would all glue together.
pytest output:
Alembic migrations will be handled by command line db-init and db-migrate tools.