使用Atlassian Confluence Python API编辑页面时设置提交消息/更新注释

Question

我正在使用atlassian python api来更新文档中描述的页面：

from atlassian import Confluence
conf = Confluence(url=srvr, username=usr, password=pswd)
page_id = '12345'
new_page_title = 'This is a new title'
new_page_body = '<p>This is a new body</p>'
conf.update_page(page_id, new_page_title, new_page_body)

这很好用。我现在想添加一条更新评论/提交消息，就像手动编辑页面时可以输入的消息一样(">你更改了什么？"(。

update_page()的atlassian python api文档没有这样的选项。有可能吗？

我试图更改页面正文以包含此

data = {
'id': {page_id}
'title': new_page_title,
'body': {
'storage':{
'value': new_page_body,
'representation':'storage',
}
},
'version': {
'number': 2
},
'comment': 'Changed the title and the body.'
}

但我想update_page()不是这样工作的，我得到了

属性错误："dict"对象没有属性"strip"

Answer 1

update_page()实际上可以直接实现这一点，尽管您是正确的，但方法的文档中没有记录这一点。

我在源代码中发现方法update_page()采用了一个可选的参数version_comment。这是您要设置的注释。

扩展您的示例：

from atlassian import Confluence
conf = Confluence(url=srvr, username=usr, password=pswd)
page_id = '12345'
new_page_title = 'This is a new title'
new_page_body = '<p>This is a new body</p>'
commit_msg = 'Changed the title and the body.'
conf.update_page(page_id, new_page_title, new_page_body, version_comment=commit_msg)

这应该是你想要的。