-
Notifications
You must be signed in to change notification settings - Fork 94
Add plugin_runs to open-api #232
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
Conversation
Deploy preview for open-api ready! Built with commit e0fdc4a |
Merging so @ehmicky can proceed but let's still talk about it 😺 |
Oh, sorry I missed the question, @vbrown608 ! Nice find in the ReDocs docs. I like your approach as an intermediate step as we work on the long term solution @keiko713 is now organizing. |
Great 👍 No worries on missing, it was more like, I asked the question and then realized I wanted to merge two minutes later 😝 |
This adds a PluginRun creation endpoint to open-api. This is a Netlify-internal endpoint that's only accessible from within our build system, but needs to be added here in order to included in the Javascript client.
I kept the specification very minimal, especially in terms of acceptable values and required fields, so we can iterate quickly as we approach GA.
I was reading through the redoc docs and saw this line: https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md#usage-in-redoc
I think we can use it to our advantage to omit endpoints from the UI. You can verify here: https://deploy-preview-232--open-api.netlify.app
I added an
x-internal
tag, which doesn't do anything but provide a bit of information to readers of the YAML file.@verythorough I would like to know what you think of this as a short-term solution while we develop our internal API docs approach.