updateFooterComment
Update footer comment
Details
- Method:
PUT - Path:
/footer-comments/{comment-id} - Operation ID:
updateFooterComment
Parameters
{
"comment-id": {
"description": "The ID of the comment to be retrieved.",
"required": true,
"location": "path",
"type": "integer",
"format": "int64"
}
}Response Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the comment."
},
"status": {
"enum": [
"current",
"draft",
"archived",
"historical",
"trashed",
"deleted",
"any"
],
"type": "string",
"description": "The status of the content."
},
"title": {
"type": "string",
"description": "Title of the comment."
},
"blogPostId": {
"type": "string",
"description": "ID of the blog post containing the comment if the comment is on a blog post."
},
"pageId": {
"type": "string",
"description": "ID of the page containing the comment if the comment is on a page."
},
"attachmentId": {
"type": "string",
"description": "ID of the attachment containing the comment if the comment is on an attachment."
},
"customContentId": {
"type": "string",
"description": "ID of the custom content containing the comment if the comment is on a custom content."
},
"parentCommentId": {
"type": "string",
"description": "ID of the parent comment if the comment is a reply."
},
"version": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when the version was created. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."
},
"message": {
"type": "string",
"description": "Message associated with the current version."
},
"number": {
"format": "int32",
"type": "integer",
"description": "The version number."
},
"minorEdit": {
"type": "boolean",
"description": "Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions."
},
"authorId": {
"type": "string",
"description": "The account ID of the user who created this version."
}
}
},
"properties": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the property"
},
"key": {
"type": "string",
"description": "Key of the property"
},
"value": {
"description": "Value of the property. Must be a valid JSON value."
},
"version": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when the version was created. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."
},
"message": {
"type": "string",
"description": "Message associated with the current version."
},
"number": {
"format": "int32",
"type": "integer",
"description": "The version number."
},
"minorEdit": {
"type": "boolean",
"description": "Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions."
},
"authorId": {
"type": "string",
"description": "The account ID of the user who created this version."
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"hasMore": {
"type": "boolean",
"description": "Indicates if there are more available results that can be fetched."
},
"cursor": {
"type": "string",
"description": "A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results."
}
}
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "A relative URL that can be used to fetch results beyond what this include parameter retrieves."
}
}
}
}
},
"operations": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"description": "The type of operation.",
"type": "string"
},
"targetType": {
"description": "The type of entity the operation type targets.",
"type": "string"
}
}
}
},
"meta": {
"type": "object",
"properties": {
"hasMore": {
"type": "boolean",
"description": "Indicates if there are more available results that can be fetched."
},
"cursor": {
"type": "string",
"description": "A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results."
}
}
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "A relative URL that can be used to fetch results beyond what this include parameter retrieves."
}
}
}
}
},
"likes": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "Account ID."
}
}
}
},
"meta": {
"type": "object",
"properties": {
"hasMore": {
"type": "boolean",
"description": "Indicates if there are more available results that can be fetched."
},
"cursor": {
"type": "string",
"description": "A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results."
}
}
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "A relative URL that can be used to fetch results beyond what this include parameter retrieves."
}
}
}
}
},
"versions": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when the version was created. In format \"YYYY-MM-DDTHH:mm:ss.sssZ\"."
},
"message": {
"type": "string",
"description": "Message associated with the current version."
},
"number": {
"format": "int32",
"type": "integer",
"description": "The version number."
},
"minorEdit": {
"type": "boolean",
"description": "Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions."
},
"authorId": {
"type": "string",
"description": "The account ID of the user who created this version."
}
}
}
},
"meta": {
"type": "object",
"properties": {
"hasMore": {
"type": "boolean",
"description": "Indicates if there are more available results that can be fetched."
},
"cursor": {
"type": "string",
"description": "A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results."
}
}
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "A relative URL that can be used to fetch results beyond what this include parameter retrieves."
}
}
}
}
},
"body": {
"type": "object",
"description": "Contains fields for each representation type requested.",
"properties": {
"storage": {
"type": "object",
"properties": {
"representation": {
"type": "string",
"description": "Type of content representation used for the value field."
},
"value": {
"type": "string",
"description": "Body of the content, in the format found in the representation field."
}
}
},
"atlas_doc_format": {
"type": "object",
"properties": {
"representation": {
"type": "string",
"description": "Type of content representation used for the value field."
},
"value": {
"type": "string",
"description": "Body of the content, in the format found in the representation field."
}
}
},
"view": {
"type": "object",
"properties": {
"representation": {
"type": "string",
"description": "Type of content representation used for the value field."
},
"value": {
"type": "string",
"description": "Body of the content, in the format found in the representation field."
}
}
}
}
},
"_links": {
"type": "object",
"properties": {
"webui": {
"type": "string",
"description": "Web UI link of the content."
}
}
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('confluence')
# Call this tool
result = await agent.call_tool('updateFooterComment', {
# Add required parameters here
})