fix(docs): don't merge payloads for PUT requests #740
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧰 Changes
For some background, here's the general workflow for when syncing a Markdown file to ReadMe via the
rdme docs
(orchangelogs
/custompages
) command:GET
request to the ReadMe API to confirm that the page existsPUT
requestPOST
requestThe problem in step 3 is that we take the response body from the
GET
request (calledexistingDoc
in the code below) and merge that with the Markdown file's data when making thePUT
request:rdme/src/lib/syncDocsPath.ts
Lines 107 to 111 in d311af9
This isn't really necessary since the API already merges the
PUT
request body with the existing doc, and it's creating adverse side effects when our API expects one field and not another (see #738 for an example).🧬 QA & Testing
Do tests pass?