This repository has been archived by the owner on Feb 1, 2024. It is now read-only.
Swagger UI curl command lacks "Token" #2371
Labels
bug
Something isn't working
client action needed
This ticket is blocked until additional information or a decision is provided by the client
OSH_JIRA
Overview
When executing an API command, a
curl
command line is displayed which suggests it could be used on a client's machine. This is not the case, as theAuthentication
field is missing the leading"Token "
text.Expected Behavior
The documentation should be self-explanatory. If need be, a comment explaining what needs to be done could be added.
Actual Behavior
When copy & pasting the command line such as
curl -X GET "https://opensupplyhub.org/api/facilities/?countries=DE" -H "accept: application/json" -H "Authorization: <token>"
Clients get a misleading error message
usually just after they created such a token, making them wonder what they have done.
That page is generally the first page for new API clients to visit after they generated a token.
Steps to Reproduce
Select "Try it out" on https://opensupplyhub.org/api/docs
Demo
N/A
Additional context
This caused questions before, and again today, and causes client dissatisfaction and extra work.
The text was updated successfully, but these errors were encountered: