31:T5b5,--- ## About _fetchGithub_ Throughout this notebook we use a helper function that wraps [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) to add the `GITHUB_ACCESS_TOKEN` to all requests as an authorization header. It returns the response’s JSON if successful, or _false_ if not. **fetchGithub**(_path_[, _params_[, _options_]]) - _path_ is an endpoint relative to https://api.github.com - _params_ is an object to be converted to a query string (optional) - _options_ is an object to be passed as the second parameter of _fetch_ (optional) To convert a simple fetchGithub example to a regular fetch: ~~~js // with helper fetchGithub(`/user`) // without helper fetch(`https://api.github.com/user`, { headers: { authorization: `token \${Secret("GITHUB_ACCESS_TOKEN")}`, // for permissions & rate limit accept: "application/vnd.github.v3+json" // specifies API version } }).then((resp) => resp.json()) ~~~ To convert a more complicated example, with query parameters and custom headers: ~~~js // with helper fetchGithub( `/repos/${username}/${repo}/issues`, { state: "all" }, { headers: { accept: "application/vnd.github.squirrel-girl-preview" } } ) // without helper fetch(`https://api.github.com/repos/${username}/${repo}/issues?state=all`, { headers: { authorization: `token \${Secret("GITHUB_ACCESS_TOKEN")}`, accept: "application/vnd.github.squirrel-girl-preview" } }).then((resp) => resp.json()) ~~~32:[] 2f:{"title":"GitHub API Explorer","cells":[{"id":0,"value":"# GitHub API Explorer\n\nThis notebook shows real responses for a curated subset of the methods in the [GitHub REST API](https://docs.github.com/en/rest/reference). Although the API supports modifying or writing data, this notebook demonstrates only `GET` requests that read information.\n\nYou’ll be rate-limited to 60 requests per hour; to increase the limit to 5,000 requests per hour, fork this notebook and authenticate it:\n\n1. Create a [GitHub personal access token](https://github.com/settings/tokens) \n2. Save it in a [Secret](https://observablehq.com/settings/secrets) named `GITHUB_ACCESS_TOKEN` ${hasApiKey ? \"✅ Secret found\" : \"⚠️ Secret not found\"}\n\nChoose a user and repository to be used throughout the examples:","pinned":false,"hidden":false,"mode":"md"},{"id":247,"value":"username = \"microsoft\"","pinned":true,"hidden":false,"mode":"ojs"},{"id":19,"value":"repo = \"typescript\"","pinned":true,"hidden":false,"mode":"ojs"},{"id":1221,"value":"Some endpoints may fail for some usernames or repositories, which shows as `false`.","pinned":false,"hidden":false,"mode":"md"},{"id":24,"value":"rateLimitSummary","pinned":false,"hidden":false,"mode":"ojs"},{"id":1054,"value":"---","pinned":false,"hidden":false,"mode":"md"},{"id":390,"value":"toc(\"h2\")","pinned":false,"hidden":false,"mode":"ojs"},{"id":281,"value":"---\n## Actions\n\n[📖 Docs](https://docs.github.com/en/rest/reference/actions) • List artifacts for a repository, or get a single artifact.","pinned":false,"hidden":false,"mode":"md"},{"id":318,"value":"artifacts = fetchGithub(`/repos/${username}/${repo}/actions/artifacts`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":319,"value":"artifact = artifacts?.artifacts?.length &&\n fetchGithub(\n `/repos/${username}/${repo}/actions/artifacts/${artifacts.artifacts[0].id}`\n )","pinned":true,"hidden":false,"mode":"ojs"},{"id":261,"value":"---\n## Activity\n[📖 Docs](https://docs.github.com/en/rest/reference/activity) • Get user events, repo events, or stargazers.","pinned":false,"hidden":false,"mode":"md"},{"id":263,"value":"userEvents = fetchGithub(`/users/${username}/events/public`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":344,"value":"Plot.tickX(userEvents, {x: d => new Date(d.created_at)}).plot()","pinned":false,"hidden":false,"mode":"ojs"},{"id":270,"value":"repoEvents = fetchGithub(`/repos/${username}/${repo}/events`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":347,"value":"Plot.tickX(repoEvents, {x: d => new Date(d.created_at)}).plot()","pinned":false,"hidden":false,"mode":"ojs"},{"id":274,"value":"stargazers = fetchGithub(`/repos/${username}/${repo}/stargazers`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":414,"value":"---\n## Gists\n[📖 Docs](https://docs.github.com/en/rest/reference/gists) • List gists for a user, or get a single gist.","pinned":false,"hidden":false,"mode":"md"},{"id":430,"value":"gists = fetchGithub(`/users/${username}/gists`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":416,"value":"viewof gistPick = Inputs.table(gists, {\n multiple: false,\n value: gists[0],\n columns: gists?.length\n ? [\n \"html_url\",\n \"description\",\n \"comments\",\n \"public\",\n \"created_at\",\n \"updated_at\"\n ]\n : [],\n format: {\n html_url: (d) => htl.html`${d.split(\"/\")[3].substr(0, 6)} `\n }\n})","pinned":false,"hidden":false,"mode":"ojs"},{"id":436,"value":"gist = gistPick && fetchGithub(`/gists/${gistPick?.id}`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":440,"value":"gistCommits = gistPick && fetchGithub(`/gists/${gistPick?.id}/commits`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":444,"value":"---\n## Gitignore\n[📖 Docs](https://docs.github.com/en/rest/reference/gitignore) • Get all gitignore templates, or get the source of a single template.","pinned":false,"hidden":false,"mode":"md"},{"id":446,"value":"gitignores = fetchGithub(`/gitignore/templates`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":453,"value":"viewof gitignoresPick = Inputs.select(gitignores, {value: gitignores[0], label: \"Template\"})","pinned":false,"hidden":false,"mode":"ojs"},{"id":450,"value":"gitignore = fetchGithub(`/gitignore/templates/${gitignoresPick}`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":458,"value":"

