[DOCS-10876] Update Atlas' "Create a New VPC Peering Connection" API Documentation to Include Required Parameter: containerId Created: 06/Oct/17  Updated: 10/Oct/17  Resolved: 10/Oct/17

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

Type: Task Priority: Major - P3
Reporter: Luke Phillippi Assignee: Ravind Kumar (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
Participants:
Days since reply: 6 years, 18 weeks, 1 day ago

 Description   

Currently, within the Create a New VPC Peering Connection : Request Body Parameters section of the Atlas documentation, the following required parameters are depicted:

Parameter Required/Optional Description
vpcId Required. The ID of the peer VPC.
awsAccountId Required. The AWS account ID of the owner of the peer VPC.
routeTableCidrBlock Required. The peer VPC CIDR block or subnet.

However, since the most recent Atlas release, an additional parameter is required when calling this API endpoint: containerId.

As an example, when attempting to call this API endpoint sans-containerId:

curl -X POST -u "$ATLAS_USERNAME:$ATLAS_API_KEY" --digest "https://cloud.mongodb.com/api/atlas/v1.0/groups/$ATLAS_PROJECT_ID/peers?pretty=true" \
 -H "Content-Type: application/json" --data '
 {
     "vpcId" : "$AWS_VPC_ID",
     "awsAccountId" : "$AWS_ACCOUNT_ID",
     "routeTableCidrBlock" : "10.0.128.0/17"
 }'

The following response is received:

{
  "detail" : "The required attribute containerId was not specified.",
  "error" : 400,
  "errorCode" : "MISSING_ATTRIBUTE",
  "parameters" : [ "containerId" ],
  "reason" : "Bad Request"
}

The containerId can be obtained via the Get a List of Cloud Services Containers API endpoint (returned as the id response element).

Ideally, the Create a New VPC Peering Connection : Request Body Parameters section of the Atlas documentation should be updated to include containerId as a required parameter.



 Comments   
Comment by Ravind Kumar (Inactive) [ 10/Oct/17 ]

Merged and Published: https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/

Comment by Luke Phillippi [ 09/Oct/17 ]

Cool - thank you, ravind.kumar!

Comment by Ravind Kumar (Inactive) [ 09/Oct/17 ]

OK. I'll see if I can get this done today. Thanks!

Comment by Ravind Kumar (Inactive) [ 09/Oct/17 ]

rob.justice re-opening this as 1199 was closed addressing only the issues in that ticket, not the `containerId`.

If you have bandwidth can you tackle this? Otherwise I can see if irene.smith has some space.

Comment by Ravind Kumar (Inactive) [ 06/Oct/17 ]

Hi luke.phillippi ,

This is a dupe of DOCSP-1199 .

rob.justice if you'd like to work on this, please do so using DOCSP-1199. Feel free to re-assign it.

I would ask that you coordinate with irene.smith who is also doing API updates for Atlas.
If you'd prefer to pass, then I can assign DOCSP-1199 to Irene so she can do all the API updates in a go.

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