pullsGetReview
Get a review for a pull request
Details
- Method:
GET - Path:
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id} - Operation ID:
pulls/get-review
Parameters
{
"owner": {
"description": "The account owner of the repository. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
},
"repo": {
"description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
},
"pull_number": {
"description": "The number that identifies the pull request.",
"required": true,
"location": "path",
"type": "integer"
},
"review_id": {
"description": "The unique identifier of the review.",
"required": true,
"location": "path",
"type": "integer"
}
}Response Schema
{
"title": "Pull Request Review",
"description": "Pull Request Reviews are reviews on pull requests.",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the review",
"example": 42,
"type": "integer",
"format": "int64"
},
"node_id": {
"type": "string",
"example": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA="
},
"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
},
"body": {
"description": "The text of the review.",
"example": "This looks great.",
"type": "string"
},
"state": {
"type": "string",
"example": "CHANGES_REQUESTED"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80"
},
"pull_request_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/pulls/12"
},
"_links": {
"type": "object",
"properties": {
"html": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
},
"pull_request": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"html",
"pull_request"
]
},
"submitted_at": {
"type": "string",
"format": "date-time"
},
"commit_id": {
"description": "A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.",
"example": "54bb654c9e6025347f57900a4a5c2313a96b8035",
"type": "string",
"nullable": true
},
"body_html": {
"type": "string"
},
"body_text": {
"type": "string"
},
"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": [
"id",
"node_id",
"user",
"body",
"state",
"commit_id",
"html_url",
"pull_request_url",
"_links",
"author_association"
]
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('github')
# Call this tool
result = await agent.call_tool('pullsGetReview', {
# Add required parameters here
})