Source of chosen template

${gitignore.source}

","pinned":false,"hidden":false,"mode":"html"},{"id":244,"value":"---\n## Issues\n[📖 Docs](https://docs.github.com/en/rest/reference/issues) • List issues for a repository, or get details about a single issue. For example, you can plot when issues were opened and closed. Here, we pass an optional media type in the headers to get the `reactions` property on the response.","pinned":false,"hidden":false,"mode":"md"},{"id":16,"value":"issues = fetchGithub(\n `/repos/${username}/${repo}/issues`,\n { state: \"all\" }, // default: \"open\"\n { headers: { accept: \"application/vnd.github.squirrel-girl-preview\" } } // to get reactions\n)","pinned":true,"hidden":false,"mode":"ojs"},{"id":558,"value":"viewof issuesPick = Inputs.select(\n issues\n ? new Map(\n issues.map((issue) => [`#${issue.number}: ${issue.title}`, issue])\n )\n : [\"—\"],\n { label: \"Issue\" }\n)","pinned":false,"hidden":false,"mode":"ojs"},{"id":553,"value":"issueComments = issues && fetchGithub(`/repos/${username}/${repo}/issues/${issuesPick?.number}/comments`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":604,"value":"issuePlot = issues && Plot.plot({\n y: {\n domain: issues.map((d) => d.number),\n label: null\n },\n marks: [\n Plot.ruleY(issues, {\n y: \"number\",\n x1: (d) => new Date(d.created_at),\n x2: (d) => (d.closed_at ? new Date(d.closed_at) : new Date())\n }),\n Plot.dot(issues, {\n y: \"number\",\n x: (d) => new Date(d.created_at),\n fill: \"#28a745\"\n }),\n Plot.dot(\n issues.filter((d) => d.closed_at),\n { y: \"number\", x: (d) => new Date(d.closed_at), fill: \"#d73a49\" }\n )\n ]\n})","pinned":false,"hidden":false,"mode":"ojs"},{"id":643,"value":"Despite the separate endpoint for Pulls, issues also include pull requests, which you can distinguish by the `pull_request` property.","pinned":false,"hidden":false,"mode":"md"},{"id":641,"value":"issues && issues.filter(d => d.pull_request)","pinned":true,"hidden":false,"mode":"ojs"},{"id":648,"value":"---\n## Licenses\n[📖 Docs](https://docs.github.com/en/rest/reference/licenses) • List common licenses, or get the license for a specific repo.","pinned":false,"hidden":false,"mode":"md"},{"id":651,"value":"licenses = fetchGithub(`/licenses`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":652,"value":"repoLicense = fetchGithub(`/repos/${username}/${repo}/license`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":655,"value":"repoLicenseSource = repoLicense && fetchGithub(`/licenses/${repoLicense.license.key}`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":661,"value":"

