searchIssuesAndPullRequests
Search issues and pull requests
Details
- Method:
GET - Path:
/search/issues - Operation ID:
search/issues-and-pull-requests
Parameters
{
"q": {
"description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.",
"required": true,
"location": "query",
"type": "string"
},
"sort": {
"description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results)",
"required": false,
"location": "query",
"type": "string",
"enum": [
"comments",
"reactions",
"reactions-+1",
"reactions--1",
"reactions-smile",
"reactions-thinking_face",
"reactions-heart",
"reactions-tada",
"interactions",
"created",
"updated"
]
},
"order": {
"description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.",
"required": false,
"location": "query",
"type": "string",
"enum": [
"desc",
"asc"
]
},
"per_page": {
"description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
"required": false,
"location": "query",
"type": "integer"
},
"page": {
"description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"",
"required": false,
"location": "query",
"type": "integer"
},
"advanced_search": {
"description": "Set to `true` to use advanced search.\nExample: `http://api.github.com/search/issues?q={query}&advanced_search=true`",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"type": "object",
"required": [
"total_count",
"incomplete_results",
"items"
],
"properties": {
"total_count": {
"type": "integer"
},
"incomplete_results": {
"type": "boolean"
},
"items": {
"type": "array",
"items": {
"title": "Issue Search Result Item",
"description": "Issue Search Result Item",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"repository_url": {
"type": "string",
"format": "uri"
},
"labels_url": {
"type": "string"
},
"comments_url": {
"type": "string",
"format": "uri"
},
"events_url": {
"type": "string",
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
},
"id": {
"type": "integer",
"format": "int64"
},
"node_id": {
"type": "string"
},
"number": {
"type": "integer"
},
"title": {
"type": "string"
},
"locked": {
"type": "boolean"
},
"active_lock_reason": {
"type": "string",
"nullable": true
},
"assignees": {
"type": "array",
"items": {
"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
},
"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
},
"labels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"node_id": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"default": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
}
}
}
},
"sub_issues_summary": {
"title": "Sub-issues Summary",
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"completed": {
"type": "integer"
},
"percent_completed": {
"type": "integer"
}
},
"required": [
"total",
"completed",
"percent_completed"
]
},
"issue_dependencies_summary": {
"title": "Issue Dependencies Summary",
"type": "object",
"properties": {
"blocked_by": {
"type": "integer"
},
"blocking": {
"type": "integer"
},
"total_blocked_by": {
"type": "integer"
},
"total_blocking": {
"type": "integer"
}
},
"required": [
"blocked_by",
"blocking",
"total_blocked_by",
"total_blocking"
]
},
"issue_field_values": {
"type": "array",
"items": {
"title": "Issue Field Value",
"description": "A value assigned to an issue field",
"type": "object",
"properties": {
"issue_field_id": {
"description": "Unique identifier for the issue field.",
"type": "integer",
"format": "int64",
"example": 1
},
"node_id": {
"type": "string",
"example": "IFT_GDKND"
},
"data_type": {
"description": "The data type of the issue field",
"type": "string",
"enum": [
"text",
"single_select",
"number",
"date"
],
"example": "text"
},
"value": {
"anyOf": [
{
"type": "string",
"example": "Sample text"
},
{
"type": "number",
"example": 42.5
},
{
"type": "integer",
"example": 1
}
],
"description": "The value of the issue field",
"nullable": true
},
"single_select_option": {
"description": "Details about the selected option (only present for single_select fields)",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier for the option.",
"type": "integer",
"format": "int64",
"example": 1
},
"name": {
"description": "The name of the option",
"type": "string",
"example": "High"
},
"color": {
"description": "The color of the option",
"type": "string",
"example": "red"
}
},
"required": [
"id",
"name",
"color"
],
"nullable": true
}
},
"required": [
"issue_field_id",
"node_id",
"data_type",
"value"
]
}
},
"state": {
"type": "string"
},
"state_reason": {
"type": "string",
"nullable": true
},
"assignee": {
"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
},
"milestone": {
"title": "Milestone",
"description": "A collection of related issues and pull requests.",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/milestones/1"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World/milestones/v1.0"
},
"labels_url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels"
},
"id": {
"type": "integer",
"example": 1002604
},
"node_id": {
"type": "string",
"example": "MDk6TWlsZXN0b25lMTAwMjYwNA=="
},
"number": {
"description": "The number of the milestone.",
"type": "integer",
"example": 42
},
"state": {
"description": "The state of the milestone.",
"example": "open",
"type": "string",
"enum": [
"open",
"closed"
],
"default": "open"
},
"title": {
"description": "The title of the milestone.",
"example": "v1.0",
"type": "string"
},
"description": {
"type": "string",
"example": "Tracking milestone for version 1.0",
"nullable": true
},
"creator": {
"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
},
"open_issues": {
"type": "integer",
"example": 4
},
"closed_issues": {
"type": "integer",
"example": 8
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2011-04-10T20:09:31Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2014-03-03T18:58:10Z"
},
"closed_at": {
"type": "string",
"format": "date-time",
"example": "2013-02-12T13:22:01Z",
"nullable": true
},
"due_on": {
"type": "string",
"format": "date-time",
"example": "2012-10-09T23:39:01Z",
"nullable": true
}
},
"required": [
"closed_issues",
"creator",
"description",
"due_on",
"closed_at",
"id",
"node_id",
"labels_url",
"html_url",
"number",
"open_issues",
"state",
"title",
"url",
"created_at",
"updated_at"
],
"nullable": true
},
"comments": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"closed_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"text_matches": {
"title": "Search Result Text Matches",
"type": "array",
"items": {
"type": "object",
"properties": {
"object_url": {
"type": "string"
},
"object_type": {
"nullable": true,
"type": "string"
},
"property": {
"type": "string"
},
"fragment": {
"type": "string"
},
"matches": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"indices": {
"type": "array",
"items": {
"type": "integer"
}
}
}
}
}
}
}
},
"pull_request": {
"type": "object",
"properties": {
"merged_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"diff_url": {
"type": "string",
"format": "uri",
"nullable": true
},
"html_url": {
"type": "string",
"format": "uri",
"nullable": true
},
"patch_url": {
"type": "string",
"format": "uri",
"nullable": true
},
"url": {
"type": "string",
"format": "uri",
"nullable": true
}
},
"required": [
"diff_url",
"html_url",
"patch_url",
"url"
]
},
"body": {
"type": "string"
},
"score": {
"type": "number"
},
"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"
]
},
"draft": {
"type": "boolean"
},
"repository": {
"title": "Repository",
"description": "A repository on GitHub.",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the repository",
"example": 42,
"type": "integer",
"format": "int64"
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"name": {
"description": "The name of the repository.",
"type": "string",
"example": "Team Environment"
},
"full_name": {
"type": "string",
"example": "octocat/Hello-World"
},
"license": {
"title": "License Simple",
"description": "License Simple",
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "mit"
},
"name": {
"type": "string",
"example": "MIT License"
},
"url": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "https://api.github.com/licenses/mit"
},
"spdx_id": {
"type": "string",
"nullable": true,
"example": "MIT"
},
"node_id": {
"type": "string",
"example": "MDc6TGljZW5zZW1pdA=="
},
"html_url": {
"type": "string",
"format": "uri"
}
},
"required": [
"key",
"name",
"url",
"spdx_id",
"node_id"
],
"nullable": true
},
"forks": {
"type": "integer"
},
"permissions": {
"type": "object",
"properties": {
"admin": {
"type": "boolean"
},
"pull": {
"type": "boolean"
},
"triage": {
"type": "boolean"
},
"push": {
"type": "boolean"
},
"maintain": {
"type": "boolean"
}
},
"required": [
"admin",
"pull",
"push"
]
},
"owner": {
"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"
]
},
"private": {
"description": "Whether the repository is private or public.",
"default": false,
"type": "boolean"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/octocat/Hello-World"
},
"description": {
"type": "string",
"example": "This your first repo!",
"nullable": true
},
"fork": {
"type": "boolean"
},
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/octocat/Hello-World"
},
"archive_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
},
"assignees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
},
"blobs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
},
"branches_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
},
"collaborators_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
},
"comments_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
},
"commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
},
"compare_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
},
"contents_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
},
"contributors_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/contributors"
},
"deployments_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/deployments"
},
"downloads_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/downloads"
},
"events_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/events"
},
"forks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/forks"
},
"git_commits_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
},
"git_refs_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
},
"git_tags_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
},
"git_url": {
"type": "string",
"example": "git:github.com/octocat/Hello-World.git"
},
"issue_comment_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
},
"issue_events_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
},
"issues_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
},
"keys_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
},
"labels_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
},
"languages_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/languages"
},
"merges_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/merges"
},
"milestones_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
},
"notifications_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
},
"pulls_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
},
"releases_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
},
"ssh_url": {
"type": "string",
"example": "git@github.com:octocat/Hello-World.git"
},
"stargazers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
},
"statuses_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
},
"subscribers_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
},
"subscription_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/subscription"
},
"tags_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/tags"
},
"teams_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/teams"
},
"trees_url": {
"type": "string",
"example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
},
"clone_url": {
"type": "string",
"example": "https://github.com/octocat/Hello-World.git"
},
"mirror_url": {
"type": "string",
"format": "uri",
"example": "git:git.example.com/octocat/Hello-World",
"nullable": true
},
"hooks_url": {
"type": "string",
"format": "uri",
"example": "http://api.github.com/repos/octocat/Hello-World/hooks"
},
"svn_url": {
"type": "string",
"format": "uri",
"example": "https://svn.github.com/octocat/Hello-World"
},
"homepage": {
"type": "string",
"format": "uri",
"example": "https://github.com",
"nullable": true
},
"language": {
"type": "string",
"nullable": true
},
"forks_count": {
"type": "integer",
"example": 9
},
"stargazers_count": {
"type": "integer",
"example": 80
},
"watchers_count": {
"type": "integer",
"example": 80
},
"size": {
"description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
"type": "integer",
"example": 108
},
"default_branch": {
"description": "The default branch of the repository.",
"type": "string",
"example": "master"
},
"open_issues_count": {
"type": "integer",
"example": 0
},
"is_template": {
"description": "Whether this repository acts as a template that can be used to generate new repositories.",
"default": false,
"type": "boolean",
"example": true
},
"topics": {
"type": "array",
"items": {
"type": "string"
}
},
"has_issues": {
"description": "Whether issues are enabled.",
"default": true,
"type": "boolean",
"example": true
},
"has_projects": {
"description": "Whether projects are enabled.",
"default": true,
"type": "boolean",
"example": true
},
"has_wiki": {
"description": "Whether the wiki is enabled.",
"default": true,
"type": "boolean",
"example": true
},
"has_pages": {
"type": "boolean"
},
"has_downloads": {
"description": "Whether downloads are enabled.",
"default": true,
"type": "boolean",
"example": true,
"deprecated": true
},
"has_discussions": {
"description": "Whether discussions are enabled.",
"default": false,
"type": "boolean",
"example": true
},
"archived": {
"description": "Whether the repository is archived.",
"default": false,
"type": "boolean"
},
"disabled": {
"type": "boolean",
"description": "Returns whether or not this repository disabled."
},
"visibility": {
"description": "The repository visibility: public, private, or internal.",
"default": "public",
"type": "string"
},
"pushed_at": {
"type": "string",
"format": "date-time",
"example": "2011-01-26T19:06:43Z",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2011-01-26T19:01:12Z",
"nullable": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2011-01-26T19:14:43Z",
"nullable": true
},
"allow_rebase_merge": {
"description": "Whether to allow rebase merges for pull requests.",
"default": true,
"type": "boolean",
"example": true
},
"temp_clone_token": {
"type": "string"
},
"allow_squash_merge": {
"description": "Whether to allow squash merges for pull requests.",
"default": true,
"type": "boolean",
"example": true
},
"allow_auto_merge": {
"description": "Whether to allow Auto-merge to be used on pull requests.",
"default": false,
"type": "boolean",
"example": false
},
"delete_branch_on_merge": {
"description": "Whether to delete head branches when pull requests are merged",
"default": false,
"type": "boolean",
"example": false
},
"allow_update_branch": {
"description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.",
"default": false,
"type": "boolean",
"example": false
},
"use_squash_pr_title_as_default": {
"type": "boolean",
"description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.",
"default": false,
"deprecated": true
},
"squash_merge_commit_title": {
"type": "string",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
],
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)."
},
"squash_merge_commit_message": {
"type": "string",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
],
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message."
},
"merge_commit_title": {
"type": "string",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
],
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
},
"merge_commit_message": {
"type": "string",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
],
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message."
},
"allow_merge_commit": {
"description": "Whether to allow merge commits for pull requests.",
"default": true,
"type": "boolean",
"example": true
},
"allow_forking": {
"description": "Whether to allow forking this repo",
"type": "boolean"
},
"web_commit_signoff_required": {
"description": "Whether to require contributors to sign off on web-based commits",
"default": false,
"type": "boolean"
},
"open_issues": {
"type": "integer"
},
"watchers": {
"type": "integer"
},
"master_branch": {
"type": "string"
},
"starred_at": {
"type": "string",
"example": "\"2020-07-09T00:17:42Z\""
},
"anonymous_access_enabled": {
"type": "boolean",
"description": "Whether anonymous git access is enabled for this repository"
},
"code_search_index_status": {
"type": "object",
"description": "The status of the code search index for this repository",
"properties": {
"lexical_search_ok": {
"type": "boolean"
},
"lexical_commit_sha": {
"type": "string"
}
}
}
},
"required": [
"archive_url",
"assignees_url",
"blobs_url",
"branches_url",
"collaborators_url",
"comments_url",
"commits_url",
"compare_url",
"contents_url",
"contributors_url",
"deployments_url",
"description",
"downloads_url",
"events_url",
"fork",
"forks_url",
"full_name",
"git_commits_url",
"git_refs_url",
"git_tags_url",
"hooks_url",
"html_url",
"id",
"node_id",
"issue_comment_url",
"issue_events_url",
"issues_url",
"keys_url",
"labels_url",
"languages_url",
"merges_url",
"milestones_url",
"name",
"notifications_url",
"owner",
"private",
"pulls_url",
"releases_url",
"stargazers_url",
"statuses_url",
"subscribers_url",
"subscription_url",
"tags_url",
"teams_url",
"trees_url",
"url",
"clone_url",
"default_branch",
"forks",
"forks_count",
"git_url",
"has_downloads",
"has_issues",
"has_projects",
"has_wiki",
"has_pages",
"homepage",
"language",
"archived",
"disabled",
"mirror_url",
"open_issues",
"open_issues_count",
"license",
"pushed_at",
"size",
"ssh_url",
"stargazers_count",
"svn_url",
"watchers",
"watchers_count",
"created_at",
"updated_at"
]
},
"body_html": {
"type": "string"
},
"body_text": {
"type": "string"
},
"timeline_url": {
"type": "string",
"format": "uri"
},
"type": {
"title": "Issue Type",
"description": "The type of issue.",
"type": "object",
"nullable": true,
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the issue type."
},
"node_id": {
"type": "string",
"description": "The node identifier of the issue type."
},
"name": {
"type": "string",
"description": "The name of the issue type."
},
"description": {
"type": "string",
"description": "The description of the issue type.",
"nullable": true
},
"color": {
"type": "string",
"description": "The color of the issue type.",
"enum": [
"gray",
"blue",
"green",
"yellow",
"orange",
"red",
"pink",
"purple"
],
"nullable": true
},
"created_at": {
"type": "string",
"description": "The time the issue type created.",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The time the issue type last updated.",
"format": "date-time"
},
"is_enabled": {
"type": "boolean",
"description": "The enabled state of the issue type."
}
},
"required": [
"id",
"node_id",
"name",
"description"
]
},
"performed_via_github_app": {
"title": "GitHub app",
"description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
"type": "object",
"nullable": true,
"properties": {
"id": {
"description": "Unique identifier of the GitHub app",
"example": 37,
"type": "integer"
},
"slug": {
"description": "The slug name of the GitHub app",
"example": "probot-owners",
"type": "string"
},
"node_id": {
"type": "string",
"example": "MDExOkludGVncmF0aW9uMQ=="
},
"client_id": {
"type": "string",
"example": "\"Iv1.25b5d1e65ffc4022\""
},
"owner": {
"oneOf": [
{
"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"
]
},
{
"title": "Enterprise",
"description": "An enterprise on GitHub.",
"type": "object",
"properties": {
"description": {
"description": "A short description of the enterprise.",
"type": "string",
"nullable": true
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/enterprises/octo-business"
},
"website_url": {
"description": "The enterprise's website URL.",
"type": "string",
"nullable": true,
"format": "uri"
},
"id": {
"description": "Unique identifier of the enterprise",
"example": 42,
"type": "integer"
},
"node_id": {
"type": "string",
"example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
},
"name": {
"description": "The name of the enterprise.",
"type": "string",
"example": "Octo Business"
},
"slug": {
"description": "The slug url identifier for the enterprise.",
"type": "string",
"example": "octo-business"
},
"created_at": {
"type": "string",
"nullable": true,
"format": "date-time",
"example": "2019-01-26T19:01:12Z"
},
"updated_at": {
"type": "string",
"nullable": true,
"format": "date-time",
"example": "2019-01-26T19:14:43Z"
},
"avatar_url": {
"type": "string",
"format": "uri"
}
},
"required": [
"id",
"node_id",
"name",
"slug",
"html_url",
"created_at",
"updated_at",
"avatar_url"
]
}
]
},
"name": {
"description": "The name of the GitHub app",
"example": "Probot Owners",
"type": "string"
},
"description": {
"type": "string",
"example": "The description of the app.",
"nullable": true
},
"external_url": {
"type": "string",
"format": "uri",
"example": "https://example.com"
},
"html_url": {
"type": "string",
"format": "uri",
"example": "https://github.com/apps/super-ci"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2017-07-08T16:18:44-04:00"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2017-07-08T16:18:44-04:00"
},
"permissions": {
"description": "The set of permissions for the GitHub app",
"type": "object",
"properties": {
"issues": {
"type": "string"
},
"checks": {
"type": "string"
},
"metadata": {
"type": "string"
},
"contents": {
"type": "string"
},
"deployments": {
"type": "string"
}
},
"additionalProperties": {
"type": "string"
},
"example": {
"issues": "read",
"deployments": "write"
}
},
"events": {
"description": "The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.",
"example": [
"label",
"deployment"
],
"type": "array",
"items": {
"type": "string"
}
},
"installations_count": {
"description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.",
"example": 5,
"type": "integer"
}
},
"required": [
"id",
"node_id",
"owner",
"name",
"description",
"external_url",
"html_url",
"created_at",
"updated_at",
"permissions",
"events"
]
},
"reactions": {
"title": "Reaction Rollup",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"total_count": {
"type": "integer"
},
"+1": {
"type": "integer"
},
"-1": {
"type": "integer"
},
"laugh": {
"type": "integer"
},
"confused": {
"type": "integer"
},
"heart": {
"type": "integer"
},
"hooray": {
"type": "integer"
},
"eyes": {
"type": "integer"
},
"rocket": {
"type": "integer"
}
},
"required": [
"url",
"total_count",
"+1",
"-1",
"laugh",
"confused",
"heart",
"hooray",
"eyes",
"rocket"
]
}
},
"required": [
"assignee",
"closed_at",
"comments",
"comments_url",
"events_url",
"html_url",
"id",
"node_id",
"labels",
"labels_url",
"milestone",
"number",
"repository_url",
"state",
"locked",
"title",
"url",
"user",
"author_association",
"created_at",
"updated_at",
"score"
]
}
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('github')
# Call this tool
result = await agent.call_tool('searchIssuesAndPullRequests', {
# Add required parameters here
})