search

netlify / open-api

Open API specification of Netlify's API
https://open-api.netlify.com/#/default
MIT License
262 stars 83 forks source link

create process with netlify's dev team to add new attributes and calls <EOM> #130

Open fool opened 5 years ago

ehmicky commented 5 years ago

@fool, has this process been solved?

fool commented 5 years ago

nope. Or at least, if it has, nobody has mentioned to me that it is now a step in the "releasing/changing API endpoints" process and I'd bet it wasn't added there (if there is even a there, there).

It's probably worth taking up as adding to to the project template we're using now in notion though.

ehmicky commented 5 years ago

Yes I agree. It seems to me the OpenAPI definition has few discrepancies. Having a process for updating it might be a good way to ensure our clients and the API documentation are in sync with the API.

verythorough commented 5 years ago

Yes! As we keep moving towards more "docs-driven devlopment", we're hoping to have it be part of the API dev process to PR changes to the OpenAPI definition before working on changes.

(Of course, we'll also need some sort of process for finding and correcting existing gaps.)

fool commented 5 years ago

@verythorough - great to hear!

The process you mention is "just" someone making time for this:

https://github.com/netlify/open-api/issues/131

which I realize doesn't say anything new but it's effectively "audit the code"

On Fri, Sep 20, 2019 at 1:35 PM Jessica Parsons notifications@github.com wrote:

Yes! As we keep moving towards more "docs-driven devlopment", we're hoping to have it be part of the API dev process to PR changes to the OpenAPI definition before working on changes.

(Of course, we'll also need some sort of process for finding and correcting existing gaps.)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/netlify/open-api/issues/130?email_source=notifications&email_token=AABX5IGV67OMP7C52GHO2QLQKUXXVA5CNFSM4GPBHBNKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD7HZ3QQ#issuecomment-533700034, or mute the thread https://github.com/notifications/unsubscribe-auth/AABX5IAOUPQNRIE4GBTGVTLQKUXXVANCNFSM4GPBHBNA .

verythorough commented 5 years ago

Yeah, I suppose "process" over-sells it a bit. 😛