Text of license

${repoLicenseSource.body}

","pinned":false,"hidden":false,"mode":"html"},{"id":671,"value":"---\n## Meta\n[📖 Docs](https://docs.github.com/en/rest/reference/meta) • Get meta information about GitHub.","pinned":false,"hidden":false,"mode":"md"},{"id":679,"value":"(await fetchGithubResponse(`/octocat`)).text()","pinned":true,"hidden":false,"mode":"ojs"},{"id":684,"value":"(await fetchGithubResponse(`/zen`)).text()","pinned":true,"hidden":false,"mode":"ojs"},{"id":689,"value":"---\n## Organizations\n[📖 Docs](https://docs.github.com/en/rest/reference/orgs) • Get an organization, or the organizations a user belongs to. If the username entered at the top is an organization, you’ll see only the former here; if it’s an individual, only the latter.","pinned":false,"hidden":false,"mode":"md"},{"id":930,"value":"organization = fetchGithub(`/orgs/${username}`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":691,"value":"organizations = fetchGithub(`/users/${username}/orgs`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":716,"value":"---\n## Projects\n[📖 Docs](https://docs.github.com/en/rest/reference/projects) • Get an organization or repository’s project boards and cards. During the developer preview, you must pass a special media type in the request headers to fetch projects.","pinned":false,"hidden":false,"mode":"md"},{"id":726,"value":"projectsMediaType = ({ headers: { accept: \"application/vnd.github.inertia-preview+json\" } })","pinned":true,"hidden":false,"mode":"ojs"},{"id":718,"value":"projects = fetchGithub(`/repos/${username}/${repo}/projects`, {}, projectsMediaType)\n// projects = fetchGithub(`/orgs/${username}/projects`, {}, projectsMediaType)\n// projects = fetchGithub(`/users/${username}/projects`, {}, projectsMediaType)","pinned":true,"hidden":false,"mode":"ojs"},{"id":763,"value":"viewof projectsPick = Inputs.select(\n projects\n ? new Map(projects.map((d) => [`${d.number}: ${d.name}`, d]))\n : [\"—\"],\n { label: \"Project\" }\n)","pinned":false,"hidden":false,"mode":"ojs"},{"id":768,"value":"columns = fetchGithub(`/projects/${projectsPick.id}/columns`, {}, projectsMediaType)","pinned":true,"hidden":false,"mode":"ojs"},{"id":781,"value":"viewof columnsPick = Inputs.select(\n columns ? new Map(columns.map((d) => [d.name, d])) : [\"—\"],\n { label: \"Column\" }\n)","pinned":false,"hidden":false,"mode":"ojs"},{"id":784,"value":"cards = fetchGithub(`/projects/columns/${columnsPick.id}/cards`, {}, projectsMediaType)","pinned":true,"hidden":false,"mode":"ojs"},{"id":797,"value":"---\n## Pulls\n[📖 Docs](https://docs.github.com/en/rest/reference/pulls) • Get pull requests for a repo, and associated commits and comments.","pinned":false,"hidden":false,"mode":"md"},{"id":801,"value":"pullRequests = fetchGithub(`/repos/${username}/${repo}/pulls`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":806,"value":"viewof pullRequestsPick = Inputs.select(\n pullRequests\n ? new Map(pullRequests.map((d) => [`${d.number}: ${d.title}`, d]))\n : [\"—\"],\n { label: \"Pull request\" }\n)","pinned":false,"hidden":false,"mode":"ojs"},{"id":813,"value":"pullRequestCommits = pullRequests && fetchGithub(`/repos/${username}/${repo}/pulls/${pullRequestsPick?.number}/commits`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":824,"value":"pullRequestComments = pullRequests && fetchGithub(`/repos/${username}/${repo}/pulls/${pullRequestsPick?.number}/comments`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":833,"value":"---\n## Rate limit\n[📖 Docs](https://docs.github.com/en/rest/reference/rate-limit) • See your current rate limit for different APIs. This request does not count toward the limit! (Rate limit information is also provided in the headers of the response to requests.)","pinned":false,"hidden":false,"mode":"md"},{"id":831,"value":"fetchGithub(`/rate_limit`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":840,"value":"---\n## Repositories\n[📖 Docs](https://docs.github.com/en/rest/reference/repos) • List repositories or their branches, collaborators, commits, forks, etc.","pinned":false,"hidden":false,"mode":"md"},{"id":844,"value":"repos = fetchGithub(`/users/${username}/repos`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":846,"value":"branches = fetchGithub(`/repos/${username}/${repo}/branches`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":849,"value":"collaborators = fetchGithub(`/repos/${username}/${repo}/collaborators`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":851,"value":"commits = fetchGithub(`/repos/${username}/${repo}/commits`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":863,"value":"forks = fetchGithub(`/repos/${username}/${repo}/forks`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":860,"value":"pages = fetchGithub(`/repos/${username}/${repo}/pages`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":856,"value":"releases = fetchGithub(`/repos/${username}/${repo}/releases`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":854,"value":"referrers = fetchGithub(`/repos/${username}/${repo}/traffic/popular/referrers`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":868,"value":"---\n## Search\n[📖 Docs](https://docs.github.com/en/rest/reference/search) • Search code, users, or repositories. These endpoints have their own distinct rate limits. ","pinned":false,"hidden":false,"mode":"md"},{"id":906,"value":"viewof searchQuery = Inputs.text({label: \"Search\", value: \"data visualization\", submit: true})","pinned":false,"hidden":false,"mode":"ojs"},{"id":870,"value":"searchResults = fetchGithub(`/search/repositories`, {q: searchQuery})","pinned":true,"hidden":false,"mode":"ojs"},{"id":874,"value":"Inputs.table(searchResults.items, {\n columns: [\n \"name\",\n \"owner\",\n \"description\",\n \"homepage\",\n \"language\",\n \"stargazers_count\"\n ],\n format: {\n name: (name, i, data) =>\n htl.html`${name}`,\n owner: (d) => d.login,\n homepage: (d) => htl.html`${d}`\n },\n sort: \"stargazers_count\",\n reverse: true\n})","pinned":false,"hidden":false,"mode":"ojs"},{"id":916,"value":"---\n## Users\n[📖 Docs](https://docs.github.com/en/rest/reference/users) • Get information like followers and following about the currently authenticated user (you!), or about a given user. If the username entered at the top is an organization, see the Organizations endpoints instead.","pinned":false,"hidden":false,"mode":"md"},{"id":919,"value":"you = fetchGithub(`/user`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":935,"value":"yourFollowers = fetchGithub(`/user/followers`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":937,"value":"yourFollowing = fetchGithub(`/user/following`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":928,"value":"user = fetchGithub(`/user/${username}`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":945,"value":"userFollowers = fetchGithub(`/user/${username}/followers`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":947,"value":"userFollowing = fetchGithub(`/user/${username}/following`)","pinned":true,"hidden":false,"mode":"ojs"},{"id":1067,"value":"$31","pinned":false,"hidden":false,"mode":"md"},{"id":312,"value":"---\n## Appendix","pinned":false,"hidden":false,"mode":"md"},{"id":388,"value":"import {toc} from \"@mbostock/toc\"","pinned":true,"hidden":false,"mode":"ojs"},{"id":5,"value":"import {fetchGithub, fetchGithubResponse, hasApiKey, rateLimitSummary} from \"@observablehq/github-actions-workflows-api\"","pinned":true,"hidden":false,"mode":"ojs"},{"id":179,"value":"// For a notebook to access Secrets, it must statically reference one; this cell grants Secret access to the notebook from which we import the GitHub API helpers. `undefined &&` prevents the Secret from appearing in plaintext in the Inspector.\nundefined && Secret(\"GITHUB_ACCESS_TOKEN\")","pinned":true,"hidden":false,"mode":"ojs"}],"files":"$W32","stdlib":"1","titling":"auto"}