actionsGetReviewsForRun
Get the review history for a workflow run
Details
- Method:
GET - Path:
/repos/{owner}/{repo}/actions/runs/{run_id}/approvals - Operation ID:
actions/get-reviews-for-run
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"
},
"run_id": {
"description": "The unique identifier of the workflow run.",
"required": true,
"location": "path",
"type": "integer"
}
}Response Schema
{
"type": "array",
"items": {
"title": "Environment Approval",
"description": "An entry in the reviews log for environment deployments",
"type": "object",
"properties": {
"environments": {
"description": "The list of environments that were approved or rejected",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "The id of the environment.",
"example": 56780428,
"type": "integer"
},
"node_id": {
"type": "string",
"example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg="
},
"name": {
"description": "The name of the environment.",
"example": "staging",
"type": "string"
},
"url": {
"type": "string",
"example": "https://api.github.com/repos/github/hello-world/environments/staging"
},
"html_url": {
"type": "string",
"example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging"
},
"created_at": {
"description": "The time that the environment was created, in ISO 8601 format.",
"example": "2020-11-23T22:00:40Z",
"format": "date-time",
"type": "string"
},
"updated_at": {
"description": "The time that the environment was last updated, in ISO 8601 format.",
"example": "2020-11-23T22:00:40Z",
"format": "date-time",
"type": "string"
}
}
}
},
"state": {
"description": "Whether deployment to the environment(s) was approved or rejected or pending (with comments)",
"enum": [
"approved",
"rejected",
"pending"
],
"example": "approved",
"type": "string"
},
"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"
]
},
"comment": {
"type": "string",
"description": "The comment submitted with the deployment review",
"example": "Ship it!"
}
},
"required": [
"environments",
"state",
"user",
"comment"
]
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('github')
# Call this tool
result = await agent.call_tool('actionsGetReviewsForRun', {
# Add required parameters here
})