DMPRoadmap / roadmap

DCC/UC3 collaboration for a data management planning tool
MIT License
106 stars 109 forks source link

API v1 wiki documentation issue #3394

Closed StCyr closed 7 months ago

StCyr commented 8 months ago

https://github.com/DMPRoadmap/roadmap/wiki/API-v1-Documentation

Expected behaviour:

"Organizational Admins with the "Use API" privilege can access the API via their email address and the API token found on their Profile page when logged in. Client applications can access the API via their client_id and client_secret. ApiClients can be managed by Super Admins via the Admin Features -> Api Clients menu."

Actual behaviour:

"Organizational Admins can access the API via their email address and the API token found on their Profile page when logged in. Client applications can access the API via their client_id and client_secret. ApiClients can be managed by Super Admins via the Admin Features -> Api Clients menu."

gjacob24 commented 8 months ago

Hi @StCyr

Similar to the previous issue that you have opened regarding API V0 documentation the answer to this is the same (https://github.com/DMPRoadmap/roadmap/issues/3393#issuecomment-1994184681). It is possible for org admins to exist without the 'Use API' permission and so we have mentioned it specifically to make it clear that you need that privilege to use the API.

Hope this is clear, if not, please let us know. Thanks!

screenshot_org_admin
StCyr commented 8 months ago

As with the other issue: This is not properly documented in https://github.com/DMPRoadmap/roadmap/wiki/API-v1-Documentation. That's why I've created this issue, for the documentation to be updated :-)

gjacob24 commented 8 months ago

Once again, sorry about this, I will edit the documentation to make it clearer. Thanks again for pointing it out! :)

gjacob24 commented 8 months ago

Hi @StCyr apologies again for the misunderstanding. I have made the change to the documentation as you suggested. Once you confirm, I will close the issue, or feel free to close it yourself after checking. Thanks again! https://github.com/DMPRoadmap/roadmap/wiki/API-v1-Documentation

StCyr commented 7 months ago

Looks good to me. Thanks @gjacob24