Build an API explorer for the Events and Orgs endpoints#567
Conversation
Signed-off-by: Matthew H. Irby <matt.irby@outlook.com>
|
@JenBauer FYI |
Signed-off-by: Matthew H. Irby <matt.irby@outlook.com>
|
@irby Related to this to-do, would it be easy / advisable to create a GitHub action that fires anytime the API files change and raise a PR with the compiled files? |
|
@allella I did try that (see earlier commits) but I ran into a couple things:
I think it would be good to have at some point but it would require some thinking on my end on how that would all work :) A homework item for another day, I think. |
allella
left a comment
allella
left a comment
There was a problem hiding this comment.
Added a few other comments or questions.
Signed-off-by: Matthew H. Irby <matt.irby@outlook.com>
|
Looks good, let's give it a whirl. |
|
@irby the require-dev is causing a bit of an issue on stage because we treat that more like production to test equivalent packages. It sounds like we agreed to expose /docs to the world. If we still want to do that, then knuckleswtf/scribe may need to be moved because our deploy script on stage and production uses composer install --no-dev |
|
@allella Gotcha. I wondered if that might happen. I'll raise a PR to move that dependency up to non-dev. |
* Build an API explorer for the Events and Orgs endpoints * Change trigger source from pull_request_target to pull_request * Migrate database * Allow contents write * Checkout branch to commit to * push commits to branch * switch to just erroring out if changes were detected * add in updated api docs * Discard update api docs Action * update route to docs/api instead of api-docs Signed-off-by: Matthew H. Irby <matt.irby@outlook.com> * Make scribe a dev dependency Signed-off-by: Matthew H. Irby <matt.irby@outlook.com> * chore(pr): Put bulletpoint on single line Signed-off-by: Matthew H. Irby <matt.irby@outlook.com> --------- Signed-off-by: Matthew H. Irby <matt.irby@outlook.com>
* Build an API explorer for the Events and Orgs endpoints * Change trigger source from pull_request_target to pull_request * Migrate database * Allow contents write * Checkout branch to commit to * push commits to branch * switch to just erroring out if changes were detected * add in updated api docs * Discard update api docs Action * update route to docs/api instead of api-docs Signed-off-by: Matthew H. Irby <matt.irby@outlook.com> * Make scribe a dev dependency Signed-off-by: Matthew H. Irby <matt.irby@outlook.com> * chore(pr): Put bulletpoint on single line Signed-off-by: Matthew H. Irby <matt.irby@outlook.com> --------- Signed-off-by: Matthew H. Irby <matt.irby@outlook.com>
3 participants
Creates an API explorer that can be visible on the
/docs/apiroute, making it easy to document the available APIs and play around with the API calls.