search

MrRefactoring / confluence.js

confluence.js is a powerful Node.JS/Browser module that allows you to interact with the Confluence API very easily
https://mrrefactoring.github.io/confluence.js/
MIT License
65 stars 15 forks source link

Enhancement: add `data` property to `customContent.updateCustomContent` #121

Open MrRefactoring opened 11 months ago

MrRefactoring commented 11 months ago

This issue tracks the need to enhance the customContent.updateCustomContent method by including a data property. The data property should have the following structure:

data: {
  id: paramerters.id, // Required field of type string
  type: parameters.type, // Required field of type string
  status: parameters.status, // Required field of type string
  spaceId: parameters.spaceId, // Optional field of type string
  pageId: parameters.pageId, // Optional field of type string
  blogPostId: parameters.blogPostId, // Optional field of type string
  customContentId: parameters.customContentId, // Optional field of type string
  title: parameters.title, // Required field of type string
  body: parameters.body, // Required field one of [CustomContentBodyWrite, CustomContentNestedBodyWrite] type
  version: parameters.version, // Required object with `{ number: number, message: string }` properties
}

PR should include also typings for id, type, status, spaceId, pageId, blogPostId, customContentId, title, body, version

Reference: For more context and detailed information, please refer to the Confluence REST API documentation.