getInlineComments
Get inline comments
Details
- Method:
GET - Path:
/inline-comments - Operation ID:
getInlineComments
Parameters
{
"body-format": {
"description": "The content format type to be returned in the `body` field of the response. If available, the representation will be available under a response field of the same name under the `body` field.",
"required": false,
"location": "query",
"type": "string",
"enum": [
"storage",
"atlas_doc_format"
]
},
"sort": {
"description": "Used to sort the result by a particular field.",
"required": false,
"location": "query",
"type": "string",
"enum": [
"created-date",
"-created-date",
"modified-date",
"-modified-date"
]
},
"cursor": {
"description": "Used for pagination, this opaque cursor will be returned in the `next` URL in the `Link` response header. Use the relative URL in the `Link` header to retrieve the `next` set of results.",
"required": false,
"location": "query",
"type": "string"
},
"limit": {
"description": "Maximum number of footer comments per result to return. If more results exist, use the `Link` header to retrieve a relative URL that will return the next set of results.",
"required": false,
"location": "query",
"type": "integer",
"format": "int32"
}
}Response Schema
{
"title": "MultiEntityResult<InlineCommentModel>",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"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."
},
"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."
}
}
},
"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."
}
}
}
}
},
"resolutionLastModifierId": {
"type": "string",
"description": "Atlassian Account ID of last person who modified the resolve state of the comment. Null until comment is resolved or reopened."
},
"resolutionLastModifiedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the last modification to the comment's resolution status. Null until comment is resolved or reopened."
},
"resolutionStatus": {
"enum": [
"open",
"reopened",
"resolved",
"dangling"
],
"type": "string",
"description": "Inline comment resolution status"
},
"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."
}
}
},
"inlineMarkerRef": {
"type": "string",
"description": "Property value used to reference the highlighted element in DOM."
},
"inlineOriginalSelection": {
"type": "string",
"description": "Text that is highlighted."
}
}
},
"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."
}
}
}
}
},
"_links": {
"type": "object",
"properties": {
"webui": {
"type": "string",
"description": "Web UI link of the content."
}
}
}
}
}
},
"_links": {
"type": "object",
"properties": {
"next": {
"type": "string",
"description": "Used for pagination. Contains the relative URL for the next set of results, using a cursor query parameter.\nThis property will not be present if there is no additional data available."
},
"base": {
"type": "string",
"description": "Base url of the Confluence site."
}
}
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('confluence')
# Call this tool
result = await agent.call_tool('getInlineComments', {
# Add required parameters here
})