documentation updated

OpenFn · Sep 6, 2017 · 3263abe · 3263abe
1 parent 7b1ede6
commit 3263abe
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 20 deletions.
diff --git a/lib/Adaptor.js b/lib/Adaptor.js
@@ -106,11 +106,14 @@ function execute() {
 /**
  * Fetch a dataValueSet
  * @example
- * execute({
- *   dataSet: 'pBOMPrpg1QX',
- *   orgUnit: 'DiszpKrYNg8',
- *   period: '201401'
- * })(state)
+ * fetchData({
+ *   fields: {
+ *     dataSet: 'pBOMPrpg1QX',
+ *     orgUnit: 'DiszpKrYNg8',
+ *     period: '201401'
+ *   },
+ *   postUrl: "yourposturl"
+ * })
  * @constructor
  * @param {object} params - data to query for events
  * @returns {Operation}
@@ -159,11 +162,15 @@ function fetchData(params) {
 /**
  * Fetch an event
  * @example
- * execute(
- *   fetchEvent(eventsQuery)
- * )(state)
+ * fetchEvents({
+ *   fields: {
+ *     orgUnit: 'DiszpKrYNg8',
+ *     period: '201401'
+ *   },
+ *   postUrl: "yourposturl"
+ * })
  * @constructor
- * @param {object} eventsQuery - data to query for events
+ * @param {object} params - data to query for events
  * @returns {Operation}
  */
 function fetchEvents(params) {
@@ -425,9 +432,10 @@ function updateTEI(tei, data) {
  * Enroll a tracked entity instance in a program
  * @example
  * execute(
- *   enroll(enrollmentData)
+ *   enroll(tei, enrollmentData)
  * )(state)
  * @constructor
+ * @param {object} tei
  * @param {object} enrollmentData - Payload data for new enrollment
  * @returns {Operation}
  */

diff --git a/src/Adaptor.js b/src/Adaptor.js
@@ -42,11 +42,14 @@ export function execute(...operations) {
 /**
  * Fetch a dataValueSet
  * @example
- * execute({
- *   dataSet: 'pBOMPrpg1QX',
- *   orgUnit: 'DiszpKrYNg8',
- *   period: '201401'
- * })(state)
+ * fetchData({
+ *   fields: {
+ *     dataSet: 'pBOMPrpg1QX',
+ *     orgUnit: 'DiszpKrYNg8',
+ *     period: '201401'
+ *   },
+ *   postUrl: "yourposturl"
+ * })
  * @constructor
  * @param {object} params - data to query for events
  * @returns {Operation}
@@ -101,11 +104,15 @@ export function fetchData(params) {
  /**
   * Fetch an event
   * @example
-  * execute(
-  *   fetchEvent(eventsQuery)
-  * )(state)
+  * fetchEvents({
+  *   fields: {
+  *     orgUnit: 'DiszpKrYNg8',
+  *     period: '201401'
+  *   },
+  *   postUrl: "yourposturl"
+  * })
   * @constructor
-  * @param {object} eventsQuery - data to query for events
+  * @param {object} params - data to query for events
   * @returns {Operation}
   */
 export function fetchEvents(params) {
@@ -380,9 +387,10 @@ export function updateTEI(tei, data) {
  * Enroll a tracked entity instance in a program
  * @example
  * execute(
- *   enroll(enrollmentData)
+ *   enroll(tei, enrollmentData)
  * )(state)
  * @constructor
+ * @param {object} tei
  * @param {object} enrollmentData - Payload data for new enrollment
  * @returns {Operation}
  */