Confusing uploading behavior for YAML files #1142
Labels
command:openapi
Issues pertaining to the `openapi`, `validate`, `reduce`, or `swagger` commands
Comments
kanadgupta
added
bug
command:openapi
This was referenced Jan 6, 2025
kanadgupta
added a commit
that referenced
this issue
Jan 6, 2025
## 🧰 Changes when reviewing #1126, i noticed a few small bugs in our `prepareOas` helper function. this PR makes a few typesafety improvements so we shouldn't run into this issue again(?) ~~one outstanding question that i'd like to figure out prior to merge, see #1142 (**edit**: going to continue bundling and handle this issue in a follow-up PR) ## 🧬 QA & Testing do tests + types pass?
kanadgupta
added a commit
that referenced
this issue
Jan 6, 2025
when reviewing #1126, i noticed a few small bugs in our `prepareOas` helper function. this PR makes a few typesafety improvements so we shouldn't run into this issue again(?) ~~one outstanding question that i'd like to figure out prior to merge, see #1142 (**edit**: going to continue bundling and handle this issue in a follow-up PR) do tests + types pass?
|
Looked into this and confirmed that YAML files are being uploaded to ReadMe in YAML. The OAS gets converted to JSON when viewed in ReadMe. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In
openapi upload, we currently always bundle (with the fix in #1141, at least) the OAS and convert it to JSON prior to sending it to ReadMe.This creates unexpected behavior for YAML files, where it's possible to send a YAML file and we'll send the file with a
.ymlfile extension, yet the file blob itself is JSON due to our converting/bundling.How should we handle this? Should we ever send the original, unbundled, unconverted file?
The text was updated successfully, but these errors were encountered: