[DOCS-16063] Docs missing for Atlas API endpoint DELETE User from Org Created: 24/Apr/23 Updated: 24/Apr/23 Resolved: 24/Apr/23 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Bug | Priority: | Major - P3 |
| Reporter: | Jalpa Trivedi (Inactive) | Assignee: | Unassigned |
| Resolution: | Duplicate | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||
| Participants: | |||||
| Days since reply: | 41 weeks, 2 days ago | ||||
| Description |
|
HELP-44783 called out that the docs for Atlas API to delete a user from Organization are missing causing confusion around whether the endpoint to remove the user from Organization is supported or not. Looking at the code for this endpoint, I notice that there is a comment that the docs are missing. Filing this ticket to add the docs or suggest otherwise. |
| Comments |
| Comment by Jalpa Trivedi (Inactive) [ 24/Apr/23 ] |
|
Thank you for the detailed context and pointer ticket, john.williams@mongodb.com! I will watch that ticket for now. |
| Comment by John Williams [ 24/Apr/23 ] |
|
Thanks for filing! When we (docs) did the OpenAPI annotation backfill this endpoint wasn't in the hand-written docs, and there was a lot of back and forth with stakeholders whether it should be available publicly. We don't have the authority to make that call, so we left it as "hidden" in the spec. As Atlas engineering now owns the OpenAPI spec, the decision whether to expose these docs publicly rest with the engineering team and the PM for the given area. If they're all on board with publishing these publicly, then we (docs) don't have any issue with removing the hidden annotations and publishing docs for this endpoint. The relevant engineering ticket is CLOUDP-172345 |