confluence.js icon indicating copy to clipboard operation
confluence.js copied to clipboard

Published 20 hours ago • verified publisher icon MrRefactoring

Version 2 API Release checklist

Open MrRefactoring opened this issue 1 year ago • 0 comments

Branch we are working

  • #40

All PR should have a target for this branch.

General

  • [x] #35 completed.
  • [x] #46
  • [ ] #44
  • [x] #47
  • [x] #110
  • [x] #117

Api

  • [ ] #105
  • [ ] #106
  • [ ] #120
  • [ ] #121
  • [ ] #122
  • [ ] #123
  • [ ] #124
  • [ ] #125
  • [ ] #126
  • [ ] #127
  • [ ] #128
  • [x] #58
  • [x] #59
  • [x] #60
  • [x] #61
  • [x] #62
  • [x] #64
  • [x] #63
  • [x] #65
  • [x] #66
  • [x] #67
  • [x] #68
  • [x] #69
  • [x] #70
  • [x] #71
  • [x] #72
  • [x] #73
  • [x] #74
  • [x] #75
  • [x] #76
  • [x] #77
  • [x] #78
  • [x] #79
  • [x] #80
  • [x] #81
  • [x] #82
  • [x] #83
  • [x] #84
  • [ ] comment.getFooterCommentById body needs to clarify the type.
  • [ ] comment.updateFooterComment body needs to clarify the type.
  • [ ] comment.updateInlineComment body needs to clarify the type.
  • [ ] content.convertContentIdsToContentTypes contentIds parameter should be added to the request.

Models

  • [ ] Attachment: clarify types for pageId, blogPostId, customContentId. Mark optional parameters as required when it's needed.
  • [ ] Body: clarify interface properties and types of these properties.
  • [ ] UpdateInlineCommentModel: type of body?
  • [ ] UpdateFooterCommentModel: type of body?
  • [ ] Task: clarify types for id, localId, spaceId, pageId, blogPostId. Mark optional parameters as required when it's needed.
  • [ ] SpaceProperty: clarify type for id.
  • [x] Space: clarify types for id, homepageId.
  • [ ] PrimaryBodyRepresentation clarify properties and properties types.
  • [ ] PageInlineCommentModel: clarify types for id, pageId. Mark optional parameters as required when it's needed.
  • [ ] PageCommentModel: clarify types for id, pageId. Mark optional parameters as required when it's needed.
  • [ ] PageBodyWrite: clarify properties.
  • [ ] Page: clarify types for id, spaceId, parentId. Mark optional parameters as required when it's needed.
  • [ ] Label: clarify types for id, name, prefix is optional?
  • [ ] InviteByEmail: clarify types.
  • [ ] InlineCommentModel: clarify types for id, blogPostId, pageId, parentCommentId. Mark optional parameters as required when it's needed.
  • [ ] InlineCommentChildrenModel: clarify types for id, parentCommentId. Mark optional parameters as required when it's needed.
  • [ ] ContentStatus: replate ContentStatus to a list of available statuses.
  • [ ] FooterCommentModel: clarify types for id, blogPostId, pageId, parentCommentId. Mark optional parameters as required when it's needed.
  • [ ] CustomContentVersion: Mark optional parameters as required when it's needed.
  • [ ] CustomContentBodyWrite: check types.
  • [ ] CustomContent: clarify types for id, spaceId, pageId, blogPostId, customContentId. Mark optional parameters as required when it's needed.
  • [ ] CreateInlineCommentModel: clarify types for body, inlineCommentProperties. Mark optional parameters as required when it's needed.
  • [ ] CreateFooterCommentModel: Mark optional parameters as required when it's needed.
  • [ ] ContentPropertyUpdateRequest: version property should be clarified.
  • [ ] ContentIdToContentTypeResponse: clarify the type.
  • [ ] CommentVersion: Mark optional parameters as required when it's needed.
  • [ ] CommentBodyWrite: clarify the type.
  • [ ] ChildrenCommentModel clarify types fo id, parentCommentId. Mark optional parameters as required when it's needed.
  • [ ] ChildPage: clarify types for id, spaceId. Mark optional parameters as required when it's needed.
  • [ ] ChildCustomContent: clarify types for id, spaceId. Mark optional parameters as required when it's needed.
  • [ ] CheckAccessByEmail: check types.
  • [ ] BlogPostVersion: Mark optional parameters as required when it's needed.
  • [ ] BlogPostInlineCommentModel: clarify types for id, blogPostId. Mark optional parameters as required when it's needed.
  • [ ] BlogPostCommentModel: clarify types for id, blogPostId. Mark optional parameters as required when it's needed.
  • [ ] BlogPostBodyWrite: clarify the type.
  • [ ] BlogPost: clarify types for id, spaceId. Mark optional parameters as required when it's needed.
  • [x] #45
  • [ ] Remove unused models.

Paramerters

  • [x] #57

Special thanks

I would like to extend my gratitude to the following individuals for their contributions and support:

  • Fabio Rodriguez made significant contributions to the Version 2 API Client of the confluence.js project. Here are the specific contributions: #60 #61 #62 #63 #64 #65 #66 #67 #68 #69 #70 #71 #72 #73 #74 #75 #76 #77 #78 #79 #80 #81 #84
  • Augustus Thomas for his contribution to making Version 2 API Client. #58
  • Haider Zaidi for his contribution to making Version 2 API Client. #83
  • mukultotla for his contribution to making Version 2 API Client. #82
  • Kunal Virk for his contribution to making Version 2 API Client. #59

MrRefactoring avatar May 20 '23 19:05 MrRefactoring