[DOCS-14877] [Atlas] Create One Project Invitation with the API page missing Example body Created: 18/Oct/21  Updated: 02/Nov/21  Resolved: 02/Nov/21

Status: Closed
Project: Documentation
Component/s: API, Atlas
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Trivial - P5
Reporter: Valmik Mehta Assignee: Sarah Simpers
Resolution: Done Votes: 0
Labels: cet-captain
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Prod


Participants:
Days since reply: 2 years, 16 weeks, 1 day ago
Story Points: 2

 Description   

Example Request Body is missing in the documents. 

 

Ref: https://docs.atlas.mongodb.com/reference/api/project-create-one-invitation/#example-request



 Comments   
Comment by Valmik Mehta [ 19/Oct/21 ]

Check out the Update One (https://docs.atlas.mongodb.com/reference/api/project-update-one-invitation/#example-request)

 

The Example Request has the "–data" as one of the curl parms. This shows what the request body needs to look like. Create One does not include that tag. 

 

I think you just need to add the "–data" option with the following:

 

{ "roles": [ "GROUP_OWNER" ], "username": "user1@mongodb.com" }

 

 

 

Comment by Julia Malkin [ 18/Oct/21 ]

I compared the linked example with examples for other endpoints for invitations and I don't see any differences in format. The example requests do not include "Request Body" portions. I think this works as designed, but I hope my team can confirm.

Generated at Thu Feb 08 08:11:24 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.