-
Notifications
You must be signed in to change notification settings - Fork 43
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
feat: adding openapi upload
#1116
Conversation
## 🧰 Changes Removes the `openapi` command in its current form. Will be replaced by `openapi upload` (see #1116!) Will be merging this PR into #1113 to collect all breaking changes as part of this PR! ## 🧬 QA & Testing Provide as much information as you can on how to test what you've done. ##⚠️ breaking changes BREAKING CHANGE: `rdme openapi` has been removed. Please use `rdme openapi upload` instead. Read more in [our migration guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md).
## 🧰 Changes cherry picks a few refactors from #1116 to minimize that diff and bring these changes to the v9 channel ## 🧬 QA & Testing do tests still pass?
|
||
headers.set('x-readme-source', source); | ||
|
||
if (fileOpts.filePath && fileOpts.fileType === 'url') { |
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.
This may get run twice if isGHA()
is true and we have a file there.
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.
ah yikes yeah this would overwrite that. we don't do anything with this header at the moment but i'll look into why i wrote it this way, this is just holdover from the API v1 code
## 🧰 Changes this PR aggregates all of the PRs going out as part of the v10 release (i.e, the second section of PRs below). all PRs should be reviewed prior to being merged into this branch. ### outstanding tasks #### needs to go out _before_ v10 is released (i.e., in the v9 release channel) - [x] #1082 #### needs to go out as part of v10 release - [x] `openapi upload` - [x] #1111 - [x] #1116 - [x] #1107 - [x] #1104 - [x] #1108 #### merge into `v9` branch once `v10` release is successfully released - [ ] #1121 #### double-check these things before merging - [x] swap out any links to the `v9` docs (e.g., `/tree/v9`) with `v10` as needed (b19416d) - [x] make sure all API v1 requests in `v10` will work - [x] make sure v10 migration guide reflects the final design decisions around `openapi upload` ##⚠️ Breaking Changes <sub>listing all of the breaking changes 1 by 1 below so they get picked up by semantic release...</sub> BREAKING CHANGE: `categories`, `custompages`, `docs` and `versions` have now been removed. Please use a bidirectional syncing workflow instead. Read more in [our migration guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md). BREAKING CHANGE: `rdme openapi` has been replaced by `rdme openapi upload`. Read more in [our migration guide](https://github.com/readmeio/rdme/tree/v10/documentation/migration-guide.md).
🧰 Changes
rdme openapi
has now been replaced byrdme openapi upload
🚀highlights:
code review notes
documentation/commands/openapi.md
orsrc/commands/openapi/upload.ts
--slug
or--identifier
or something else. went with--slug
since it's short and it was easy to write clear explainer docs aroundoutstanding tasks (archived)
optionaledit: might be a good enhancement further down the line, but going to pass on this for now!--action
arg?useSpecVersion
pending
timeout (there's a nock API for duplicating an interceptor, use that!)follow-up enhancements
readmeAPIv2Fetch
--action
arg for use in CI to prevent accidental overwrites--timeout
arg to allow user to configure timeout🧬 QA & Testing
this can only be tested locally for now:
http://api.readme.local:3000/v2