Comments (6)
ehmicky
commented on August 16, 2024
@fool, has this process been solved?
from open-api.
fool
commented on August 16, 2024
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.
from open-api.
ehmicky
commented on August 16, 2024
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.
from open-api.
verythorough
commented on August 16, 2024
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.)
from open-api.
fool
commented on August 16, 2024
@verythorough - great to hear!
The process you mention is "just" someone making time for this:
#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 ***@***.***> 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
<#130?email_source=notifications&email_token=AABX5IGV67OMP7C52GHO2QLQKUXXVA5CNFSM4GPBHBNKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD7HZ3QQ#issuecomment-533700034>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AABX5IAOUPQNRIE4GBTGVTLQKUXXVANCNFSM4GPBHBNA>
.
from open-api.
verythorough
commented on August 16, 2024
Yeah, I suppose "process" over-sells it a bit. 😛
from open-api.
Related Issues (20)
- [security] Enforce Branch Protections
- `draft` property not being returned in `listSiteDeploys`
- Optimization
- Review docs for createSite endpoint - repo id type HOT 1
- Wrong response schema for createSite when there is an error HOT 1
- Add API endpoint to search for a specific deploy preview
- Sort operations alphabetically HOT 1
- Add operation/docs for changing an existing team member's role
- Document clear_cache in createSiteBuild HOT 2
- Document `clear_cache` query param on the createSiteBuild call HOT 1
- Remove gobin in makefile in favor of plain go HOT 1
- CloudQuery Source Plugin?
- Implement GA4 tag
- Don't retry file uploads with `422` responses HOT 2
- [ documentation ] For sites list
- d9021685bd8cc850f5eb17a13f3c7c746d4fe93d
- info:
- Fix Incorrect Return Response for go version 1.21.1 HOT 5
- authentication signup bug HOT 1
- Fix Incorrect DNS Zone API Specifications HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from open-api.