Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-5294

API: Make clearer that not all entity members need to be sent for PATCH

    XMLWordPrintableJSON

Details

    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.

      Attachments

        Activity

          People

            bgrabar Bob Grabar
            eric.sommer@mongodb.com Eric Sommer
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              8 years, 42 weeks, 2 days ago