gistsUpdateComment
Update a gist comment
Details
- Method:
PATCH - Path:
/gists/{gist_id}/comments/{comment_id} - Operation ID:
gists/update-comment
Parameters
{
"gist_id": {
"description": "The unique identifier of the gist.",
"required": true,
"location": "path",
"type": "string"
},
"comment_id": {
"description": "The unique identifier of the comment.",
"required": true,
"location": "path",
"type": "integer",
"format": "int64"
},
"body": {
"description": "The comment text.",
"required": true,
"location": "body",
"type": "string"
}
}Response Schema
{
"title": "Gist Comment",
"description": "A comment made to a gist.",
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"node_id": {
"type": "string",
"example": "MDExOkdpc3RDb21tZW50MQ=="
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1"
},
"body": {
"description": "The comment text.",
"type": "string",
"maxLength": 65535,
"example": "Body of the attachment"
},
"user": {
"title": "Simple User",
"description": "A GitHub user.",
"type": "object",
"properties": {
"name": {
"nullable": true,
"type": "string"
},
"email": {
"nullable": true,
"type": "string"
},
"login": {
"type": "string",
"example": "octocat"
},
"id": {
"type": "integer",
"format": "int64",
"example": 1
},
"node_id": {
"type": "string",
"example": "MDQ6VXNlcjE="
},
"avatar_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/images/error/octocat_happy.gif"
},
"gravatar_id": {
"type": "string",
"example": "41d064eb2195891e12d0413f63227ea7",
"nullable": true
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat"
},
"followers_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/followers"
},
"following_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/following{/other_user}"
},
"gists_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
},
"starred_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
},
"subscriptions_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/subscriptions"
},
"organizations_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/orgs"
},
"repos_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/repos"
},
"events_url": {
"type": "string",
"example": "https://api.github.com/users/octocat/events{/privacy}"
},
"received_events_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/users/octocat/received_events"
},
"type": {
"type": "string",
"example": "User"
},
"site_admin": {
"type": "boolean"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:55Z\""
},
"user_view_type": {
"type": "string",
"example": "public"
}
},
"required": [
"avatar_url",
"events_url",
"followers_url",
"following_url",
"gists_url",
"gravatar_id",
"html_url",
"id",
"node_id",
"login",
"organizations_url",
"received_events_url",
"repos_url",
"site_admin",
"starred_url",
"subscriptions_url",
"type",
"url"
],
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2011-04-18T23:23:56Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2011-04-18T23:23:56Z"
},
"author_association": {
"title": "author_association",
"type": "string",
"example": "OWNER",
"description": "How the author is associated with the repository.",
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
}
},
"required": [
"url",
"id",
"node_id",
"user",
"body",
"author_association",
"created_at",
"updated_at"
]
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('github')
# Call this tool
result = await agent.call_tool('gistsUpdateComment', {
# Add required parameters here
})