update documentation

johnpduane · Mar 25, 2018 · 2358236 · 2358236
1 parent eb9b1f4
commit 2358236
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -40,8 +40,8 @@ Confluence currently exposes the following API...
     * [.getContentById(id, callback)](#Confluence+getContentById)
     * [.getCustomContentById(options, callback)](#Confluence+getCustomContentById)
     * [.getContentByPageTitle(space, title, callback)](#Confluence+getContentByPageTitle)
-    * [.postContent(space, title, content, parentId, callback)](#Confluence+postContent)
-    * [.putContent(space, id, version, title, content, callback, minorEdit)](#Confluence+putContent)
+    * [.postContent(space, title, content, parentId, callback, representation)](#Confluence+postContent)
+    * [.putContent(space, id, version, title, content, callback, minorEdit, representation)](#Confluence+putContent)
     * [.deleteContent(id, callback)](#Confluence+deleteContent)
     * [.getAttachments(space, id, callback)](#Confluence+getAttachments)
     * [.createAttachment(space, id, filepath, callback)](#Confluence+createAttachment)
@@ -140,7 +140,7 @@ Post content to a new page.
 | content | <code>string</code> |  |
 | parentId | <code>number</code> | A null value will cause the page to be added under the space's home page |
 | callback | <code>function</code> |  |
-| representation | <code>string</code> | Optional value that will change the type of content (Wiki, Storage, etc.) |
+| representation | <code>string</code> | Optional |
 
 <a name="Confluence+putContent"></a>
 
@@ -158,7 +158,7 @@ Put/update stored content for a page.
 | content | <code>string</code> |  |
 | callback | <code>function</code> |  |
 | minorEdit | <code>boolean</code> | Optional |
-| representation | <code>string</code> | Optional value that will change the type of content (Wiki, Storage, etc.) |
+| representation | <code>string</code> | Optional |
 
 <a name="Confluence+deleteContent"></a>
 

diff --git a/api.md b/api.md
@@ -29,8 +29,8 @@ Released under the MIT License</p>
     * [.getContentById(id, callback)](#Confluence+getContentById)
     * [.getCustomContentById(options, callback)](#Confluence+getCustomContentById)
     * [.getContentByPageTitle(space, title, callback)](#Confluence+getContentByPageTitle)
-    * [.postContent(space, title, content, parentId, callback)](#Confluence+postContent)
-    * [.putContent(space, id, version, title, content, callback, minorEdit)](#Confluence+putContent)
+    * [.postContent(space, title, content, parentId, callback, representation)](#Confluence+postContent)
+    * [.putContent(space, id, version, title, content, callback, minorEdit, representation)](#Confluence+putContent)
     * [.deleteContent(id, callback)](#Confluence+deleteContent)
     * [.getAttachments(space, id, callback)](#Confluence+getAttachments)
     * [.createAttachment(space, id, filepath, callback)](#Confluence+createAttachment)
@@ -117,7 +117,7 @@ Get stored content for a specific space and page title.
 
 <a name="Confluence+postContent"></a>
 
-### confluence.postContent(space, title, content, parentId, callback)
+### confluence.postContent(space, title, content, parentId, callback, representation)
 Post content to a new page.
 
 **Kind**: instance method of [<code>Confluence</code>](#Confluence)  
@@ -129,10 +129,11 @@ Post content to a new page.
 | content | <code>string</code> |  |
 | parentId | <code>number</code> | A null value will cause the page to be added under the space's home page |
 | callback | <code>function</code> |  |
+| representation | <code>string</code> | Optional |
 
 <a name="Confluence+putContent"></a>
 
-### confluence.putContent(space, id, version, title, content, callback, minorEdit)
+### confluence.putContent(space, id, version, title, content, callback, minorEdit, representation)
 Put/update stored content for a page.
 
 **Kind**: instance method of [<code>Confluence</code>](#Confluence)  
@@ -146,6 +147,7 @@ Put/update stored content for a page.
 | content | <code>string</code> |  |
 | callback | <code>function</code> |  |
 | minorEdit | <code>boolean</code> | Optional |
+| representation | <code>string</code> | Optional |
 
 <a name="Confluence+deleteContent"></a>
 

diff --git a/lib/confluence.js b/lib/confluence.js
@@ -166,6 +166,7 @@ Confluence.prototype.getContentByPageTitle = function(space, title, callback){
  * @param {string} content
  * @param {number} parentId - A null value will cause the page to be added under the space's home page
  * @param {Function} callback
+ * @param {string} representation - Optional
  */
 Confluence.prototype.postContent = function(space, title, content, parentId, callback, representation){
     var config = this.config;
@@ -226,6 +227,7 @@ Confluence.prototype.postContent = function(space, title, content, parentId, cal
  * @param {string} content
  * @param {Function} callback
  * @param {boolean} minorEdit - Optional
+ * @param {string} representation - Optional
  */
 Confluence.prototype.putContent = function(space, id, version, title, content, callback, minorEdit, representation){
     var page = {

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "confluence-api",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "Confluence API wrapper for NodeJS",
   "main": "./lib/confluence.js",
   "scripts": {
@@ -47,6 +47,10 @@
     {
       "name": "arthmoeros",
       "url": "https://github.com/arthmoeros"
+    },
+    {
+      "name": "Richard Hurt",
+      "url": "https://github.com/rnhurt"
     }
   ],
   "license": "MIT",