plone / plone.restapi

RESTful API for Plone.
http://plonerestapi.readthedocs.org/
84 stars 73 forks source link

Openapi schema generation #1790

Open folix-01 opened 1 month ago

folix-01 commented 1 month ago

Script and infrastructure to generate the opneapi documentation for a Plone site. + PyDantic schema for the login endpoint to be used as an example.

mister-roboto commented 1 month ago

@folix-01 thanks for creating this Pull Request and helping to improve Plone!

TL;DR: Finish pushing changes, pass all other checks, then paste a comment:

@jenkins-plone-org please run jobs

To ensure that these changes do not break other parts of Plone, the Plone test suite matrix needs to pass, but it takes 30-60 min. Other CI checks are usually much faster and the Plone Jenkins resources are limited, so when done pushing changes and all other checks pass either start all Jenkins PR jobs yourself, or simply add the comment above in this PR to start all the jobs automatically.

Happy hacking!

netlify[bot] commented 1 month ago

Deploy Preview for plone-restapi canceled.

Name Link
Latest commit 70a57a57466837a9840e83cec6fdee3e39622dd4
Latest deploy log https://app.netlify.com/sites/plone-restapi/deploys/664b210194a262000806be6c