[DOCS-5294] API: Make clearer that not all entity members need to be sent for PATCH Created: 27/Apr/15  Updated: 11/Jan/17  Resolved: 18/Feb/16

Status: Closed
Project: Documentation
Component/s: Cloud Manager, Ops Manager
Affects Version/s: None
Fix Version/s: 01112017-cleanup

Type: Bug Priority: Minor - P4
Reporter: Eric Sommer Assignee: Bob Grabar
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: 8 years, 42 weeks, 2 days ago

 Description   

https://docs.opsmanager.mongodb.com/v1.5/reference/api/backup-configurations/

On this page, there is a "Sample Entity" that shows all possible fields that can be returned. The example at the bottom of the page for updating a backup shows a PATCH request including a subset of those fields:

curl -i -u "username:apiKey" --digest "https://mms.mongodb.com/api/public/v1.0/groups/5196d3628d022db4cbc26d9e/backupConfigs/5196e5b0e4b0fca9cc88334a" -H "Content-Type: application/json" -X PATCH --data @-
{
  "statusName": "STOPPED"
}

Even so, it should be made clear at the top, where the sample entity is presented, that a PATCH request need send only those fields whose values are being changed.



 Comments   
Comment by Eric Sommer [ 27/Apr/15 ]

Linking CS-18885 where the customer mistakenly assumed that "groupId" and "clusterId" needed to be included in the PATCH request.

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