-
Notifications
You must be signed in to change notification settings - Fork 17
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
OpenAPI documentation #37
Conversation
I see three valid approaches here:
I feel like (3) is the cleanest, but we will not have a doc for the latest commit in |
I am no fan of manual interaction as it is pron to errors. If you do not like the logic for generatin the docu in this repo I'd go with 2. we can use repository dispatches for that. |
My main concern is using a personal access token (PAT) that has a broader scope than needed. I do not think there is currently a way to restrict a PAT to a subset of repositories. If we can work around that, I'm fine with (1) and (2) also. It seems like deploy keys can also be used to write to a repository. Maybe we could put a deploy key for |
Ah sorry overlooked that the dispatches needs auth too. Yeah I think the deploy key should work best then. Let's try with one. |
We now have a |
Implemented the push to the website repo - works well. However I do not know where the warnings about multiple declarations of routes come. They are defined only once. We know need to think about:
|
Nice, I wasn't aware this already pushes into |
I added your website as contact, linked the pushbits team as general URL and added the license. For me it is ready to merge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just wondering about the version. Also, I've changed the path where the new file will be dropped.
Add OpenAPI documentation compatible with swag and a workflow to push a static html to website