[DOCS-4700] MMS API Examples don't work Created: 20/Jan/15  Updated: 05/Feb/15  Resolved: 05/Feb/15

Status: Closed
Project: Documentation
Component/s: Cloud Manager
Affects Version/s: None
Fix Version/s: v1.3.18

Type: Bug Priority: Critical - P2
Reporter: David Hows Assignee: Allison Reinheimer Moore
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

https://docs.mms.mongodb.com/reference/api


Issue Links:
Related
Participants:
Days since reply: 9 years, 1 week, 6 days ago

 Description   

Within the MMS API Documentation we have a number of examples.

These examples all consistently use -data @{ some: "Json"}. The @ symbol in this case is incorrect as it states that what follows will be a filename.

Example command from API:

curl -u "username:apiKey" -H "Content-Type: application/json" "https://mms.mongodb.com/api/public/v1.0/groups/<groupid>/hosts" -X POST --digest --data @-
{
  "hostname": "localhost",
  "port": 27017
}

Correct Example

curl -u "username:apiKey" -H "Content-Type: application/json" "https://mms.mongodb.com/api/public/v1.0/groups/<groupid>/hosts" -X POST --digest --data '{ "hostname": "localhost", "port": 27017 }'

Can we please update (and ideally test) all the examples to confirm that they are correct?



 Comments   
Comment by Githook User [ 05/Feb/15 ]

Author:

{u'username': u'schmalliso', u'name': u'Allison Moore', u'email': u'allison.moore@10gen.com'}

Message: DOCS-4700: fixes curl --data syntax
Branch: v1.6
https://github.com/10gen/mms-docs/commit/be06ffcbc69cc6771c3da8e235d0091eebf865ed

Comment by Githook User [ 05/Feb/15 ]

Author:

{u'username': u'schmalliso', u'name': u'Allison Moore', u'email': u'allison.moore@10gen.com'}

Message: DOCS-4700: fixes curl --data syntax
Branch: master
https://github.com/10gen/mms-docs/commit/dd798c41a4ba4566d098cb399484eb2df89e0211

Generated at Thu Feb 08 07:48:38 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.