Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API v1 wiki documentation issue #3394

Closed
StCyr opened this issue Mar 5, 2024 · 5 comments
Closed

API v1 wiki documentation issue #3394

StCyr opened this issue Mar 5, 2024 · 5 comments

Comments

@StCyr
Copy link

StCyr commented Mar 5, 2024

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
Copy link
Contributor

Hi @StCyr

Similar to the previous issue that you have opened regarding API V0 documentation the answer to this is the same (#3393 (comment)). 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
Copy link
Author

StCyr commented Mar 14, 2024

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
Copy link
Contributor

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

@gjacob24
Copy link
Contributor

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
Copy link
Author

StCyr commented Apr 9, 2024

Looks good to me. Thanks @gjacob24

@StCyr StCyr closed this as completed Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants