[DOCS-16005] API docs: Get Started with the Atlas Administration API doesn't show how to use digest auth Created: 04/Apr/23 Updated: 17/Apr/23 Resolved: 17/Apr/23 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | API, Atlas |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Task | Priority: | Major - P3 |
| Reporter: | Colm Quinn | Assignee: | David Hou |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Σ Remaining Estimate: | Not Specified | Remaining Estimate: | Not Specified |
| Σ Time Spent: | Not Specified | Time Spent: | Not Specified |
| Σ Original Estimate: | Not Specified | Original Estimate: | Not Specified |
| Issue Links: |
|
|||||||||||||||
| Sub-Tasks: |
|
|||||||||||||||
| Participants: | ||||||||||||||||
| Days since reply: | 42 weeks, 2 days ago | |||||||||||||||
| Story Points: | 3 | |||||||||||||||
| Description |
|
The current API docs dont give a clear example of how to get started with our API, particularly how to use digest auth for authentication.
Our https://www.mongodb.com/docs/atlas/configure-api-access/#get-started-with-the-atlas-administration-api guide goes into great detail on how to setup an API key, but shows no usage/example of what to do with the API key. Our old docs were better here, giving a full curl example for each resource: https://www.mongodb.com/docs/atlas/reference/api/project-get-all/#example Our users are struggling to use the current API docs to setup digest, for example, https://www.mongodb.com/community/forums/t/how-to-prepare-auth-for-mongodb-atlas-administration-api/194273 where they went to the old docs to setup auth.
Proposal
|
| Comments |
| Comment by Cloud GitHub Webhooks [ 17/Apr/23 ] |
|
evrg-bot-webhook merged a pull request (DOCS-16005 [Open API] Add digest auth guidance and link to Atlas Admin API docs) into the following branch: |
| Comment by Colm Quinn [ 04/Apr/23 ] |
|
EDIT: CLOUDP-169979 will make the spec updates; this docs ticket covers just updates to getting started |
| Comment by Julia Malkin [ 04/Apr/23 ] |
|
Hi colm.quinn@mongodb.com Thank you for logging this ticket and recognizing the need for it! Re: OpenAPI spec updates that you propose, are you planning to create a separate CLOUDP? |