Issue Summary
Swagger renders cURL calls with double quotes which only work on Windows command prompts. Users must adjust to use apostrophes (instead of double quotes) in order to run curl statements on unix based command prompts (e.g. on a Mac).
curl -X GET "https://uat.agilecraft.xyz/rest/align/api/2/Products?filter=title%20eq%20%27Er1Product%27" -H "accept: application/json;odata.metadata=minimal;odata.streaming=true" -H "Authorization: bearer MyObfuscatedToken"
Steps to Reproduce
- Browse to Swagger
- Authorise a token
- Expand any endpoint
- Click Try out button
- Provide any details (if necessary)
- Click Execute button
- Notice the cURL statement
Expected Results
Swagger should be updated to let users know that cURL calls with double quotes only work on Windows command prompts. Users must adjust to use apostrophes (instead of double quotes) in order to run curl statements on unix based command prompts (e.g. on a Mac).
Actual Results
- The presented URL statement does not work from a MacOS console.
Workaround
- Edit the provided cURL statement and replace all double quotes with apostrophes, like the example below:
Swagger Provided Edited Statement curl -X GET "https://uat.agilecraft.xyz/rest/align/api/2/Products?filter=title%20eq%20%27Er1Product%27" -H "accept: application/json;odata.metadata=minimal;odata.streaming=true" -H "Authorization: bearer MyObfuscatedToken"
curl -X GET 'https://uat.agilecraft.xyz/rest/align/api/2/Products?filter=title%20eq%20%27Er1Product%27' -H "accept: application/json;odata.metadata=minimal;odata.streaming=true" -H 'Authorization: bearer MyObfuscatedToken'
- mentioned in
-
Page Loading...
- resolves
-
ALIGNSP-5864 Loading...