Skip to content

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

Merged
merged 3 commits into from
May 11, 2020
Merged

Add plugin_runs to open-api #232

merged 3 commits into from
May 11, 2020

Conversation

vbrown608
Copy link
Contributor

@vbrown608 vbrown608 commented May 9, 2020

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

please make sure you add all tags to a group, since a tag that is not in a group, will not be displayed at all!

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.

@netlify
Copy link

netlify bot commented May 9, 2020

Deploy preview for open-api ready!

Built with commit e0fdc4a

https://deploy-preview-232--open-api.netlify.app

@vbrown608 vbrown608 added the type: feature code contributing to the implementation of a feature and/or user facing functionality label May 9, 2020
@vbrown608 vbrown608 marked this pull request as ready for review May 11, 2020 18:49
@vbrown608 vbrown608 requested review from a team as code owners May 11, 2020 18:49
@vbrown608
Copy link
Contributor Author

@verythorough I would like to know what you think of this as a short-term solution while we develop our internal API docs approach.

Merging so @ehmicky can proceed but let's still talk about it 😺

@vbrown608 vbrown608 merged commit cf6f3fd into master May 11, 2020
@vbrown608 vbrown608 deleted the plugin-runs branch May 11, 2020 18:59
@verythorough
Copy link
Contributor

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.

@vbrown608
Copy link
Contributor Author

vbrown608 commented May 11, 2020

Great 👍

No worries on missing, it was more like, I asked the question and then realized I wanted to merge two minutes later 😝

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature code contributing to the implementation of a feature and/or user facing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants