From 2358236d1d93290cb19da4193aff8496f1b35333 Mon Sep 17 00:00:00 2001 From: johnpduane Date: Sun, 25 Mar 2018 13:39:39 -0600 Subject: [PATCH] update documentation --- README.md | 8 ++++---- api.md | 10 ++++++---- lib/confluence.js | 2 ++ package.json | 6 +++++- 4 files changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 34fc59f..b53cd8d 100644 --- 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 | string | | | parentId | number | A null value will cause the page to be added under the space's home page | | callback | function | | -| representation | string | Optional value that will change the type of content (Wiki, Storage, etc.) | +| representation | string | Optional | @@ -158,7 +158,7 @@ Put/update stored content for a page. | content | string | | | callback | function | | | minorEdit | boolean | Optional | -| representation | string | Optional value that will change the type of content (Wiki, Storage, etc.) | +| representation | string | Optional | diff --git a/api.md b/api.md index 9a471ff..06558c2 100644 --- a/api.md +++ b/api.md @@ -29,8 +29,8 @@ Released under the MIT License

* [.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. -### 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 [Confluence](#Confluence) @@ -129,10 +129,11 @@ Post content to a new page. | content | string | | | parentId | number | A null value will cause the page to be added under the space's home page | | callback | function | | +| representation | string | Optional | -### 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 [Confluence](#Confluence) @@ -146,6 +147,7 @@ Put/update stored content for a page. | content | string | | | callback | function | | | minorEdit | boolean | Optional | +| representation | string | Optional | diff --git a/lib/confluence.js b/lib/confluence.js index d56efe9..1590f95 100644 --- 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 index 4f69d10..7e5b0c3 100644 --- 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",