CLOUDP-321939: Fix curl examples for POST/PU/PATCH #735
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.
Proposed changes
Jira ticket: CLOUDP-321939
Description
Bug
Doc team feedback: cURL commands for PUT, PATCH, and POST methods are not valid. Users receive errors if copying and pasting into terminal and replacing variables with their own data. Each command that uses these methods and requires a request body needs an extra
\
after the endpoint URI in order for shells to handle the line break.Fix
This PR adds an additional
\
and update the payload from{ <Payload> }
to'{ <Payload> }'
for PUT, PATCH, and POST.You can check how this change renders in https://redocly.github.io/redoc/#tag/Projects/operation/createProject. Example: