Skip to content

Commit d2831ec

Browse files
updated docs for post
Signed-off-by: NeelParihar <[email protected]>
1 parent 498b8f4 commit d2831ec

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

docs/api/woql.js.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ file("/path/to/file", {type: 'turtle'} )
394394
```
395395

396396
### post
397-
#### WOQL.post(url, [formatObj]) ⇒ <code>WOQLQuery</code>
397+
#### WOQL.post(url, [formatObj], [source]) ⇒ <code>WOQLQuery</code>
398398
Identifies a resource as a local path on the client, to be sent to the server through a
399399
HTTP POST request, with the format defined through the options
400400

@@ -404,6 +404,7 @@ HTTP POST request, with the format defined through the options
404404
| --- | --- | --- |
405405
| url | <code>string</code> | The Path on the server at which the file resource can be accessed |
406406
| [formatObj] | <code>typedef.DataFormatObj</code> | imput options, optional |
407+
| [source] | <code>string</code> | It defines the source of the file, it can be 'url','post' |
407408

408409
**Example**
409410
```js

lib/woql.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -368,10 +368,10 @@ WOQL.file = function(url, formatObj) {
368368
* HTTP POST request, with the format defined through the options
369369
* @param {string} url - The Path on the server at which the file resource can be accessed
370370
* @param {typedef.DataFormatObj} [formatObj] - imput options, optional
371-
* @param {string} [source] - It defines the source of the file, it can be 'url','file','post'
371+
* @param {string} [source] - It defines the source of the file, it can be 'url','post'
372372
* @returns {WOQLQuery} A WOQLQuery which contains the Post resource identifier
373373
* @example
374-
* post("/.../.../", {type:'csv'}, 'file')
374+
* post("/.../.../", {type:'csv'})
375375
*/
376376
WOQL.post = function(url, formatObj, source) {
377377
return new WOQLQuery().post(url, formatObj, source)

0 commit comments

Comments
 (0)