Skip to content

Commit e7a1633

Browse files
authored
Merge pull request #1218 from OpenFn/feature/1215-dhis2-update
dhis2: update docs for the `update()` operation
2 parents a8b7191 + e2d8757 commit e7a1633

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

packages/dhis2/src/Adaptor.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -275,12 +275,12 @@ export function get(path, params = {}) {
275275
}
276276

277277
/**
278-
* Update a resource object of any type. Updating an object requires to send `all required fields` or the `full body`
278+
* Update a resource object of any type. Updating an object requires all fields of the object you are updating, even if they have not been modified
279279
* @public
280280
* @function
281281
* @param {string} resourceType - The type of resource to be updated. E.g. `dataElements`, `organisationUnits`, etc.
282282
* @param {string} path - The `id` or `path` to the `object` to be updated. E.g. `FTRrcoaog83` or `FTRrcoaog83/{collection-name}/{object-id}`
283-
* @param {Object} data - Data to update. It requires to send `all required fields` or the `full body`. If you want `partial updates`, use `patch` operation.
283+
* @param {Object} data - Data to update. It requires to send the full body. If you want partial updates, use patch operation.
284284
* @param {RequestOptions} [options] - An optional object containing query, parseAs,and headers for the request.
285285
* @state data - the resource returned by DHIS2
286286
* @returns {Operation}

0 commit comments

Comments
 (0)