Open Context Protocol is live! 🚀 Read the launch post
getInlineCommentById

getInlineCommentById

Get inline comment by id

Details

  • Method: GET
  • Path: /inline-comments/{comment-id}
  • Operation ID: getInlineCommentById

Parameters

{
  "comment-id": {
    "description": "The ID of the comment to be retrieved.",
    "required": true,
    "location": "path",
    "type": "integer",
    "format": "int64"
  },
  "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",
      "view",
      "export_view",
      "anonymous_export_view",
      "styled_view",
      "editor"
    ]
  },
  "version": {
    "description": "Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.",
    "required": false,
    "location": "query",
    "type": "integer"
  },
  "include-properties": {
    "description": "Includes content properties associated with this inline comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.",
    "required": false,
    "location": "query",
    "type": "boolean"
  },
  "include-operations": {
    "description": "Includes operations associated with this inline comment in the response, as defined in the `Operation` object.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.",
    "required": false,
    "location": "query",
    "type": "boolean"
  },
  "include-likes": {
    "description": "Includes likes associated with this inline comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.",
    "required": false,
    "location": "query",
    "type": "boolean"
  },
  "include-versions": {
    "description": "Includes versions associated with this inline comment in the response.\nThe number of results will be limited to 50 and sorted in the default sort order. \nA `meta` and `_links` property will be present to indicate if more results are available and a link to retrieve the rest of the results.",
    "required": false,
    "location": "query",
    "type": "boolean"
  },
  "include-version": {
    "description": "Includes the current version associated with this inline comment in the response.\nBy default this is included and can be omitted by setting the value to `false`.",
    "required": false,
    "location": "query",
    "type": "boolean"
  }
}

Response Schema

{
  "allOf": [
    {
      "$ref": "#/components/schemas/InlineCommentModel"
    },
    {
      "type": "object",
      "properties": {
        "_links": {
          "type": "object",
          "properties": {
            "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('getInlineCommentById', {
    # Add required parameters here
})