Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement: add data property to customContent.updateCustomContent #121

Open
Tracked by #43
MrRefactoring opened this issue Oct 16, 2023 · 0 comments
Open
Tracked by #43
Labels
enhancement Denotes a suggestion or request aimed at improving or adding new features to the project good first issue Highlights beginner-friendly tasks, ideal for those looking to contribute for the first time help wanted Signals that additional assistance or expertise is needed on a particular issue or feature

Comments

@MrRefactoring
Copy link
Owner

MrRefactoring commented Oct 16, 2023

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.

@MrRefactoring MrRefactoring added this to the Version 2 API support milestone Oct 16, 2023
@MrRefactoring MrRefactoring added enhancement Denotes a suggestion or request aimed at improving or adding new features to the project help wanted Signals that additional assistance or expertise is needed on a particular issue or feature good first issue Highlights beginner-friendly tasks, ideal for those looking to contribute for the first time labels Oct 16, 2023
@MrRefactoring MrRefactoring moved this to Todo in Confluence.js Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Denotes a suggestion or request aimed at improving or adding new features to the project good first issue Highlights beginner-friendly tasks, ideal for those looking to contribute for the first time help wanted Signals that additional assistance or expertise is needed on a particular issue or feature
Projects
Status: Todo
Development

No branches or pull requests

1 participant