` tag will.
+ - Some Octicons used as labels have dynamic `aria-label` elements that change based on the state of the UI element or a user input. For example, when someone has two security policies-`Policy A` and `Policy B`-their UI will show two trash Octicons labelled `{% octicon "trash" aria-label="Delete Policy A" %}` and `{% octicon "trash" aria-label="Delete Policy B" %}`. For dynamic `aria-label` elements, since we can't document the exact `aria-label` that people will encounter, describe the Octicon and a placeholder example of the label (for example, `"{% octicon "trash" aria-label="The trash icon, labelled 'Delete YOUR-POLICY-NAME'." %}"`). This will help people identify both the Octicon and how it is labelled, and give context for collaborating with people who are visually describing the Octicon.
- If the Octicon is decorative, it's likely hidden to screen readers with the `aria-hidden=true` attribute. If so, for consistency with the product, use `aria-hidden="true"` in the Liquid syntax for the Octicon in the docs as well (for example, `"{% octicon "plus" aria-hidden="true" %} Add message"`).
If you're using the Octicon in another way, such as using the "check" and "x" icons to reflect binary values in tables, use the `aria-label` to describe the meaning of the Octicon, not its visual characteristics. For example, if you're using a "x" icon in the "Supported" column of a table, use "Not supported" as the `aria-label`. For more information, see "[AUTOTITLE](/contributing/writing-for-github-docs/style-guide#tables)."
-### Example usage of octicons
+### Example usage of Octicons
```text
{% raw %}{% octicon "
" %}
@@ -186,7 +187,7 @@ These instructions are pertinent to Windows users.
{% endwindows %}{% endraw %}
```
-You can define a default platform in an article's YAML frontmatter. For more information, see the [frontmatter documentation](https://github.com/github/docs/blob/main/content/README.md#frontmatter).
+You can define a default platform in an article's YAML frontmatter. For more information, see "[AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter#defaultplatform)."
## Tool tags
@@ -194,7 +195,7 @@ We occasionally need to write documentation for different tools ({% data variabl
On rare occasions, we will add new tools. Before adding a new tool, read "[AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/creating-tool-switchers-in-articles)." To add a new tool, add an entry to the `allTools` object in [`lib/all-tools.js`](https://github.com/github/docs/blob/main/src/tools/lib/all-tools.js) as a key-value pair. The key is the tag you'll use to refer to the tool in the article, and the value is how the tool will be identified on the tool picker at the top of the article.
-You can define a default tool for an article in the YAML frontmatter. For more information, see the [frontmatter documentation](https://github.com/github/docs/blob/main/content/README.md#frontmatter).
+You can define a default tool for an article in the YAML frontmatter. For more information, see "[AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter#defaulttool)."
### Example usage of tool tags
@@ -343,11 +344,64 @@ If this happens, add the following CSS style to the `` HTML tag:
For a current example of this usage, see "[AUTOTITLE](/actions/examples)."
-## Internal links with AUTOTITLE
+## Links
+
+Links to docs in the `docs` repository must start with a product ID (like `/actions` or `/admin`) and contain the entire filepath, but not the file extension. For example, `/actions/creating-actions/about-custom-actions`.
+
+Image paths must start with `/assets` and contain the entire filepath including the file extension. For example, `/assets/images/help/settings/settings-account-delete.png`.
+
+The links to Markdown pages undergo some transformations on the server side to match the current page's language and version. The handling for these transformations lives in [`lib/render-content/plugins/rewrite-local-links`](https://github.com/github/docs/blob/main/src/content-render/unified/rewrite-local-links.js).
+
+For example, if you include the following link in a content file:
+
+```
+/github/writing-on-github/creating-a-saved-reply
+```
+When viewed on {% data variables.product.prodname_dotcom_the_website %} docs, the link gets rendered with the language code:
+```
+/en/github/writing-on-github/creating-a-saved-reply
+```
+and when viewed on {% data variables.product.prodname_ghe_server %} docs, the version is included as well:
+```
+/en/enterprise-server@2.20/github/writing-on-github/creating-a-saved-reply
+```
+For more information about links, see "[AUTOTITLE](/contributing/writing-for-github-docs/style-guide#links)."
+
+### Permalinks
+
+Because the site is dynamic, it does not build HTML files for each different version of an article. Instead it generates a "permalink" for every version of the article. It does this based on the article's [`versions` frontmatter](/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter#versions).
+
+{% note %}
+
+**Note**: As of early 2021, the `free-pro-team@latest` version is not included in URLs. A helper function called `lib/remove-fpt-from-path.js` removes the version from URLs.
+
+{% endnote %}
+
+For example, an article that is available in currently supported versions will have permalink URLs like the following:
+
+- `/en/get-started/quickstart/set-up-git`
+- `/en/enterprise-cloud@latest/get-started/quickstart/set-up-git`
+- `/en/enterprise-server@3.10/get-started/quickstart/set-up-git`
+- `/en/enterprise-server@3.9/get-started/quickstart/set-up-git`
+- `/en/enterprise-server@3.8/get-started/quickstart/set-up-git`
+- `/en/enterprise-server@3.7/get-started/quickstart/set-up-git`
+- `/en/enterprise-server@3.6/get-started/quickstart/set-up-git`
+
+An article that is not available in {% data variables.product.prodname_ghe_server %} will have just one permalink:
+
+- `/en/get-started/quickstart/set-up-git`
+
+{% note %}
+
+**Note:** If you are a content contributor, you don't need to worry about supported versions when adding a link to a document. Following the examples above, if you want to reference an article, you can just use its relative location: `/github/getting-started-with-github/set-up-git`.
+
+{% endnote %}
+
+### Internal links with AUTOTITLE
When linking to another {% data variables.product.prodname_docs %} page, use standard Markdown syntax like `[]()`, but type `AUTOTITLE` instead of the page title. The {% data variables.product.prodname_docs %} application will replace `AUTOTITLE` with the title of the linked page during rendering. This special keyword is case-sensitive, so take care with your typing or the replacement will not work.
-### Example usage of internal links with AUTOTITLE
+#### Example usage of internal links with AUTOTITLE
- `For more information, see "[AUTOTITLE](/path/to/page)."`
- `For more information, see "[AUTOTITLE](/path/to/page#section-link)."`
@@ -359,4 +413,31 @@ When linking to another {% data variables.product.prodname_docs %} page, use sta
{% endnote %}
-For more information about links, see "[AUTOTITLE](/contributing/writing-for-github-docs/style-guide#links)."
+### Linking to the current article in a different version of the docs
+
+Sometimes you may want to link from an article to the same article in a different product version. For example:
+
+- You mention some functionality that is not available for free, pro, or team plans and you want to link to the {% data variables.product.prodname_ghe_cloud %} version of the same page.
+- The {% data variables.product.prodname_ghe_server %} version of an article describes a feature that shipped with that version, but site administrators can upgrade to the latest version of the feature that's in use on {% data variables.product.prodname_ghe_cloud %}.
+
+You can link directly to a different version of the page using the `currentArticle` property. This means that the link will continue to work directly even if the article URL changes.
+
+```markdown
+{% raw %}{% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest{{ currentArticle }}).{% endif %}{% endraw %}
+```
+
+### Preventing transformations
+
+Sometimes you want to link to a Dotcom-only article in Enterprise content and you don't want the link to be Enterprise-ified. To prevent the transformation, you should include the preferred version in the path.
+
+```markdown
+"[GitHub's Terms of Service](/free-pro-team@latest/github/site-policy/github-terms-of-service)"
+```
+
+Sometimes the canonical home of content moves outside the docs site. None of the links included in [`src/redirects/lib/external-sites.json`](https://github.com/github/docs/blob/main/src/redirects/lib/external-sites.json) get rewritten. See [`contributing/redirects.md`](https://github.com/github/docs/blob/main/contributing/redirects.md) for more info about this type of redirect.
+
+### Legacy filepaths and redirects for links
+
+Our docs contain links that use legacy filepaths such as `/article/article-name` or `/github/article-name`. Our docs also contain links that refer to articles by past names. Both of these link types function properly because of redirects, but they are bugs.
+
+When you add a link to an article, use the current filepath and article name.
diff --git a/content/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter.md b/content/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter.md
new file mode 100644
index 000000000000..517b3e52e103
--- /dev/null
+++ b/content/contributing/syntax-and-versioning-for-github-docs/using-yaml-frontmatter.md
@@ -0,0 +1,320 @@
+---
+title: Using YAML frontmatter
+shortTitle: YAML frontmatter # Max 31 characters
+intro: 'You can use YAML frontmatter to define versioning, add metadata, and control the layout for articles.'
+product: '{% data reusables.contributing.product-note %}'
+versions:
+ feature: 'contributing'
+---
+
+## About YAML frontmatter
+
+YAML frontmatter is an authoring convention popularized by Jekyll that provides a way to add metadata to pages.
+It is a block of key-value content that lives at the top of every Markdown file within {% data variables.product.prodname_docs %}. For more information, see the [YAML frontmatter documentation](https://jekyllrb.com/docs/front-matter/).
+
+## YAML frontmatter values
+
+The following frontmatter values have special meanings and requirements for {% data variables.product.prodname_docs %}.
+There's also a schema that's used by the test suite to validate every page's frontmatter.
+For more information, see [`lib/frontmatter.js`](https://github.com/github/docs/blob/main/lib/frontmatter.js).
+
+- [`versions`](#versions)
+- [`redirect_from`](#redirect_from)
+- [`title`](#title)
+- [`shortTitle`](#shorttitle)
+- [`intro`](#intro)
+- [`permissions`](#permissions)
+- [`product`](#product)
+- [`layout`](#layout)
+- [`children`](#children)
+- [`childGroups`](#childgroups)
+- [`featuredLinks`](#featuredlinks)
+- [`showMiniToc`](#showminitoc)
+- [`allowTitleToDifferFromFilename`](#allowtitletodifferfromfilename)
+- [`changelog`](#changelog)
+- [`defaultPlatform`](#defaultplatform)
+- [`defaultTool`](#defaulttool)
+- [`learningTracks`](#learningtracks)
+- [`includeGuides`](#includeguides)
+- [`type`](#type)
+- [`topics`](#topics)
+- [`communityRedirect`](#communityredirect)
+- [`effectiveDate`](#effectivedate)
+
+### `versions`
+
+- Purpose: Indicates the [versions](https://github.com/github/docs/blob/main/lib/all-versions.js) to which a page applies.
+For more information about the different types of versioning, see "[Versioning documentation](/contributing/syntax-and-versioning-for-github-docs/versioning-documentation)."
+- Type: `Object`. Allowable keys map to product names and can be found in the `versions` object in [`lib/frontmatter.js`](https://github.com/github/docs/blob/main/lib/frontmatter.js).
+- This frontmatter value is currently **required** for all pages.
+- The `*` is used to denote all releases for the version.
+
+This frontmatter value is used by the docs site to generate "permalinks" for each version of an article. For more information, see [Permalinks](#permalinks).
+
+Example that applies to {% data variables.product.prodname_dotcom_the_website %} and recent versions of {% data variables.product.prodname_ghe_server %}:
+
+```yaml
+title: About your personal dashboard
+versions:
+ fpt: '*'
+ ghes: '>=2.20'
+```
+
+Example that applies to all supported versions of {% data variables.product.prodname_ghe_server %}, but not {% data variables.product.prodname_dotcom_the_website %}:
+
+```yaml
+title: Downloading your license
+versions:
+ ghes: '*'
+```
+
+You can also version a page for a range of releases. This would version the page for {% data variables.product.prodname_dotcom_the_website %}, and {% data variables.product.prodname_ghe_server %} versions 2.22 and 3.0 only:
+
+```yaml
+versions:
+ fpt: '*'
+ ghes: '>=2.22 <3.1'
+```
+
+### `redirect_from`
+
+- Purpose: List URLs that should redirect to this page.
+- Type: `Array`
+- Optional
+
+Example:
+
+```yaml
+title: Getting started with GitHub Desktop
+redirect_from:
+ - /articles/first-launch/
+ - /articles/error-github-enterprise-version-is-too-old/
+ - /articles/getting-started-with-github-for-windows/
+```
+
+See [`contributing/redirects`](https://github.com/github/docs/blob/main/contributing/redirects.md) for more info.
+
+### `title`
+
+- Purpose: Set a human-friendly title for use in the rendered page's `` tag and an `h1` element at the top of the page.
+- Type: `String`
+- Optional. If omitted, the page `<title>` will still be set, albeit with a generic value like `GitHub.com` or `GitHub Enterprise`.
+
+### `shortTitle`
+
+- Purpose: An abbreviated variant of the page title for use in breadcrumbs and navigation elements.
+- Type: `String`
+- Optional. If omitted, `title` will be used.
+
+|Article type |Maximum character length |
+--- | --- |
+|articles | 31 |
+|categories |27 |
+|map topics |30 |
+
+Example:
+
+```yaml
+title: Contributing to projects with GitHub Desktop
+shortTitle: Contributing to projects
+```
+
+### `intro`
+
+- Purpose: Sets the intro for the page. This string will render after the `title`.
+- Type: `String`
+- Optional.
+
+### `permissions`
+
+- Purpose: Sets the permission statement for the article. This string will render after the `intro`.
+- Type: `String`
+- Optional.
+
+### `product`
+
+- Purpose: Sets the product callout for the article. This string will render after the `intro` and `permissions` statement.
+- Type: `String`
+- Optional.
+
+### `layout`
+
+- Purpose: Render the proper page layout.
+- Type: `String` that matches the name of the layout.
+For a layout named `components/landing`, the value would be `product-landing`.
+- Optional. If omitted, `DefaultLayout` is used.
+
+### `children`
+
+- Purpose: Lists the relative links that belong to the product/category/map topic. For more information, see [Index pages](#index-pages).
+- Type: `Array`. Default is `false`.
+- Required on `index.md` pages.
+
+### `childGroups`
+
+- Purpose: Renders children into groups on the homepage. For more information, see [Homepage](#homepage).
+- Type: `Array`. Default is `false`.
+- Require on the homepage `index.md`.
+
+### `featuredLinks`
+
+- Purpose: Renders the linked articles' titles and intros on product landing pages and the homepage.
+- Type: `Object`.
+- Optional.
+
+The list of popular links are the links displayed on the landing page under the title "Popular." Alternately, you can customize the title "Popular" by setting the `featuredLinks.popularHeading` property to a new string.
+
+Example:
+
+```yaml
+featuredLinks:
+ gettingStarted:
+ - /path/to/page
+ startHere:
+ - /guides/example
+ popular:
+ - /path/to/popular/article1
+ - /path/to/popular/article2
+ popularHeading: An alternate heading to Popular
+```
+
+### `showMiniToc`
+
+- Purpose: Indicates whether an article should show a mini table of contents (TOC) above the rest of the content. For more information, see [Autogenerated mini TOCs](#autogenerated-mini-tocs).
+- Type: `Boolean`. Default is `true` on articles, and `false` on map topics and `index.md` pages.
+- Optional.
+
+### `allowTitleToDifferFromFilename`
+
+- Purpose: Indicates whether a page is allowed to have a title that differs from its filename. For example, `content/rest/reference/orgs.md` has a title of `Organizations` instead of `Orgs`. Pages with this frontmatter set to `true` will not be flagged in tests or updated by `script/reconcile-ids-with-filenames.js`.
+- Type: `Boolean`. Default is `false`.
+- Optional.
+
+### `changelog`
+
+- Purpose: Render a list of items pulled from [GitHub Changelog](https://github.blog/changelog/) on product landing pages (`components/landing`). The one exception is Education, which pulls from https://github.blog/category/community/education.
+- Type: `Object`, properties:
+ - `label` -- must be present and corresponds to the labels used in the [GitHub Changelog](https://github.blog/changelog/)
+ - `prefix` -- optional string that starts each changelog title that should be omitted in the docs feed. For example, with the prefix `GitHub Actions: ` specified, changelog titles like `GitHub Actions: Some Title Here` will render as `Some Title Here` in the docs feed.
+- Optional.
+
+### `defaultPlatform`
+
+- Purpose: Override the initial platform selection for a page. If this frontmatter is omitted, then the platform-specific content matching the reader's operating system is shown by default. This behavior can be changed for individual pages, for which a manual selection is more reasonable. For example, most {% data variables.product.prodname_actions %} runners use Linux and their operating system is independent of the reader's operating system.
+- Type: `String`, one of: `mac`, `windows`, `linux`.
+- Optional.
+
+Example:
+
+```yaml
+defaultPlatform: linux
+```
+
+### `defaultTool`
+
+- Purpose: Override the initial tool selection for a page, where the tool refers to the application the reader is using to work with GitHub (such as GitHub.com's web UI, the GitHub CLI, or GitHub Desktop) or the GitHub APIs. For more information about the tool selector, see "[AUTOTITLE](/contributing/syntax-and-versioning-for-github-docs/using-markdown-and-liquid-in-github-docs#tool-tags)." If this frontmatter is omitted, then the tool-specific content matching the GitHub web UI is shown by default. If a user has indicated a tool preference (by clicking on a tool tab), then the user's preference will be applied instead of the default value.
+- Type: `String`, one of: `webui`, `cli`, `desktop`, `curl`, `codespaces`, `vscode`, `importer_cli`, `graphql`, `powershell`, `bash`, `javascript`.
+- Optional.
+
+```yaml
+defaultTool: cli
+```
+
+### `learningTracks`
+- Purpose: Render a list of learning tracks on a product's sub-landing page.
+- type: `String`. This should reference learning tracks' names defined in [`data/learning-tracks/*.yml`](https://github.com/github/docs/tree/main/data/learning-tracks).
+- Optional
+
+{% note %}
+
+**Note:** the featured track is set by a specific property in the learning tracks YAML. See that [README](https://github.com/github/docs/blob/main/data/learning-tracks/README.md) for details.
+
+{% endnote %}
+
+### `includeGuides`
+- Purpose: Render a list of articles, filterable by `type` and `topics`. Only applicable when used with `layout: product-guides`.
+- Type: `Array`
+- Optional.
+
+Example:
+
+```yaml
+includeGuides:
+ - /actions/guides/about-continuous-integration
+ - /actions/guides/setting-up-continuous-integration-using-workflow-templates
+ - /actions/guides/building-and-testing-nodejs
+ - /actions/guides/building-and-testing-powershell
+```
+
+### `type`
+- Purpose: Indicate the type of article.
+- Type: `String`, one of the `overview`, `quick_start`, `tutorial`, `how_to`, `reference`.
+- Optional.
+
+### `topics`
+- Purpose: Indicate the topics covered by the article. The topics are used to filter guides on some landing pages. For example, the guides at the bottom of "[Guides for {% data variables.product.prodname_actions %}](/actions/guides#all-guides)" can be filtered by topics, and the topics are listed under the guide intro. Refer to the content models for more details about adding topics. A full list of existing topics is located in the [allowed topics file](https://github.com/github/docs/blob/main/data/allowed-topics.js). If topics in article frontmatter and the allow-topics list become out of sync, the [topics CI test](https://github.com/github/docs/blob/main/src/search/tests/topics.js) will fail.
+- Type: Array of `String`s
+- Optional: Topics are preferred for each article, but, there may be cases where existing articles don't yet have topics, or adding a topic to a new article may not add value.
+
+### `communityRedirect`
+- Purpose: Set a custom link and link name for `Ask the GitHub community` link in the footer.
+- Type: `Object`. Properties are `name` and `href`.
+- Optional.
+
+### `effectiveDate`
+- Purpose: Set an effective date for Terms of Service articles so that engineering teams can automatically re-prompt users to confirm the terms
+- Type: `string` YEAR-MONTH-DAY e.g. 2021-10-04 is October 4th, 2021
+- Optional.
+
+{% note %}
+
+**Note:** The `effectiveDate` frontmatter value is for use by {% data variables.product.company_short %} staff only.
+
+{% endnote %}
+
+## Escaping single quotes
+
+If you see two single quotes in a row (`''`) in YAML frontmatter where you might expect to see one (`'`), this is the YAML-preferred way to escape a single quote.
+
+As an alternative, you can change the single quotes surrounding the frontmatter field to double quotes and leave interior single quotes unescaped.
+
+## Autogenerated mini TOCs
+
+Every article displays a mini table of contents (TOC), which is an autogenerated "In this article" section that includes links to all `H2`s in the article. Only `H2` headers are included in the mini TOCs. If an article uses `H3` or `H4` headers to divide information in a way that only certain sections are relevant to a particular task, you can help people navigate to the content most relevant to them by using a [sectional TOC](/contributing/writing-for-github-docs/style-guide#sectional-tocs).
+
+You can use the [`showMiniToc`](#showminitoc) frontmatter value, set to `false`, to prevent the mini TOC from showing up for an article.
+
+Mini TOCs do not appear on product landing pages, category landing pages, or map topic pages.
+
+Do not add hardcoded "In this article" sections in the Markdown source or else the page will display duplicate mini TOCs.
+
+## Filenames
+
+When adding a new article, make sure the filename is a [kebab-cased](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles) version of the title you use in the article's [`title`](#title) frontmatter. This can get tricky when a title has punctuation (such as "GitHub's Billing Plans"). A test will flag any discrepancies between title and filename. To override this requirement for a given article, you can add [`allowTitleToDifferFromFilename`](#allowtitletodifferfromfilename) frontmatter.
+
+## Index pages
+
+Index pages are the Table of Contents files for the docs site. Every product, category, and map topic subdirectory has an `index.md` that serves as the landing page. Each `index.md` must contain a `children` frontmatter property with a list of relative links to the child pages of the product, category, or map topic.
+
+{% note %}
+
+**Note**: The site only knows about paths included in `children` frontmatter. If a directory or article exists but is **not** included in `children`, its path will return a 404.
+
+{% endnote %}
+
+## Homepage
+
+The homepage is the main Table of Contents file for the docs site. The homepage must have a complete list of `children`, like every [Index page](#index-pages) but must also specify the `childGroups` frontmatter property that will be highlighted in the main content area.
+
+`childGroups` is an array of mappings containing a `name` for the group, an optional `icon` for the group, and an array of `children`. The `children` in the array must be present in the `children` frontmatter property.
+
+## Creating new product guides pages
+
+To create a product guides page (e.g. [{% data variables.product.prodname_actions %} Guide page](/actions/guides)), create or modify an existing markdown file with these specific frontmatter values:
+
+- Use the product guides page template by referencing `layout: product-guides`.
+- Include the learning tracks in [`learningTracks`](#learningtracks). Optional.
+- Define which articles to include with [`includeGuides`](#includeguides). Optional.
+
+If using learning tracks, they need to be defined in [`data/learning-tracks/*.yml`](https://github.com/github/docs/tree/main/data/learning-tracks).
+If using `includeGuides`, make sure each of the articles in this list has [`topics`](#topics) and [`type`](#type) in its frontmatter.
diff --git a/content/contributing/syntax-and-versioning-for-github-docs/versioning-documentation.md b/content/contributing/syntax-and-versioning-for-github-docs/versioning-documentation.md
index 71a6fc0d28f5..a4d3f8e58fce 100644
--- a/content/contributing/syntax-and-versioning-for-github-docs/versioning-documentation.md
+++ b/content/contributing/syntax-and-versioning-for-github-docs/versioning-documentation.md
@@ -156,6 +156,38 @@ When at least one operand must be true for the condition to be true, use the ope
Do not use the operators `&&` or `||`. Liquid does not recognize them, and the content will not render in the intended versions.
+### Whitespace control
+
+When using Liquid conditionals in lists or tables, you can use [whitespace control](https://shopify.github.io/liquid/basics/whitespace/) characters to prevent the addition of newlines and other whitespace that would break the list or table rendering.
+
+You can add a hyphen (`-`) on either the left, right, or both sides to indicate that there should be no newline or other whitespace on that side.
+
+```
+{% raw %}{%- ifversion fpt %}{% endraw %}
+```
+
+For example, to version a table row, instead of adding liquid versioning for the row starting at the end of the previous row, like this:
+
+```
+Column A | Column B | Column C
+---------|----------|---------
+This row is for all versions | B1 | C1{% raw %}{% ifversion ghes %}{% endraw %}
+This row is for GHES only | B2 | C2{% raw %}{% endif %}{% endraw %}
+This row is for all versions | B3 | C3
+```
+
+You can include the liquid versioning on its own line and use whitespace control to strip the newline to the left of the liquid tag. This makes reading the source much easier, without breaking the rendering of the table:
+
+```
+Column A | Column B | Column C
+---------|----------|---------
+This row is for all versions | B1 | C1
+{% raw %}{%- ifversion ghes %}{% endraw %}
+This row is for GHES only | B2 | C2
+{% raw %}{%- endif %}{% endraw %}
+This row is for all versions | B3 | C3
+```
+
## About feature-based versioning
When you document any new change or feature, use feature-based versioning.
diff --git a/content/contributing/writing-for-github-docs/style-guide.md b/content/contributing/writing-for-github-docs/style-guide.md
index f4126747a373..33cd21207bb8 100644
--- a/content/contributing/writing-for-github-docs/style-guide.md
+++ b/content/contributing/writing-for-github-docs/style-guide.md
@@ -754,6 +754,12 @@ A release note for a security fix answers the following questions.
- > **MEDIUM**: An attacker could embed dangerous links in the instance's web UI because pull request preview links did not properly sanitize URLs. This vulnerability was reported via the [{% data variables.product.company_short %} Bug Bounty program](https://bounty.github.com).
+#### Base image and package updates
+
+We also include base image and dependent package updates in the "Security fixes" section, since these updates often address security issues. We consolidate all of these updates in the following note.
+
+> Packages have been updated to the latest security versions.
+
### Bug fixes
A release note for a bug fix describes a correction to an undesired or otherwise unexpected behavior. Generally, notes for bug fixes are only part of patch releases.
diff --git a/content/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization.md b/content/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization.md
index a71bb134b2bd..f9a6648f37cd 100644
--- a/content/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization.md
+++ b/content/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization.md
@@ -15,9 +15,9 @@ shortTitle: Organization settings
{% data reusables.copilot.about-copilot %}
-{% ifversion ghec %}To configure {% data variables.product.prodname_copilot %} use in your organization, the organization must be owned by a {% data variables.product.prodname_ghe_cloud %} account, and an enterprise admin must first enable {% data variables.product.prodname_copilot_business_short %} for your organization. Organization admins will then be able to manage seat assignment within the organization.
+{% ifversion ghec %}To configure {% data variables.product.prodname_copilot %} use in your organization, the organization must be owned by a {% data variables.product.prodname_ghe_cloud %} account, and an enterprise admin must first enable {% data variables.product.prodname_copilot_business_short %} for your organization. Organization owners will then be able to manage seat assignment within the organization.
-Depending on the policy settings configured at the enterprise level, an organization admin may also be able to determine whether to allow or block {% data variables.product.prodname_copilot %} suggestions that match public code. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise)."{% endif %}
+Depending on the policy settings configured at the enterprise level, an organization owner may also be able to determine whether to allow or block {% data variables.product.prodname_copilot %} suggestions that match public code. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise)."{% endif %}
## Configuring access to {% data variables.product.prodname_copilot %} in your organization
diff --git a/content/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot.md b/content/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot.md
index 969421298bfc..9ebe43b03cea 100644
--- a/content/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot.md
+++ b/content/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot.md
@@ -25,7 +25,7 @@ If you have a license for {% data variables.product.prodname_copilot_business_sh
## Configuring proxy settings for {% data variables.product.prodname_copilot %}
-{% data variables.product.prodname_copilot %} supports basic HTTP proxy setups, with or without basic authentication. If the proxy URL starts `https://`, the proxy is not currently supported.
+{% data variables.product.prodname_copilot %} supports basic HTTP proxy setups. If you need to authenticate to a proxy, {% data variables.product.prodname_copilot %} supports basic authentication or authentication with Kerberos. If the proxy URL starts `https://`, the proxy is not currently supported.
You can configure an HTTP proxy for {% data variables.product.prodname_copilot %} in your chosen editor. To view instructions for your editor, use the tabs at the top of this article.
@@ -48,7 +48,7 @@ If you have configured a proxy but are still encountering connection errors, see
### Configuring a proxy in a JetBrains IDE
-1. In your JetBrains IDE, click the **File** menu, then click **Settings**.
+1. In your JetBrains IDE, click the **File** menu (Windows) or the name of the application in the menu bar (macOS), then click **Settings**.
1. Under **Appearance & Behavior**, click **System Settings** and then click **HTTP Proxy**.
1. Select **Manual proxy configuration**, and then select **HTTP**.
1. In the "Host name" field, enter the hostname of your proxy server, and in the "Port number" field, enter the port number of your proxy server.
@@ -60,7 +60,7 @@ If you have configured a proxy but are still encountering connection errors, see
{% endwarning %}
-### Authentication
+### Basic authentication
{% data variables.product.prodname_copilot %} for JetBrains supports basic authentication. To authenticate, you can select **Proxy authentication** on the "Manual proxy configuration" page, then enter your credentials.
@@ -83,7 +83,7 @@ This stores your credentials as plaintext in your editor's settings. Alternative
{% endwarning %}
-### Authentication
+### Basic authentication
{% data variables.product.prodname_copilot %} for {% data variables.product.prodname_vscode_shortname %} supports basic authentication. To authenticate, you can include your credentials in the proxy URL, for example: `http://USERNAME:PASSWORD@10.203.0.1:5187/`. You can store this URL in your {% data variables.product.prodname_vscode_shortname %} settings or in one of the environment variables listed in "[Configuring proxy settings for {% data variables.product.prodname_copilot %}](#configuring-proxy-settings-for-github-copilot)."
@@ -95,12 +95,46 @@ This stores your credentials as plaintext in your editor's settings. Alternative
{% data variables.product.prodname_copilot %} for {% data variables.product.prodname_vs %} reads the proxy settings from Windows. For information about configuring proxy settings on Windows, see the instructions under "To set up a proxy server connection manually" in [Use a proxy server in Windows](https://support.microsoft.com/en-us/windows/use-a-proxy-server-in-windows-03096c53-0554-4ffe-b6ab-8b1deee8dae1) in the Microsoft documentation.
-### Authentication
+### Basic authentication
{% data variables.product.prodname_copilot %} for {% data variables.product.prodname_vs %} does not retrieve authentication credentials from the Windows settings. If you need to authenticate to a proxy, you can include your credentials in the proxy URL (for example: `http://USERNAME:PASSWORD@10.203.0.1:5187/`), then set this URL as one of the supported environment variables listed in "[Configuring proxy settings for {% data variables.product.prodname_copilot %}](#configuring-proxy-settings-for-github-copilot)."
{% endvisualstudio %}
+### Authentication with Kerberos
+
+Kerberos is an authentication protocol that allows users and services to prove their identity to each other. When a user successfully authenticates, an authentication service grants the user a ticket that gives them access to a service for a period of time. Network administrators may prefer Kerberos to basic authentication because it is more secure and doesn't require sending unencrypted credentials.
+
+{% data variables.product.prodname_copilot %} supports authentication to a proxy with Kerberos. To use Kerberos, you must have the appropriate krb5 library for your operating system installed on your machine, and an active ticket for the proxy service (either created manually with the `kinit` command, or by another application). You can use the `klist` command to check if you have a ticket for the proxy service.
+
+Kerberos uses a service principal name (SPN) to uniquely identify a service instance. By default, the SPN is derived from the proxy URL. For example, if the proxy URL is `http://proxy.example.com:3128`, the SPN is `HTTP/proxy.example.com`.
+
+If the default SPN isn't correct for your proxy, you can override the SPN in {% data variables.product.prodname_vscode_shortname %} and in JetBrains IDEs. You cannot currently override the default SPN in {% data variables.product.prodname_vs %}.
+
+{% vscode %}
+
+#### Overriding the default SPN in {% data variables.product.prodname_vscode_shortname %}
+
+1. Open the {% data variables.product.prodname_vscode_command_palette_shortname %} by pressing <kbd>Shift</kbd>+<kbd>Command</kbd>+<kbd>P</kbd> (Mac) / <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux).
+1. Type `settings`, then click **Preferences: Open User Settings (JSON)**.
+1. In the JSON object, add the following top-level property, replacing `YOUR-SPN` with the correct SPN for your proxy service.
+
+ ```json copy
+ "http.proxyKerberosServicePrincipal": "YOUR-SPN",
+ ```
+
+{% endvscode %}
+
+{% jetbrains %}
+
+#### Overriding the default SPN in JetBrains IDEs
+
+1. In your JetBrains IDE, click the **File** menu (Windows) or the name of the application in the menu bar (macOS), then click **Settings**.
+1. In the left sidebar, click **Languages & Frameworks**, then click **GitHub Copilot**.
+1. In the "Advanced" section, in the "Override Kerberos Proxy Service Principal Name" field, type the SPN for your proxy service.
+
+{% endjetbrains %}
+
## Allowing {% data variables.product.prodname_copilot %} to use custom certificates
If your organization uses {% data variables.product.prodname_copilot_business_short %}, {% data variables.product.prodname_copilot_short %} can read custom SSL certificates installed on a user's machine.
diff --git a/content/copilot/overview-of-github-copilot/enabling-and-setting-up-github-copilot-for-business.md b/content/copilot/overview-of-github-copilot/enabling-and-setting-up-github-copilot-for-business.md
index 19b0339fea04..1293282365be 100644
--- a/content/copilot/overview-of-github-copilot/enabling-and-setting-up-github-copilot-for-business.md
+++ b/content/copilot/overview-of-github-copilot/enabling-and-setting-up-github-copilot-for-business.md
@@ -26,7 +26,7 @@ To use {% data variables.product.prodname_copilot_for_business %}, you need to s
Your enterprise owner can enable {% data variables.product.prodname_copilot_business_short %} for the organizations in the enterprise by first establishing the policy and then assigning users. To enforce a policy to manage the use of {% data variables.product.prodname_copilot_business_short %}, follow the steps in "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise#enforcing-a-policy-to-manage-the-use-of-github-copilot-for-business-in-your-enterprise)." If you need additional help with policy configuration or user assignment for {% data variables.product.prodname_copilot_business_short %}, you can contact {% data variables.contact.contact_enterprise_sales %}.
-{% data variables.product.prodname_copilot %} includes a filter which detects code suggestions that match public code on {% data variables.product.prodname_dotcom %}. Your enterprise owner can choose whether to enable or disable the filter at the enterprise-level, or allow organization administrators to decide at the organization-level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise#enforcing-a-policy-to-manage-the-use-of-github-copilot-suggestions-that-match-public-code-in-your-enterprise)."{% endif %}
+{% data variables.product.prodname_copilot %} includes a filter which detects code suggestions that match public code on {% data variables.product.prodname_dotcom %}. Your enterprise owner can choose whether to enable or disable the filter at the enterprise-level, or allow organization owners to decide at the organization-level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-copilot-in-your-enterprise#enforcing-a-policy-to-manage-the-use-of-github-copilot-suggestions-that-match-public-code-in-your-enterprise)."{% endif %}
## Configuring {% data variables.product.prodname_copilot %} settings in your organization
@@ -37,7 +37,7 @@ Your enterprise owner can enable {% data variables.product.prodname_copilot_busi
{% endnote %}
-Once an enterprise owner has enabled {% data variables.product.prodname_copilot_business_short %} for an organization, organization administrators and members with admin permissions can configure {% data variables.product.prodname_copilot %} access for their organization. Depending on the policy settings configured at the enterprise-level, an organization administrator may also be able to determine whether to allow or block {% data variables.product.prodname_copilot %} suggestions that match public code.{% endif %}{% ifversion fpt %}After setting up a {% data variables.product.prodname_copilot_business_short %} subscription for your organization, you can configure {% data variables.product.prodname_copilot %} settings in your organization. This includes granting and revoking access to individuals and teams, and determining whether to block suggestions that match public code.{% endif %} For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)."
+Once an enterprise owner has enabled {% data variables.product.prodname_copilot_business_short %} for an organization, organization owners and members with admin permissions can configure {% data variables.product.prodname_copilot %} access for their organization. Depending on the policy settings configured at the enterprise-level, an organization owner may also be able to determine whether to allow or block {% data variables.product.prodname_copilot %} suggestions that match public code.{% endif %}{% ifversion fpt %}After setting up a {% data variables.product.prodname_copilot_business_short %} subscription for your organization, you can configure {% data variables.product.prodname_copilot %} settings in your organization. This includes granting and revoking access to individuals and teams, and determining whether to block suggestions that match public code.{% endif %} For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)."
## Assigning {% data variables.product.prodname_copilot %} seats
diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot.md b/content/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot.md
index a7f5995c17e8..bc013cbe3a88 100644
--- a/content/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot.md
+++ b/content/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot.md
@@ -48,7 +48,7 @@ If you know you are connecting via a proxy, make sure the proxy is configured co
{% data variables.product.prodname_copilot %} uses custom code to connect to proxies. This means a proxy setup that is supported by your editor is not necessarily supported by {% data variables.product.prodname_copilot %}. Some common causes for errors related to proxies are:
- If your proxy's URL starts `https://`, it is not currently supported by {% data variables.product.prodname_copilot %}.
-- You may need to authenticate to the proxy. {% data variables.product.prodname_copilot %} supports basic authentication. Depending on your editor, you may be able to enter your credentials in the editor, or you may need to include the credentials directly in the proxy URL.
+- You may need to authenticate to the proxy. {% data variables.product.prodname_copilot %} supports basic authentication or authentication with Kerberos. If you are using Kerberos, ensure you have a valid ticket for the proxy service and that you are using the correct service principal name for the service. For more information, see "[AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot#authentication-with-kerberos)."
- {% data variables.product.prodname_copilot %} may reject custom certificates. For more information, see "[Troubleshooting certificate-related errors](#troubleshooting-certificate-related-errors)."
## Troubleshooting certificate-related errors
diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/checking-out-a-commit-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/checking-out-a-commit-in-github-desktop.md
new file mode 100644
index 000000000000..1f3eb36d0429
--- /dev/null
+++ b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/checking-out-a-commit-in-github-desktop.md
@@ -0,0 +1,48 @@
+---
+title: Checking out a commit in GitHub Desktop
+shortTitle: Checking out a commit
+intro: 'You can use {% data variables.product.prodname_desktop %} to checkout a previous commit in your repository.'
+versions:
+ feature: desktop
+---
+
+## About checking out a commit
+
+Checking out a commit allows you to view your repository in a previous state without needing to create a new branch or modify an existing branch. This can be helpful when debugging since it allows you to see if a bug exists in your repository at a previous commit.
+
+Checking out a commit puts your repository in a "detached HEAD" state. In Git terminology "HEAD" is the reference that points to the tip, or latest commit, of a named branch in your repository. A "detached HEAD" state means that HEAD refers to a specific commit, but not on a named branch in your repository.
+
+{% note %}
+
+**Note:** Any commits made in a "detached HEAD" state will be lost when switching branches, since these commits have not been made on a named branch. If you need to recover the lost commits, see "[Troubleshooting](#troubleshooting)."
+
+{% endnote %}
+
+
+## Checking out a commit
+
+{% data reusables.desktop.history-tab %}
+1. Right-click on the commit you would like to checkout and select **Checkout commit**.
+ 
+1. The {% octicon "git-branch" aria-hidden="true" %} **Current Branch** item in the repository bar will now show "Detached HEAD", along with the SHA of the commit that was checked out.
+ 
+1. To exit the "detached HEAD" state you will need to switch branches. For more information, see "[AUTOTITLE](/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches-in-github-desktop#switching-between-branches)."
+
+## Troubleshooting
+
+You can recover commits that have been made in a "detached HEAD" state using the `git reflog` command from the Git command line. You can open your repository in the command line from {% data variables.product.prodname_desktop %} by going to the menu bar, selecting **Repository**, and clicking **Open in command line**.
+
+The `git reflog` command will show the output of events that have happened in your repository, including commits. Here is a sample output of the `git reflog` command:
+
+```shell
+81fa9136f8 (HEAD -> main) HEAD@{0}: checkout: moving from 8bd5e736a27a52a7e36a856b30e6f0582d341aa1 to main
+8bd5e736a2 HEAD@{1}: commit: testing out a feature
+22fa76c125 HEAD@{2}: checkout: moving from main to 22fa76c1250a2847305b9325752d941dbaa55983
+```
+
+The `8bd5e736a2 HEAD@{1}: commit: testing out a feature` line is the commit that we want to recover, since it was made while the repository was in a "detached HEAD" state. To recover it you can run `git cherry-pick 8bd5e736a2` to apply the commit to the current branch in your repository.
+
+## Further reading
+
+- [Detached HEAD](https://git-scm.com/docs/git-checkout#_detached_head) in the Git documentation
+- [Git cherry-pick](https://git-scm.com/docs/git-cherry-pick) in the Git documentation
diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/index.md b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/index.md
index 5b192262c79f..a6eddee34d5c 100644
--- a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/index.md
+++ b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/index.md
@@ -10,5 +10,6 @@ children:
- /squashing-commits-in-github-desktop
- /amending-a-commit-in-github-desktop
- /managing-tags-in-github-desktop
+ - /checking-out-a-commit-in-github-desktop
---
diff --git a/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop.md b/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop.md
index a1ba1f046f27..8a02f2d7ee43 100644
--- a/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop.md
+++ b/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop.md
@@ -44,6 +44,7 @@ shortTitle: Configure default editor
- [Emacs](https://www.gnu.org/software/emacs/)
- [Lite XL](https://lite-xl.com/)
- [Pulsar](https://pulsar-edit.dev/)
+- [Zed](https://zed.dev/)
{% endmac %}
@@ -94,3 +95,37 @@ shortTitle: Configure default editor
1. Click **Save**.
{% endwindows %}
+
+## Opening a repository in the default editor
+
+To open the current repository in the default editor, you can use the menu bar:
+
+1. In the menu bar, select **Repository**.
+1. Click **Open in default editor**
+
+If you want to open another repository in the default editor, you can use the repository list.
+
+1. In the upper-left corner of {% data variables.product.prodname_desktop %}, to the right of the current repository name, click {% octicon "triangle-down" aria-label="The triangle-down icon" %}.
+1. Right-click the repository, then click **Open in default editor**.
+
+{% tip %}
+
+{% mac %}
+
+**Tip:** You can use the <kbd>Shift</kbd>+<kbd>Command</kbd>+<kbd>A</kbd> keyboard shortcut to open a repository in the default editor.
+
+{% endmac %}
+
+{% windows %}
+
+**Tip:** You can use the <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>A</kbd> keyboard shortcut to open a repository in the default editor.
+
+{% endwindows %}
+
+{% endtip %}
+
+## Opening a file in the default editor
+
+1. Navigate to the "Changes" tab in the left sidebar.
+2. Double-click on the file, or right-click on the file and select **Open in default editor**.
+
\ No newline at end of file
diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert.md
index 0809e2eec69d..f298fe6694c2 100644
--- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert.md
+++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/use-github-at-your-educational-institution/applying-to-be-a-github-campus-expert.md
@@ -26,7 +26,7 @@ To become a {% data variables.product.prodname_student_leader_program_singular %
- Be a {% data variables.product.prodname_dotcom %} user for at least six months.
- Be at least 18 years of age.
-- Be enrolled in a post-secondary formal education institution.
+- Be enrolled in a formal higher education institution.
- Have more than one year left as a student before graduating.
- Not be enrolled in the {% data variables.product.prodname_dotcom %} Campus Advisors Program.
- Validate your student status through the [{% data variables.product.prodname_student_pack %}](https://education.github.com/pack).
diff --git a/content/get-started/learning-about-github/about-versions-of-github-docs.md b/content/get-started/learning-about-github/about-versions-of-github-docs.md
index 7c1f8ac50487..440e14df3caf 100644
--- a/content/get-started/learning-about-github/about-versions-of-github-docs.md
+++ b/content/get-started/learning-about-github/about-versions-of-github-docs.md
@@ -1,7 +1,11 @@
---
title: About versions of GitHub Docs
intro: 'You can read documentation that reflects the {% data variables.product.company_short %} product you''re currently using.'
-versions: '*'
+versions:
+ fpt: '*'
+ ghes: '*'
+ ghae: '*'
+ ghec: '*'
shortTitle: Docs versions
---
diff --git a/content/get-started/using-github/github-mobile.md b/content/get-started/using-github/github-mobile.md
index d3ffb2c10260..d5db29c07d63 100644
--- a/content/get-started/using-github/github-mobile.md
+++ b/content/get-started/using-github/github-mobile.md
@@ -39,7 +39,7 @@ To install {% data variables.product.prodname_mobile %} for Android or iOS, see
## Managing accounts
-You can be simultaneously signed into mobile with one personal account on {% data variables.product.prodname_dotcom_the_website %} and one personal account on {% data variables.product.prodname_ghe_server %}. For more information about our different products, see "[AUTOTITLE](/get-started/learning-about-github/githubs-plans)."
+You can be simultaneously signed into mobile with multiple accounts on {% data variables.product.prodname_dotcom_the_website %} and on {% data variables.product.prodname_ghe_server %}. For more information about our different products, see "[AUTOTITLE](/get-started/learning-about-github/githubs-plans)."
{% data reusables.mobile.push-notifications-on-ghes %}
@@ -55,11 +55,13 @@ During the beta for {% data variables.product.prodname_mobile %} with {% data va
### Adding, switching, or signing out of accounts
-You can sign into mobile with a personal account on {% data variables.product.prodname_ghe_server %}. At the bottom of the app, long-press {% octicon "person" aria-hidden="true" %} **Profile**, then tap {% octicon "plus" aria-hidden="true" %} **Add Enterprise Account**. Follow the prompts to sign in.
+You can sign into mobile with any {% data variables.product.company_short %} account, either on {% data variables.product.prodname_dotcom_the_website %} or on {% data variables.product.prodname_ghe_server %}. At the bottom of the app, long-press {% octicon "person" aria-hidden="true" %} **Profile**, then tap {% octicon "plus" aria-hidden="true" %} **Add Enterprise Account**. Follow the prompts to sign in.
-After you sign into mobile with a personal account on {% data variables.product.prodname_ghe_server %}, you can switch between the account and your account on {% data variables.product.prodname_dotcom_the_website %}. At the bottom of the app, long-press {% octicon "person" aria-hidden="true" %} **Profile**, then tap the account you want to switch to.
+After signing in with an account on {% data variables.product.prodname_ghe_server %}, you can switch between any other accounts you're currently logged into within the app. At the bottom of the app, long-press {% octicon "person" aria-hidden="true" %} **Profile**, then tap the account you want to switch to.
-If you no longer need to access data for your personal account on {% data variables.product.prodname_ghe_server %} from {% data variables.product.prodname_mobile %}, you can sign out of the account. At the bottom of the app, long-press {% octicon "person" aria-hidden="true" %} **Profile**, swipe left on the account to sign out of, then tap **Sign out**.
+If you no longer need to access your account on {% ifversion ghec or ghes%}{% data variables.product.prodname_ghe_server %} from{% endif %} {% data variables.product.prodname_mobile %}, you can sign out of the account. At the bottom of the app, long-press {% octicon "person" aria-hidden="true" %} **Profile**, swipe left on the account to sign out of, then tap **Sign out**.
+
+Alternatively, once logged into one account, access the account switcher to log into other accounts or log out of an existing account by navigating to the {% octicon "person" aria-hidden="true" %} **Profile** tab, then tapping {% octicon "gear" aria-hidden="true" %}, and then tapping **Manage Accounts**.
## Supported languages for {% data variables.product.prodname_mobile %}
diff --git a/content/get-started/using-github/keyboard-shortcuts.md b/content/get-started/using-github/keyboard-shortcuts.md
index 0b734e8011ec..561fb63ff951 100644
--- a/content/get-started/using-github/keyboard-shortcuts.md
+++ b/content/get-started/using-github/keyboard-shortcuts.md
@@ -94,7 +94,7 @@ If you view a code file in a repository using the **Code** view and click on any
| Keyboard shortcut | Description
|-----------|------------
|<kbd>Shift</kbd>+<kbd>J</kbd>| Highlights the line that is currently selected by the cursor within the code file
-|<kbd>Shift</kbd>+<kbd>F10</kbd> | If a line of code is currently selected, this shortcut opens the line menu for that line, appearing under {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} to the left of the line
+|<kbd>Shift</kbd>+<kbd>Option</kbd>+<kbd>C</kbd> (Mac) or </br> <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>C</kbd> (Windows/Linux) | If a line of code is currently selected, this shortcut opens the line menu for that line, appearing under {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} to the left of the line
|<kbd>Command</kbd>+<kbd>Enter</kbd> (Mac) or </br> <kbd>Control</kbd>+<kbd>Enter</kbd> (Windows/Linux) | Highlights the code symbol currently selected by the cursor and all other occurrences of the symbol in the code, and shows the symbol in the symbols pane
{% endif %}
diff --git a/content/index.md b/content/index.md
index 6e18d653bcec..86f7ca3379dc 100644
--- a/content/index.md
+++ b/content/index.md
@@ -42,7 +42,11 @@ redirect_from:
- /github/enforcing-best-practices-with-github-policies/sharing
- /early-access/github/enforcing-best-practices-with-github-policies/syntax
- /github/enforcing-best-practices-with-github-policies/syntax
-versions: '*'
+versions:
+ fpt: '*'
+ ghes: '*'
+ ghae: '*'
+ ghec: '*'
children:
- search
- get-started
diff --git a/content/issues/managing-your-tasks-with-tasklists/creating-a-tasklist.md b/content/issues/managing-your-tasks-with-tasklists/creating-a-tasklist.md
index 67fcacec9ff3..5417693a8df6 100644
--- a/content/issues/managing-your-tasks-with-tasklists/creating-a-tasklist.md
+++ b/content/issues/managing-your-tasks-with-tasklists/creating-a-tasklist.md
@@ -46,8 +46,7 @@ You can also use the **Add tasklist** button while editing your issue to insert
Once you have started editing your tasklist Markdown, you can add new tasks by preceding each new task with `- [ ] ` and then adding either:
- A draft task. Draft tasks are text that can later be converted into issues.
-- The full link to an issue or pull request or, if the issue or pull request is in the same repository as your tasklist, you can use the #ISSUE-NUMBER shorthand syntax. For example, `https://github.com/octo-org/octo-repo/issues/45` or `#45`.
-- If an issue or pull request is in the same repository
+- The full link to an issue or pull request. For example, `https://github.com/octo-org/octo-repo/issues/45`. If an issue or pull request is in the same repository as your tasklist, you can use the #ISSUE-NUMBER shorthand syntax. For example, `#45`.
If you add a draft task, it must meet these requirements:
diff --git a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-board-layout.md b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-board-layout.md
index fa18fe86534f..bc86b727ae0b 100644
--- a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-board-layout.md
+++ b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-board-layout.md
@@ -59,6 +59,14 @@ In the board layout, you can can choose which columns to display. The available
1. Select the columns you want to show.
{% endif %}
+{% ifversion projects-v2-slice-panel %}
+
+## Slicing by field values
+
+{% data reusables.projects.customize.slice-panel %}
+
+{% endif %}
+
{% ifversion projects-v2-consistent-sorting %}
## Sorting by field values
diff --git a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout.md b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout.md
index dbd5816a7b4c..62786bbfa705 100644
--- a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout.md
+++ b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout.md
@@ -50,6 +50,14 @@ You can choose the density of items on your roadmap. You can zoom in to show one
1. Select either **Month**, **Quarter**, or **Year**.
+{% ifversion projects-v2-slice-panel %}
+
+## Slicing by field values
+
+{% data reusables.projects.customize.slice-panel %}
+
+{% endif %}
+
{% ifversion projects-v2-consistent-sorting %}
## Sorting by field values
diff --git a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md
index 1b9b5424f48e..4d7e8cb0379d 100644
--- a/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md
+++ b/content/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout.md
@@ -33,6 +33,14 @@ You can group items by a custom field value. {% data reusables.projects.customiz
{% data reusables.projects.customize.group-fields %}
+{% ifversion projects-v2-slice-panel %}
+
+## Slicing by field values
+
+{% data reusables.projects.customize.slice-panel %}
+
+{% endif %}
+
## Reordering fields
You can change the order of fields.
diff --git a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project.md b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project.md
index 9e1b83e1a316..583199501879 100644
--- a/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project.md
+++ b/content/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project.md
@@ -18,7 +18,7 @@ allowTitleToDifferFromFilename: true
## Adding issues and pull requests to a project
-You can add issues and pull requests to your project individually{% ifversion projects-v2-auto-add %}, automatically, {% endif %} or in bulk. You can also add draft issues which can later be transformed into issues. For more information, see "[Creating draft issues](#creating-draft-issues)."
+You have several options for adding issues and pull requests to your project. You can add them individually{% ifversion projects-v2-auto-add %}, automatically, {% endif %} or in bulk. Furthermore, you can include issues and pull requests from any organization, and you also have the ability to add draft issues that can be converted into regular issues later on. For more information, see "[Creating draft issues](#creating-draft-issues).
{% ifversion projects-v2-timeline-events %}
diff --git a/content/issues/tracking-your-work-with-issues/creating-an-issue.md b/content/issues/tracking-your-work-with-issues/creating-an-issue.md
index efa2bbc40d44..4e3a899cd4ed 100644
--- a/content/issues/tracking-your-work-with-issues/creating-an-issue.md
+++ b/content/issues/tracking-your-work-with-issues/creating-an-issue.md
@@ -165,7 +165,7 @@ Query parameter | Example
`labels` | `https://github.com/octo-org/octo-repo/issues/new?labels=help+wanted,bug` creates an issue with the labels "help wanted" and "bug".
`milestone` | `https://github.com/octo-org/octo-repo/issues/new?milestone=testing+milestones` creates an issue with the milestone "testing milestones."
`assignees` | `https://github.com/octo-org/octo-repo/issues/new?assignees=octocat` creates an issue and assigns it to @octocat.
-`projects` | `https://github.com/octo-org/octo-repo/issues/new?title=Bug+fix&projects=octo-org/1` creates an issue with the title "Bug fix" and adds it to the organization's project board 1.
+`projects` | `https://github.com/octo-org/octo-repo/issues/new?title=Bug+fix&projects=octo-org/1` creates an issue with the title "Bug fix" and adds it to the organization's project board 1. {% ifversion projects-v2 and projects-v1 %}{% ifversion projects-in-issue-forms %}{% else %}Only {% data variables.projects.projects_v1_boards %} can currently be specified in URL queries.{% endif %}{% endif %}
`template` | `https://github.com/octo-org/octo-repo/issues/new?template=issue_template.md` creates an issue with a template in the issue body. The `template` query parameter works with templates stored in an `ISSUE_TEMPLATE` subdirectory within the root, `docs/` or `.github/` directory in a repository. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)."
{% ifversion fpt or ghec %}
diff --git a/content/migrations/overview/planning-your-migration-to-github.md b/content/migrations/overview/planning-your-migration-to-github.md
index 936146675ba9..b3d3f74bda78 100644
--- a/content/migrations/overview/planning-your-migration-to-github.md
+++ b/content/migrations/overview/planning-your-migration-to-github.md
@@ -164,7 +164,7 @@ For some migration paths, we offer specialist tools that allow you to migrate so
</tr>
<tr>
<th scope="row"><b>Bitbucket Server</b></th>
- <td><ul><li><code>bbs-exporter</code> (expert-led migrations only)</li><li>{% data variables.product.prodname_importer_proper_name %} (private beta)</li></ul></td>
+ <td><ul><li><code>bbs-exporter</code> (expert-led migrations only)</li><li>{% data variables.product.prodname_importer_proper_name %} (public beta)</li></ul></td>
<td><code>bbs-exporter</code> (expert-led migrations only)</td>
</tr>
<tr>
diff --git a/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-between-github-products-with-github-enterprise-importer.md b/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-between-github-products-with-github-enterprise-importer.md
index 2ce9044d570a..7b076f5776b3 100644
--- a/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-between-github-products-with-github-enterprise-importer.md
+++ b/content/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/migrating-between-github-products-with-github-enterprise-importer.md
@@ -157,7 +157,7 @@ If you use {% data variables.product.prodname_actions %} in a repository, your w
During the migration process, {% data variables.product.prodname_actions %} is disabled for all migrated repositories to avoid workflows being accidentally triggered, but {% data variables.product.prodname_actions %} is re-enabled when the migration finishes.
-If you were using self-hosted runners or encrypted secrets, you must reconfigure them.
+If you were using {% data variables.actions.hosted_runner %}s, self-hosted runners, or encrypted secrets, you must reconfigure them.
{% note %}
@@ -169,6 +169,11 @@ If you were using self-hosted runners or encrypted secrets, you must reconfigure
- Add runners to the appropriate repository, organization, or enterprise. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners)."
- To use runners at the organization or enterprise level, update your workflows. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow)."
+1. If you use {% data variables.actions.hosted_runner %}s, reconfigure your runners.
+
+ - Configure runner groups to control access to your runners. For more information, see "[AUTOTITLE]({% ifversion ghes or ghae %}/enterprise-cloud@latest{% endif %}/actions/using-github-hosted-runners/controlling-access-to-larger-runners)."
+ - Set up your {% data variables.actions.hosted_runner %}s. For more information, see "[AUTOTITLE]({% ifversion ghes or ghae %}/enterprise-cloud@latest{% endif %}/actions/using-github-hosted-runners/managing-larger-runners)."
+ - Update your workflows to point to your runners. For more information, see "[AUTOTITLE]({% ifversion ghes or ghae %}/enterprise-cloud@latest{% endif %}/actions/using-github-hosted-runners/running-jobs-on-larger-runners)."
1. Re-add any encrypted secrets.
- To use the browser, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository)."
diff --git a/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md b/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md
index 63a297546595..b44f15ceb28f 100644
--- a/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md
+++ b/content/organizations/collaborating-with-groups-in-organizations/about-organizations.md
@@ -56,6 +56,6 @@ Enterprise accounts are a feature of {% data variables.product.prodname_ghe_clou
## Terms of service and data protection for organizations
-An entity, such as a company, non-profit, or group, can agree to the Standard Terms of Service or the Corporate Terms of Service for their organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/upgrading-to-the-corporate-terms-of-service)."
+An entity, such as a company, non-profit, or group, can agree to the Standard Terms of Service or the {% data variables.product.company_short %} Customer Agreement for their organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/upgrading-to-the-github-customer-agreement)."
{% endif %}
diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization.md
index d2a07e2085a3..743d5c335ff2 100644
--- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization.md
+++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization.md
@@ -380,7 +380,7 @@ For more information, see "[AUTOTITLE](/organizations/managing-organization-sett
| `update_member` | Triggered when an owner changes a person's role from owner to member or member to owner.
| `update_member_repository_creation_permission` | Triggered when an owner changes the create repository permission for organization members.{% ifversion fpt or ghec %}
| `update_saml_provider_settings` | Triggered when an organization's SAML provider settings are updated.
-| `update_terms_of_service` | Triggered when an organization changes between the Standard Terms of Service and the Corporate Terms of Service. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/upgrading-to-the-corporate-terms-of-service)."{% endif %}
+| `update_terms_of_service` | Triggered when an organization changes between the Standard Terms of Service and the {% data variables.product.company_short %} Customer Agreement. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/upgrading-to-the-github-customer-agreement)."{% endif %}
{% ifversion ghec %}
diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md
index f83474a14559..1a1f7e81ae4a 100644
--- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md
+++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization.md
@@ -44,6 +44,7 @@ You can also configure allowed IP addresses at the enterprise account level, and
{% data reusables.identity-and-permissions.about-adding-ip-allow-list-entries %}
{% data reusables.identity-and-permissions.ipv6-allow-lists %}
+{% data reusables.identity-and-permissions.ip-address-add-or-remove-caching %}
{% data reusables.profile.access_org %}
{% data reusables.profile.org_settings %}
@@ -103,6 +104,8 @@ For more information about how to create an allow list for a {% data variables.p
## Deleting an allowed IP address
+{% data reusables.identity-and-permissions.ip-address-add-or-remove-caching %}
+
{% data reusables.profile.access_org %}
{% data reusables.profile.org_settings %}
{% data reusables.organizations.security %}
diff --git a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md
index 0184c3256ae0..32021e5da100 100644
--- a/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md
+++ b/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization.md
@@ -129,6 +129,20 @@ To allow {% data variables.product.prodname_dependabot %} to access a private {%
{% endif %}
+{% ifversion secret-scanning-validity-check-partner-patterns %}
+
+## Allowing validity checks for partner patterns in an organization
+
+{% data reusables.secret-scanning.validity-check-partner-patterns-beta %}
+{% data reusables.gated-features.partner-pattern-validity-check-ghas %}
+
+You can allow {% data variables.product.prodname_secret_scanning %} to automatically check the validity of a secret by sending it to the relevant partner. When you select the checkbox in the organization settings, the feature is enabled for all repositories in the organization. Alternatively, you can enable the validity check for a single repository, or at the enterprise level. For more information, see "[Allowing validity checks for partner patterns in a repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#allowing-validity-checks-for-partner-patterns-in-a-repository)" and "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise)."
+
+1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)."
+{% data reusables.secret-scanning.validity-check-auto-enable %}
+
+{% endif %}
+
{% ifversion ghes or ghec %}
## Removing access to {% data variables.product.prodname_GH_advanced_security %} from individual repositories in an organization
diff --git a/content/organizations/managing-organization-settings/index.md b/content/organizations/managing-organization-settings/index.md
index 58bbd51b1259..cafe197671dc 100644
--- a/content/organizations/managing-organization-settings/index.md
+++ b/content/organizations/managing-organization-settings/index.md
@@ -41,7 +41,7 @@ children:
- /deleting-an-organization-account
- /converting-an-organization-into-a-user
- /integrating-jira-with-your-organization-project-board
- - /upgrading-to-the-corporate-terms-of-service
+ - /upgrading-to-the-github-customer-agreement
- /disabling-project-boards-in-your-organization
- /disabling-insights-for-projects-in-your-organization
- /managing-base-permissions-for-projects
diff --git a/content/organizations/managing-organization-settings/upgrading-to-the-corporate-terms-of-service.md b/content/organizations/managing-organization-settings/upgrading-to-the-github-customer-agreement.md
similarity index 51%
rename from content/organizations/managing-organization-settings/upgrading-to-the-corporate-terms-of-service.md
rename to content/organizations/managing-organization-settings/upgrading-to-the-github-customer-agreement.md
index 2835272a4a1b..10fb5e1e9148 100644
--- a/content/organizations/managing-organization-settings/upgrading-to-the-corporate-terms-of-service.md
+++ b/content/organizations/managing-organization-settings/upgrading-to-the-github-customer-agreement.md
@@ -1,9 +1,10 @@
---
-title: Upgrading to the Corporate Terms of Service
-intro: Organizations can upgrade from the Standard Terms of Service to the Corporate Terms of Service.
+title: Upgrading to the GitHub Customer Agreement
+intro: Organizations can upgrade from the Standard Terms of Service to the {% data variables.product.company_short %} Customer Agreement.
redirect_from:
- /articles/upgrading-to-the-corporate-terms-of-service
- /github/setting-up-and-managing-organizations-and-teams/upgrading-to-the-corporate-terms-of-service
+ - /organizations/managing-organization-settings/upgrading-to-the-corporate-terms-of-service
versions:
fpt: '*'
ghec: '*'
@@ -13,16 +14,16 @@ topics:
shortTitle: Upgrade to Corporate ToS
---
-The Standard Terms of Service is an agreement between {% data variables.product.prodname_dotcom %} and you as an individual. To enter into an agreement with {% data variables.product.prodname_dotcom %} on behalf of an entity, such as a company, non-profit, or group, organization owners can upgrade to the Corporate Terms of Service.
+The Standard Terms of Service is an agreement between {% data variables.product.prodname_dotcom %} and you as an individual. To enter into an agreement with {% data variables.product.prodname_dotcom %} on behalf of an entity, such as a company, non-profit, or group, organization owners can upgrade to the {% data variables.product.company_short %} Customer Agreement.
-You can upgrade to the Corporate Terms of Service instead of using the Standard Terms of Service to help prevent sensitive information from being exposed. For more information see "[AUTOTITLE](/code-security/getting-started/best-practices-for-preventing-data-leaks-in-your-organization)."
+You can upgrade to the {% data variables.product.company_short %} Customer Agreement instead of using the Standard Terms of Service to help prevent sensitive information from being exposed. For more information see "[AUTOTITLE](/code-security/getting-started/best-practices-for-preventing-data-leaks-in-your-organization)."
1. Navigate to your organization's settings and scroll to the **Terms of Service** section.
-1. Click **Read the Corporate Terms of Service**.
-1. After you've read the Corporate Terms of Service, click **Sign corporate terms**.
+1. Click **Read the {% data variables.product.company_short %} Customer Agreement**.
+1. After you've read the {% data variables.product.company_short %} Customer Agreement, click **Sign {% data variables.product.company_short %} customer terms**.
1. Select **Yes, I want to sign these terms on behalf of my business.**
1. In the text field, type the name of the company, non-profit, or group that owns the organization account. This is the entity that will enter into an agreement with {% data variables.product.prodname_dotcom %}.
-1. To agree to the Corporate Terms of Service on behalf of your entity, click **Accept terms**.
+1. To agree to the {% data variables.product.company_short %} Customer Agreement on behalf of your entity, click **Accept terms**.
## Further reading
diff --git a/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md b/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md
index 64bb707447e3..dee535928cc6 100644
--- a/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md
+++ b/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md
@@ -22,7 +22,7 @@ shortTitle: Verify or approve a domain
## About domain verification
-After verifying ownership of your organization's domains, a "Verified" badge will display on the organization's profile. {% ifversion ghec %}If your organization has agreed to the Corporate Terms of Service, organization owners will be able to verify the identity of organization members by viewing each member's email address within the verified domain. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile)" and "[AUTOTITLE](/free-pro-team@latest/organizations/managing-organization-settings/upgrading-to-the-corporate-terms-of-service)."{% endif %}
+After verifying ownership of your organization's domains, a "Verified" badge will display on the organization's profile. {% ifversion ghec %}If your organization has agreed to the {% data variables.product.company_short %} Customer Agreement, organization owners will be able to verify the identity of organization members by viewing each member's email address within the verified domain. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile)" and "[AUTOTITLE](/organizations/managing-organization-settings/upgrading-to-the-github-customer-agreement)."{% endif %}
{% ifversion ghec or ghes %}
{% ifversion ghec %}If your organization is owned by an enterprise account, a{% else %}A{% endif %} "Verified" badge will display on your organization's profile for any domains verified for the enterprise account, in addition to any domains verified for the organization. Organization owners can view any domains that an enterprise owner has verified or approved, and edit the domains if the organization owner is also an enterprise owner. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)."
diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md
index b84bdffa551b..7d205c0da8eb 100644
--- a/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md
+++ b/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md
@@ -95,8 +95,8 @@ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else
{% data reusables.package_registry.authenticate-step %}
1. Build the package from the _gemspec_ to create the _.gem_ package. Replace `GEM_NAME` with the name of your gem.
-
- ```
+
+ ```shell
gem build GEM_NAME.gemspec
```
@@ -108,7 +108,7 @@ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else
{% endnote %}
- ```
+ ```shell
$ gem push --key github \
--host https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY_URL{% endif %}/NAMESPACE \
GEM_NAME-0.0.1.gem
@@ -169,7 +169,7 @@ You can use gems from {% data variables.product.prodname_registry %} much like y
1. Install the package:
- ```
+ ```shell
gem install GEM_NAME --version "0.1.1"
```
diff --git a/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md b/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md
index c998e9cb1665..0cf121dbab0b 100644
--- a/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md
+++ b/content/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site.md
@@ -89,7 +89,7 @@ When you configure your site to publish with {% data variables.product.prodname_
1. Use the [`actions/upload-pages-artifact`](https://github.com/actions/upload-pages-artifact) action to upload the static files as an artifact.
1. If the workflow was triggered by a push to the default branch, use the [`actions/deploy-pages`](https://github.com/actions/deploy-pages) action to deploy the artifact. This step is skipped if the workflow was triggered by a pull request.
-The starter workflows use a deployment environment called `github-pages`. If your repository does not already include an environment called `github-pages`, the environment will be created automatically. We recommend that you add an environment protection rule so that only the default branch can deploy to this environment. For more information, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+The starter workflows use a deployment environment called `github-pages`. If your repository does not already include an environment called `github-pages`, the environment will be created automatically. We recommend that you add a deployment protection rule so that only the default branch can deploy to this environment. For more information, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
{% ifversion fpt or ghec %}
{% note %}
diff --git a/content/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages.md b/content/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages.md
index 0c2b1a112832..88d785f47879 100644
--- a/content/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages.md
+++ b/content/pages/getting-started-with-github-pages/using-custom-workflows-with-github-pages.md
@@ -45,7 +45,7 @@ The `deploy-pages` action handles the necessary setup for deploying artifacts. T
- The job must have a minimum of `pages: write` and `id-token: write` permissions.
- The `needs` parameter must be set to the `id` of the build step. Not setting this parameter may result in an independent deployment that continuously searches for an artifact that hasn't been created.
-- An `environment` must be established to enforce branch/environment protection rules. The default environment is `github-pages`.
+- An `environment` must be established to enforce branch/deployment protection rules. The default environment is `github-pages`.
- To specify the URL of the page as an output, utilize the `url:` field.
For more information, see the [`deploy-pages`](https://github.com/marketplace/actions/deploy-github-pages-site) action.
diff --git a/content/repositories/creating-and-managing-repositories/about-repositories.md b/content/repositories/creating-and-managing-repositories/about-repositories.md
index f655b7088f85..d67ff1d08eb8 100644
--- a/content/repositories/creating-and-managing-repositories/about-repositories.md
+++ b/content/repositories/creating-and-managing-repositories/about-repositories.md
@@ -120,9 +120,7 @@ Most of the limits below affect both {% data variables.product.product_name %} a
### Text limits
-Text files over **512 KB** are always displayed as plain text. Code is not syntax highlighted, and prose files are not converted to HTML (such as Markdown, AsciiDoc, _etc._).
-
-Text files over **5 MB** are only available through their raw URLs, which are served through `{% data variables.product.raw_github_com %}`; for example, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Click the **Raw** button to get the raw URL for a file.
+{% data variables.product.prodname_dotcom %} displays formatted previews of some files, such as Markdown and Mermaid diagrams. {% data variables.product.prodname_dotcom %} always attempts to render these previews if the files are small (generally less than 2 MB), but more complex files may time out and either fall back to plain text or not be displayed at all. These files are always available in their raw formats, which are served through `{% data variables.product.raw_github_com %}`; for example, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Click the **Raw** button to get the raw URL for a file.
### Diff limits
diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md
index cada58fad775..5b71e0c1c00e 100644
--- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md
+++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview.md
@@ -22,7 +22,7 @@ Until you add an image, repository links expand to show basic information about
{% tip %}
-**Tip:** Your image should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend keeping the image at 640 by 320 pixels.
+**Tip:** Your image should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend a size of at least 640 by 320 pixels (1280 by 640 pixels for best display).
{% endtip %}
diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md
index e60d6ea92e84..74cf67c2cf45 100644
--- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md
+++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md
@@ -51,7 +51,7 @@ License | License keyword
| Creative Commons license family | `cc` |
| Creative Commons Zero v1.0 Universal | `cc0-1.0` |
| Creative Commons Attribution 4.0 | `cc-by-4.0` |
-| Creative Commons Attribution Share Alike 4.0 | `cc-by-sa-4.0` |
+| Creative Commons Attribution ShareAlike 4.0 | `cc-by-sa-4.0` |
| Do What The F*ck You Want To Public License | `wtfpl` |
| Educational Community License v2.0 | `ecl-2.0` |
| Eclipse Public License 1.0 | `epl-1.0` |
diff --git a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md
index 412aa09bd5c0..f45736b8b92c 100644
--- a/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md
+++ b/content/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository.md
@@ -94,6 +94,28 @@ Organization owners and repository administrators can only grant access to view
1. Click **Save changes**.
+{% ifversion secret-scanning-validity-check-partner-patterns %}
+
+## Allowing validity checks for partner patterns in a repository
+
+{% data reusables.secret-scanning.validity-check-partner-patterns-beta %}
+{% data reusables.gated-features.partner-pattern-validity-check-ghas %}
+
+You can allow {% data variables.product.prodname_secret_scanning %} to automatically check the validity of a secret found in your repository by sending it to the relevant partner. Alternatively, organization owners and enterprise administrators can enable the feature for all repositories in the organization or enterprise settings. For more information, see "[Allowing validity checks for partner patterns in an organization](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization#allowing-validity-checks-for-partner-patterns-in-an-organization)" and "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/managing-github-advanced-security-features-for-your-enterprise)."
+
+{% note %}
+
+**Note:** When you enable automatic validity checks for a repository, you also allow on-demand validity checks to be performed for patterns detected in that repository.
+
+{% endnote %}
+
+{% data reusables.repositories.navigate-to-repo %}
+{% data reusables.repositories.sidebar-settings %}
+{% data reusables.repositories.navigate-to-code-security-and-analysis %}
+{% data reusables.secret-scanning.validity-check-auto-enable %}
+
+{% endif %}
+
## Further reading
- "[AUTOTITLE](/code-security/getting-started/securing-your-repository)"
diff --git a/content/rest/actions/artifacts.md b/content/rest/actions/artifacts.md
index d97273483ee3..5cc2c8746cd4 100644
--- a/content/rest/actions/artifacts.md
+++ b/content/rest/actions/artifacts.md
@@ -19,6 +19,4 @@ autogenerated: rest
You can use the REST API to download, delete, and retrieve information about workflow artifacts in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-artifacts %} For more information, see "[AUTOTITLE](/actions/using-workflows/storing-workflow-data-as-artifacts)."
-{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %}
-
<!-- Content after this section is automatically generated -->
diff --git a/content/rest/actions/index.md b/content/rest/actions/index.md
index 76758c88d306..ead2b8eb9045 100644
--- a/content/rest/actions/index.md
+++ b/content/rest/actions/index.md
@@ -28,6 +28,4 @@ children:
autogenerated: rest
---
-You can use the REST API to manage and control {% data variables.product.prodname_actions %} for an organization or repository. {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} require the permissions mentioned in each endpoint. For more information, see "[AUTOTITLE](/actions)."
-
<!-- Content after this section is automatically generated -->
diff --git a/content/rest/actions/oidc.md b/content/rest/actions/oidc.md
index ad90d32457ed..804864955389 100644
--- a/content/rest/actions/oidc.md
+++ b/content/rest/actions/oidc.md
@@ -14,6 +14,8 @@ versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
autogenerated: rest
---
+## About {% data variables.product.prodname_actions %} OIDC
+You can use the REST API to query and manage a customization template for an OpenID Connect (OIDC) subject claim. For more information, see "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)."
<!-- Content after this section is automatically generated -->
diff --git a/content/rest/actions/secrets.md b/content/rest/actions/secrets.md
index 405362249802..091eaedd04d3 100644
--- a/content/rest/actions/secrets.md
+++ b/content/rest/actions/secrets.md
@@ -19,6 +19,4 @@ autogenerated: rest
You can use the REST API to create, update, delete, and retrieve information about encrypted secrets that can be used in workflows in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-secrets %} For more information, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)."
-{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `secrets` permission to use these endpoints. Authenticated users must have collaborator access to a repository to create, update, or read secrets.
-
<!-- Content after this section is automatically generated -->
diff --git a/content/rest/actions/self-hosted-runners.md b/content/rest/actions/self-hosted-runners.md
index 66bbb2773c3f..dece0aa6f763 100644
--- a/content/rest/actions/self-hosted-runners.md
+++ b/content/rest/actions/self-hosted-runners.md
@@ -17,6 +17,4 @@ autogenerated: rest
You can use the REST API to register, view, and delete self-hosted runners in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-self-hosted-runners %} For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners)."
-{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use these endpoints.
-
<!-- Content after this section is automatically generated -->
diff --git a/content/rest/actions/variables.md b/content/rest/actions/variables.md
index c6fe7cce6cbc..62c26cb5e756 100644
--- a/content/rest/actions/variables.md
+++ b/content/rest/actions/variables.md
@@ -16,8 +16,6 @@ autogenerated: rest
## About variables in {% data variables.product.prodname_actions %}
-You can use the REST API to create, update, delete, and retrieve information about variables that can be used in workflows in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-variables %}
-
-{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `actions_variables/environments/organization_actions_variables` permission to use these endpoints. Authenticated users must have collaborator access to a repository to create, update, or read variables.
+You can use the REST API to create, update, delete, and retrieve information about variables that can be used in workflows in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-variables %} For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables)" in the {% data variables.product.prodname_actions %} documentation.
<!-- Content after this section is automatically generated -->
diff --git a/content/rest/actions/workflow-jobs.md b/content/rest/actions/workflow-jobs.md
index b5fb5f20373c..2e0b356747a2 100644
--- a/content/rest/actions/workflow-jobs.md
+++ b/content/rest/actions/workflow-jobs.md
@@ -15,8 +15,6 @@ autogenerated: rest
## About workflow jobs in {% data variables.product.prodname_actions %}
-You can use the REST API to view logs and workflow jobs in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflow-jobs %} For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions)".
-
-{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %}
+You can use the REST API to view logs and workflow jobs in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflow-jobs %} For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions)."
<!-- Content after this section is automatically generated -->
diff --git a/content/rest/actions/workflow-runs.md b/content/rest/actions/workflow-runs.md
index d1f7a802639a..5a0f598488b9 100644
--- a/content/rest/actions/workflow-runs.md
+++ b/content/rest/actions/workflow-runs.md
@@ -17,6 +17,4 @@ autogenerated: rest
You can use the REST API to view, re-run, cancel, and view logs for workflow runs in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflow-runs %} For more information, see "[AUTOTITLE](/actions/managing-workflow-runs)."
-{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %}
-
<!-- Content after this section is automatically generated -->
diff --git a/content/rest/actions/workflows.md b/content/rest/actions/workflows.md
index 5bbdbb7d74f0..06bae857a00c 100644
--- a/content/rest/actions/workflows.md
+++ b/content/rest/actions/workflows.md
@@ -15,8 +15,6 @@ autogenerated: rest
## About workflows in {% data variables.product.prodname_actions %}
-You can use the REST API to view workflows for a repository in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflows %} For more information, see "[AUTOTITLE](/actions)."
-
-{% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %}
+You can use the REST API to view workflows for a repository in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflows %} For more information, see "[AUTOTITLE](/actions/using-workflows/about-workflows)" in the {% data variables.product.prodname_actions %} documentation.
<!-- Content after this section is automatically generated -->
diff --git a/content/rest/codespaces/organizations.md b/content/rest/codespaces/organizations.md
index 4c2af4481200..2f9a8268b266 100644
--- a/content/rest/codespaces/organizations.md
+++ b/content/rest/codespaces/organizations.md
@@ -15,7 +15,7 @@ autogenerated: rest
You can manage {% data variables.product.prodname_codespaces %} billed to your
organization. These endpoints are available for authenticated
-organization admins and {% data variables.product.prodname_oauth_apps %}, but not GitHub Apps. For more information,
+organization owners and {% data variables.product.prodname_oauth_apps %}, but not GitHub Apps. For more information,
see "[AUTOTITLE](/codespaces)."
<!-- Content after this section is automatically generated -->
diff --git a/content/rest/overview/authenticating-to-the-rest-api.md b/content/rest/overview/authenticating-to-the-rest-api.md
index c4fd9113294a..a376fdb2c14a 100644
--- a/content/rest/overview/authenticating-to-the-rest-api.md
+++ b/content/rest/overview/authenticating-to-the-rest-api.md
@@ -39,6 +39,8 @@ If you try to use a REST API endpoint without a token or with a token that has i
If you want to use the {% data variables.product.company_short %} REST API for personal use, you can create a {% data variables.product.pat_generic %}.{% ifversion pat-v2 %} If possible, {% data variables.product.company_short %} recommends that you use a {% data variables.product.pat_v2 %} instead of a {% data variables.product.pat_v1 %}.{% endif %} For more information about creating a {% data variables.product.pat_generic %}, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."
+{% ifversion pat-v2 %}If you are using a {% data variables.product.pat_v2 %}, your {% data variables.product.pat_v2 %} requires specific permissions in order to access each REST API endpoint. For more information about the permissions that are required for each endpoint, see "[AUTOTITLE](/rest/overview/permissions-required-for-fine-grained-personal-access-tokens)." If you are using a {% data variables.product.pat_v1 %}, your {% else %}Your {% endif %}{% data variables.product.pat_v1 %} requires specific scopes in order to access each REST API endpoint. For general guidance about what scopes to choose, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes)."
+
{% ifversion fpt or ghec %}If you use a {% data variables.product.pat_v1 %} to access an organization that enforces SAML single sign-on (SSO) for authentication, you will need to authorize your token after creation.{% ifversion pat-v2 %} {% data variables.product.pat_v2_caps %}s are authorized during token creation, before access to the organization is granted.{% endif %} For more information, see "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)."
If you do not authorize your {% data variables.product.pat_v1 %} for SAML SSO before you try to use it to access an organization that enforces SAML SSO, you may receive a `404 Not Found` or a `403 Forbidden` error. If you receive a `403 Forbidden` error, you can follow the URL in the `X-GitHub-SSO` header to authorize your token. The URL expires after one hour. If you requested data that could come from multiple organizations, the API will not return results from the organizations that require SAML SSO. The `X-GitHub-SSO` header will indicate the ID of the organizations that require SAML SSO authorization of your {% data variables.product.pat_v1 %}. For example: `X-GitHub-SSO: partial-results; organizations=21955855,20582480`.
@@ -48,6 +50,8 @@ If you do not authorize your {% data variables.product.pat_v1 %} for SAML SSO be
If you want to use the API for an organization or on behalf of another user, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app)."
+Your {% data variables.product.prodname_github_app %} requires specific permissions in order to access each REST API endpoint. For more information about the permissions that are required for each endpoint, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps)."
+
You can also create an OAuth token with an {% data variables.product.prodname_oauth_app %} to access the REST API. However, {% data variables.product.company_short %} recommends that you use a {% data variables.product.prodname_github_app %} instead. {% data variables.product.prodname_github_apps %} allow more control over the access and permission that the app has.
{% ifversion fpt or ghec %}Access tokens created by apps are automatically authorized for SAML SSO.{% endif %}
diff --git a/content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md b/content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md
index 3e3af1588db8..09b05e909607 100644
--- a/content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md
+++ b/content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md
@@ -11,6 +11,8 @@ autogenerated: github-apps
When you create a {% data variables.product.pat_v2 %}, you grant it a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."
+{% data reusables.rest-api.permission-header %}
+
Some endpoints require additional permissions. When this is the case, the "Additional permissions" column will indicate the other permissions that are required to use the endpoint.
<!-- The content of this page is rendered as a NextJS page component. -->
diff --git a/content/rest/overview/permissions-required-for-github-apps.md b/content/rest/overview/permissions-required-for-github-apps.md
index 96b60468570a..14ec3ea4687a 100644
--- a/content/rest/overview/permissions-required-for-github-apps.md
+++ b/content/rest/overview/permissions-required-for-github-apps.md
@@ -19,6 +19,8 @@ autogenerated: github-apps
{% data variables.product.prodname_github_apps %} are created with a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/setting-permissions-for-github-apps)."
+{% data reusables.rest-api.permission-header %}
+
Some endpoints require additional permissions. When this is the case, the "Additional permissions" column will indicate the other permissions that are required to use the endpoint.
<!-- The content of this page is rendered as a NextJS page component. -->
diff --git a/content/rest/overview/troubleshooting.md b/content/rest/overview/troubleshooting.md
index 034095c5ea63..5fc3bce9d5aa 100644
--- a/content/rest/overview/troubleshooting.md
+++ b/content/rest/overview/troubleshooting.md
@@ -88,3 +88,19 @@ curl -H 'Authorization: Bearer YOUR-OAUTH-TOKEN' https://api.github.com/user/rep
If {% data variables.product.product_name %} takes more than 10 seconds to process an API request, {% data variables.product.product_name %} will terminate the request and you will receive a timeout response.
{% endif %}
+
+{% ifversion rest-permissions-header %}
+
+## Insufficient permissions errors
+
+If you are using a {% data variables.product.prodname_github_app %}{% ifversion pat-v2 %} or {% data variables.product.pat_v2 %}{% endif %} and you receive an error due to your token having insufficient permissions, you can use the `X-Accepted-GitHub-Permissions` header to identify the permissions that are required to access the REST API endpoint.
+
+The value of the `X-Accepted-GitHub-Permissions` header is a comma separated list of the permissions that are required to use the endpoint. Occasionally, you can choose from multiple permission sets. In these cases, multiple comma separated lists will be separated by a semicolon.
+
+For example:
+
+- `X-Accepted-GitHub-Permissions: contents=read` means that your {% data variables.product.prodname_github_app %}{% ifversion pat-v2 %} or {% data variables.product.pat_v2 %}{% endif %} needs read access to the contents permission.
+- `X-Accepted-GitHub-Permissions: pull_requests=write,contents=read` means that your {% data variables.product.prodname_github_app %}{% ifversion pat-v2 %} or {% data variables.product.pat_v2 %}{% endif %} needs write access to the pull request permission and read access to the contents permission.
+- `X-Accepted-GitHub-Permissions: pull_requests=read,contents=read; issues=read,contents=read` means that your {% data variables.product.prodname_github_app %}{% ifversion pat-v2 %} or {% data variables.product.pat_v2 %}{% endif %} needs either read access to the pull request permission and read access to the contents permission, or read access to the issues permission and read access to the contents permission.
+
+{% endif %}
diff --git a/content/rest/repos/lfs.md b/content/rest/repos/lfs.md
index e3ada8a67e5b..6358351e9a11 100644
--- a/content/rest/repos/lfs.md
+++ b/content/rest/repos/lfs.md
@@ -4,7 +4,6 @@ intro: >-
Use the REST API to enable or disable {% data
variables.large_files.product_name_long %} (LFS) for a repository.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
- fpt: '*'
ghae: '*'
ghec: '*'
ghes: '*'
diff --git a/content/search-github/github-code-search/understanding-github-code-search-syntax.md b/content/search-github/github-code-search/understanding-github-code-search-syntax.md
index 7bc253223006..eb3627ee5f90 100644
--- a/content/search-github/github-code-search/understanding-github-code-search-syntax.md
+++ b/content/search-github/github-code-search/understanding-github-code-search-syntax.md
@@ -75,7 +75,7 @@ To search for documents containing either one term or the other, you can use the
sparse OR index
```
-To exclude files from your search results, you can use the `NOT` operator. For example, to exclude file in the `__testing__` directory, you can search:
+To exclude files from your search results, you can use the `NOT` operator. For example, to exclude files in the `__testing__` directory, you can search:
```
"fatal error" NOT path:__testing__
diff --git a/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md b/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md
index 9089c09a56fe..39a4d5b924ca 100644
--- a/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md
+++ b/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md
@@ -12,11 +12,11 @@ topics:
**Short version:** _We host a wide variety of collaborative projects from all over the world, and that collaboration only works when our users are able to work together in good faith. While using the Service, you must comply with our Acceptable Use Policies, which include some restrictions on content and conduct on GitHub related to user safety, intellectual property, privacy, authenticity, and other limitations. In short, be excellent to each other._
-Capitalized terms used but not defined in these Acceptable Use Policies have the meanings assigned to them in our [Terms of Service](/site-policy/github-terms/github-terms-of-service), [Corporate Terms of Service](/site-policy/github-terms/github-corporate-terms-of-service), and [Privacy Statement](/site-policy/privacy-policies/github-privacy-statement). For customers subject to the [Corporate Terms of Service](/site-policy/github-terms/github-corporate-terms-of-service), "you" and "your" refer to "Customer" or "Users". "We", "us", "our" refer to "GitHub".
+Capitalized terms used but not defined in these Acceptable Use Policies have the meanings assigned to them in your main agreement with us — the [GitHub Terms of Service](/site-policy/github-terms/github-terms-of-service) or GitHub Customer Agreement, or the [GitHub Corporate Terms of Service](/site-policy/github-terms/github-corporate-terms-of-service) or other legacy GitHub contract, or a Microsoft volume licensing agreement. For customers subject to the legacy Corporate Terms of Service, "you" and "your" refer to "Customer" or "Users". "We", "us", and "our" refer to "GitHub".
## 1. Compliance with Laws and Regulations
-You are responsible for using the Service in compliance with all applicable laws, regulations, and all of our Acceptable Use Policies. These policies may be updated from time to time and are provided below, as well as in our [Terms of Service](/site-policy/github-terms/github-terms-of-service) and [Corporate Terms of Service](/site-policy/github-terms/github-corporate-terms-of-service).
+You are responsible for using the Service in compliance with all applicable laws, regulations, and all of our Acceptable Use Policies. These policies may be updated from time to time and are provided below.
## 2. User Safety
@@ -55,8 +55,8 @@ We do not allow content or activity on GitHub that:
## 4. Spam and Inauthentic Activity on GitHub
We do not allow content or activity on GitHub that is:
-- automated excessive bulk activity and coordinated inauthentic activity, such as
- - spamming
+- automated excessive bulk activity and coordinated inauthentic activity, such as
+ - spamming
- cryptocurrency mining;
- bulk distribution of promotions and advertising prohibited by GitHub terms and policies;
- inauthentic interactions, such as fake accounts and automated inauthentic activity;
@@ -114,7 +114,7 @@ If you decide to post any promotional materials in your Account, you are solely
## 11. User Protection
You must not engage in activity that significantly harms other users.
-
+
We will interpret our policies and resolve disputes in favor of protecting users as a whole.
---
diff --git a/content/site-policy/github-terms/github-corporate-terms-of-service.md b/content/site-policy/github-terms/github-corporate-terms-of-service.md
index 7d5a947af92d..d5919cd6ce52 100644
--- a/content/site-policy/github-terms/github-corporate-terms-of-service.md
+++ b/content/site-policy/github-terms/github-corporate-terms-of-service.md
@@ -10,7 +10,11 @@ topics:
- Legal
---
-_These terms apply to GitHub.com customers who have executed agreements in place referencing the Corporate Terms of Service. All other business or institution customers are directed to [github.com/customer-terms](https://github.com/customer-terms) for current terms._
+{% note %}
+
+**Note:** The GitHub Corporate Terms of Service were deprecated effective 30 November 2021, and are no longer used for new customers. The terms below apply _only_ to those GitHub customers with executed agreements that explicitly reference the Corporate Terms of Service. All other business or institution customers are directed to the GitHub Customer Agreement terms available at [github.com/customer-terms](https://github.com/customer-terms).
+
+{% endnote %}
## GitHub Corporate Terms of Service
@@ -106,7 +110,7 @@ In order to create an account, Customer must adhere to the following:
- A User’s login may not be shared by multiple people.
-- Customer must not use the Products (a) in violation of export control or sanctions laws of the United States or any other applicable jurisdiction; (b) if it is located in or ordinarily resident in a country or territory subject to comprehensive to comprehensive sanctions administered by the U.S. Office of Foreign Assets Control (OFAC); or (c) if it is or is working on behalf of a [Specially Designated National (SDN)](https://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx) or a person subject to similar blocking or denied party prohibitions. For more information, please see our [Export Controls policy](/site-policy/other-site-policies/github-and-trade-controls).
+- Customer must not use the Products (a) in violation of export control or sanctions laws of the United States or any other applicable jurisdiction; (b) if it is located in or ordinarily resident in a country or territory subject to comprehensive sanctions administered by the U.S. Office of Foreign Assets Control (OFAC); or (c) if it is or is working on behalf of a [Specially Designated National (SDN)](https://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx) or a person subject to similar blocking or denied party prohibitions. For more information, please see our [Export Controls policy](/site-policy/other-site-policies/github-and-trade-controls).
### 3. Account Security
@@ -178,7 +182,7 @@ GitHub considers Customer Content in Customer’s Private Repositories to be Cus
### 3. Access
-GitHub personnel may only access Customer's Private Repositories in the situations described in our [Privacy Statement](/site-policy/privacy-policies/github-privacy-statement#repository-contents).
+GitHub personnel may only access Customer's Private Repositories in the situations described in our [Privacy Statement](/site-policy/privacy-policies/github-privacy-statement#repository-contents).
Customer may choose to enable additional access to its Private Repositories. For example, Customer may enable various GitHub services or features that require additional rights to Customer Content in Private Repositories. These rights may vary depending on the service or feature, but GitHub will continue to treat Customer Content in Customer’s Private Repositories as Customer’s Confidential Information. If those services or features require rights in addition to those it needs to provide the Service, GitHub will provide an explanation of those rights.
diff --git a/content/site-policy/github-terms/github-marketplace-terms-of-service.md b/content/site-policy/github-terms/github-marketplace-terms-of-service.md
index 28ee2f0e47d7..9230969046ba 100644
--- a/content/site-policy/github-terms/github-marketplace-terms-of-service.md
+++ b/content/site-policy/github-terms/github-marketplace-terms-of-service.md
@@ -18,7 +18,7 @@ Effective Date: November 20, 2020
## A. GitHub.com's Terms of Service
-Marketplace is provided by GitHub, and is governed by either the [Terms of Service](/site-policy/github-terms/github-terms-of-service) or the [Corporate Terms of Service](/site-policy/github-terms/github-corporate-terms-of-service) ("GitHub Terms"), depending on the type of account you're on, as well as these Marketplace Terms. If you configure the Developer Products to work with one or more accounts on the GitHub.com website, your use of the Developer Products will also be governed by your applicable GitHub Terms. Any capitalized terms not defined in this document will be defined in your applicable GitHub Terms.
+Marketplace is provided by GitHub, and is governed by these Marketplace Terms combined with your main agreement with us — the [GitHub Terms of Service](/site-policy/github-terms/github-terms-of-service) or GitHub Customer Agreement, or the [GitHub Corporate Terms of Service](/site-policy/github-terms/github-corporate-terms-of-service) or other legacy GitHub contract, or a Microsoft volume licensing agreement. If you configure the Developer Products to work with one or more accounts on the GitHub.com website, your use of the Developer Products will also be governed by your applicable GitHub Terms. Any capitalized terms not defined in this document will be defined in your applicable GitHub Terms.
You may not use a Developer Product to violate your applicable GitHub Terms. Many of these Developer Products are used exclusively for performing automated tasks. In addition, multiple Users may direct the actions of a Developer Product. However, if you purchase and/or set up a Developer Product on your account, or you are an owner of an account with an integrated Developer Product, then you will be responsible for the Developer Product's actions that are performed on or through your account.
diff --git a/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md b/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md
index 1b90f36a9709..6c869fe3cf88 100644
--- a/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md
+++ b/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md
@@ -16,7 +16,7 @@ topics:
Version Effective Date: November 3, 2022
-When you use GitHub, you may be given access to lots of additional products and features ("Additional Products and Features"). Because many of the Additional Products and Features offer different functionality, specific terms for that product or feature may apply in addition to your main agreement with us—the GitHub Terms of Service, GitHub Corporate Terms of Service, GitHub General Terms, or Microsoft volume licensing agreement (each, the "Agreement"). Below, we've listed those products and features, along with the corresponding additional terms that apply to your use of them.
+When you use GitHub, you may be given access to lots of additional products and features ("Additional Products and Features"). Because many of the Additional Products and Features offer different functionality, your Agreement with us (the "Agreement") includes the specific terms for that product or feature combined with your main agreement — the GitHub Terms of Service or GitHub Customer Agreement, or the GitHub Corporate Terms of Service or other legacy GitHub contract, or a Microsoft volume licensing agreement. Below, we've listed those products and features, along with the corresponding additional terms that apply to your use of them.
By using the Additional Products and Features, you also agree to the applicable GitHub Terms for Additional Products and Features listed below. A violation of these GitHub Terms for Additional Products and Features is a violation of the Agreement. Capitalized terms not defined here have the meaning given in the Agreement.
@@ -62,6 +62,8 @@ GitHub makes extra security features available to customers under an Advanced Se
Advanced Security is licensed on a "Unique Committer" basis. A "Unique Committer" is a licensed user of GitHub Enterprise, GitHub Enterprise Cloud, GitHub Enterprise Server, or GitHub AE, who has made a commit in the last 90 days to any repository with any GitHub Advanced Security functionality activated. You must acquire a GitHub Advanced Security User license for each of your Unique Committers. You may only use GitHub Advanced Security on codebases that are developed by or for you. For GitHub Enterprise Cloud users, some Advanced Security features also require the use of GitHub Actions.
+For secret scanning with GitHub Advanced Security, when you opt-in to automatic validity checks for partner patterns, exposed third-party tokens may be shared with the relevant partner, in order to provide you with more information about the validity of the token. Not all partners are based in the United States. The [Secret scanning patterns documentation](/enterprise-cloud@latest/code-security/secret-scanning/secret-scanning-patterns) provides more details on which partners support the validity check.
+
## Advisory Database
The GitHub Advisory Database allows you to browse or search for vulnerabilities that affect open source projects on GitHub.
diff --git a/content/site-policy/github-terms/github-terms-of-service.md b/content/site-policy/github-terms/github-terms-of-service.md
index 972d93324157..d76ddb108a22 100644
--- a/content/site-policy/github-terms/github-terms-of-service.md
+++ b/content/site-policy/github-terms/github-terms-of-service.md
@@ -170,7 +170,7 @@ GitHub will provide notice regarding our access to private repository content, u
## F. Copyright Infringement and DMCA Policy
-If you believe that content on our website violates your copyright, please contact us in accordance with our [Digital Millennium Copyright Act Policy](/site-policy/content-removal-policies/dmca-takedown-policy). If you are a copyright owner and you believe that content on GitHub violates your rights, please contact us via [our convenient DMCA form](https://github.com/contact/dmca) or by emailing copyright@github.com. There may be legal consequences for sending a false or frivolous takedown notice. Before sending a takedown request, you must consider legal uses such as fair use and licensed uses.
+If you believe that content on our website violates your copyright, please contact us in accordance with our [Digital Millennium Copyright Act Policy](/site-policy/content-removal-policies/dmca-takedown-policy). If you are a copyright owner and you believe that content on GitHub violates your rights, please contact us via [our convenient DMCA form](https://github.com/contact/dmca) or by emailing [copyright@github.com](mailto:copyright@github.com). There may be legal consequences for sending a false or frivolous takedown notice. Before sending a takedown request, you must consider legal uses such as fair use and licensed uses.
We will terminate the Accounts of [repeat infringers](/site-policy/content-removal-policies/dmca-takedown-policy#e-repeated-infringement) of this policy.
diff --git a/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md b/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md
index b9a62abaa8f9..832cedb0e2c1 100644
--- a/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md
+++ b/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md
@@ -43,6 +43,81 @@ Donations between sponsored developers will not be matched.
{% data reusables.sponsors.legal-additional-terms %}
+## Supported regions for {% data variables.product.prodname_sponsors %}
+
+Anyone in any region can sponsor eligible maintainers, but you must reside in a supported region to receive funds.
+
+<ul style="-webkit-column-count: 3; -moz-column-count: 3; column-count: 3;">
+<li>Argentina</li>
+<li>Australia</li>
+<li>Austria</li>
+<li>Belgium</li>
+<li>Bolivia</li>
+<li>Brazil</li>
+<li>Bulgaria</li>
+<li>Canada</li>
+<li>Chile</li>
+<li>Colombia</li>
+<li>Costa Rica</li>
+<li>Croatia</li>
+<li>Cyprus</li>
+<li>Czech Republic</li>
+<li>Denmark</li>
+<li>Dominican Republic</li>
+<li>Egypt</li>
+<li>Estonia</li>
+<li>Finland</li>
+<li>France</li>
+<li>Gambia</li>
+<li>Germany</li>
+<li>Gibraltar</li>
+<li>Greece</li>
+<li>Hong Kong SAR</li>
+<li>Hungary</li>
+<li>Iceland</li>
+<li>India</li>
+<li>Indonesia</li>
+<li>Ireland</li>
+<li>Israel</li>
+<li>Italy</li>
+<li>Japan</li>
+<li>Kenya</li>
+<li>Latvia</li>
+<li>Liechtenstein</li>
+<li>Lithuania</li>
+<li>Luxembourg</li>
+<li>Malta</li>
+<li>Mexico</li>
+<li>Morocco</li>
+<li>Netherlands</li>
+<li>New Zealand</li>
+<li>Norway</li>
+<li>Paraguay</li>
+<li>Peru</li>
+<li>Philippines</li>
+<li>Poland</li>
+<li>Portugal</li>
+<li>Romania</li>
+<li>Saudi Arabia</li>
+<li>Serbia</li>
+<li>Singapore</li>
+<li>Slovakia</li>
+<li>Slovenia</li>
+<li>South Africa</li>
+<li>South Korea</li>
+<li>Spain</li>
+<li>Sweden</li>
+<li>Switzerland</li>
+<li>Thailand</li>
+<li>Trinidad & Tobago</li>
+<li>Tunisia</li>
+<li>Turkey</li>
+<li>United Arab Emirates</li>
+<li>United Kingdom</li>
+<li>United States</li>
+<li>Uruguay</li>
+</ul>
+
## Sharing feedback about {% data variables.product.prodname_sponsors %}
{% data reusables.sponsors.feedback %}
diff --git a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md
index 281441238864..28217d9cc18b 100644
--- a/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md
+++ b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md
@@ -33,7 +33,7 @@ You can use a credit card to sponsor an account on {% data variables.product.pro
{% data reusables.sponsors.no-fees %} For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-sponsors/about-billing-for-github-sponsors)."
-When you sponsor an account using a credit card, the change will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %}
+When you sponsor an account using a credit card, the charge will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %}
We may share certain limited tax information with sponsored accounts. For more information, see "[Tax information](#tax-information)."
diff --git a/content/webhooks-and-events/events/issue-event-types.md b/content/webhooks-and-events/events/issue-event-types.md
index aa94c3e42205..ef2b083767bb 100644
--- a/content/webhooks-and-events/events/issue-event-types.md
+++ b/content/webhooks-and-events/events/issue-event-types.md
@@ -780,7 +780,7 @@ Name | Type | Description
`body` | `string` | The review summary text.
`commit_id` | `string` | The SHA of the latest commit in the pull request at the time of the review.
`submitted_at` | `string` | The timestamp indicating when the review was submitted.
-`state` | `string` | The state of the submitted review. Can be one of: `commented`, `changes_requested`, or `approved`.
+`state` | `string` | The state of the submitted review. Can be one of: `commented`, `changes_requested`, `approved` or `dismissed`.
`html_url` | `string` | The HTML URL of the review.
`pull_request_url` | `string` | The REST API URL to retrieve the pull request.
`author_association` | `string` | The permissions the user has in the issue's repository. For example, the value would be `"OWNER"` if the owner of repository created a comment.
diff --git a/content/webhooks-and-events/webhooks/securing-your-webhooks.md b/content/webhooks-and-events/webhooks/securing-your-webhooks.md
index 4dfb86fdd76e..721b51ca2f24 100644
--- a/content/webhooks-and-events/webhooks/securing-your-webhooks.md
+++ b/content/webhooks-and-events/webhooks/securing-your-webhooks.md
@@ -62,7 +62,24 @@ Your language and server implementations may differ from the following examples.
- No matter which implementation you use, the hash signature starts with `sha256=`, using the key of your secret token and your payload body.
-- Using a plain `==` operator is **not advised**. A method like [`secure_compare`][secure_compare] performs a "constant time" string comparison, which helps mitigate certain timing attacks against regular equality operators.
+- Using a plain `==` operator is **not advised**. A method like [`secure_compare`][secure_compare] or [`crypto.timingSafeEqual`][timingSafeEqual] performs a "constant time" string comparison, which helps mitigate certain timing attacks against regular equality operators, or regular loops in JIT-optimized languages.
+
+### Test values
+
+Regardless of the programming language that you use to implement HMAC verification in your code, you can use the following `secret` and `payload` values to verify that your implementation is correct.
+
+- secret: "It's a Secret to Everybody"
+- payload: "Hello, World!"
+
+If your implementation is correct and uses the SHA-256 algorithm, the signatures that you generate should match the following signature values:
+
+- signature: 757107ea0eb2509fc211221cce984b8a37570b6d7586c22c46f4379c8b043e17
+- x-hub-signature: sha256=757107ea0eb2509fc211221cce984b8a37570b6d7586c22c46f4379c8b043e17
+
+If your implementation is correct and uses the SHA-1 algorithm, the signatures that you generate should match the following signature values:
+
+- signature: 01dc10d0c83e72ed246219cdd91669667fe2ca59
+- x-hub-signature: sha1=01dc10d0c83e72ed246219cdd91669667fe2ca59
### Ruby example
@@ -112,6 +129,57 @@ def verify_signature(payload_body, secret_token, signature_header):
raise HTTPException(status_code=403, detail="Request signatures didn't match!")
```
+### JavaScript example
+
+For example, you can define the following `verifySignature` function and call it in any JavaScript environment when you receive a webhook payload:
+
+```javascript
+let encoder = new TextEncoder();
+
+async function verifySignature(secret, header, payload) {
+ let parts = header.split("=");
+ let sigHex = parts[1];
+
+ let algorithm = { name: "HMAC", hash: { name: 'SHA-256' } };
+
+ let keyBytes = encoder.encode(secret);
+ let extractable = false;
+ let key = await crypto.subtle.importKey(
+ "raw",
+ keyBytes,
+ algorithm,
+ extractable,
+ [ "sign", "verify" ],
+ );
+
+ let sigBytes = hexToBytes(sigHex);
+ let dataBytes = encoder.encode(payload);
+ let equal = await crypto.subtle.verify(
+ algorithm.name,
+ key,
+ sigBytes,
+ dataBytes,
+ );
+
+ return equal;
+}
+
+function hexToBytes(hex) {
+ let len = hex.length / 2;
+ let bytes = new Uint8Array(len);
+
+ let index = 0;
+ for (let i = 0; i < hex.length; i += 2) {
+ let c = hex.slice(i, i + 2);
+ let b = parseInt(c, 16);
+ bytes[index] = b;
+ index += 1;
+ }
+
+ return bytes;
+}
+```
+
### Typescript example
For example, you can define the following `verify_signature` function and call it when you receive a webhook payload:
@@ -126,7 +194,9 @@ const verify_signature = (req: Request) => {
.createHmac("sha256", WEBHOOK_SECRET)
.update(JSON.stringify(req.body))
.digest("hex");
- return `sha256=${signature}` === req.headers.get("x-hub-signature-256");
+ let trusted = Buffer.from(`sha256=${signature}`, 'ascii');
+ let untrusted = Buffer.from(req.headers.get("x-hub-signature-256"), 'ascii');
+ return crypto.timingSafeEqual(trusted, untrusted);
};
const handleWebhook = (req: Request, res: Response) => {
@@ -139,3 +209,4 @@ const handleWebhook = (req: Request, res: Response) => {
```
[secure_compare]: https://rubydoc.info/github/rack/rack/main/Rack/Utils:secure_compare
+[timingSafeEqual]: https://nodejs.org/api/crypto.html#cryptotimingsafeequala-b
diff --git a/contributing/translations-for-writers.md b/contributing/Cachiman
similarity index 69%
rename from contributing/translations-for-writers.md
rename to contributing/Cachiman
index 98f18206fc0e..f0c408d3d289 100644
--- a/contributing/translations-for-writers.md
+++ b/contributing/Cachiman
@@ -1,25 +1,25 @@
-# Translations guide for writers
+cachiman# Translations guide for writers
Use the following checklist to help make your files more translation-friendly. For additional information, refer to the [style guide](../content-style-guide.md).
-- [ ] Use examples that are generic and can be understood by most people.
-- [ ] Avoid examples that are controversial or culturally specific to a group.
-- [ ] Write in active voice.
-- [ ] Write simple, short, and easy-to-understand sentences.
-- [ ] Avoid using too many pronouns that can make text unclear.
-- [ ] Avoid using slang and jokes.
-- [ ] Avoid negative sentences.
-- [ ] Use industry-standard acronyms whenever possible and explain custom acronyms.
-- [ ] Use indicative mood.
-- [ ] Eliminate redundant and wordy expressions.
-- [ ] Avoid the excessive use of stacked modifiers (noun strings). The translator can misunderstand which noun is the one being modified.
-- [ ] Avoid invisible plurals in which it is not clear if the first noun is meant to be singular or plural.
-- [ ] Avoid nominalization.
-- [ ] Avoid using ambiguous modal auxiliary verbs.
-- [ ] Avoid gender-specific words.
-- [ ] Avoid prepositional phrases.
-- [ ] Avoid vague nouns and pronouns (vague sentence subject).
-- [ ] Keep inline links to a minimum. If they are necessary, preface them with a phrase such as "For more information, see "Link title". Alternatively, add relevant links to a "Further reading" section at the end of the topic.
+- [x ] Use examples that are generic and can be understood by most people.
+- [ x] Avoid examples that are controversial or culturally specific to a group.
+- [x ] Write in active voice.
+- [x ] Write simple, short, and easy-to-understand sentences.
+- [x ] Avoid using too many pronouns that can make text unclear.
+- [x ] Avoid using slang and jokes.
+- [x ] Avoid negative sentences.
+- [x ] Use industry-standard acronyms whenever possible and explain custom acronyms.
+- [ x] Use indicative mood.
+- [ x] Eliminate redundant and wordy expressions.
+- [ x] Avoid the excessive use of stacked modifiers (noun strings). The translator can misunderstand which noun is the one being modified.
+- [x ] Avoid invisible plurals in which it is not clear if the first noun is meant to be singular or plural.
+- [x ] Avoid nominalization.
+- [x ] Avoid using ambiguous modal auxiliary verbs.
+- [ x] Avoid gender-specific words.
+- [ x] Avoid prepositional phrases.
+- [x ] Avoid vague nouns and pronouns (vague sentence subject).
+- [x ] Keep inline links to a minimum. If they are necessary, preface them with a phrase such as "For more information, see "Link title". Alternatively, add relevant links to a "Further reading" section at the end of the topic.
## Examples
diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md
index caecfdc967ae..7b0aa6f38187 100644
--- a/contributing/content-style-guide.md
+++ b/contributing/content-style-guide.md
@@ -693,6 +693,12 @@ A release note for a security fix answers the following questions.
- > **MEDIUM**: An attacker could embed dangerous links in the instance's web UI because pull request preview links did not properly sanitize URLs. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com).
+#### Base image and package updates
+
+We also include base image and dependent package updates in the "Security fixes" section, since these updates often address security issues. We consolidate all of these updates in the following note.
+
+> Packages have been updated to the latest security versions.
+
### Bug fixes
A release note for a bug fix describes a correction to an undesired or otherwise unexpected behavior. Generally, notes for bug fixes are only part of patch releases.
diff --git a/data/features/actions-protected-branches-restrictions.yml b/data/features/actions-protected-branches-restrictions.yml
new file mode 100644
index 000000000000..68876d11afc0
--- /dev/null
+++ b/data/features/actions-protected-branches-restrictions.yml
@@ -0,0 +1,6 @@
+# Reference: #11588
+# Documentation for security fix that block runs triggered from tag or fork with the same name as the protected branch
+versions:
+ fpt: '*'
+ ghec: '*'
+ ghes: '>=3.11'
diff --git a/data/features/actions-single-use-tokens.yml b/data/features/actions-single-use-tokens.yml
index 0b095c9b47fe..9fdb01a3b83f 100644
--- a/data/features/actions-single-use-tokens.yml
+++ b/data/features/actions-single-use-tokens.yml
@@ -3,4 +3,4 @@
versions:
fpt: '*'
ghec: '*'
- ghes: '>=3.11'
+ ghes: '>=3.10'
diff --git a/data/features/dependabot-version-updates-groups.yml b/data/features/dependabot-version-updates-groups.yml
index faf9a6f82c24..63621b6910c5 100644
--- a/data/features/dependabot-version-updates-groups.yml
+++ b/data/features/dependabot-version-updates-groups.yml
@@ -4,3 +4,4 @@
versions:
fpt: '*'
ghec: '*'
+ ghes: '>=3.11'
diff --git a/data/features/issue-form-dropdown-defaults.yml b/data/features/issue-form-dropdown-defaults.yml
new file mode 100644
index 000000000000..ce63850f9fe7
--- /dev/null
+++ b/data/features/issue-form-dropdown-defaults.yml
@@ -0,0 +1,6 @@
+# Ability to set a default in issue form dropdowns (#11231)
+versions:
+ fpt: '*'
+ ghec: '*'
+ ghes: '>=3.11'
+ ghae: '>=3.11'
diff --git a/data/features/projects-in-issue-forms.yml b/data/features/projects-in-issue-forms.yml
new file mode 100644
index 000000000000..27bac8a18071
--- /dev/null
+++ b/data/features/projects-in-issue-forms.yml
@@ -0,0 +1,6 @@
+# Ability to set projects in issue forms (#11231)
+versions:
+ fpt: '*'
+ ghec: '*'
+ ghes: '>=3.11'
+ ghae: '>=3.11'
diff --git a/data/features/projects-v2-slice-panel.yml b/data/features/projects-v2-slice-panel.yml
new file mode 100644
index 000000000000..d5cc2d8db723
--- /dev/null
+++ b/data/features/projects-v2-slice-panel.yml
@@ -0,0 +1,6 @@
+# Issue 10597
+# Slice panel for Projects
+versions:
+ fpt: '*'
+ ghec: '*'
+ ghes: '>=3.11'
diff --git a/data/features/rest-permissions-header.yml b/data/features/rest-permissions-header.yml
new file mode 100644
index 000000000000..fadf54092e20
--- /dev/null
+++ b/data/features/rest-permissions-header.yml
@@ -0,0 +1,6 @@
+# Issue 11209
+versions:
+ fpt: '*'
+ ghec: '*'
+ ghes: '>=3.11'
+ ghae: '>=3.11'
diff --git a/data/features/secret-scanning-backfills-historical-issues.yml b/data/features/secret-scanning-backfills-historical-issues.yml
index 5d0a7f2f7329..706fcd32e23b 100644
--- a/data/features/secret-scanning-backfills-historical-issues.yml
+++ b/data/features/secret-scanning-backfills-historical-issues.yml
@@ -2,4 +2,4 @@
# Documentation for secret scanning detects secrets in historical issues content.
versions:
ghec: '*'
- ghes: '>=3.9'
+ ghes: '>=3.11'
diff --git a/data/features/secret-scanning-issue-body-comments.yml b/data/features/secret-scanning-issue-body-comments.yml
index 9294825d647e..b9a48fa0aa9c 100644
--- a/data/features/secret-scanning-issue-body-comments.yml
+++ b/data/features/secret-scanning-issue-body-comments.yml
@@ -2,5 +2,4 @@
# Secret scanning: Scan Issues body and comments
versions:
ghec: '*'
- ghes: '>3.8'
- ghae: '>3.8'
+ ghes: '>=3.11'
diff --git a/data/features/secret-scanning-validity-check-partner-patterns.yml b/data/features/secret-scanning-validity-check-partner-patterns.yml
new file mode 100644
index 000000000000..75f566ba0f8f
--- /dev/null
+++ b/data/features/secret-scanning-validity-check-partner-patterns.yml
@@ -0,0 +1,5 @@
+# Reference: #9861.
+# Documentation for secret scanning: validity check for partner patterns (GHAS).
+versions:
+ ghec: '*'
+ ghes: '>=3.12'
diff --git a/data/graphql/ghae/schema.docs-ghae.graphql b/data/graphql/ghae/schema.docs-ghae.graphql
index 9930e0640351..6e125047bde9 100644
--- a/data/graphql/ghae/schema.docs-ghae.graphql
+++ b/data/graphql/ghae/schema.docs-ghae.graphql
@@ -697,6 +697,46 @@ type AddPullRequestReviewThreadPayload {
thread: PullRequestReviewThread
}
+"""
+Autogenerated input type of AddPullRequestReviewThreadReply
+"""
+input AddPullRequestReviewThreadReplyInput {
+ """
+ The text of the reply.
+ """
+ body: String!
+
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The Node ID of the pending review to which the reply will belong.
+ """
+ pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"])
+
+ """
+ The Node ID of the thread to which this reply is being written.
+ """
+ pullRequestReviewThreadId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewThread"])
+}
+
+"""
+Autogenerated return type of AddPullRequestReviewThreadReply
+"""
+type AddPullRequestReviewThreadReplyPayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The newly created reply.
+ """
+ comment: PullRequestReviewComment
+}
+
"""
Autogenerated input type of AddReaction
"""
@@ -18722,6 +18762,16 @@ type Mutation {
input: AddPullRequestReviewThreadInput!
): AddPullRequestReviewThreadPayload
+ """
+ Adds a reply to an existing Pull Request Review Thread.
+ """
+ addPullRequestReviewThreadReply(
+ """
+ Parameters for AddPullRequestReviewThreadReply
+ """
+ input: AddPullRequestReviewThreadReplyInput!
+ ): AddPullRequestReviewThreadReplyPayload
+
"""
Adds a reaction to a subject.
"""
@@ -27957,6 +28007,21 @@ type PullRequest implements Assignable & Closable & Comment & Labelable & Lockab
viewerSubscription: SubscriptionState
}
+"""
+The possible methods for updating a pull request's head branch with the base branch.
+"""
+enum PullRequestBranchUpdateMethod {
+ """
+ Update branch via merge
+ """
+ MERGE
+
+ """
+ Update branch via rebase
+ """
+ REBASE
+}
+
"""
A file changed in a pull request.
"""
@@ -39748,7 +39813,8 @@ input StartRepositoryMigrationInput {
"""
Whether to continue the migration on error. Defaults to `false`. We strongly
- recommend setting this to `true` for the smoothest migration experience.
+ recommend setting this to `true` for the smoothest migration experience. *This
+ default will change to `true` on September 4, 2023.*
"""
continueOnError: Boolean
@@ -45120,6 +45186,11 @@ input UpdatePullRequestBranchInput {
The Node ID of the pull request.
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
+
+ """
+ The update branch method to use. If omitted, defaults to 'MERGE'
+ """
+ updateMethod: PullRequestBranchUpdateMethod
}
"""
diff --git a/data/graphql/ghec/schema.docs.graphql b/data/graphql/ghec/schema.docs.graphql
index 9051775ebe34..b95c8eb5395d 100644
--- a/data/graphql/ghec/schema.docs.graphql
+++ b/data/graphql/ghec/schema.docs.graphql
@@ -864,6 +864,46 @@ type AddPullRequestReviewThreadPayload {
thread: PullRequestReviewThread
}
+"""
+Autogenerated input type of AddPullRequestReviewThreadReply
+"""
+input AddPullRequestReviewThreadReplyInput {
+ """
+ The text of the reply.
+ """
+ body: String!
+
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The Node ID of the pending review to which the reply will belong.
+ """
+ pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"])
+
+ """
+ The Node ID of the thread to which this reply is being written.
+ """
+ pullRequestReviewThreadId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewThread"])
+}
+
+"""
+Autogenerated return type of AddPullRequestReviewThreadReply
+"""
+type AddPullRequestReviewThreadReplyPayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The newly created reply.
+ """
+ comment: PullRequestReviewComment
+}
+
"""
Autogenerated input type of AddReaction
"""
@@ -16069,6 +16109,11 @@ type GitHubMetadata {
"""
gitIpAddresses: [String!]
+ """
+ IP addresses that GitHub Enterprise Importer uses for outbound connections
+ """
+ githubEnterpriseImporterIpAddresses: [String!]
+
"""
IP addresses that service hooks are sent from
"""
@@ -21439,6 +21484,16 @@ type Mutation {
input: AddPullRequestReviewThreadInput!
): AddPullRequestReviewThreadPayload
+ """
+ Adds a reply to an existing Pull Request Review Thread.
+ """
+ addPullRequestReviewThreadReply(
+ """
+ Parameters for AddPullRequestReviewThreadReply
+ """
+ input: AddPullRequestReviewThreadReplyInput!
+ ): AddPullRequestReviewThreadReplyPayload
+
"""
Adds a reaction to a subject.
"""
@@ -34934,6 +34989,21 @@ type PullRequest implements Assignable & Closable & Comment & Labelable & Lockab
viewerSubscription: SubscriptionState
}
+"""
+The possible methods for updating a pull request's head branch with the base branch.
+"""
+enum PullRequestBranchUpdateMethod {
+ """
+ Update branch via merge
+ """
+ MERGE
+
+ """
+ Update branch via rebase
+ """
+ REBASE
+}
+
"""
A file changed in a pull request.
"""
@@ -50406,7 +50476,8 @@ input StartRepositoryMigrationInput {
"""
Whether to continue the migration on error. Defaults to `false`. We strongly
- recommend setting this to `true` for the smoothest migration experience.
+ recommend setting this to `true` for the smoothest migration experience. *This
+ default will change to `true` on September 4, 2023.*
"""
continueOnError: Boolean
@@ -56422,6 +56493,11 @@ input UpdatePullRequestBranchInput {
The Node ID of the pull request.
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
+
+ """
+ The update branch method to use. If omitted, defaults to 'MERGE'
+ """
+ updateMethod: PullRequestBranchUpdateMethod
}
"""
diff --git a/data/graphql/ghes-3.10/graphql_previews.enterprise.yml b/data/graphql/ghes-3.10/graphql_previews.enterprise.yml
index 617fbdd1129d..e6ae97ea1a9e 100644
--- a/data/graphql/ghes-3.10/graphql_previews.enterprise.yml
+++ b/data/graphql/ghes-3.10/graphql_previews.enterprise.yml
@@ -52,7 +52,7 @@
- UpdateRefsInput
- UpdateRefsPayload
owning_teams:
- - '@github/reponauts'
+ - '@github/repos'
- title: Access to a Repository's Dependency Graph
description: This preview adds support for reading a dependency graph for a repository.
toggled_by: ':hawkgirl-preview'
diff --git a/data/graphql/ghes-3.10/graphql_upcoming_changes.public-enterprise.yml b/data/graphql/ghes-3.10/graphql_upcoming_changes.public-enterprise.yml
index f16f51076bed..f04fac936552 100644
--- a/data/graphql/ghes-3.10/graphql_upcoming_changes.public-enterprise.yml
+++ b/data/graphql/ghes-3.10/graphql_upcoming_changes.public-enterprise.yml
@@ -78,30 +78,6 @@ upcoming_changes:
date: '2022-10-01T00:00:00+00:00'
criticality: breaking
owner: jhunschejones
- - location: PackageType.NPM
- description: '`NPM` will be removed.'
- reason:
- NPM will be removed from this enum as this type will be migrated to only
- be used by the Packages REST API.
- date: '2022-11-21'
- criticality: breaking
- owner: s-anupam
- - location: PackageType.NUGET
- description: '`NUGET` will be removed.'
- reason:
- NUGET will be removed from this enum as this type will be migrated to only
- be used by the Packages REST API.
- date: '2022-11-21'
- criticality: breaking
- owner: s-anupam
- - location: PackageType.RUBYGEMS
- description: '`RUBYGEMS` will be removed.'
- reason:
- RUBYGEMS will be removed from this enum as this type will be migrated to
- only be used by the Packages REST API.
- date: '2022-12-28'
- criticality: breaking
- owner: ankitkaushal01
- location: Commit.changedFiles
description: '`changedFiles` will be removed. Use `changedFilesIfAvailable` instead.'
reason: '`changedFiles` will be removed.'
@@ -118,14 +94,6 @@ upcoming_changes:
date: '2023-01-01T00:00:00+00:00'
criticality: breaking
owner: mattruggio
- - location: PackageType.MAVEN
- description: '`MAVEN` will be removed.'
- reason:
- MAVEN will be removed from this enum as this type will be migrated to only
- be used by the Packages REST API.
- date: '2023-02-10'
- criticality: breaking
- owner: ankitkaushal01
- location: ProjectV2View.groupBy
description:
'`groupBy` will be removed. Check out the `ProjectV2View#group_by_fields`
@@ -164,80 +132,12 @@ upcoming_changes:
date: '2023-04-01T00:00:00+00:00'
criticality: breaking
owner: github/pull_requests
- - location: RepositoryVulnerabilityAlert.fixReason
- description: '`fixReason` will be removed.'
- reason:
- The `fixReason` field is being removed. You can still use `fixedAt` and
- `dismissReason`.
- date: '2023-04-01T00:00:00+00:00'
- criticality: breaking
- owner: jamestran201
- location: Commit.pushedDate
description: '`pushedDate` will be removed.'
reason: '`pushedDate` is no longer supported.'
date: '2023-07-01T00:00:00+00:00'
criticality: breaking
owner: darthwillis
- - location: MergeQueue.headOid
- description: '`headOid` will be removed. Use `entry.headOid` instead.'
- reason: '`headOid` will be removed.'
- date: '2023-07-01T00:00:00+00:00'
- criticality: breaking
- owner: github/merge_queue
- - location: MergeQueue.mergeMethod
- description: '`mergeMethod` will be removed. Use `configuration.merge_method` instead.'
- reason: '`mergeMethod` will be removed.'
- date: '2023-07-01T00:00:00+00:00'
- criticality: breaking
- owner: github/merge_queue
- - location: MergeQueue.mergingEntries
- description: '`mergingEntries` will be removed.'
- reason: '`mergingEntries` will be removed.'
- date: '2023-07-01T00:00:00+00:00'
- criticality: breaking
- owner: github/merge_queue
- - location: MergeQueue.pendingRemovalEntries
- description: '`pendingRemovalEntries` will be removed.'
- reason: '`pendingRemovalEntries` will be removed.'
- date: '2023-07-01T00:00:00+00:00'
- criticality: breaking
- owner: github/merge_queue
- - location: MergeQueueEntry.baseOid
- description: '`baseOid` will be removed. Use `baseCommit` instead.'
- reason: '`baseOid` will be removed.'
- date: '2023-07-01T00:00:00+00:00'
- criticality: breaking
- owner: github/merge_queue
- - location: MergeQueueEntry.blockedByMergeConflicts
- description: '`blockedByMergeConflicts` will be removed. Use `state` instead.'
- reason: '`blockedByMergeConflicts` will be removed.'
- date: '2023-07-01T00:00:00+00:00'
- criticality: breaking
- owner: github/merge_queue
- - location: MergeQueueEntry.checkStatus
- description: '`checkStatus` will be removed. Use `state` instead.'
- reason: '`checkStatus` will be removed.'
- date: '2023-07-01T00:00:00+00:00'
- criticality: breaking
- owner: github/merge_queue
- - location: MergeQueueEntry.hasJumpedQueue
- description: '`hasJumpedQueue` will be removed. Use `jump` instead.'
- reason: '`hasJumpedQueue` will be removed.'
- date: '2023-07-01T00:00:00+00:00'
- criticality: breaking
- owner: github/merge_queue
- - location: MergeQueueEntry.headOid
- description: '`headOid` will be removed. Use `headCommit` instead.'
- reason: '`headOid` will be removed.'
- date: '2023-07-01T00:00:00+00:00'
- criticality: breaking
- owner: github/merge_queue
- - location: MergeQueueEntry.isSolo
- description: '`isSolo` will be removed. Use `solo` instead.'
- reason: '`isSolo` will be removed.'
- date: '2023-07-01T00:00:00+00:00'
- criticality: breaking
- owner: github/merge_queue
- location: ProjectV2ItemFieldGroup.field
description:
'`field` will be removed. Check out the `ProjectV2ItemFieldGroup#groupByField`
diff --git a/data/graphql/ghes-3.10/schema.docs-enterprise.graphql b/data/graphql/ghes-3.10/schema.docs-enterprise.graphql
index 3ca079a77331..32933af89c70 100644
--- a/data/graphql/ghes-3.10/schema.docs-enterprise.graphql
+++ b/data/graphql/ghes-3.10/schema.docs-enterprise.graphql
@@ -4237,7 +4237,7 @@ type Commit implements GitObject & Node & Subscribable & UniformResourceLocatabl
): Blame!
"""
- We recommend using the `changedFielsIfAvailable` field instead of
+ We recommend using the `changedFilesIfAvailable` field instead of
`changedFiles`, as `changedFiles` will cause your request to return an error
if GitHub is unable to calculate the number of changed files.
"""
@@ -8668,8 +8668,6 @@ type DependencyGraphDependency @preview(toggledBy: "hawkgirl-preview") {
"""
The name of the package in the canonical form used by the package manager.
- This may differ from the original textual form (see packageLabel), for example
- in a package manager that uses case-insensitive comparisons.
"""
packageName: String!
@@ -11248,7 +11246,8 @@ type Enterprise implements AnnouncementBanner & Node {
): OrganizationConnection!
"""
- Enterprise information only visible to enterprise owners.
+ Enterprise information visible to enterprise owners or enterprise owners'
+ personal access tokens (classic) with read:enterprise or admin:enterprise scope.
"""
ownerInfo: EnterpriseOwnerInfo
@@ -11661,6 +11660,8 @@ type EnterpriseFailedInvitationEdge {
"""
An identity provider configured to provision identities for an enterprise.
+Visible to enterprise owners or enterprise owners' personal access tokens
+(classic) with read:enterprise or admin:enterprise scope.
"""
type EnterpriseIdentityProvider implements Node {
"""
@@ -11976,7 +11977,8 @@ type EnterpriseOutsideCollaboratorEdge {
}
"""
-Enterprise information only visible to enterprise owners.
+Enterprise information visible to enterprise owners or enterprise owners'
+personal access tokens (classic) with read:enterprise or admin:enterprise scope.
"""
type EnterpriseOwnerInfo {
"""
@@ -12145,7 +12147,8 @@ type EnterpriseOwnerInfo {
): OrganizationConnection!
"""
- A list of domains owned by the enterprise.
+ A list of domains owned by the enterprise. Visible to enterprise owners or
+ enterprise owners' personal access tokens (classic) with admin:enterprise scope.
"""
domains(
"""
@@ -12221,6 +12224,8 @@ type EnterpriseOwnerInfo {
"""
The IP addresses that are allowed to access resources owned by the enterprise.
+ Visible to enterprise owners or enterprise owners' personal access tokens
+ (classic) with admin:enterprise scope.
"""
ipAllowListEntries(
"""
@@ -12821,8 +12826,7 @@ type EnterpriseOwnerInfo {
): OrganizationConnection!
"""
- The SAML Identity Provider for the enterprise. When used by a GitHub App,
- requires an installation token with read and write access to members.
+ The SAML Identity Provider for the enterprise.
"""
samlIdentityProvider: EnterpriseIdentityProvider
@@ -13831,7 +13835,13 @@ type EnvironmentEdge {
}
"""
-An external identity provisioned by SAML SSO or SCIM.
+An external identity provisioned by SAML SSO or SCIM. If SAML is configured on
+the organization, the external identity is visible to (1) organization owners,
+(2) organization owners' personal access tokens (classic) with read:org or
+admin:org scope, (3) GitHub App with an installation token with read or write
+access to members. If SAML is configured on the enterprise, the external
+identity is visible to (1) enterprise owners, (2) enterprise owners' personal
+access tokens (classic) with read:enterprise or admin:enterprise scope.
"""
type ExternalIdentity implements Node {
"""
@@ -15528,7 +15538,7 @@ union IpAllowListOwner = App | Enterprise | Organization
"""
An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.
"""
-type Issue implements Assignable & Closable & Comment & Labelable & Lockable & Node & ProjectV2Owner & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment {
+type Issue implements Assignable & Closable & Comment & Deletable & Labelable & Lockable & Node & ProjectV2Owner & Reactable & RepositoryNode & Subscribable & UniformResourceLocatable & Updatable & UpdatableComment {
"""
Reason that the conversation was locked.
"""
@@ -16046,6 +16056,11 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N
"""
viewerCanClose: Boolean!
+ """
+ Check if the current viewer can delete this object.
+ """
+ viewerCanDelete: Boolean!
+
"""
Can user react to this subject
"""
@@ -16590,6 +16605,31 @@ type IssueTemplate {
"""
about: String
+ """
+ The suggested assignees.
+ """
+ assignees(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): UserConnection!
+
"""
The suggested issue body.
"""
@@ -16600,6 +16640,36 @@ type IssueTemplate {
"""
filename: String!
+ """
+ The suggested issue labels
+ """
+ labels(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+
+ """
+ Ordering options for labels returned from the connection.
+ """
+ orderBy: LabelOrder = {field: CREATED_AT, direction: ASC}
+ ): LabelConnection
+
"""
The template name.
"""
@@ -17874,6 +17944,36 @@ type MarkFileAsViewedPayload {
pullRequest: PullRequest
}
+"""
+Autogenerated input type of MarkProjectV2AsTemplate
+"""
+input MarkProjectV2AsTemplateInput {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The ID of the Project to mark as a template.
+ """
+ projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"])
+}
+
+"""
+Autogenerated return type of MarkProjectV2AsTemplate
+"""
+type MarkProjectV2AsTemplatePayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The project.
+ """
+ projectV2: ProjectV2
+}
+
"""
Autogenerated input type of MarkPullRequestReadyForReview
"""
@@ -18612,6 +18712,12 @@ interface Migration {
The migration state.
"""
state: MigrationState!
+
+ """
+ The number of warnings encountered for this migration. To review the warnings,
+ check the [Migration Log](https://docs.github.com/en/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer).
+ """
+ warningsCount: Int!
}
"""
@@ -20187,6 +20293,16 @@ type Mutation {
input: MarkFileAsViewedInput!
): MarkFileAsViewedPayload
+ """
+ Mark a project as a template. Note that only projects which are owned by an Organization can be marked as a template.
+ """
+ markProjectV2AsTemplate(
+ """
+ Parameters for MarkProjectV2AsTemplate
+ """
+ input: MarkProjectV2AsTemplateInput!
+ ): MarkProjectV2AsTemplatePayload
+
"""
Marks a pull request ready for review.
"""
@@ -20587,6 +20703,16 @@ type Mutation {
input: UnmarkIssueAsDuplicateInput!
): UnmarkIssueAsDuplicatePayload
+ """
+ Unmark a project as a template.
+ """
+ unmarkProjectV2AsTemplate(
+ """
+ Parameters for UnmarkProjectV2AsTemplate
+ """
+ input: UnmarkProjectV2AsTemplateInput!
+ ): UnmarkProjectV2AsTemplatePayload
+
"""
Unminimizes a comment on an Issue, Commit, Pull Request, or Gist
"""
@@ -20967,6 +21093,16 @@ type Mutation {
input: UpdateProjectV2Input!
): UpdateProjectV2Payload
+ """
+ Update the collaborators on a team or a project
+ """
+ updateProjectV2Collaborators(
+ """
+ Parameters for UpdateProjectV2Collaborators
+ """
+ input: UpdateProjectV2CollaboratorsInput!
+ ): UpdateProjectV2CollaboratorsPayload
+
"""
Updates a draft issue within a Project.
"""
@@ -21196,17 +21332,17 @@ Metadata for an audit entry with action oauth_application.*
"""
interface OauthApplicationAuditEntryData {
"""
- The name of the OAuth Application.
+ The name of the OAuth application.
"""
oauthApplicationName: String
"""
- The HTTP path for the OAuth Application
+ The HTTP path for the OAuth application
"""
oauthApplicationResourcePath: URI
"""
- The HTTP URL for the OAuth Application
+ The HTTP URL for the OAuth application
"""
oauthApplicationUrl: URI
}
@@ -21251,12 +21387,12 @@ type OauthApplicationCreateAuditEntry implements AuditEntry & Node & OauthApplic
actorUrl: URI
"""
- The application URL of the OAuth Application.
+ The application URL of the OAuth application.
"""
applicationUrl: URI
"""
- The callback URL of the OAuth Application.
+ The callback URL of the OAuth application.
"""
callbackUrl: URI
@@ -21267,17 +21403,17 @@ type OauthApplicationCreateAuditEntry implements AuditEntry & Node & OauthApplic
id: ID!
"""
- The name of the OAuth Application.
+ The name of the OAuth application.
"""
oauthApplicationName: String
"""
- The HTTP path for the OAuth Application
+ The HTTP path for the OAuth application
"""
oauthApplicationResourcePath: URI
"""
- The HTTP URL for the OAuth Application
+ The HTTP URL for the OAuth application
"""
oauthApplicationUrl: URI
@@ -21307,12 +21443,12 @@ type OauthApplicationCreateAuditEntry implements AuditEntry & Node & OauthApplic
organizationUrl: URI
"""
- The rate limit of the OAuth Application.
+ The rate limit of the OAuth application.
"""
rateLimit: Int
"""
- The state of the OAuth Application.
+ The state of the OAuth application.
"""
state: OauthApplicationCreateAuditEntryState
@@ -21338,21 +21474,21 @@ type OauthApplicationCreateAuditEntry implements AuditEntry & Node & OauthApplic
}
"""
-The state of an OAuth Application when it was created.
+The state of an OAuth application when it was created.
"""
enum OauthApplicationCreateAuditEntryState {
"""
- The OAuth Application was active and allowed to have OAuth Accesses.
+ The OAuth application was active and allowed to have OAuth Accesses.
"""
ACTIVE
"""
- The OAuth Application was in the process of being deleted.
+ The OAuth application was in the process of being deleted.
"""
PENDING_DELETION
"""
- The OAuth Application was suspended from generating OAuth Accesses due to abuse or security concerns.
+ The OAuth application was suspended from generating OAuth Accesses due to abuse or security concerns.
"""
SUSPENDED
}
@@ -22902,17 +23038,17 @@ type OrgOauthAppAccessApprovedAuditEntry implements AuditEntry & Node & OauthApp
id: ID!
"""
- The name of the OAuth Application.
+ The name of the OAuth application.
"""
oauthApplicationName: String
"""
- The HTTP path for the OAuth Application
+ The HTTP path for the OAuth application
"""
oauthApplicationResourcePath: URI
"""
- The HTTP URL for the OAuth Application
+ The HTTP URL for the OAuth application
"""
oauthApplicationUrl: URI
@@ -23008,17 +23144,17 @@ type OrgOauthAppAccessDeniedAuditEntry implements AuditEntry & Node & OauthAppli
id: ID!
"""
- The name of the OAuth Application.
+ The name of the OAuth application.
"""
oauthApplicationName: String
"""
- The HTTP path for the OAuth Application
+ The HTTP path for the OAuth application
"""
oauthApplicationResourcePath: URI
"""
- The HTTP URL for the OAuth Application
+ The HTTP URL for the OAuth application
"""
oauthApplicationUrl: URI
@@ -23114,17 +23250,17 @@ type OrgOauthAppAccessRequestedAuditEntry implements AuditEntry & Node & OauthAp
id: ID!
"""
- The name of the OAuth Application.
+ The name of the OAuth application.
"""
oauthApplicationName: String
"""
- The HTTP path for the OAuth Application
+ The HTTP path for the OAuth application
"""
oauthApplicationResourcePath: URI
"""
- The HTTP URL for the OAuth Application
+ The HTTP URL for the OAuth application
"""
oauthApplicationUrl: URI
@@ -25233,7 +25369,10 @@ type Organization implements Actor & AnnouncementBanner & MemberStatusable & Nod
resourcePath: URI!
"""
- The Organization's SAML identity providers
+ The Organization's SAML identity provider. Visible to (1) organization owners,
+ (2) organization owners' personal access tokens (classic) with read:org or
+ admin:org scope, (3) GitHub App with an installation token with read or write
+ access to members.
"""
samlIdentityProvider: OrganizationIdentityProvider
@@ -25276,6 +25415,11 @@ type Organization implements Actor & AnnouncementBanner & MemberStatusable & Nod
"""
ldapMapped: Boolean
+ """
+ If non-null, filters teams according to notification setting
+ """
+ notificationSetting: TeamNotificationSetting
+
"""
Ordering options for teams returned from the connection
"""
@@ -25592,7 +25736,10 @@ type OrganizationEnterpriseOwnerEdge {
}
"""
-An Identity Provider configured to provision SAML and SCIM identities for Organizations
+An Identity Provider configured to provision SAML and SCIM identities for
+Organizations. Visible to (1) organization owners, (2) organization owners'
+personal access tokens (classic) with read:org or admin:org scope, (3) GitHub
+App with an installation token with read or write access to members.
"""
type OrganizationIdentityProvider implements Node {
"""
@@ -25963,6 +26110,11 @@ enum OrganizationMigrationState {
"""
FAILED
+ """
+ The Octoshift migration has invalid credentials.
+ """
+ FAILED_VALIDATION
+
"""
The Octoshift migration is in progress.
"""
@@ -25973,6 +26125,11 @@ enum OrganizationMigrationState {
"""
NOT_STARTED
+ """
+ The Octoshift migration needs to have its credentials validated.
+ """
+ PENDING_VALIDATION
+
"""
The Octoshift migration is performing post repository migrations.
"""
@@ -26488,25 +26645,16 @@ enum PackageType {
A maven package.
"""
MAVEN
- @deprecated(
- reason: "MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API. Removal on 2023-02-10 UTC."
- )
"""
An npm package.
"""
NPM
- @deprecated(
- reason: "NPM will be removed from this enum as this type will be migrated to only be used by the Packages REST API. Removal on 2022-11-21 UTC."
- )
"""
A nuget package.
"""
NUGET
- @deprecated(
- reason: "NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API. Removal on 2022-11-21 UTC."
- )
"""
A python package.
@@ -26517,9 +26665,6 @@ enum PackageType {
A rubygems package.
"""
RUBYGEMS
- @deprecated(
- reason: "RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API. Removal on 2022-12-28 UTC."
- )
}
"""
@@ -28542,6 +28687,71 @@ type ProjectV2 implements Closable & Node & Updatable {
): ProjectV2WorkflowConnection!
}
+"""
+Possible collaborators for a project.
+"""
+union ProjectV2Actor = Team | User
+
+"""
+The connection type for ProjectV2Actor.
+"""
+type ProjectV2ActorConnection {
+ """
+ A list of edges.
+ """
+ edges: [ProjectV2ActorEdge]
+
+ """
+ A list of nodes.
+ """
+ nodes: [ProjectV2Actor]
+
+ """
+ Information to aid in pagination.
+ """
+ pageInfo: PageInfo!
+
+ """
+ Identifies the total count of items in the connection.
+ """
+ totalCount: Int!
+}
+
+"""
+An edge in a connection.
+"""
+type ProjectV2ActorEdge {
+ """
+ A cursor for use in pagination.
+ """
+ cursor: String!
+
+ """
+ The item at the end of the edge.
+ """
+ node: ProjectV2Actor
+}
+
+"""
+A collaborator to update on a project. Only one of the userId or teamId should be provided.
+"""
+input ProjectV2Collaborator {
+ """
+ The role to grant the collaborator
+ """
+ role: ProjectV2Roles!
+
+ """
+ The ID of the team as a collaborator.
+ """
+ teamId: ID @possibleTypes(concreteTypes: ["Team"])
+
+ """
+ The ID of the user as a collaborator.
+ """
+ userId: ID @possibleTypes(concreteTypes: ["User"])
+}
+
"""
The connection type for ProjectV2.
"""
@@ -28929,7 +29139,7 @@ type ProjectV2Item implements Node {
databaseId: Int
"""
- A specific field value given a field name
+ The field value of the first project field which matches the 'name' argument that is set on the item.
"""
fieldValueByName(
"""
@@ -28939,7 +29149,7 @@ type ProjectV2Item implements Node {
): ProjectV2ItemFieldValue
"""
- List of field values
+ The field values that are set on the item.
"""
fieldValues(
"""
@@ -29830,6 +30040,31 @@ interface ProjectV2Recent {
): ProjectV2Connection!
}
+"""
+The possible roles of a collaborator on a project.
+"""
+enum ProjectV2Roles {
+ """
+ The collaborator can view, edit, and maange the settings of the project
+ """
+ ADMIN
+
+ """
+ The collaborator has no direct access to the project
+ """
+ NONE
+
+ """
+ The collaborator can view the project
+ """
+ READER
+
+ """
+ The collaborator can view and edit the project
+ """
+ WRITER
+}
+
"""
A single select field inside a project.
"""
@@ -29858,7 +30093,12 @@ type ProjectV2SingleSelectField implements Node & ProjectV2FieldCommon {
"""
Options for the single select field
"""
- options: [ProjectV2SingleSelectFieldOption!]!
+ options(
+ """
+ Filter returned options to only those matching these names, case insensitive.
+ """
+ names: [String!]
+ ): [ProjectV2SingleSelectFieldOption!]!
"""
The project that contains this field.
@@ -33210,11 +33450,6 @@ type PullRequestTimelineItemsEdge {
The possible item types found in a timeline.
"""
enum PullRequestTimelineItemsItemType {
- """
- Represents an 'added_to_merge_queue' event on a given pull request.
- """
- ADDED_TO_MERGE_QUEUE_EVENT
-
"""
Represents a 'added_to_project' event on a given issue or pull request.
"""
@@ -33420,11 +33655,6 @@ enum PullRequestTimelineItemsItemType {
"""
REFERENCED_EVENT
- """
- Represents a 'removed_from_merge_queue' event on a given pull request.
- """
- REMOVED_FROM_MERGE_QUEUE_EVENT
-
"""
Represents a 'removed_from_project' event on a given issue or pull request.
"""
@@ -33734,7 +33964,8 @@ type Query {
): RateLimit
"""
- Hack to workaround https://github.com/facebook/relay/issues/112 re-exposing the root query object
+ Workaround for re-exposing the root query object. (Refer to
+ https://github.com/facebook/relay/issues/112 for more information.)
"""
relay: Query!
@@ -37948,6 +38179,11 @@ type Repository implements Node & PackageOwner & ProjectOwner & ProjectV2Recent
"""
allowUpdateBranch: Boolean!
+ """
+ Identifies the date and time when the repository was archived.
+ """
+ archivedAt: DateTime
+
"""
A list of users that can be assigned to issues in this repository.
"""
@@ -39039,7 +39275,7 @@ type Repository implements Node & PackageOwner & ProjectOwner & ProjectV2Recent
): PullRequestConnection!
"""
- Identifies when the repository was last pushed to.
+ Identifies the date and time when the repository was last pushed to.
"""
pushedAt: DateTime
@@ -39791,6 +40027,11 @@ type RepositoryEdge {
A subset of repository info.
"""
interface RepositoryInfo {
+ """
+ Identifies the date and time when the repository was archived.
+ """
+ archivedAt: DateTime
+
"""
Identifies the date and time when the object was created.
"""
@@ -39912,7 +40153,7 @@ interface RepositoryInfo {
owner: RepositoryOwner!
"""
- Identifies when the repository was last pushed to.
+ Identifies the date and time when the repository was last pushed to.
"""
pushedAt: DateTime
@@ -40132,6 +40373,12 @@ type RepositoryMigration implements Migration & Node {
The migration state.
"""
state: MigrationState!
+
+ """
+ The number of warnings encountered for this migration. To review the warnings,
+ check the [Migration Log](https://docs.github.com/en/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer).
+ """
+ warningsCount: Int!
}
"""
@@ -40753,14 +41000,6 @@ type RepositoryVulnerabilityAlert implements Node & RepositoryNode {
"""
dismisser: User
- """
- The reason the alert was marked as fixed.
- """
- fixReason: String
- @deprecated(
- reason: "The `fixReason` field is being removed. You can still use `fixedAt` and `dismissReason`. Removal on 2023-04-01 UTC."
- )
-
"""
When was the alert fixed?
"""
@@ -42095,6 +42334,11 @@ enum SecurityAdvisoryEcosystem {
Rust crates
"""
RUST
+
+ """
+ Swift packages
+ """
+ SWIFT
}
"""
@@ -43611,6 +43855,11 @@ type Team implements MemberStatusable & Node & Subscribable {
"""
newTeamUrl: URI!
+ """
+ The notification setting that the team has set.
+ """
+ notificationSetting: TeamNotificationSetting!
+
"""
The organization that owns this team.
"""
@@ -44903,6 +45152,21 @@ enum TeamMembershipType {
IMMEDIATE
}
+"""
+The possible team notification values.
+"""
+enum TeamNotificationSetting {
+ """
+ No one will receive notifications.
+ """
+ NOTIFICATIONS_DISABLED
+
+ """
+ Everyone will receive notifications when the team is @mentioned.
+ """
+ NOTIFICATIONS_ENABLED
+}
+
"""
Ways in which team connections can be ordered.
"""
@@ -46180,6 +46444,36 @@ type UnmarkIssueAsDuplicatePayload {
duplicate: IssueOrPullRequest
}
+"""
+Autogenerated input type of UnmarkProjectV2AsTemplate
+"""
+input UnmarkProjectV2AsTemplateInput {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The ID of the Project to unmark as a template.
+ """
+ projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"])
+}
+
+"""
+Autogenerated return type of UnmarkProjectV2AsTemplate
+"""
+type UnmarkProjectV2AsTemplatePayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The project.
+ """
+ projectV2: ProjectV2
+}
+
"""
Represents an 'unmarked_as_duplicate' event on a given issue or pull request.
"""
@@ -47949,6 +48243,61 @@ type UpdateProjectPayload {
project: Project
}
+"""
+Autogenerated input type of UpdateProjectV2Collaborators
+"""
+input UpdateProjectV2CollaboratorsInput {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The collaborators to update.
+ """
+ collaborators: [ProjectV2Collaborator!]!
+
+ """
+ The ID of the project to update the collaborators for.
+ """
+ projectId: ID! @possibleTypes(concreteTypes: ["ProjectV2"])
+}
+
+"""
+Autogenerated return type of UpdateProjectV2Collaborators
+"""
+type UpdateProjectV2CollaboratorsPayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The collaborators granted a role
+ """
+ collaborators(
+ """
+ Returns the elements in the list that come after the specified cursor.
+ """
+ after: String
+
+ """
+ Returns the elements in the list that come before the specified cursor.
+ """
+ before: String
+
+ """
+ Returns the first _n_ elements from the list.
+ """
+ first: Int
+
+ """
+ Returns the last _n_ elements from the list.
+ """
+ last: Int
+ ): ProjectV2ActorConnection
+}
+
"""
Autogenerated input type of UpdateProjectV2DraftIssue
"""
@@ -49063,7 +49412,7 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner &
isEmployee: Boolean!
"""
- Whether or not this user is following the viewer. Inverse of viewer_is_following
+ Whether or not this user is following the viewer. Inverse of viewerIsFollowing
"""
isFollowingViewer: Boolean!
@@ -49930,7 +50279,7 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner &
viewerCanFollow: Boolean!
"""
- Whether or not this user is followed by the viewer. Inverse of is_following_viewer.
+ Whether or not this user is followed by the viewer. Inverse of isFollowingViewer.
"""
viewerIsFollowing: Boolean!
@@ -50531,7 +50880,7 @@ interface Votable {
"""
A workflow contains meta information about an Actions workflow file.
"""
-type Workflow implements Node {
+type Workflow implements Node & UniformResourceLocatable {
"""
Identifies the date and time when the object was created.
"""
@@ -50548,6 +50897,11 @@ type Workflow implements Node {
"""
name: String!
+ """
+ The HTTP path for this workflow
+ """
+ resourcePath: URI!
+
"""
The runs of the workflow.
"""
@@ -50587,6 +50941,11 @@ type Workflow implements Node {
Identifies the date and time when the object was last updated.
"""
updatedAt: DateTime!
+
+ """
+ The HTTP URL for this workflow
+ """
+ url: URI!
}
"""
@@ -50637,6 +50996,11 @@ type WorkflowRun implements Node & UniformResourceLocatable {
The event that triggered the workflow run
"""
event: String!
+
+ """
+ The workflow file
+ """
+ file: WorkflowRunFile
id: ID!
"""
@@ -50730,6 +51094,53 @@ type WorkflowRunEdge {
node: WorkflowRun
}
+"""
+An executed workflow file for a workflow run.
+"""
+type WorkflowRunFile implements Node & UniformResourceLocatable {
+ id: ID!
+
+ """
+ The path of the workflow file relative to its repository.
+ """
+ path: String!
+
+ """
+ The direct link to the file in the repository which stores the workflow file.
+ """
+ repositoryFileUrl: URI!
+
+ """
+ The repository name and owner which stores the workflow file.
+ """
+ repositoryName: URI!
+
+ """
+ The HTTP path for this workflow run file
+ """
+ resourcePath: URI!
+
+ """
+ The parent workflow run execution for this file.
+ """
+ run: WorkflowRun!
+
+ """
+ The HTTP URL for this workflow run file
+ """
+ url: URI!
+
+ """
+ If the viewer has permissions to push to the repository which stores the workflow.
+ """
+ viewerCanPushRepository: Boolean!
+
+ """
+ If the viewer has permissions to read the repository which stores the workflow.
+ """
+ viewerCanReadRepository: Boolean!
+}
+
"""
Ways in which lists of workflow runs can be ordered upon return.
"""
diff --git a/data/graphql/schema.docs.graphql b/data/graphql/schema.docs.graphql
index 9051775ebe34..b95c8eb5395d 100644
--- a/data/graphql/schema.docs.graphql
+++ b/data/graphql/schema.docs.graphql
@@ -864,6 +864,46 @@ type AddPullRequestReviewThreadPayload {
thread: PullRequestReviewThread
}
+"""
+Autogenerated input type of AddPullRequestReviewThreadReply
+"""
+input AddPullRequestReviewThreadReplyInput {
+ """
+ The text of the reply.
+ """
+ body: String!
+
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The Node ID of the pending review to which the reply will belong.
+ """
+ pullRequestReviewId: ID @possibleTypes(concreteTypes: ["PullRequestReview"])
+
+ """
+ The Node ID of the thread to which this reply is being written.
+ """
+ pullRequestReviewThreadId: ID! @possibleTypes(concreteTypes: ["PullRequestReviewThread"])
+}
+
+"""
+Autogenerated return type of AddPullRequestReviewThreadReply
+"""
+type AddPullRequestReviewThreadReplyPayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The newly created reply.
+ """
+ comment: PullRequestReviewComment
+}
+
"""
Autogenerated input type of AddReaction
"""
@@ -16069,6 +16109,11 @@ type GitHubMetadata {
"""
gitIpAddresses: [String!]
+ """
+ IP addresses that GitHub Enterprise Importer uses for outbound connections
+ """
+ githubEnterpriseImporterIpAddresses: [String!]
+
"""
IP addresses that service hooks are sent from
"""
@@ -21439,6 +21484,16 @@ type Mutation {
input: AddPullRequestReviewThreadInput!
): AddPullRequestReviewThreadPayload
+ """
+ Adds a reply to an existing Pull Request Review Thread.
+ """
+ addPullRequestReviewThreadReply(
+ """
+ Parameters for AddPullRequestReviewThreadReply
+ """
+ input: AddPullRequestReviewThreadReplyInput!
+ ): AddPullRequestReviewThreadReplyPayload
+
"""
Adds a reaction to a subject.
"""
@@ -34934,6 +34989,21 @@ type PullRequest implements Assignable & Closable & Comment & Labelable & Lockab
viewerSubscription: SubscriptionState
}
+"""
+The possible methods for updating a pull request's head branch with the base branch.
+"""
+enum PullRequestBranchUpdateMethod {
+ """
+ Update branch via merge
+ """
+ MERGE
+
+ """
+ Update branch via rebase
+ """
+ REBASE
+}
+
"""
A file changed in a pull request.
"""
@@ -50406,7 +50476,8 @@ input StartRepositoryMigrationInput {
"""
Whether to continue the migration on error. Defaults to `false`. We strongly
- recommend setting this to `true` for the smoothest migration experience.
+ recommend setting this to `true` for the smoothest migration experience. *This
+ default will change to `true` on September 4, 2023.*
"""
continueOnError: Boolean
@@ -56422,6 +56493,11 @@ input UpdatePullRequestBranchInput {
The Node ID of the pull request.
"""
pullRequestId: ID! @possibleTypes(concreteTypes: ["PullRequest"])
+
+ """
+ The update branch method to use. If omitted, defaults to 'MERGE'
+ """
+ updateMethod: PullRequestBranchUpdateMethod
}
"""
diff --git a/data/release-notes/enterprise-server/3-10/0-rc1.yml b/data/release-notes/enterprise-server/3-10/0-rc1.yml
index d0d9277d891b..a9bb4549a801 100644
--- a/data/release-notes/enterprise-server/3-10/0-rc1.yml
+++ b/data/release-notes/enterprise-server/3-10/0-rc1.yml
@@ -133,6 +133,10 @@ sections:
- |
To prevent unnecessary transfer of OIDC tokens between workflows, to fetch an OIDC token generated within a reusable workflow that is outside their enterprise or organization, users must set the `id-token` permission to `write` in the workflow or specific job where the reusable workflow is called. For more information, see "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers#adding-permissions-settings)."
+ # https://github.com/github/docs-content/issues/9102
+ - |
+ Repository administrators, organization owners, and users with the `manage_runners:enterprise` scope for enterprises can use the REST API to create ephemeral, just-in-time (JIT) runners that can perform at most one job before being automatically removed from the repository, organization, or enterprise. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#using-just-in-time-runners)."
+
- heading: Community experience
notes:
# https://github.com/github/releases/issues/2673
diff --git a/data/release-notes/enterprise-server/3-6/14.yml b/data/release-notes/enterprise-server/3-6/14.yml
index 73bf35c3a68c..040d5963d3ba 100644
--- a/data/release-notes/enterprise-server/3-6/14.yml
+++ b/data/release-notes/enterprise-server/3-6/14.yml
@@ -2,7 +2,7 @@ date: '2023-05-30'
sections:
security_fixes:
- |
- **MEDIUM**: Scoped installation tokens for a GitHub App kept approved permissions after the permissions on the integration installation were downgraded or removed. GitHub has requested CVE ID [CVE-2023-23765](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2023-23765) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com).
+ **MEDIUM**: Scoped installation tokens for a GitHub App kept approved permissions after the permissions on the integration installation were downgraded or removed. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com).
- Packages have been updated to the latest security versions.
bugs:
- On an instance in a cluster configuration, when upgrading the MySQL master node, the post-upgrade configuration run would take 600 seconds longer than required due to incorrect detection of unhealthy nodes.
@@ -36,4 +36,4 @@ sections:
- |
When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
- '{% data reusables.release-notes.slow-deleted-repos-migration-known-issue-updated %}'
- - '{% data reusables.release-notes.user-already-taken %}'
\ No newline at end of file
+ - '{% data reusables.release-notes.user-already-taken %}'
diff --git a/data/release-notes/enterprise-server/3-6/17.yml b/data/release-notes/enterprise-server/3-6/17.yml
new file mode 100644
index 000000000000..ca7348b080c2
--- /dev/null
+++ b/data/release-notes/enterprise-server/3-6/17.yml
@@ -0,0 +1,46 @@
+date: '2023-08-10'
+sections:
+ security_fixes:
+ - |
+ **LOW:** An attacker could circumvent branch protection by changing a PR base branch to an invalid ref name. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com/).
+ - |
+ Packages have been updated to the latest security versions.
+ bugs:
+ - |
+ On an instance in a high availability configuration, on some platforms, replication could perform poorly over links with very high latency.
+ - |
+ On an instance with custom firewall rules defined, a configuration run with `ghe-config-apply` could take longer than expected.
+ - |
+ Events related to repository notifications did not appear in the audit log.
+ - |
+ A collaborator with the "Set the social preview" permission inherited from the "Read" role couldnt upload the social preview image of a repository.
+ - |
+ On an instance in a high availability configuration, existing nodes with out-of-sync repositories prevented new nodes from replicating those repositories.
+ - |
+ GitHub Enterprise Server was queuing zip jobs unnecessarily.
+ changes:
+ - |
+ The secondary abuse rate limits of the GraphQL API are now configurable in the Management Console.
+ - |
+ The description of the `ghe-cluster-balance` command line utility clarifies that it can be used to balance jobs other than `github-unicorn`.
+ - |
+ Administrators can display all repositories in a network with `spokesctl` by using the `repositories` subcommand.
+ known_issues:
+ - |
+ Custom firewall rules are removed during the upgrade process.
+ - |
+ Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository.
+ - |
+ The GitHub Packages npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues.
+ - |
+ In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality.
+ - |
+ Custom patterns for secret scanning have `.*` as an end delimiter, specifically in the "After secret" field. This delimiter causes inconsistencies in scans for secrets across repositories, and you may notice gaps in a repository's history where no scans completed. Incremental scans may also be impacted. To prevent issues with scans, modify the end of the pattern to remove the `.*` delimiter.
+ - |
+ {% data reusables.release-notes.repository-inconsistencies-errors %}
+ - |
+ On an instance in a high-availability configuration, passive replica nodes accept Git client requests and forward the requests to the primary node.
+ - |
+ If an instance is configured to forward logs to a target server with TLS enabled, certificate authority (CA) bundles that a site administrator uploads using `ghe-ssl-ca-certificate-install` are not respected, and connections to the server fail.
+ - |
+ When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
diff --git a/data/release-notes/enterprise-server/3-7/11.yml b/data/release-notes/enterprise-server/3-7/11.yml
index 2144d292c23e..c5b1a0d67454 100644
--- a/data/release-notes/enterprise-server/3-7/11.yml
+++ b/data/release-notes/enterprise-server/3-7/11.yml
@@ -2,8 +2,7 @@ date: '2023-05-30'
sections:
security_fixes:
- |
- **MEDIUM**: Scoped installation tokens for a GitHub App kept approved permissions after the permissions on the integration installation were downgraded or removed. GitHub has requested CVE ID [CVE-2023-23765](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2023-23765) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com).
- - Packages have been updated to the latest security versions.
+ **MEDIUM**: Scoped installation tokens for a GitHub App kept approved permissions after the permissions on the integration installation were downgraded or removed. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com).
bugs:
- On an instance in a cluster configuration, when upgrading the MySQL master node, the post-upgrade configuration run would take 600 seconds longer than required due to incorrect detection of unhealthy nodes.
- In some situations on an instance with multiple nodes, Git replication failed to fully replicate repositories that had previously been deleted, which resulted in a warning in `ghe-repl-status` output.
diff --git a/data/release-notes/enterprise-server/3-7/15.yml b/data/release-notes/enterprise-server/3-7/15.yml
new file mode 100644
index 000000000000..a55f412e8a51
--- /dev/null
+++ b/data/release-notes/enterprise-server/3-7/15.yml
@@ -0,0 +1,56 @@
+date: '2023-08-10'
+sections:
+ security_fixes:
+ - |
+ **LOW:** An attacker could circumvent branch protection by changing a PR base branch to an invalid ref name. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com/).
+ - |
+ In some cases, users could reopen a pull request that should not have been able to be reopened.
+ - |
+ Packages have been updated to the latest security versions.
+ bugs:
+ - |
+ In rare circumstances, Git commits signed with SSH keys using the RSA algorithm would incorrectly indicate the signature was invalid.
+ - |
+ Issues with cross references to pull requests from deleted accounts would not load.
+ - |
+ The site admin page for organizations erroneously included a "Blocked Copilot Repositories" link.
+ - |
+ The checks in the merge box for a pull request did not always match the the checks for the most recent commit in the pull request.
+ - |
+ When a site administrator used GitHub Enterprise Importer on versions 3.7 and below to migrate repositories from GitHub Enterprise Server, the system backup size would increase after running many migrations due to storage files not being cleaned up.
+ - |
+ API results were incomplete, and ordering of results was incorrect if `asc` or `desc` appeared in lowercase within the API query.
+ - |
+ A collaborator with the "Set the social preview" permission inherited from the "Read" role couldnt upload the social preview image of a repository.
+ - |
+ In some cases, on an instance with GitHub Actions enabled, deployment of GitHub Pages site using a GitHub Actions workflow failed with a status of `deployment_lost`.
+ - |
+ On an instance in a high availability configuration, existing nodes with out-of-sync repositories prevented new nodes from replicating those repositories.
+ - |
+ GitHub Enterprise Server was queuing zip jobs unnecessarily.
+ changes:
+ - |
+ The description of the `ghe-cluster-balance` command line utility clarifies that it can be used to balance jobs other than `github-unicorn`.
+ - |
+ Administrators can display all repositories in a network with `spokesctl` by using the `repositories` subcommand.
+ - |
+ Site administrators can see improved diagnostic information about repositories that have been deleted.
+ known_issues:
+ - |
+ Custom firewall rules are removed during the upgrade process.
+ - |
+ The GitHub Packages npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues.
+ - |
+ In a repository's settings, enabling the option to allow users with read access to create discussions does not enable this functionality.
+ - |
+ Custom patterns for secret scanning have `.*` as an end delimiter, specifically in the "After secret" field. This delimiter causes inconsistencies in scans for secrets across repositories, and you may notice gaps in a repository's history where no scans completed. Incremental scans may also be impacted. To prevent issues with scans, modify the end of the pattern to remove the `.*` delimiter.
+ - |
+ {% data reusables.release-notes.repository-inconsistencies-errors %}
+ - |
+ During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start.
+ - |
+ On an instance in a high-availability configuration, passive replica nodes accept Git client requests and forward the requests to the primary node.
+ - |
+ If an instance is configured to forward logs to a target server with TLS enabled, certificate authority (CA) bundles that a site administrator uploads using `ghe-ssl-ca-certificate-install` are not respected, and connections to the server fail.
+ - |
+ When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
diff --git a/data/release-notes/enterprise-server/3-8/3.yml b/data/release-notes/enterprise-server/3-8/3.yml
index 77b4da6e8878..191cd0b5a49b 100644
--- a/data/release-notes/enterprise-server/3-8/3.yml
+++ b/data/release-notes/enterprise-server/3-8/3.yml
@@ -51,3 +51,5 @@ sections:
# https://github.com/github/driftwood/issues/2746
- |
On an instance with audit log streaming enabled, the `driftwood` service does not start, preventing the normal operation of audit log streaming. [Updated: 2023-06-06]
+ - |
+ {% data reusables.release-notes.mermaid-rendering-known-issue %} [Updated: 2023-08-18]
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-8/4.yml b/data/release-notes/enterprise-server/3-8/4.yml
index 8d14e2b853a9..f9d8a4ab167a 100644
--- a/data/release-notes/enterprise-server/3-8/4.yml
+++ b/data/release-notes/enterprise-server/3-8/4.yml
@@ -2,7 +2,7 @@ date: '2023-05-30'
sections:
security_fixes:
- |
- **MEDIUM**: Scoped installation tokens for a GitHub App kept approved permissions after the permissions on the integration installation were downgraded or removed. GitHub has requested CVE ID [CVE-2023-23765](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2023-23765) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com).
+ **MEDIUM**: Scoped installation tokens for a GitHub App kept approved permissions after the permissions on the integration installation were downgraded or removed. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com).
- Packages have been updated to the latest security versions.
bugs:
- On an instance in a cluster configuration, when upgrading the MySQL master node, the post-upgrade configuration run would take 600 seconds longer than required due to incorrect detection of unhealthy nodes.
@@ -36,4 +36,4 @@ sections:
- |
When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
- |
- On an instance with subdomain isolation disabled, Mermaid diagrams in the web UI display an "Unable to render rich display" error and fail to render.
+ {% data reusables.release-notes.mermaid-rendering-known-issue %}
diff --git a/data/release-notes/enterprise-server/3-8/5.yml b/data/release-notes/enterprise-server/3-8/5.yml
index 807b3f29359f..b0f43bd51c6a 100644
--- a/data/release-notes/enterprise-server/3-8/5.yml
+++ b/data/release-notes/enterprise-server/3-8/5.yml
@@ -2,7 +2,7 @@ date: '2023-06-20'
sections:
security_fixes:
- |
- **MEDIUM**: Scoped installation tokens for a GitHub App kept approved permissions after the permissions on the integration installation were downgraded or removed. GitHub has requested CVE ID [CVE-2023-23765](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2023-23765) for this vulnerability, which was reported via the [GitHub Bug Bounty program](https://bounty.github.com).
+ **MEDIUM**: Scoped installation tokens for a GitHub App kept approved permissions after the permissions on the integration installation were downgraded or removed. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com).
- |
If a user's request to the instance's API included authentication credentials within a URL parameter, administrators could see the credentials in JSON within the instance's audit log.
- Packages have been updated to the latest security versions.
@@ -13,7 +13,6 @@ sections:
- After an enterprise owner set a permanent rate limit for a users GitHub App at `http(s)://HOSTNAME/stafftools/users/USERNAME/installations`, the instance did not respect the rate limit.
- On an instance with multiple nodes, when using the `spokesctl` command-line utility to manage repositories with replicas that failed to fully create, the utility would spuriously attempt to repair healthy replicas.
- On an instance with a GitHub Advanced Security license and code scanning enabled, code scanning could not process some SARIF files produced by newer versions of CodeQL.
- - On an instance with subdomain isolation disabled, Mermaid diagrams in the web UI displayed an "Unable to render rich display" error and failed to render.
changes:
- If a configuration runs fails due to Elasticsearch errors, `ghe-config-apply` displays a more actionable error message.
known_issues:
@@ -38,6 +37,6 @@ sections:
- |
When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
- |
- On an instance with subdomain isolation disabled, Mermaid diagrams in the web UI display an "Unable to render rich display" error and fail to render.
+ {% data reusables.release-notes.mermaid-rendering-known-issue %}
- |
Organization owners cannot register a new SSH certificate authorities (CAs) due to an erroneous suggestion to start a trial. Organization SSH CAs configured before an upgrade to an affected version are still usable after the upgrade. Enterprise owners can can still register SSH CAs for all organizations.
diff --git a/data/release-notes/enterprise-server/3-8/6.yml b/data/release-notes/enterprise-server/3-8/6.yml
index 0816abe7b438..295cb9712280 100644
--- a/data/release-notes/enterprise-server/3-8/6.yml
+++ b/data/release-notes/enterprise-server/3-8/6.yml
@@ -95,6 +95,6 @@ sections:
- |
When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
- |
- On an instance with subdomain isolation disabled, Mermaid diagrams in the web UI display an "Unable to render rich display" error and fail to render.
+ {% data reusables.release-notes.mermaid-rendering-known-issue %}
- |
{% data reusables.release-notes.enterprise-backup-utils-encryption-keys %}
diff --git a/data/release-notes/enterprise-server/3-8/7.yml b/data/release-notes/enterprise-server/3-8/7.yml
index a597e24f8a3c..5f71daae0f07 100644
--- a/data/release-notes/enterprise-server/3-8/7.yml
+++ b/data/release-notes/enterprise-server/3-8/7.yml
@@ -16,7 +16,7 @@ sections:
- |
When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
- |
- On an instance with subdomain isolation disabled, Mermaid diagrams in the web UI display an "Unable to render rich display" error and fail to render.
+ {% data reusables.release-notes.mermaid-rendering-known-issue %}
- |
{% data reusables.release-notes.enterprise-backup-utils-encryption-keys %}
changes:
diff --git a/data/release-notes/enterprise-server/3-8/8.yml b/data/release-notes/enterprise-server/3-8/8.yml
new file mode 100644
index 000000000000..a5bb39a3d538
--- /dev/null
+++ b/data/release-notes/enterprise-server/3-8/8.yml
@@ -0,0 +1,48 @@
+date: '2023-08-10'
+sections:
+ security_fixes:
+ - |
+ **LOW:** An attacker could circumvent branch protection by changing a PR base branch to an invalid ref name. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com/).
+ - |
+ Packages have been updated to the latest security versions.
+ bugs:
+ - |
+ API results were incomplete, and ordering of results was incorrect if `asc` or `desc` appeared in lowercase within the API query.
+ - |
+ The checks in the merge box for a pull request did not always match the the checks for the most recent commit in the pull request.
+ - |
+ When a site administrator used GitHub Enterprise Importer on versions 3.7 and below to migrate repositories from GitHub Enterprise Server, the system backup size would increase after running many migrations due to storage files not being cleaned up.
+ - |
+ A collaborator with the "Set the social preview" permission inherited from the "Read" role couldnt upload the social preview image of a repository.
+ - |
+ When running the `ghe-migrator`, certain error messages contained an invalid link to import documentation.
+ - |
+ In some cases, on an instance with GitHub Actions enabled, deployment of GitHub Pages site using a GitHub Actions workflow failed with a status of `deployment_lost`.
+ - |
+ On an instance in a high availability configuration, existing nodes with out-of-sync repositories prevented new nodes from replicating those repositories.
+ - |
+ GitHub Enterprise Server was queuing zip jobs unnecessarily.
+ changes:
+ - |
+ The description of the `ghe-cluster-balance` command line utility clarifies that it can be used to balance jobs other than `github-unicorn`.
+ - |
+ On GitHub Enterprise Server 3.8 and above, a blob storage provider must be configured in the Management Console in order to use the GitHub Enterprise Importer CLI, "startRepositoryMigration" GraphQL API, or "Start an organization migration" REST API. The "Migrations" section in the Management Console was mistakenly removed and has been added back.
+ - |
+ Administrators can display all repositories in a network with `spokesctl` by using the `repositories` subcommand.
+ known_issues:
+ - |
+ Custom firewall rules are removed during the upgrade process.
+ - |
+ The GitHub Packages npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues.
+ - |
+ During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start.
+ - |
+ If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see "[Troubleshooting access to the Management Console](https://docs.github.com/en/enterprise-server@3.8/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account)." [Updated: 2023-02-23]
+ - |
+ On an instance in a high-availability configuration, passive replica nodes accept Git client requests and forward the requests to the primary node.
+ - |
+ If an instance is configured to forward logs to a target server with TLS enabled, certificate authority (CA) bundles that a site administrator uploads using `ghe-ssl-ca-certificate-install` are not respected, and connections to the server fail.
+ - |
+ When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
+ - |
+ {% data reusables.release-notes.mermaid-rendering-known-issue %}
diff --git a/data/release-notes/enterprise-server/3-9/0.yml b/data/release-notes/enterprise-server/3-9/0.yml
index 9c0549c11fbb..f9c6dd67a62c 100644
--- a/data/release-notes/enterprise-server/3-9/0.yml
+++ b/data/release-notes/enterprise-server/3-9/0.yml
@@ -381,7 +381,7 @@ sections:
known_issues:
- |
- After an administrator upgrades from {% data variables.product.prodname_ghe_server %} 3.7 or 3.8 to 3.9, I/O utilization will increase, and in some cases the instance's performance will be impacted. Reduced performance is due to the database server being upgraded from MySQL 5.7 to MySQL 8.0. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance)."
+ {% data reusables.release-notes.upgrade-to-3-9-or-to-3-10-io-utilization-increase %}
- |
{% data reusables.release-notes.upgrade-mysql8-cannot-start-up %}
- |
@@ -416,6 +416,8 @@ sections:
During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start.
- |
If the root site administrator is locked out of the Management Console after failed login attempts, the account will not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see "[AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account)."
+ - |
+ {% data reusables.release-notes.mermaid-rendering-known-issue %} [Updated: 2023-08-18]
deprecations:
# https://github.com/github/releases/issues/2826
diff --git a/data/release-notes/enterprise-server/3-9/1.yml b/data/release-notes/enterprise-server/3-9/1.yml
index 49db08c5c9f9..34dc74278082 100644
--- a/data/release-notes/enterprise-server/3-9/1.yml
+++ b/data/release-notes/enterprise-server/3-9/1.yml
@@ -85,8 +85,6 @@ sections:
On an instance with a GitHub Advanced Security license that was also configured for a timezone greater than UTC, the list of secret scanning alerts displayed a "Loading secrets failed" error if a user sorted secrets by date in descending order.
- |
Code Scanning workflow runs now only request the `code-scanning` label so that they can be used with runner scale sets.
- - |
- On an instance with subdomain isolation disabled, Mermaid diagrams in the web UI displayed an "Unable to render rich display" error and failed to render.
changes:
- |
On an instance in a cluster configuration, the `ghe-cluster-config-check` command-line utility will return an affirmative message when no warnings or errors are detected. The affirmative message is "Configuration validation complete. No errors found."
@@ -100,7 +98,7 @@ sections:
On an instance with multiple nodes, internal tooling to repair repositories now attempts to resolve problems within the entire repository network.
known_issues:
- |
- After an administrator upgrades from {% data variables.product.prodname_ghe_server %} 3.7 or 3.8 to 3.9, I/O utilization will increase, and in some cases the instance's performance will be impacted. Reduced performance is due to the database server being upgraded from MySQL 5.7 to MySQL 8.0. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance)."
+ {% data reusables.release-notes.upgrade-to-3-9-or-to-3-10-io-utilization-increase %}
- |
{% data reusables.release-notes.upgrade-mysql8-cannot-start-up %}
- |
@@ -135,4 +133,5 @@ sections:
During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start.
- |
If the root site administrator is locked out of the Management Console after failed login attempts, the account will not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see "[AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account)."
-
+ - |
+ {% data reusables.release-notes.mermaid-rendering-known-issue %} [Updated: 2023-08-18]
\ No newline at end of file
diff --git a/data/release-notes/enterprise-server/3-9/2.yml b/data/release-notes/enterprise-server/3-9/2.yml
index f02b2da974fa..7828ebee6c3a 100644
--- a/data/release-notes/enterprise-server/3-9/2.yml
+++ b/data/release-notes/enterprise-server/3-9/2.yml
@@ -44,6 +44,8 @@ sections:
During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start.
- |
If the root site administrator is locked out of the Management Console after failed login attempts, the account will not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see "[AUTOTITLE](/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account)."
+ - |
+ {% data reusables.release-notes.mermaid-rendering-known-issue %} [Updated: 2023-08-18]
changes:
- |
Added a pre-upgrade check to validate the GHES version and MySQL configuration before allowing an upgrade to 3.9.
diff --git a/data/release-notes/enterprise-server/3-9/3.yml b/data/release-notes/enterprise-server/3-9/3.yml
new file mode 100644
index 000000000000..5bde85d85b12
--- /dev/null
+++ b/data/release-notes/enterprise-server/3-9/3.yml
@@ -0,0 +1,54 @@
+date: '2023-08-10'
+intro: |
+ {% warning %}
+
+ **Warning**: This release contains known issues that can impact the performance of your instance. Before you upgrade, make sure you've read the "[Known issues](#3.9.3-known-issues)" section of these release notes.
+ {% endwarning %}
+sections:
+ security_fixes:
+ - |
+ **LOW:** An attacker could circumvent branch protection by changing a PR base branch to an invalid ref name. This vulnerability was reported via the [GitHub Bug Bounty program](https://bounty.github.com/).
+ bugs:
+ - |
+ API results were incomplete, and ordering of results was incorrect if `asc` or `desc` appeared in lowercase within the API query.
+ - |
+ The checks in the merge box for a pull request did not always match the the checks for the most recent commit in the pull request.
+ - |
+ When a site administrator used GitHub Enterprise Importer on versions 3.7 and below to migrate repositories from GitHub Enterprise Server, the system backup size would increase after running many migrations due to storage files not being cleaned up.
+ - |
+ A collaborator with the "Set the social preview" permission inherited from the "Read" role could not upload the social preview image of a repository.
+ - |
+ The security settings page for a repository would return an error when enterprise-level runners were assigned to the repository.
+ - |
+ GitHub Enterprise Server was queuing zip jobs unnecessarily.
+ changes:
+ - |
+ On GitHub Enterprise Server 3.8 and above, a blob storage provider must be configured in the Management Console in order to use the GitHub Enterprise Importer CLI, "startRepositoryMigration" GraphQL API, or "Start an organization migration" REST API. The "Migrations" section in the Management Console was mistakenly removed and has been added back.
+ - |
+ Administrators can display all repositories in a network with `spokesctl` by using the `repositories` subcommand.
+ known_issues:
+ - |
+ {% data reusables.release-notes.upgrade-to-3-9-or-to-3-10-io-utilization-increase %} [Updated: 2023-08-11]
+ - |
+ {% data reusables.release-notes.upgrade-mysql8-cannot-start-up %}
+ - |
+ Custom firewall rules are removed during the upgrade process.
+ - |
+ The GitHub Packages npm registry no longer returns a time value in metadata responses. This was done to allow for substantial performance improvements. We continue to have all the data necessary to return a time value as part of the metadata response and will resume returning this value in the future once we have solved the existing performance issues.
+ - |
+ During the validation phase of a configuration run, a `No such object` error may occur for the Notebook and Viewscreen services. This error can be ignored as the services should still correctly start.
+ - |
+ If the root site administrator is locked out of the Management Console after failed login attempts, the account does not unlock automatically after the defined lockout time. Someone with administrative SSH access to the instance must unlock the account using the administrative shell. For more information, see "[Troubleshooting access to the Management Console](https://docs.github.com/en/enterprise-server@3.8/admin/configuration/administering-your-instance-from-the-management-console/troubleshooting-access-to-the-management-console#unlocking-the-root-site-administrator-account)." [Updated: 2023-02-23]
+ - |
+ On an instance in a high-availability configuration, passive replica nodes accept Git client requests and forward the requests to the primary node.
+ - |
+ If an instance is configured to forward logs to a target server with TLS enabled, certificate authority (CA) bundles that a site administrator uploads using `ghe-ssl-ca-certificate-install` are not respected, and connections to the server fail.
+ - |
+ When running `ghe-config-apply`, the process may stall with the message `Deployment is running pending automatic promotion`.
+ - |
+ The `mbind: Operation not permitted` error in the `/var/log/mysql/mysql.err` file can be ignored. MySQL 8 does not gracefully handle when the `CAP_SYS_NICE` capability isn't required, and outputs an error instead of a warning.
+ - |
+ {% data reusables.release-notes.mermaid-rendering-known-issue %}
+ - |
+ When enabling CodeQL via default setup [at scale](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-at-scale), some checks related to GitHub Actions are omitted, potentially preventing the process from completing.
+
diff --git a/data/reusables/actions/actions-app-actions-permissions-api.md b/data/reusables/actions/actions-app-actions-permissions-api.md
deleted file mode 100644
index 2e323c163137..000000000000
--- a/data/reusables/actions/actions-app-actions-permissions-api.md
+++ /dev/null
@@ -1 +0,0 @@
-{% data variables.product.prodname_github_apps %} must have the `actions` permission to use these endpoints.
diff --git a/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md b/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md
index 5c298dbfe50c..ae6717edba30 100644
--- a/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md
+++ b/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md
@@ -8,6 +8,7 @@ Use `jobs.<job_id>.runs-on` to define the type of machine to run the job on.
- a single string
- a single variable containing a string
- an array of strings, variables containing strings, or a combination of both
+ - a `key: value` pair using the `group` or `label` keys
- If you specify an array of strings or variables, your workflow will execute on any runner that matches all of the specified `runs-on` values. For example, here the job will only run on a self-hosted runner that has the labels `linux`, `x64`, and `gpu`:
```yaml
diff --git a/data/reusables/actions/jobs/section-using-concurrency.md b/data/reusables/actions/jobs/section-using-concurrency.md
index bf74ebdb3ab3..2a253f86be3f 100644
--- a/data/reusables/actions/jobs/section-using-concurrency.md
+++ b/data/reusables/actions/jobs/section-using-concurrency.md
@@ -1,4 +1,4 @@
-Use `concurrency` to ensure that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can only use the [`github` context](/actions/learn-github-actions/contexts#github-context). For more information about expressions, see "[AUTOTITLE](/actions/learn-github-actions/expressions)."
+Use `concurrency` to ensure that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can only use [`github`](/actions/learn-github-actions/contexts#github-context), [`inputs`](/actions/learn-github-actions/contexts#inputs-context) and [`vars`](/actions/learn-github-actions/contexts#vars-context) contexts. For more information about expressions, see "[AUTOTITLE](/actions/learn-github-actions/expressions)."
You can also specify `concurrency` at the job level. For more information, see [`jobs.<job_id>.concurrency`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idconcurrency).
diff --git a/data/reusables/actions/jobs/section-using-environments-for-jobs.md b/data/reusables/actions/jobs/section-using-environments-for-jobs.md
index 7ac8cb814f81..6d0e3eebaa05 100644
--- a/data/reusables/actions/jobs/section-using-environments-for-jobs.md
+++ b/data/reusables/actions/jobs/section-using-environments-for-jobs.md
@@ -1,4 +1,4 @@
-Use `jobs.<job_id>.environment` to define the environment that the job references. All environment protection rules must pass before a job referencing the environment is sent to a runner. For more information, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
+Use `jobs.<job_id>.environment` to define the environment that the job references. All deployment protection rules must pass before a job referencing the environment is sent to a runner. For more information, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
You can provide the environment as only the environment `name`, or as an environment object with the `name` and `url`. The URL maps to `environment_url` in the deployments API. For more information about the deployments API, see "[AUTOTITLE](/rest/repos#deployments)."
diff --git a/data/reusables/actions/runners-etc-hosts-file.md b/data/reusables/actions/runners-etc-hosts-file.md
new file mode 100644
index 000000000000..32692026f82a
--- /dev/null
+++ b/data/reusables/actions/runners-etc-hosts-file.md
@@ -0,0 +1 @@
+{% data variables.product.prodname_dotcom %}-hosted runners are provisioned with an `etc/hosts` file that blocks network access to various cryptocurrency mining pools and malicious sites. Hosts such as MiningMadness.com and cpu-pool.com are rerouted to localhost so that they do not present a significant security risk.
\ No newline at end of file
diff --git a/data/reusables/actions/workflows/required-workflow-beta.md b/data/reusables/actions/workflows/required-workflow-beta.md
index bf23a97d3230..1557e90e2d89 100644
--- a/data/reusables/actions/workflows/required-workflow-beta.md
+++ b/data/reusables/actions/workflows/required-workflow-beta.md
@@ -1,5 +1,5 @@
{% note %}
-**Note:** Required workflows for {% data variables.product.prodname_actions %} are in private beta and are not available for new signups.
+**Note:** Required workflows for {% data variables.product.prodname_actions %} are in private beta and are not available for new signups. On October 18th, 2023, you will no longer be able to access required workflows for {% data variables.product.prodname_actions %} and must use repository rulesets instead. You can read more about this change on the [{% data variables.product.company_short %} blog](https://github.blog/changelog/2023-08-02-github-actions-required-workflows-will-move-to-repository-rules/).{% ifversion fpt or ghec %} For more information about repository rulesets, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)."{% endif %}
{% endnote %}
diff --git a/data/reusables/actions/workflows/section-triggering-a-workflow-branches.md b/data/reusables/actions/workflows/section-triggering-a-workflow-branches.md
index 44acb1ab7369..5c6d02dca4af 100644
--- a/data/reusables/actions/workflows/section-triggering-a-workflow-branches.md
+++ b/data/reusables/actions/workflows/section-triggering-a-workflow-branches.md
@@ -34,7 +34,7 @@ on:
#### Example: Excluding branches
-When a pattern matches the `branches-ignore` pattern, the workflow will not run. The patterns defined in `branches` are evaluated against the Git ref's name. For example, the following workflow would run whenever there is a `pull_request` event unless the pull request is targeting:
+When a pattern matches the `branches-ignore` pattern, the workflow will not run. The patterns defined in `branches-ignore` are evaluated against the Git ref's name. For example, the following workflow would run whenever there is a `pull_request` event unless the pull request is targeting:
- A branch named `mona/octocat` (`refs/heads/mona/octocat`)
- A branch whose name matches `releases/**-alpha`, like `releases/beta/3-alpha` (`refs/heads/releases/beta/3-alpha`)
diff --git a/data/reusables/community/issue-forms-sample.md b/data/reusables/community/issue-forms-sample.md
index 2c1ef37932cc..a72f44d5b89e 100644
--- a/data/reusables/community/issue-forms-sample.md
+++ b/data/reusables/community/issue-forms-sample.md
@@ -2,7 +2,8 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
-labels: ["bug", "triage"]
+labels: ["bug", "triage"]{% ifversion projects-in-issue-forms %}
+projects: ["octo-org/1", "octo-org/44"]{% endif %}
assignees:
- octocat
body:
@@ -34,7 +35,8 @@ body:
description: What version of our software are you running?
options:
- 1.0.2 (Default)
- - 1.0.3 (Edge)
+ - 1.0.3 (Edge){% ifversion issue-form-dropdown-defaults %}
+ default: 0{% endif %}
validations:
required: true
- type: dropdown
diff --git a/data/reusables/dependabot/dependabot-ignore-dependencies.md b/data/reusables/dependabot/dependabot-ignore-dependencies.md
new file mode 100644
index 000000000000..6df870aeaf67
--- /dev/null
+++ b/data/reusables/dependabot/dependabot-ignore-dependencies.md
@@ -0,0 +1,4 @@
+If you want to ignore version updates for the dependency, you must do one of the following.
+
+- Configure an `ignore` rule for the dependency in the `dependabot.yml` file. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#ignore)."
+- Use the `@dependabot ignore` comment command for the dependency in the pull request for the grouped updates. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-for-grouped-version-updates-with-comment-commands)."
\ No newline at end of file
diff --git a/data/reusables/dependabot/dependabot-version-updates-groups-semver.md b/data/reusables/dependabot/dependabot-version-updates-groups-semver.md
new file mode 100644
index 000000000000..76ab0c8ab7ed
--- /dev/null
+++ b/data/reusables/dependabot/dependabot-version-updates-groups-semver.md
@@ -0,0 +1 @@
+You can also specify grouping settings based on how updates affect a specific ecosystem and follow semantic versioning (SemVer). This means you can, for example, group all patch updates together. This approach helps {% data variables.product.prodname_dependabot %} create as few pull requests as possible, while also reducing the chances of accidentally accepting changes that could cause issues. If a package follows SemVer, there's a higher chance (but not a guarantee) that minor and patch updates will be backwards compatible.
\ No newline at end of file
diff --git a/data/reusables/dependabot/dependabot-version-updates-groups-yaml-example.md b/data/reusables/dependabot/dependabot-version-updates-groups-yaml-example.md
index d459119cf1fe..8bb9366c3225 100644
--- a/data/reusables/dependabot/dependabot-version-updates-groups-yaml-example.md
+++ b/data/reusables/dependabot/dependabot-version-updates-groups-yaml-example.md
@@ -1,6 +1,23 @@
```yaml
-# `dependabot.yml` file with customized bundler configuration
+# `dependabot.yml` file using the `dependency-type` option to group updates
+# in conjunction with `patterns` and `exclude-patterns`.
+
+groups:
+ production-dependencies:
+ dependency-type: "production"
+ development-dependencies:
+ dependency-type: "development"
+ exclude-patterns:
+ - "rubocop*"
+ rubocop:
+ patterns:
+ - "rubocop*"
+```
+```yaml
+# `dependabot.yml` file with customized bundler configuration
+# In this example, the name of the group is `dev-dependencies`, and
+# only the `patterns` and `exclude-patterns` options are used.
version: 2
updates:
# Keep bundler dependencies up to date
@@ -25,4 +42,39 @@ updates:
exclude-patterns:
- "gc_ruboconfig"
- "gocardless-*"
+```
+
+```yaml
+# `dependabot.yml` file using the `update-types` option to group updates.
+# Any packages matching the pattern @angular* where the highest resolvable
+# version is minor or patch will be grouped together.
+version: 2
+updates:
+ - package-ecosystem: "npm"
+ directory: "/"
+ schedule:
+ interval: "weekly"
+groups:
+ angular:
+ patterns:
+ - "@angular*"
+ update-types:
+ - "minor"
+ - "patch"
+```
+
+```yaml
+# `dependabot.yml` file using the `update-types` option to group updates
+# in conjunction with an `ignore` condition.
+# If you do not want updates to `major` versions of `@angular*` packages, you can specify an `ignore` condition
+groups:
+ angular:
+ patterns:
+ - "@angular*"
+ update-types:
+ - "minor"
+ - "patch"
+ignore:
+ - dependency-name: "@angular*"
+ update-types: ["version-update:semver-major"]
```
\ No newline at end of file
diff --git a/data/reusables/dependabot/dependabot-version-updates-supported-options-for-groups.md b/data/reusables/dependabot/dependabot-version-updates-supported-options-for-groups.md
new file mode 100644
index 000000000000..eff473239f7f
--- /dev/null
+++ b/data/reusables/dependabot/dependabot-version-updates-supported-options-for-groups.md
@@ -0,0 +1,8 @@
+When you first configure a group, you specify a group name that will display in pull request titles and branch names. You can then define other options to include or exclude specific dependencies from the group. You must use the `patterns`, `dependency-type`, or `update-types` options to define the group, or any combination thereof.
+
+Option | Description |
+-------|-------------|
+| <code><span style="white-space: nowrap;">dependency-type</span></code> | Use to specify a dependency type to be included in the group. `dependency-type` can be `development` or `production`. |
+| `patterns` | Use to define strings of characters that match with a dependency name (or multiple dependency names) to include those dependencies in the group. |
+| <code><span style="white-space: nowrap;">exclude-patterns</span></code> | Use to exclude certain dependencies from the group. If a dependency is excluded from a group, {% data variables.product.prodname_dependabot %} will continue to raise single pull requests to update the dependency to its latest version. |
+| <code><span style="white-space: nowrap;">update-types</span></code> | Use to specify the semantic versioning level to include in the group. Possible values are `minor`, `patch`, and `major`. |
diff --git a/data/reusables/desktop/note-start-ssh-agent.md b/data/reusables/desktop/note-start-ssh-agent.md
new file mode 100644
index 000000000000..40501d3d94bc
--- /dev/null
+++ b/data/reusables/desktop/note-start-ssh-agent.md
@@ -0,0 +1,5 @@
+{% tip %}
+
+**Note:** The eval commands above start ssh-agent manually in your environment. These commands may fail if ssh-agent already runs as a background system service. If that happens, we recommend you check the relevant documentation for your environment.
+
+{% endtip %}
\ No newline at end of file
diff --git a/data/reusables/desktop/windows_git_bash_turn_on_ssh_agent.md b/data/reusables/desktop/windows_git_bash_turn_on_ssh_agent.md
index 447c363fe10c..f3730618f821 100644
--- a/data/reusables/desktop/windows_git_bash_turn_on_ssh_agent.md
+++ b/data/reusables/desktop/windows_git_bash_turn_on_ssh_agent.md
@@ -1,7 +1,7 @@
**If you are using Git Bash**, turn on ssh-agent:
-```shell
-# start the ssh-agent in the background
-$ eval "$(ssh-agent -s)"
-> Agent pid 59566
-```
+ ```shell
+ # start the ssh-agent in the background
+ $ eval "$(ssh-agent -s)"
+ > Agent pid 59566
+ ```
diff --git a/data/reusables/desktop/windows_git_for_windows_turn_on_ssh_agent.md b/data/reusables/desktop/windows_git_for_windows_turn_on_ssh_agent.md
index c6675c02968a..3f3df9720ccc 100644
--- a/data/reusables/desktop/windows_git_for_windows_turn_on_ssh_agent.md
+++ b/data/reusables/desktop/windows_git_for_windows_turn_on_ssh_agent.md
@@ -1,7 +1,7 @@
**If you are using another terminal prompt**, such as [Git for Windows](https://git-for-windows.github.io/), turn on ssh-agent:
-```shell
-# start the ssh-agent in the background
-$ eval $(ssh-agent -s)
-> Agent pid 59566
-```
+ ```shell
+ # start the ssh-agent in the background
+ $ eval $(ssh-agent -s)
+ > Agent pid 59566
+ ```
diff --git a/data/reusables/enterprise-migration-tool/data-not-migrated.md b/data/reusables/enterprise-migration-tool/data-not-migrated.md
index 7fb107983552..05d23ee8e1cc 100644
--- a/data/reusables/enterprise-migration-tool/data-not-migrated.md
+++ b/data/reusables/enterprise-migration-tool/data-not-migrated.md
@@ -1,7 +1,7 @@
Currently, the following data is **not** migrated.
- {% data variables.large_files.product_name_short %} objects and large binaries (repositories using {% data variables.large_files.product_name_short %} are still supported, see "[Limitations of {% data variables.product.prodname_importer_proper_name %}](#limitations-of-github-enterprise-importer)")
-- {% data variables.product.prodname_actions %} secrets, variables, environments, or workflow run history
+- {% data variables.product.prodname_actions %} secrets, variables, environments, self-hosted runners, {% data variables.actions.hosted_runner %}s, or workflow run history
- Webhook secrets
- {% data variables.product.prodname_github_codespaces %} secrets
- {% data variables.product.prodname_code_scanning_caps %} results
diff --git a/data/reusables/enterprise/upgrade-to-3-9-or-to-3-10-mysql-cannot-start-up.md b/data/reusables/enterprise/upgrade-to-3-9-or-to-3-10-mysql-cannot-start-up.md
index d4d9c2e28faf..c930b32782f2 100644
--- a/data/reusables/enterprise/upgrade-to-3-9-or-to-3-10-mysql-cannot-start-up.md
+++ b/data/reusables/enterprise/upgrade-to-3-9-or-to-3-10-mysql-cannot-start-up.md
@@ -1 +1 @@
-After an administrator upgrades from {% data variables.product.prodname_ghe_server %} 3.7 or 3.8, 3.9, or 3.10, MySQL may not start back up. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance#mysql-does-not-start-after-upgrade-to-github-enterprise-server-39)."
+After an administrator upgrades from {% data variables.product.prodname_ghe_server %} 3.7 or 3.8, to 3.9 or 3.10, MySQL may not start back up. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance#mysql-does-not-start-after-upgrade-to-github-enterprise-server-39)."
diff --git a/data/reusables/gated-features/environments.md b/data/reusables/gated-features/environments.md
index 2e58922759ed..aed8968a277d 100644
--- a/data/reusables/gated-features/environments.md
+++ b/data/reusables/gated-features/environments.md
@@ -1 +1 @@
-Environments, environment secrets, and environment protection rules are available in **public** repositories for all products. For access to environments, environment secrets, and deployment branches in **private** or **internal** repositories, you must use {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_enterprise %}. For access to other environment protection rules in **private** or **internal** repositories, you must use {% data variables.product.prodname_enterprise %}. {% data reusables.gated-features.more-info %}
+Environments, environment secrets, and deployment protection rules are available in public repositories for all current {% data variables.product.prodname_dotcom %} plans. They are not available on legacy plans, such as Bronze, Silver, or Gold. For access to environments, environment secrets, and deployment branches in private or internal repositories, you must use {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, or {% data variables.product.prodname_enterprise %}. {% ifversion fpt %}If you are on a {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, or {% data variables.product.prodname_team %} plan, other deployment protection rules, such as a wait timer or required reviewers, are only available for public repositories.{% endif %}
\ No newline at end of file
diff --git a/data/reusables/gated-features/historical-insights-for-projects.md b/data/reusables/gated-features/historical-insights-for-projects.md
index 6342fa548c28..4917bbd0af56 100644
--- a/data/reusables/gated-features/historical-insights-for-projects.md
+++ b/data/reusables/gated-features/historical-insights-for-projects.md
@@ -1 +1 @@
-Historical charts are available with {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} for organizations. You can save unlimited charts in private projects with {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} for organizations and {% data variables.product.prodname_pro %} for users. Users and organizations using a public project can also save unlimited charts. Users and organizations using {% data variables.product.prodname_free_team %} or a legacy plan can save two charts in private projects. {% data reusables.gated-features.more-info %}
+Insights is available for the new Projects experience, you cannot use Insights with {% data variables.product.prodname_projects_v1 %}. Historical charts are available with {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} for organizations. You can save unlimited charts in private projects with {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} for organizations and {% data variables.product.prodname_pro %} for users. Users and organizations using a public project can also save unlimited charts. Users and organizations using {% data variables.product.prodname_free_team %} or a legacy plan can save two charts in private projects. {% data reusables.gated-features.more-info %}
\ No newline at end of file
diff --git a/data/reusables/gated-features/partner-pattern-validity-check-ghas.md b/data/reusables/gated-features/partner-pattern-validity-check-ghas.md
new file mode 100644
index 000000000000..9b7008eb2f01
--- /dev/null
+++ b/data/reusables/gated-features/partner-pattern-validity-check-ghas.md
@@ -0,0 +1,7 @@
+{% ifversion ghec %}
+Validity checks for partner patterns is available on all types of repositories on {% data variables.product.prodname_dotcom_the_website %}. To use this feature, you must have a license for {% data variables.product.prodname_GH_advanced_security %}.
+
+{% elsif ghes %}
+Validity checks for partner patterns is available on all types of repositories in {% data variables.product.product_name %}. This feature requires a license for {% data variables.product.prodname_GH_advanced_security %}.
+
+{% endif %}
\ No newline at end of file
diff --git a/data/reusables/getting-started/sign-in-dotcom.md b/data/reusables/getting-started/sign-in-dotcom.md
new file mode 100644
index 000000000000..c47a5faec446
--- /dev/null
+++ b/data/reusables/getting-started/sign-in-dotcom.md
@@ -0,0 +1 @@
+1. Sign in to {% data variables.product.prodname_dotcom_the_website %}, if you haven't already done so.
\ No newline at end of file
diff --git a/data/reusables/gpg/copy-ssh-public-key.md b/data/reusables/gpg/copy-ssh-public-key.md
index d592fbef5fe8..4d760b846a9f 100644
--- a/data/reusables/gpg/copy-ssh-public-key.md
+++ b/data/reusables/gpg/copy-ssh-public-key.md
@@ -21,11 +21,19 @@
# Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard
```
- {% tip %}
+ {% note %}
- **Tip:** With Windows Subsystem for Linux (WSL), you can use `clip.exe`. Otherwise if `clip` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard.
+ **Notes:**
- {% endtip %}
+ - With Windows Subsystem for Linux (WSL), you can use `clip.exe`. Otherwise if `clip` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard.
+ - On newer versions of Windows that use the Windows Terminal, or anywhere else that uses the PowerShell command line, you may receive a `ParseError` stating that `The '<' operator is reserved for future use.` In this case, the following alternative `clip` command should be used:
+
+ ```shell
+ $ cat ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub | clip
+ # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard
+ ```
+
+ {% endnote %}
{% endwindows %}
{% linux %}
diff --git a/data/reusables/identity-and-permissions/ip-address-add-or-remove-caching.md b/data/reusables/identity-and-permissions/ip-address-add-or-remove-caching.md
new file mode 100644
index 000000000000..268dc3af7463
--- /dev/null
+++ b/data/reusables/identity-and-permissions/ip-address-add-or-remove-caching.md
@@ -0,0 +1,5 @@
+{% note %}
+
+**Note:** Due to caching, adding or removing IP addresses can take a few minutes to fully take effect.
+
+{% endnote %}
diff --git a/data/reusables/projects/customize/slice-panel.md b/data/reusables/projects/customize/slice-panel.md
new file mode 100644
index 000000000000..00a0612fcf92
--- /dev/null
+++ b/data/reusables/projects/customize/slice-panel.md
@@ -0,0 +1,14 @@
+You can slice your items by a field to view a list of the field values in a separate panel. When you click on a value in the slice panel, the current view will adjust to only show items with that value. The slice panel works with the current filter applied to your view.
+
+{% note %}
+
+**Note:** You cannot slice by title, reviewers, or linked pull requests.
+
+{% endnote %}
+
+{% data reusables.projects.open-view-menu %}
+1. Click **Slice by**.
+1. Click the field you want to slice by.
+1. Optionally, to disable slicing, click {% octicon "x" aria-hidden="true" %} **No slicing** at the bottom of the list.
+
+With the slice panel open, you can change the current field by using the menu at the top of the slice panel.
\ No newline at end of file
diff --git a/data/reusables/projects/insights-release-note.md b/data/reusables/projects/insights-release-note.md
index 188df92929d4..0f470ef4e43c 100644
--- a/data/reusables/projects/insights-release-note.md
+++ b/data/reusables/projects/insights-release-note.md
@@ -2,8 +2,8 @@
{% note %}
-**Note:** Insights is available for the new Projects experience, you cannot use Insights with {% data variables.product.prodname_projects_v1 %}. Historical charts have been available for organizations using {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %}. However, these charts will no longer allow grouping values. Over the next couple of months, support for existing historical charts will be gradually discontinued. Additionally, new accounts will not have access to this feature.
+**Note:** Support for the **Group by** field in historical charts is being removed and will be gradually phased out on existing historical charts over the coming weeks. In the meantime, new accounts and newly upgraded accounts will not have access to historical charts.
{% endnote %}
-{% endif %}
+{% endif %}
\ No newline at end of file
diff --git a/data/reusables/release-notes/mermaid-rendering-known-issue.md b/data/reusables/release-notes/mermaid-rendering-known-issue.md
new file mode 100644
index 000000000000..4b2f4a33ad5d
--- /dev/null
+++ b/data/reusables/release-notes/mermaid-rendering-known-issue.md
@@ -0,0 +1 @@
+On an instance with subdomain isolation disabled, Mermaid diagrams in the web UI display an "Unable to render rich display" error and fail to render.
\ No newline at end of file
diff --git a/data/reusables/release-notes/upgrade-mysql8-cannot-start-up.md b/data/reusables/release-notes/upgrade-mysql8-cannot-start-up.md
index 7156d779547b..56770a0fd7d3 100644
--- a/data/reusables/release-notes/upgrade-mysql8-cannot-start-up.md
+++ b/data/reusables/release-notes/upgrade-mysql8-cannot-start-up.md
@@ -1 +1 @@
-{% data reusables.enterprise.upgrade-to-3-9-or-to-3-10-mysql-cannot-start-up %} [Updated: 2023-07-27]
+{% data reusables.enterprise.upgrade-to-3-9-or-to-3-10-mysql-cannot-start-up %} [Updated: 2023-08-11]
diff --git a/data/reusables/release-notes/upgrade-to-3-9-or-to-3-10-io-utilization-increase.md b/data/reusables/release-notes/upgrade-to-3-9-or-to-3-10-io-utilization-increase.md
new file mode 100644
index 000000000000..a379aa654f67
--- /dev/null
+++ b/data/reusables/release-notes/upgrade-to-3-9-or-to-3-10-io-utilization-increase.md
@@ -0,0 +1,3 @@
+After an administrator upgrades from {% data variables.product.prodname_ghe_server %} 3.7 or 3.8 to 3.9 or 3.10, I/O utilization will increase, and in some cases the instance's performance will be impacted.
+Reduced performance is due to the database server being upgraded from MySQL 5.7 to MySQL 8.0.
+For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance)."
diff --git a/data/reusables/rest-api/permission-header.md b/data/reusables/rest-api/permission-header.md
new file mode 100644
index 000000000000..e876d4c3cb41
--- /dev/null
+++ b/data/reusables/rest-api/permission-header.md
@@ -0,0 +1,5 @@
+{% ifversion rest-permissions-header %}
+
+To help you choose the correct permissions, you will receive the `X-Accepted-GitHub-Permissions` header in the REST API response. The header will tell you what permissions are required in order to access the endpoint. For more information, see "[AUTOTITLE](/rest/overview/troubleshooting#insufficient-permissions-errors)."
+
+{% endif %}
\ No newline at end of file
diff --git a/data/reusables/secret-scanning/validity-check-auto-enable.md b/data/reusables/secret-scanning/validity-check-auto-enable.md
new file mode 100644
index 000000000000..ce6da78b9e89
--- /dev/null
+++ b/data/reusables/secret-scanning/validity-check-auto-enable.md
@@ -0,0 +1 @@
+1. Under {% data variables.product.prodname_secret_scanning_caps %}, select the checkbox next to "Automatically verify if a secret is valid by sending it to the relevant partner".
\ No newline at end of file
diff --git a/data/reusables/secret-scanning/validity-check-partner-patterns-beta.md b/data/reusables/secret-scanning/validity-check-partner-patterns-beta.md
new file mode 100644
index 000000000000..096c8eed2f9b
--- /dev/null
+++ b/data/reusables/secret-scanning/validity-check-partner-patterns-beta.md
@@ -0,0 +1,5 @@
+{% note %}
+
+**Note:** Validity checks for partner patterns is currently in beta and subject to change.
+
+{% endnote %}
\ No newline at end of file
diff --git a/data/reusables/secret-scanning/validity-check-table.md b/data/reusables/secret-scanning/validity-check-table.md
new file mode 100644
index 000000000000..0ad415c5161a
--- /dev/null
+++ b/data/reusables/secret-scanning/validity-check-table.md
@@ -0,0 +1,7 @@
+ | Validity | Result |
+ |-------------------------|--------------------------------------------------------------------------------|
+ | Active secret | {% data variables.product.company_short %} confirmed this secret is active |
+ | Active secret | {% data variables.product.company_short %} checked with this secret's provider and found that the secret is active |
+ | Possibly active secret | {% data variables.product.company_short %} does not support validation checks for this token type yet |
+ | Possibly active secret | {% data variables.product.company_short %} could not verify this secret |
+ | Secret appears inactive | You should make sure no unauthorized access has already occurred |
\ No newline at end of file
diff --git a/data/reusables/webhooks/webhooks-rest-api-links.md b/data/reusables/webhooks/webhooks-rest-api-links.md
index 5ff8292c7790..84cf95f383f2 100644
--- a/data/reusables/webhooks/webhooks-rest-api-links.md
+++ b/data/reusables/webhooks/webhooks-rest-api-links.md
@@ -1,5 +1,5 @@
You can use the REST API to manage repository, organization, and app webhooks. You can list webhook deliveries for a webhook, or get and redeliver an individual delivery for a webhook, which can be integrated into an external app or service. You can also use the REST API to change the configuration of the webhook. For example, you can modify the payload URL, content type, SSL verification, and secret. For more information, see:
- [Repository Webhooks](/rest/webhooks#repository-webhooks)
-- [Organization Webhooks](/rest/orgs#webhooks)
-- [{% data variables.product.prodname_github_app %} Webhooks](/rest/apps#webhooks)
+- [Organization Webhooks](/rest/orgs/webhooks)
+- [{% data variables.product.prodname_github_app %} Webhooks](/rest/apps/webhooks)
diff --git a/data/reusables/webhooks/webhooks_intro.md b/data/reusables/webhooks/webhooks_intro.md
index 812d7bd6b854..82cc13d78065 100644
--- a/data/reusables/webhooks/webhooks_intro.md
+++ b/data/reusables/webhooks/webhooks_intro.md
@@ -1 +1 @@
-When configuring a webhook, you can choose which events will send you payloads. To limit the number of HTTP requests to your server, you should only subscribe to the specific events that you plan on handling. By default, webhooks installed on {% ifversion ghes or ghae %} [{% data variables.product.prodname_enterprise %}](/rest/enterprise-admin#global-webhooks/),{% endif %} an [organization][org-hooks], or a [repository][repo-hooks] are only subscribed to the push event. By default, webhooks on {% data variables.product.prodname_github_apps %} are not subscribed to any events. You can change events that a webhook is subscribed to at any time.
+When configuring a webhook, you can choose which events will send you payloads. To limit the number of HTTP requests to your server, you should only subscribe to the specific events that you plan on handling. By default, webhooks installed on {% ifversion ghes or ghae %} [{% data variables.product.prodname_enterprise %}](/rest/enterprise-admin#global-webhooks/),{% endif %} an [organization](/rest/orgs/webhooks), or a [repository](/rest/webhooks) are only subscribed to the push event. By default, webhooks on {% data variables.product.prodname_github_apps %} are not subscribed to any events. You can change events that a webhook is subscribed to at any time.
diff --git a/data/secret-scanning.yml b/data/secret-scanning.yml
index 8a5cc6f20a7f..2114134e83a4 100644
--- a/data/secret-scanning.yml
+++ b/data/secret-scanning.yml
@@ -102,8 +102,8 @@
hasPushProtection: true
hasValidityCheck: false
-- provider: 'Amazon'
- supportedSecret: 'Amazon OAuth Client ID with Amazon OAuth Client Secret'
+- provider: 'Login with Amazon'
+ supportedSecret: 'Login with Amazon OAuth Client ID with Login with Amazon OAuth Client Secret'
secretType: 'amazon_oauth_client_id </br>amazon_oauth_client_secret'
versions:
fpt: '*'
diff --git a/lib/excluded-links.js b/lib/excluded-links.js
index 9ae16ecc9dac..e0f215e9acc2 100644
--- a/lib/excluded-links.js
+++ b/lib/excluded-links.js
@@ -59,4 +59,5 @@ export default [
'https://www.microsoft.com/en-us/security/mobile-authenticator-app',
'https://microsoft.com/powershell',
'https://dev.mysql.com/doc/refman/8.0/en/innodb-parameters.html#sysvar_innodb_flush_method',
+ 'https://support.pingidentity.com/s/marketplace-integration/a7i1W0000004ID3QAM/github-connector',
]
diff --git a/lib/get-applicable-versions.js b/lib/get-applicable-versions.js
index cc05f5f14f3d..633ef693f675 100644
--- a/lib/get-applicable-versions.js
+++ b/lib/get-applicable-versions.js
@@ -14,9 +14,11 @@ function getApplicableVersions(versionsObj, filepath, opts = {}) {
throw new Error(`No \`versions\` frontmatter found in ${filepath}`)
}
- // all versions are applicable!
+ // Catch an old frontmatter value that was used to indicate an article was available in all versions.
if (versionsObj === '*') {
- return allVersionKeys
+ throw new Error(
+ `${filepath} contains the invalid versions frontmatter: *. Please explicitly list out all the versions that apply to this article.`,
+ )
}
if (!featureData) {
diff --git a/lib/page.js b/lib/page.js
index 92dad0e464af..14c1919e8627 100644
--- a/lib/page.js
+++ b/lib/page.js
@@ -242,15 +242,21 @@ class Page {
}
// set a flag so layout knows whether to render a mac/windows/linux switcher element
- this.detectedPlatforms = ['mac', 'windows', 'linux'].filter(
- (platform) => html.includes(`ghd-tool ${platform}`) || html.includes(`platform-${platform}`),
- )
+ this.detectedPlatforms = ['mac', 'windows', 'linux'].filter((platform) => {
+ // This matches `ghd-tool mac` but not `ghd-tool macos`
+ // Whereas `html.includes('ghd-tool mac')` would match both.
+ const regex = new RegExp(`ghd-tool ${platform}\\b|platform-${platform}\\b`)
+ return regex.test(html)
+ })
this.includesPlatformSpecificContent = this.detectedPlatforms.length > 0
// set flags for webui, cli, etc switcher element
- this.detectedTools = Object.keys(allTools).filter(
- (tool) => html.includes(`ghd-tool ${tool}`) || html.includes(`tool-${tool}`),
- )
+ this.detectedTools = Object.keys(allTools).filter((tool) => {
+ // This matches `ghd-tool jetbrain` but not `ghd-tool jetbrain_beta`
+ // Whereas `html.includes('ghd-tool jetbrain')` would match both.
+ const regex = new RegExp(`ghd-tool ${tool}\\b|tool-${tool}\\b`)
+ return regex.test(html)
+ })
// pass the list of all possible tools around to components and utilities that will need it later on
this.allToolsParsed = allTools
diff --git a/middleware/contextualizers/secret-scanning.js b/middleware/contextualizers/secret-scanning.js
index 558cc251c76d..695c40cb8111 100644
--- a/middleware/contextualizers/secret-scanning.js
+++ b/middleware/contextualizers/secret-scanning.js
@@ -1,7 +1,9 @@
import fs from 'fs'
import path from 'path'
import yaml from 'js-yaml'
+
import getApplicableVersions from '../../lib/get-applicable-versions.js'
+import { liquid } from '#src/content-render/index.js'
const secretScanningPath = path.join('data/secret-scanning.yml')
@@ -17,5 +19,16 @@ export default async function secretScanning(req, res, next) {
getApplicableVersions(entry.versions).includes(currentVersion),
)
+ // Some entries might use Liquid syntax, so we need
+ // to execute that Liquid to get the actual value.
+ req.context.secretScanningData.forEach(async (entry, i) => {
+ for (const [key, value] of Object.entries(entry)) {
+ if (typeof value === 'string' && value.includes('{%')) {
+ const evaluated = yaml.load(await liquid.parseAndRender(value, req.context))
+ entry[key] = evaluated
+ }
+ }
+ })
+
return next()
}
diff --git a/package-lock.json b/package-lock.json
index 348713aede25..6d6f6e5d560b 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -9,11 +9,11 @@
"dependencies": {
"@elastic/elasticsearch": "7.11.0",
"@github/failbot": "0.8.3",
- "@primer/behaviors": "^1.3.3",
- "@primer/css": "^21.0.1",
- "@primer/octicons": "^19.1.0",
- "@primer/octicons-react": "^19.1.0",
- "@primer/react": "35.27.0",
+ "@primer/behaviors": "^1.3.5",
+ "@primer/css": "^21.0.7",
+ "@primer/octicons": "^19.5.0",
+ "@primer/octicons-react": "^19.5.0",
+ "@primer/react": "35.27.1",
"accept-language-parser": "^1.5.0",
"ajv": "^8.11.0",
"ajv-errors": "^3.0.0",
@@ -114,14 +114,14 @@
"cross-env": "^7.0.3",
"csp-parse": "0.0.2",
"dedent": "^1.0.1",
- "eslint": "8.46.0",
+ "eslint": "8.47.0",
"eslint-config-prettier": "9.0.0",
- "eslint-config-standard": "^17.0.0",
+ "eslint-config-standard": "17.1.0",
"eslint-import-resolver-typescript": "^3.5.5",
- "eslint-plugin-import": "^2.27.5",
+ "eslint-plugin-import": "2.28.0",
"eslint-plugin-jsx-a11y": "^6.5.1",
- "eslint-plugin-node": "^11.1.0",
- "eslint-plugin-promise": "^6.0.0",
+ "eslint-plugin-n": "16.0.1",
+ "eslint-plugin-promise": "6.1.1",
"event-to-promise": "^0.8.0",
"graphql": "^16.5.0",
"http-status-code": "^2.1.0",
@@ -133,7 +133,7 @@
"jest-slow-test-reporter": "^1.0.0",
"json-schema-merge-allof": "^0.8.1",
"kill-port": "2.0.1",
- "lint-staged": "^13.0.1",
+ "lint-staged": "^14.0.0",
"make-promises-safe": "^5.1.0",
"markdownlint": "^0.28.2",
"markdownlint-rule-helpers": "^0.19.0",
@@ -845,9 +845,9 @@
}
},
"node_modules/@eslint/eslintrc": {
- "version": "2.1.1",
- "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-2.1.1.tgz",
- "integrity": "sha512-9t7ZA7NGGK8ckelF0PQCfcxIUzs1Md5rrO6U/c+FIQNanea5UZC0wqKXH4vHBccmu4ZJgZ2idtPeW7+Q2npOEA==",
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-2.1.2.tgz",
+ "integrity": "sha512-+wvgpDsrB1YqAMdEUCcnTlpfVBH7Vqn6A/NT3D8WVXFIaKMlErPIZT3oCIAVCOtarRpMtelZLqJeU3t7WY6X6g==",
"dev": true,
"dependencies": {
"ajv": "^6.12.4",
@@ -894,9 +894,9 @@
}
},
"node_modules/@eslint/eslintrc/node_modules/globals": {
- "version": "13.20.0",
- "resolved": "https://registry.npmjs.org/globals/-/globals-13.20.0.tgz",
- "integrity": "sha512-Qg5QtVkCy/kv3FUSlu4ukeZDVf9ee0iXLAUYX13gbR17bnejFTzr4iS9bY7kwCf1NztRNm1t91fjOiyx4CSwPQ==",
+ "version": "13.21.0",
+ "resolved": "https://registry.npmjs.org/globals/-/globals-13.21.0.tgz",
+ "integrity": "sha512-ybyme3s4yy/t/3s35bewwXKOf7cvzfreG2lH0lZl0JB7I4GxRP2ghxOK/Nb9EkRXdbBXZLfq/p/0W2JUONB/Gg==",
"dev": true,
"dependencies": {
"type-fest": "^0.20.2"
@@ -939,9 +939,9 @@
}
},
"node_modules/@eslint/js": {
- "version": "8.46.0",
- "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.46.0.tgz",
- "integrity": "sha512-a8TLtmPi8xzPkCbp/OGFUo5yhRkHM2Ko9kOWP4znJr0WAhWyThaw3PnwX4vOTWOAMsV2uRt32PPDcEz63esSaA==",
+ "version": "8.47.0",
+ "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.47.0.tgz",
+ "integrity": "sha512-P6omY1zv5MItm93kLM8s2vr1HICJH8v0dvddDhysbIuZ+vcjOHg5Zbkf1mTkcmi2JA9oBG2anOkRnW8WJTS8Og==",
"dev": true,
"engines": {
"node": "^12.22.0 || ^14.17.0 || >=16.0.0"
@@ -1953,6 +1953,17 @@
"universal-user-agent": "^6.0.0"
}
},
+ "node_modules/@octokit/core/node_modules/@octokit/request-error": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.1.0.tgz",
+ "integrity": "sha512-1VIvgXxs9WHSjicsRwq8PlR2LR2x6DwsJAaFgzdi0JfJoGSO8mYI/cHJQ+9FbN21aa+DrgNLnwObmyeSC8Rmpg==",
+ "dev": true,
+ "dependencies": {
+ "@octokit/types": "^6.0.3",
+ "deprecation": "^2.0.0",
+ "once": "^1.4.0"
+ }
+ },
"node_modules/@octokit/endpoint": {
"version": "6.0.12",
"dev": true,
@@ -2080,10 +2091,11 @@
"universal-user-agent": "^6.0.0"
}
},
- "node_modules/@octokit/request-error": {
+ "node_modules/@octokit/request/node_modules/@octokit/request-error": {
"version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.1.0.tgz",
+ "integrity": "sha512-1VIvgXxs9WHSjicsRwq8PlR2LR2x6DwsJAaFgzdi0JfJoGSO8mYI/cHJQ+9FbN21aa+DrgNLnwObmyeSC8Rmpg==",
"dev": true,
- "license": "MIT",
"dependencies": {
"@octokit/types": "^6.0.3",
"deprecation": "^2.0.0",
@@ -2268,15 +2280,16 @@
}
},
"node_modules/@primer/behaviors": {
- "version": "1.3.4",
- "resolved": "https://registry.npmjs.org/@primer/behaviors/-/behaviors-1.3.4.tgz",
- "integrity": "sha512-j6PhkDD1IdL9xrlKbUQ3YEM74B7Fgr1mIZJ6JaYJjM1Mvdutd/nBouM8SnwFZdBBbS+ZRfGhnx3plr833Pvf1Q=="
+ "version": "1.3.5",
+ "resolved": "https://registry.npmjs.org/@primer/behaviors/-/behaviors-1.3.5.tgz",
+ "integrity": "sha512-HWwz+6MrfK5NTWcg9GdKFpMBW/yrAV937oXiw2eDtsd88P3SRwoCt6ZO6QmKp9RP3nDU9cbqmuGZ0xBh0eIFeg=="
},
"node_modules/@primer/css": {
- "version": "21.0.1",
- "license": "MIT",
+ "version": "21.0.7",
+ "resolved": "https://registry.npmjs.org/@primer/css/-/css-21.0.7.tgz",
+ "integrity": "sha512-Iq0VkpLVZqHZTo2JOIv+RPVu3bWj/BU/MIZrNZ4GRTJTY0YFQ/YCmUYKY1swgiCiPF/RKew5xIkf1cWaqtkQEA==",
"dependencies": {
- "@primer/primitives": "^7.11.7",
+ "@primer/primitives": "^7.11.12",
"@primer/view-components": "^0.1.0"
},
"engines": {
@@ -2284,17 +2297,17 @@
}
},
"node_modules/@primer/octicons": {
- "version": "19.1.0",
- "resolved": "https://registry.npmjs.org/@primer/octicons/-/octicons-19.1.0.tgz",
- "integrity": "sha512-5o90F89gNPnAk1qfzl3hb/TcsUjk5g0WFI+fBRHLkBKzB3uc9EvxTpgzjXhhjyriOkrBOjFo58D0sjtwttaQww==",
+ "version": "19.5.0",
+ "resolved": "https://registry.npmjs.org/@primer/octicons/-/octicons-19.5.0.tgz",
+ "integrity": "sha512-b3IBp3EmzLc/YMw3xdqy7Lg8CgFObYaWegPntoKO1bZLZ4sAG5PRMPp36rj4TF1sDHbNufhGMvdCCM5VdS3mPQ==",
"dependencies": {
"object-assign": "^4.1.1"
}
},
"node_modules/@primer/octicons-react": {
- "version": "19.4.0",
- "resolved": "https://registry.npmjs.org/@primer/octicons-react/-/octicons-react-19.4.0.tgz",
- "integrity": "sha512-6zFbvbQYQdGd9cIgNscnofSe0LkV28PvcL4mWPoKFV1u7Mdn3MlOjgawzuA2oXB18LLkMadTJ4Ky77FybUlrBg==",
+ "version": "19.5.0",
+ "resolved": "https://registry.npmjs.org/@primer/octicons-react/-/octicons-react-19.5.0.tgz",
+ "integrity": "sha512-8GZCcoyGz0CYhW+zi0yMsrn2qSBzZp4dbRomesAhtOzJLxKGZMyFd7VSp7mEYCCujMSCj/8faKgzyj7UrL6/3w==",
"engines": {
"node": ">=8"
},
@@ -2303,14 +2316,14 @@
}
},
"node_modules/@primer/primitives": {
- "version": "7.11.11",
- "resolved": "https://registry.npmjs.org/@primer/primitives/-/primitives-7.11.11.tgz",
- "integrity": "sha512-5McPeE83AGcYm2uHbQEIOOa6JPv2SUFPDjYbf2I5QnvmNm9ZUbS446zWC3ygNi54uks7znuTDFrU325vpnze7g=="
+ "version": "7.12.0",
+ "resolved": "https://registry.npmjs.org/@primer/primitives/-/primitives-7.12.0.tgz",
+ "integrity": "sha512-QKNxfWm7Ik1Ulswyp3KeUL2xnQj8i0E7DdB6lOrh29o7LgyuutwcOHi4CGapBIOR1fYURu+yROSTHQ2C2aDK7A=="
},
"node_modules/@primer/react": {
- "version": "35.27.0",
- "resolved": "https://registry.npmjs.org/@primer/react/-/react-35.27.0.tgz",
- "integrity": "sha512-aToT6Qdwqv4TM/3l63LNMfUyRjDLaXdKhqw0++BHcbD9z9W4va0If5OsPqDYIsOun6BDdptMdliFYTUW0ZPH3w==",
+ "version": "35.27.1",
+ "resolved": "https://registry.npmjs.org/@primer/react/-/react-35.27.1.tgz",
+ "integrity": "sha512-xA10ygf2OUECqPCclYdA4wRyheLUj61BqOU6I+bY9AckQCNitpbFcbS9TIuOI/KTO9NkfngvcEtYkLtEZ8btNQ==",
"dependencies": {
"@github/combobox-nav": "^2.1.5",
"@github/markdown-toolbar-element": "^2.1.0",
@@ -2683,8 +2696,9 @@
},
"node_modules/@types/json5": {
"version": "0.0.29",
- "dev": true,
- "license": "MIT"
+ "resolved": "https://registry.npmjs.org/@types/json5/-/json5-0.0.29.tgz",
+ "integrity": "sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==",
+ "dev": true
},
"node_modules/@types/lodash": {
"version": "4.14.182",
@@ -3069,18 +3083,6 @@
"acorn": "^6.0.0 || ^7.0.0 || ^8.0.0"
}
},
- "node_modules/aggregate-error": {
- "version": "3.1.0",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "clean-stack": "^2.0.0",
- "indent-string": "^4.0.0"
- },
- "engines": {
- "node": ">=8"
- }
- },
"node_modules/ajv": {
"version": "8.11.0",
"license": "MIT",
@@ -3124,17 +3126,6 @@
"string-width": "^4.1.0"
}
},
- "node_modules/ansi-colors": {
- "version": "4.1.3",
- "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz",
- "integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==",
- "dev": true,
- "optional": true,
- "peer": true,
- "engines": {
- "node": ">=6"
- }
- },
"node_modules/ansi-escapes": {
"version": "4.3.2",
"dev": true,
@@ -3246,6 +3237,25 @@
"node": ">=8"
}
},
+ "node_modules/array.prototype.findlastindex": {
+ "version": "1.2.2",
+ "resolved": "https://registry.npmjs.org/array.prototype.findlastindex/-/array.prototype.findlastindex-1.2.2.tgz",
+ "integrity": "sha512-tb5thFFlUcp7NdNF6/MpDk/1r/4awWG1FIz3YqDf+/zJSTezBb+/5WViH41obXULHVpDzoiCLpJ/ZO9YbJMsdw==",
+ "dev": true,
+ "dependencies": {
+ "call-bind": "^1.0.2",
+ "define-properties": "^1.1.4",
+ "es-abstract": "^1.20.4",
+ "es-shim-unscopables": "^1.0.0",
+ "get-intrinsic": "^1.1.3"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
"node_modules/array.prototype.flat": {
"version": "1.3.1",
"dev": true,
@@ -3285,14 +3295,6 @@
"dev": true,
"license": "ISC"
},
- "node_modules/astral-regex": {
- "version": "2.0.0",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=8"
- }
- },
"node_modules/asynckit": {
"version": "0.4.0",
"dev": true,
@@ -3820,10 +3822,10 @@
"dev": true
},
"node_modules/builtins": {
- "version": "4.1.0",
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/builtins/-/builtins-5.0.1.tgz",
+ "integrity": "sha512-qwVpFEHNfhYJIzNRBvd2C1kyo6jz3ZSMPyyuR47OPdiKWlbYnZNyDWuyR175qDnAJLiCo5fBBqPb3RiXgWlkOQ==",
"dev": true,
- "license": "MIT",
- "peer": true,
"dependencies": {
"semver": "^7.0.0"
}
@@ -3926,7 +3928,9 @@
"license": "MIT"
},
"node_modules/caniuse-lite": {
- "version": "1.0.30001441",
+ "version": "1.0.30001521",
+ "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001521.tgz",
+ "integrity": "sha512-fnx1grfpEOvDGH+V17eccmNjucGUnCbP6KL+l5KqBIerp26WK/+RQ7CIDE37KGJjaPyqWXXlFUyKiWmvdNNKmQ==",
"funding": [
{
"type": "opencollective",
@@ -3935,9 +3939,12 @@
{
"type": "tidelift",
"url": "https://tidelift.com/funding/github/npm/caniuse-lite"
+ },
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/ai"
}
- ],
- "license": "CC-BY-4.0"
+ ]
},
"node_modules/capital-case": {
"version": "1.0.4",
@@ -4126,14 +4133,6 @@
"version": "2.3.1",
"license": "MIT"
},
- "node_modules/clean-stack": {
- "version": "2.2.0",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=6"
- }
- },
"node_modules/cli-boxes": {
"version": "3.0.0",
"license": "MIT",
@@ -4145,14 +4144,17 @@
}
},
"node_modules/cli-cursor": {
- "version": "3.1.0",
- "dev": true,
- "license": "MIT",
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-4.0.0.tgz",
+ "integrity": "sha512-VGtlMu3x/4DOtIUwEkRezxUZ2lBacNJCHash0N0WeZDBS+7Ux1dm3XWAgWYxLJFMMdOeXMHXorshEFhbMSGelg==",
"dependencies": {
- "restore-cursor": "^3.1.0"
+ "restore-cursor": "^4.0.0"
},
"engines": {
- "node": ">=8"
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
}
},
"node_modules/cli-spinners": {
@@ -4168,8 +4170,9 @@
},
"node_modules/cli-truncate": {
"version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/cli-truncate/-/cli-truncate-3.1.0.tgz",
+ "integrity": "sha512-wfOBkjXteqSnI59oPcJkcPl/ZmwvMMOj340qUIY1SKZCv0B9Cf4D4fAucRkIKQmsIuYK3x1rrgU7MeGRruiuiA==",
"dev": true,
- "license": "MIT",
"dependencies": {
"slice-ansi": "^5.0.0",
"string-width": "^5.0.0"
@@ -4181,24 +4184,14 @@
"url": "https://github.com/sponsors/sindresorhus"
}
},
- "node_modules/cli-truncate/node_modules/is-fullwidth-code-point": {
- "version": "4.0.0",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=12"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
"node_modules/cli-truncate/node_modules/string-width": {
- "version": "5.0.1",
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz",
+ "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==",
"dev": true,
- "license": "MIT",
"dependencies": {
+ "eastasianwidth": "^0.2.0",
"emoji-regex": "^9.2.2",
- "is-fullwidth-code-point": "^4.0.0",
"strip-ansi": "^7.0.1"
},
"engines": {
@@ -4309,9 +4302,10 @@
"license": "MIT"
},
"node_modules/colorette": {
- "version": "2.0.19",
- "dev": true,
- "license": "MIT"
+ "version": "2.0.20",
+ "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz",
+ "integrity": "sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==",
+ "dev": true
},
"node_modules/combined-stream": {
"version": "1.0.8",
@@ -5094,20 +5088,6 @@
"node": ">=10.13.0"
}
},
- "node_modules/enquirer": {
- "version": "2.3.6",
- "resolved": "https://registry.npmjs.org/enquirer/-/enquirer-2.3.6.tgz",
- "integrity": "sha512-yjNnPr315/FjS4zIsUxYguYUPP2e1NK4d7E7ZOLiyYCcbFBiTMyID+2wvm2w6+pZ/odMA7cRkjhsPbltwBOrLg==",
- "dev": true,
- "optional": true,
- "peer": true,
- "dependencies": {
- "ansi-colors": "^4.1.1"
- },
- "engines": {
- "node": ">=8.6"
- }
- },
"node_modules/ensure-posix-path": {
"version": "1.1.1",
"license": "ISC"
@@ -5234,15 +5214,15 @@
}
},
"node_modules/eslint": {
- "version": "8.46.0",
- "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.46.0.tgz",
- "integrity": "sha512-cIO74PvbW0qU8e0mIvk5IV3ToWdCq5FYG6gWPHHkx6gNdjlbAYvtfHmlCMXxjcoVaIdwy/IAt3+mDkZkfvb2Dg==",
+ "version": "8.47.0",
+ "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.47.0.tgz",
+ "integrity": "sha512-spUQWrdPt+pRVP1TTJLmfRNJJHHZryFmptzcafwSvHsceV81djHOdnEeDmkdotZyLNjDhrOasNK8nikkoG1O8Q==",
"dev": true,
"dependencies": {
"@eslint-community/eslint-utils": "^4.2.0",
"@eslint-community/regexpp": "^4.6.1",
- "@eslint/eslintrc": "^2.1.1",
- "@eslint/js": "^8.46.0",
+ "@eslint/eslintrc": "^2.1.2",
+ "@eslint/js": "^8.47.0",
"@humanwhocodes/config-array": "^0.11.10",
"@humanwhocodes/module-importer": "^1.0.1",
"@nodelib/fs.walk": "^1.2.8",
@@ -5253,7 +5233,7 @@
"doctrine": "^3.0.0",
"escape-string-regexp": "^4.0.0",
"eslint-scope": "^7.2.2",
- "eslint-visitor-keys": "^3.4.2",
+ "eslint-visitor-keys": "^3.4.3",
"espree": "^9.6.1",
"esquery": "^1.4.2",
"esutils": "^2.0.2",
@@ -5300,7 +5280,9 @@
}
},
"node_modules/eslint-config-standard": {
- "version": "17.0.0",
+ "version": "17.1.0",
+ "resolved": "https://registry.npmjs.org/eslint-config-standard/-/eslint-config-standard-17.1.0.tgz",
+ "integrity": "sha512-IwHwmaBNtDK4zDHQukFDW5u/aTb8+meQWZvNFWkiGmbWjD6bqyuSSBxxXKkCftCUzc1zwCH2m/baCNDLGmuO5Q==",
"dev": true,
"funding": [
{
@@ -5316,11 +5298,13 @@
"url": "https://feross.org/support"
}
],
- "license": "MIT",
+ "engines": {
+ "node": ">=12.0.0"
+ },
"peerDependencies": {
"eslint": "^8.0.1",
"eslint-plugin-import": "^2.25.2",
- "eslint-plugin-n": "^15.0.0",
+ "eslint-plugin-n": "^15.0.0 || ^16.0.0 ",
"eslint-plugin-promise": "^6.0.0"
}
},
@@ -5423,45 +5407,49 @@
"ms": "^2.1.1"
}
},
- "node_modules/eslint-plugin-es": {
- "version": "4.1.0",
+ "node_modules/eslint-plugin-es-x": {
+ "version": "7.2.0",
+ "resolved": "https://registry.npmjs.org/eslint-plugin-es-x/-/eslint-plugin-es-x-7.2.0.tgz",
+ "integrity": "sha512-9dvv5CcvNjSJPqnS5uZkqb3xmbeqRLnvXKK7iI5+oK/yTusyc46zbBZKENGsOfojm/mKfszyZb+wNqNPAPeGXA==",
"dev": true,
- "license": "MIT",
- "peer": true,
"dependencies": {
- "eslint-utils": "^2.0.0",
- "regexpp": "^3.0.0"
+ "@eslint-community/eslint-utils": "^4.1.2",
+ "@eslint-community/regexpp": "^4.6.0"
},
"engines": {
- "node": ">=8.10.0"
+ "node": "^14.18.0 || >=16.0.0"
},
"funding": {
- "url": "https://github.com/sponsors/mysticatea"
+ "url": "https://github.com/sponsors/ota-meshi"
},
"peerDependencies": {
- "eslint": ">=4.19.1"
+ "eslint": ">=8"
}
},
"node_modules/eslint-plugin-import": {
- "version": "2.27.5",
+ "version": "2.28.0",
+ "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.28.0.tgz",
+ "integrity": "sha512-B8s/n+ZluN7sxj9eUf7/pRFERX0r5bnFA2dCaLHy2ZeaQEAz0k+ZZkFWRFHJAqxfxQDx6KLv9LeIki7cFdwW+Q==",
"dev": true,
- "license": "MIT",
"dependencies": {
"array-includes": "^3.1.6",
+ "array.prototype.findlastindex": "^1.2.2",
"array.prototype.flat": "^1.3.1",
"array.prototype.flatmap": "^1.3.1",
"debug": "^3.2.7",
"doctrine": "^2.1.0",
"eslint-import-resolver-node": "^0.3.7",
- "eslint-module-utils": "^2.7.4",
+ "eslint-module-utils": "^2.8.0",
"has": "^1.0.3",
- "is-core-module": "^2.11.0",
+ "is-core-module": "^2.12.1",
"is-glob": "^4.0.3",
"minimatch": "^3.1.2",
+ "object.fromentries": "^2.0.6",
+ "object.groupby": "^1.0.0",
"object.values": "^1.1.6",
- "resolve": "^1.22.1",
- "semver": "^6.3.0",
- "tsconfig-paths": "^3.14.1"
+ "resolve": "^1.22.3",
+ "semver": "^6.3.1",
+ "tsconfig-paths": "^3.14.2"
},
"engines": {
"node": ">=4"
@@ -5510,9 +5498,10 @@
}
},
"node_modules/eslint-plugin-import/node_modules/semver": {
- "version": "6.3.0",
+ "version": "6.3.1",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz",
+ "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==",
"dev": true,
- "license": "ISC",
"bin": {
"semver": "bin/semver.js"
}
@@ -5563,22 +5552,22 @@
}
},
"node_modules/eslint-plugin-n": {
- "version": "15.2.0",
+ "version": "16.0.1",
+ "resolved": "https://registry.npmjs.org/eslint-plugin-n/-/eslint-plugin-n-16.0.1.tgz",
+ "integrity": "sha512-CDmHegJN0OF3L5cz5tATH84RPQm9kG+Yx39wIqIwPR2C0uhBGMWfbbOtetR83PQjjidA5aXMu+LEFw1jaSwvTA==",
"dev": true,
- "license": "MIT",
- "peer": true,
"dependencies": {
- "builtins": "^4.0.0",
- "eslint-plugin-es": "^4.1.0",
- "eslint-utils": "^3.0.0",
- "ignore": "^5.1.1",
- "is-core-module": "^2.3.0",
- "minimatch": "^3.0.4",
- "resolve": "^1.10.1",
- "semver": "^6.3.0"
+ "@eslint-community/eslint-utils": "^4.4.0",
+ "builtins": "^5.0.1",
+ "eslint-plugin-es-x": "^7.1.0",
+ "ignore": "^5.2.4",
+ "is-core-module": "^2.12.1",
+ "minimatch": "^3.1.2",
+ "resolve": "^1.22.2",
+ "semver": "^7.5.3"
},
"engines": {
- "node": ">=12.22.0"
+ "node": ">=16.0.0"
},
"funding": {
"url": "https://github.com/sponsors/mysticatea"
@@ -5591,35 +5580,15 @@
"version": "1.1.11",
"dev": true,
"license": "MIT",
- "peer": true,
"dependencies": {
"balanced-match": "^1.0.0",
"concat-map": "0.0.1"
}
},
- "node_modules/eslint-plugin-n/node_modules/eslint-utils": {
- "version": "3.0.0",
- "dev": true,
- "license": "MIT",
- "peer": true,
- "dependencies": {
- "eslint-visitor-keys": "^2.0.0"
- },
- "engines": {
- "node": "^10.0.0 || ^12.0.0 || >= 14.0.0"
- },
- "funding": {
- "url": "https://github.com/sponsors/mysticatea"
- },
- "peerDependencies": {
- "eslint": ">=5"
- }
- },
"node_modules/eslint-plugin-n/node_modules/minimatch": {
"version": "3.1.2",
"dev": true,
"license": "ISC",
- "peer": true,
"dependencies": {
"brace-expansion": "^1.1.7"
},
@@ -5627,84 +5596,11 @@
"node": "*"
}
},
- "node_modules/eslint-plugin-n/node_modules/semver": {
- "version": "6.3.0",
- "dev": true,
- "license": "ISC",
- "peer": true,
- "bin": {
- "semver": "bin/semver.js"
- }
- },
- "node_modules/eslint-plugin-node": {
- "version": "11.1.0",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "eslint-plugin-es": "^3.0.0",
- "eslint-utils": "^2.0.0",
- "ignore": "^5.1.1",
- "minimatch": "^3.0.4",
- "resolve": "^1.10.1",
- "semver": "^6.1.0"
- },
- "engines": {
- "node": ">=8.10.0"
- },
- "peerDependencies": {
- "eslint": ">=5.16.0"
- }
- },
- "node_modules/eslint-plugin-node/node_modules/brace-expansion": {
- "version": "1.1.11",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "balanced-match": "^1.0.0",
- "concat-map": "0.0.1"
- }
- },
- "node_modules/eslint-plugin-node/node_modules/eslint-plugin-es": {
- "version": "3.0.1",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "eslint-utils": "^2.0.0",
- "regexpp": "^3.0.0"
- },
- "engines": {
- "node": ">=8.10.0"
- },
- "funding": {
- "url": "https://github.com/sponsors/mysticatea"
- },
- "peerDependencies": {
- "eslint": ">=4.19.1"
- }
- },
- "node_modules/eslint-plugin-node/node_modules/minimatch": {
- "version": "3.1.1",
- "dev": true,
- "license": "ISC",
- "dependencies": {
- "brace-expansion": "^1.1.7"
- },
- "engines": {
- "node": "*"
- }
- },
- "node_modules/eslint-plugin-node/node_modules/semver": {
- "version": "6.3.0",
- "dev": true,
- "license": "ISC",
- "bin": {
- "semver": "bin/semver.js"
- }
- },
"node_modules/eslint-plugin-promise": {
- "version": "6.0.0",
+ "version": "6.1.1",
+ "resolved": "https://registry.npmjs.org/eslint-plugin-promise/-/eslint-plugin-promise-6.1.1.tgz",
+ "integrity": "sha512-tjqWDwVZQo7UIPMeDReOpUgHCmCiH+ePnVT+5zVapL0uuHnegBUs2smM13CzOs2Xb5+MHMRFTs9v24yjba4Oig==",
"dev": true,
- "license": "ISC",
"engines": {
"node": "^12.22.0 || ^14.17.0 || >=16.0.0"
},
@@ -5728,37 +5624,6 @@
"url": "https://opencollective.com/eslint"
}
},
- "node_modules/eslint-utils": {
- "version": "2.1.0",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "eslint-visitor-keys": "^1.1.0"
- },
- "engines": {
- "node": ">=6"
- },
- "funding": {
- "url": "https://github.com/sponsors/mysticatea"
- }
- },
- "node_modules/eslint-utils/node_modules/eslint-visitor-keys": {
- "version": "1.3.0",
- "dev": true,
- "license": "Apache-2.0",
- "engines": {
- "node": ">=4"
- }
- },
- "node_modules/eslint-visitor-keys": {
- "version": "2.1.0",
- "dev": true,
- "license": "Apache-2.0",
- "peer": true,
- "engines": {
- "node": ">=10"
- }
- },
"node_modules/eslint/node_modules/ajv": {
"version": "6.12.6",
"dev": true,
@@ -5799,9 +5664,9 @@
}
},
"node_modules/eslint/node_modules/eslint-visitor-keys": {
- "version": "3.4.2",
- "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.2.tgz",
- "integrity": "sha512-8drBzUEyZ2llkpCA67iYrgEssKDUu68V8ChqqOfFupIaG/LCVPUT+CoGJpT77zJprs4T/W7p07LP7zAIMuweVw==",
+ "version": "3.4.3",
+ "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz",
+ "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==",
"dev": true,
"engines": {
"node": "^12.22.0 || ^14.17.0 || >=16.0.0"
@@ -5943,9 +5808,9 @@
}
},
"node_modules/espree/node_modules/eslint-visitor-keys": {
- "version": "3.4.2",
- "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.2.tgz",
- "integrity": "sha512-8drBzUEyZ2llkpCA67iYrgEssKDUu68V8ChqqOfFupIaG/LCVPUT+CoGJpT77zJprs4T/W7p07LP7zAIMuweVw==",
+ "version": "3.4.3",
+ "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz",
+ "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==",
"dev": true,
"engines": {
"node": "^12.22.0 || ^14.17.0 || >=16.0.0"
@@ -7610,14 +7475,6 @@
"node": ">=0.8.19"
}
},
- "node_modules/indent-string": {
- "version": "4.0.0",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=8"
- }
- },
"node_modules/inflight": {
"version": "1.0.6",
"dev": true,
@@ -7774,9 +7631,10 @@
}
},
"node_modules/is-core-module": {
- "version": "2.12.1",
+ "version": "2.13.0",
+ "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.13.0.tgz",
+ "integrity": "sha512-Z7dk6Qo8pOCp3l4tsX2C5ZVas4V+UxwQodwZhLopL91TX8UyyHEXafPcyoeeWuLrwzHcr3igO78wNLwHJHsMCQ==",
"dev": true,
- "license": "MIT",
"dependencies": {
"has": "^1.0.3"
},
@@ -9360,9 +9218,10 @@
}
},
"node_modules/lilconfig": {
- "version": "2.0.5",
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-2.1.0.tgz",
+ "integrity": "sha512-utWOt/GHzuUxnLKxB6dk81RoOeoNeHgbrXiuGk4yyF5qlRz+iIVWu56E2fqGHFrXz0QNUhLB/8nKqvRH66JKGQ==",
"dev": true,
- "license": "MIT",
"engines": {
"node": ">=10"
}
@@ -9382,50 +9241,41 @@
}
},
"node_modules/lint-staged": {
- "version": "13.0.3",
+ "version": "14.0.0",
+ "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-14.0.0.tgz",
+ "integrity": "sha512-0tLf0pqZYkar/wu3nTctk4rVIG+d7PanDYv4/IQR4qwdqfQkTDziLRFnqMcLuLBTuUqmcLwsHPD2EjQ18d/oaA==",
"dev": true,
- "license": "MIT",
"dependencies": {
- "cli-truncate": "^3.1.0",
- "colorette": "^2.0.17",
- "commander": "^9.3.0",
- "debug": "^4.3.4",
- "execa": "^6.1.0",
- "lilconfig": "2.0.5",
- "listr2": "^4.0.5",
- "micromatch": "^4.0.5",
- "normalize-path": "^3.0.0",
- "object-inspect": "^1.12.2",
- "pidtree": "^0.6.0",
- "string-argv": "^0.3.1",
- "yaml": "^2.1.1"
+ "chalk": "5.3.0",
+ "commander": "11.0.0",
+ "debug": "4.3.4",
+ "execa": "7.2.0",
+ "lilconfig": "2.1.0",
+ "listr2": "6.6.1",
+ "micromatch": "4.0.5",
+ "pidtree": "0.6.0",
+ "string-argv": "0.3.2",
+ "yaml": "2.3.1"
},
"bin": {
"lint-staged": "bin/lint-staged.js"
},
"engines": {
- "node": "^14.13.1 || >=16.0.0"
+ "node": "^16.14.0 || >=18.0.0"
},
"funding": {
"url": "https://opencollective.com/lint-staged"
}
},
- "node_modules/lint-staged/node_modules/commander": {
- "version": "9.5.0",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": "^12.20.0 || >=14"
- }
- },
"node_modules/lint-staged/node_modules/execa": {
- "version": "6.1.0",
+ "version": "7.2.0",
+ "resolved": "https://registry.npmjs.org/execa/-/execa-7.2.0.tgz",
+ "integrity": "sha512-UduyVP7TLB5IcAQl+OzLyLcS/l32W/GLg+AhHJ+ow40FOk2U3SAllPwR44v4vmdFwIWqpdwxxpQbF1n5ta9seA==",
"dev": true,
- "license": "MIT",
"dependencies": {
"cross-spawn": "^7.0.3",
"get-stream": "^6.0.1",
- "human-signals": "^3.0.1",
+ "human-signals": "^4.3.0",
"is-stream": "^3.0.0",
"merge-stream": "^2.0.0",
"npm-run-path": "^5.1.0",
@@ -9434,24 +9284,26 @@
"strip-final-newline": "^3.0.0"
},
"engines": {
- "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ "node": "^14.18.0 || ^16.14.0 || >=18.0.0"
},
"funding": {
"url": "https://github.com/sindresorhus/execa?sponsor=1"
}
},
"node_modules/lint-staged/node_modules/human-signals": {
- "version": "3.0.1",
+ "version": "4.3.1",
+ "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-4.3.1.tgz",
+ "integrity": "sha512-nZXjEF2nbo7lIw3mgYjItAfgQXog3OjJogSbKa2CQIIvSGWcKgeJnQlNXip6NglNzYH45nSRiEVimMvYL8DDqQ==",
"dev": true,
- "license": "Apache-2.0",
"engines": {
- "node": ">=12.20.0"
+ "node": ">=14.18.0"
}
},
"node_modules/lint-staged/node_modules/is-stream": {
"version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-3.0.0.tgz",
+ "integrity": "sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==",
"dev": true,
- "license": "MIT",
"engines": {
"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
},
@@ -9461,8 +9313,9 @@
},
"node_modules/lint-staged/node_modules/mimic-fn": {
"version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-4.0.0.tgz",
+ "integrity": "sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw==",
"dev": true,
- "license": "MIT",
"engines": {
"node": ">=12"
},
@@ -9472,8 +9325,9 @@
},
"node_modules/lint-staged/node_modules/npm-run-path": {
"version": "5.1.0",
+ "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.1.0.tgz",
+ "integrity": "sha512-sJOdmRGrY2sjNTRMbSvluQqg+8X7ZK61yvzBEIDhz4f8z1TZFYABsqjjCBd/0PUNE9M6QDgHJXQkGUEm7Q+l9Q==",
"dev": true,
- "license": "MIT",
"dependencies": {
"path-key": "^4.0.0"
},
@@ -9486,8 +9340,9 @@
},
"node_modules/lint-staged/node_modules/onetime": {
"version": "6.0.0",
+ "resolved": "https://registry.npmjs.org/onetime/-/onetime-6.0.0.tgz",
+ "integrity": "sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ==",
"dev": true,
- "license": "MIT",
"dependencies": {
"mimic-fn": "^4.0.0"
},
@@ -9500,8 +9355,9 @@
},
"node_modules/lint-staged/node_modules/path-key": {
"version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/path-key/-/path-key-4.0.0.tgz",
+ "integrity": "sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ==",
"dev": true,
- "license": "MIT",
"engines": {
"node": ">=12"
},
@@ -9511,8 +9367,9 @@
},
"node_modules/lint-staged/node_modules/strip-final-newline": {
"version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-3.0.0.tgz",
+ "integrity": "sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw==",
"dev": true,
- "license": "MIT",
"engines": {
"node": ">=12"
},
@@ -9547,21 +9404,20 @@
}
},
"node_modules/listr2": {
- "version": "4.0.5",
+ "version": "6.6.1",
+ "resolved": "https://registry.npmjs.org/listr2/-/listr2-6.6.1.tgz",
+ "integrity": "sha512-+rAXGHh0fkEWdXBmX+L6mmfmXmXvDGEKzkjxO+8mP3+nI/r/CWznVBvsibXdxda9Zz0OW2e2ikphN3OwCT/jSg==",
"dev": true,
- "license": "MIT",
"dependencies": {
- "cli-truncate": "^2.1.0",
- "colorette": "^2.0.16",
- "log-update": "^4.0.0",
- "p-map": "^4.0.0",
+ "cli-truncate": "^3.1.0",
+ "colorette": "^2.0.20",
+ "eventemitter3": "^5.0.1",
+ "log-update": "^5.0.1",
"rfdc": "^1.3.0",
- "rxjs": "^7.5.5",
- "through": "^2.3.8",
- "wrap-ansi": "^7.0.0"
+ "wrap-ansi": "^8.1.0"
},
"engines": {
- "node": ">=12"
+ "node": ">=16.0.0"
},
"peerDependencies": {
"enquirer": ">= 2.3.0 < 3"
@@ -9572,32 +9428,56 @@
}
}
},
- "node_modules/listr2/node_modules/cli-truncate": {
- "version": "2.1.0",
+ "node_modules/listr2/node_modules/ansi-styles": {
+ "version": "6.2.1",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz",
+ "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==",
+ "dev": true,
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+ }
+ },
+ "node_modules/listr2/node_modules/eventemitter3": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-5.0.1.tgz",
+ "integrity": "sha512-GWkBvjiSZK87ELrYOSESUYeVIc9mvLLf/nXalMOS5dYrgZq9o5OVkbZAVM06CVxYsCwH9BDZFPlQTlPA1j4ahA==",
+ "dev": true
+ },
+ "node_modules/listr2/node_modules/string-width": {
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz",
+ "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==",
"dev": true,
- "license": "MIT",
"dependencies": {
- "slice-ansi": "^3.0.0",
- "string-width": "^4.2.0"
+ "eastasianwidth": "^0.2.0",
+ "emoji-regex": "^9.2.2",
+ "strip-ansi": "^7.0.1"
},
"engines": {
- "node": ">=8"
+ "node": ">=12"
},
"funding": {
"url": "https://github.com/sponsors/sindresorhus"
}
},
- "node_modules/listr2/node_modules/slice-ansi": {
- "version": "3.0.0",
+ "node_modules/listr2/node_modules/wrap-ansi": {
+ "version": "8.1.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz",
+ "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==",
"dev": true,
- "license": "MIT",
"dependencies": {
- "ansi-styles": "^4.0.0",
- "astral-regex": "^2.0.0",
- "is-fullwidth-code-point": "^3.0.0"
+ "ansi-styles": "^6.1.0",
+ "string-width": "^5.0.1",
+ "strip-ansi": "^7.0.1"
},
"engines": {
- "node": ">=8"
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
}
},
"node_modules/locate-path": {
@@ -9657,60 +9537,95 @@
}
},
"node_modules/log-update": {
- "version": "4.0.0",
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/log-update/-/log-update-5.0.1.tgz",
+ "integrity": "sha512-5UtUDQ/6edw4ofyljDNcOVJQ4c7OjDro4h3y8e1GQL5iYElYclVHJ3zeWchylvMaKnDbDilC8irOVyexnA/Slw==",
"dev": true,
- "license": "MIT",
"dependencies": {
- "ansi-escapes": "^4.3.0",
- "cli-cursor": "^3.1.0",
- "slice-ansi": "^4.0.0",
- "wrap-ansi": "^6.2.0"
+ "ansi-escapes": "^5.0.0",
+ "cli-cursor": "^4.0.0",
+ "slice-ansi": "^5.0.0",
+ "strip-ansi": "^7.0.1",
+ "wrap-ansi": "^8.0.1"
},
"engines": {
- "node": ">=10"
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
},
"funding": {
"url": "https://github.com/sponsors/sindresorhus"
}
},
- "node_modules/log-update/node_modules/slice-ansi": {
- "version": "4.0.0",
+ "node_modules/log-update/node_modules/ansi-escapes": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-5.0.0.tgz",
+ "integrity": "sha512-5GFMVX8HqE/TB+FuBJGuO5XG0WrsA6ptUqoODaT/n9mmUaZFkqnBueB4leqGBCmrUHnCnC4PCZTCd0E7QQ83bA==",
"dev": true,
- "license": "MIT",
"dependencies": {
- "ansi-styles": "^4.0.0",
- "astral-regex": "^2.0.0",
- "is-fullwidth-code-point": "^3.0.0"
+ "type-fest": "^1.0.2"
},
"engines": {
- "node": ">=10"
+ "node": ">=12"
},
"funding": {
- "url": "https://github.com/chalk/slice-ansi?sponsor=1"
+ "url": "https://github.com/sponsors/sindresorhus"
}
},
- "node_modules/log-update/node_modules/strip-ansi": {
- "version": "6.0.1",
+ "node_modules/log-update/node_modules/ansi-styles": {
+ "version": "6.2.1",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz",
+ "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==",
+ "dev": true,
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+ }
+ },
+ "node_modules/log-update/node_modules/string-width": {
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz",
+ "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==",
"dev": true,
- "license": "MIT",
"dependencies": {
- "ansi-regex": "^5.0.1"
+ "eastasianwidth": "^0.2.0",
+ "emoji-regex": "^9.2.2",
+ "strip-ansi": "^7.0.1"
},
"engines": {
- "node": ">=8"
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/log-update/node_modules/type-fest": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-1.4.0.tgz",
+ "integrity": "sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==",
+ "dev": true,
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
}
},
"node_modules/log-update/node_modules/wrap-ansi": {
- "version": "6.2.0",
+ "version": "8.1.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz",
+ "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==",
"dev": true,
- "license": "MIT",
"dependencies": {
- "ansi-styles": "^4.0.0",
- "string-width": "^4.1.0",
- "strip-ansi": "^6.0.0"
+ "ansi-styles": "^6.1.0",
+ "string-width": "^5.0.1",
+ "strip-ansi": "^7.0.1"
},
"engines": {
- "node": ">=8"
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
}
},
"node_modules/longest-streak": {
@@ -12555,6 +12470,35 @@
"url": "https://github.com/sponsors/ljharb"
}
},
+ "node_modules/object.fromentries": {
+ "version": "2.0.6",
+ "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.6.tgz",
+ "integrity": "sha512-VciD13dswC4j1Xt5394WR4MzmAQmlgN72phd/riNp9vtD7tp4QQWJ0R4wvclXcafgcYK8veHRed2W6XeGBvcfg==",
+ "dev": true,
+ "dependencies": {
+ "call-bind": "^1.0.2",
+ "define-properties": "^1.1.4",
+ "es-abstract": "^1.20.4"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/object.groupby": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/object.groupby/-/object.groupby-1.0.0.tgz",
+ "integrity": "sha512-70MWG6NfRH9GnbZOikuhPPYzpUpof9iW2J9E4dW7FXTqPNb6rllE6u39SKwwiNh8lCwX3DDb5OgcKGiEBrTTyw==",
+ "dev": true,
+ "dependencies": {
+ "call-bind": "^1.0.2",
+ "define-properties": "^1.2.0",
+ "es-abstract": "^1.21.2",
+ "get-intrinsic": "^1.2.1"
+ }
+ },
"node_modules/object.values": {
"version": "1.1.6",
"dev": true,
@@ -12665,40 +12609,11 @@
"url": "https://github.com/sponsors/sindresorhus"
}
},
- "node_modules/ora/node_modules/cli-cursor": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-4.0.0.tgz",
- "integrity": "sha512-VGtlMu3x/4DOtIUwEkRezxUZ2lBacNJCHash0N0WeZDBS+7Ux1dm3XWAgWYxLJFMMdOeXMHXorshEFhbMSGelg==",
- "dependencies": {
- "restore-cursor": "^4.0.0"
- },
- "engines": {
- "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
"node_modules/ora/node_modules/emoji-regex": {
"version": "10.2.1",
"resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.2.1.tgz",
"integrity": "sha512-97g6QgOk8zlDRdgq1WxwgTMgEWGVAQvB5Fdpgc1MkNy56la5SKP9GsMXKDOdqwn90/41a8yPwIGk1Y6WVbeMQA=="
},
- "node_modules/ora/node_modules/restore-cursor": {
- "version": "4.0.0",
- "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-4.0.0.tgz",
- "integrity": "sha512-I9fPXU9geO9bHOt9pHHOhOkYerIMsmVaWB0rA2AI9ERh/+x/i7MV5HKBNrg+ljO5eoPVgCcnFuRjJ9uH6I/3eg==",
- "dependencies": {
- "onetime": "^5.1.0",
- "signal-exit": "^3.0.2"
- },
- "engines": {
- "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
"node_modules/ora/node_modules/string-width": {
"version": "6.1.0",
"resolved": "https://registry.npmjs.org/string-width/-/string-width-6.1.0.tgz",
@@ -12763,20 +12678,6 @@
"url": "https://github.com/sponsors/sindresorhus"
}
},
- "node_modules/p-map": {
- "version": "4.0.0",
- "dev": true,
- "license": "MIT",
- "dependencies": {
- "aggregate-error": "^3.0.0"
- },
- "engines": {
- "node": ">=10"
- },
- "funding": {
- "url": "https://github.com/sponsors/sindresorhus"
- }
- },
"node_modules/p-queue": {
"version": "7.3.4",
"dev": true,
@@ -13740,17 +13641,6 @@
"url": "https://github.com/sponsors/ljharb"
}
},
- "node_modules/regexpp": {
- "version": "3.2.0",
- "dev": true,
- "license": "MIT",
- "engines": {
- "node": ">=8"
- },
- "funding": {
- "url": "https://github.com/sponsors/mysticatea"
- }
- },
"node_modules/rehype-highlight": {
"version": "6.0.0",
"license": "MIT",
@@ -14264,11 +14154,12 @@
"license": "MIT"
},
"node_modules/resolve": {
- "version": "1.22.1",
+ "version": "1.22.4",
+ "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.4.tgz",
+ "integrity": "sha512-PXNdCiPqDqeUou+w1C2eTQbNfxKSuMxqTCuvlmmMsk1NWHL5fRrhY6Pl0qEYYc6+QqGClco1Qj8XnjPego4wfg==",
"dev": true,
- "license": "MIT",
"dependencies": {
- "is-core-module": "^2.9.0",
+ "is-core-module": "^2.13.0",
"path-parse": "^1.0.7",
"supports-preserve-symlinks-flag": "^1.0.0"
},
@@ -14344,15 +14235,18 @@
}
},
"node_modules/restore-cursor": {
- "version": "3.1.0",
- "dev": true,
- "license": "MIT",
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-4.0.0.tgz",
+ "integrity": "sha512-I9fPXU9geO9bHOt9pHHOhOkYerIMsmVaWB0rA2AI9ERh/+x/i7MV5HKBNrg+ljO5eoPVgCcnFuRjJ9uH6I/3eg==",
"dependencies": {
"onetime": "^5.1.0",
"signal-exit": "^3.0.2"
},
"engines": {
- "node": ">=8"
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
}
},
"node_modules/reusify": {
@@ -14366,8 +14260,9 @@
},
"node_modules/rfdc": {
"version": "1.3.0",
- "dev": true,
- "license": "MIT"
+ "resolved": "https://registry.npmjs.org/rfdc/-/rfdc-1.3.0.tgz",
+ "integrity": "sha512-V2hovdzFbOi77/WajaSMXk2OLm+xNIeQdMMuB7icj7bk6zi2F8GGAxigcnDFpJHbNyNcgyJDiP+8nOrY5cZGrA==",
+ "dev": true
},
"node_modules/rimraf": {
"version": "5.0.0",
@@ -14843,8 +14738,9 @@
},
"node_modules/slice-ansi": {
"version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-5.0.0.tgz",
+ "integrity": "sha512-FC+lgizVPfie0kkhqUScwRu1O/lF6NOgJmlCgK+/LYxDCTk8sGelYaHDhFcDN+Sn3Cv+3VSa4Byeo+IMCzpMgQ==",
"dev": true,
- "license": "MIT",
"dependencies": {
"ansi-styles": "^6.0.0",
"is-fullwidth-code-point": "^4.0.0"
@@ -14857,9 +14753,10 @@
}
},
"node_modules/slice-ansi/node_modules/ansi-styles": {
- "version": "6.1.0",
+ "version": "6.2.1",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz",
+ "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==",
"dev": true,
- "license": "MIT",
"engines": {
"node": ">=12"
},
@@ -14869,8 +14766,9 @@
},
"node_modules/slice-ansi/node_modules/is-fullwidth-code-point": {
"version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-4.0.0.tgz",
+ "integrity": "sha512-O4L094N2/dZ7xqVdrXhh9r1KODPJpFms8B5sGdJLPy664AgvXsreZUyCQQNItZRDlYug4xStLjNp/sz3HvBowQ==",
"dev": true,
- "license": "MIT",
"engines": {
"node": ">=12"
},
@@ -15125,9 +15023,10 @@
"license": "MIT"
},
"node_modules/string-argv": {
- "version": "0.3.1",
+ "version": "0.3.2",
+ "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.2.tgz",
+ "integrity": "sha512-aqD2Q0144Z+/RqG52NeHEkZauTAUWJO8c6yTftGJKO3Tja5tUgIfmIl6kExvhtxSDP7fXB6DvzkfMpCd/F3G+Q==",
"dev": true,
- "license": "MIT",
"engines": {
"node": ">=0.6.19"
}
@@ -15720,20 +15619,22 @@
}
},
"node_modules/tsconfig-paths": {
- "version": "3.14.1",
+ "version": "3.14.2",
+ "resolved": "https://registry.npmjs.org/tsconfig-paths/-/tsconfig-paths-3.14.2.tgz",
+ "integrity": "sha512-o/9iXgCYc5L/JxCHPe3Hvh8Q/2xm5Z+p18PESBU6Ff33695QnCHBEjcytY2q19ua7Mbl/DavtBOLq+oG0RCL+g==",
"dev": true,
- "license": "MIT",
"dependencies": {
"@types/json5": "^0.0.29",
- "json5": "^1.0.1",
+ "json5": "^1.0.2",
"minimist": "^1.2.6",
"strip-bom": "^3.0.0"
}
},
"node_modules/tsconfig-paths/node_modules/json5": {
"version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/json5/-/json5-1.0.2.tgz",
+ "integrity": "sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA==",
"dev": true,
- "license": "MIT",
"dependencies": {
"minimist": "^1.2.0"
},
@@ -15743,8 +15644,9 @@
},
"node_modules/tsconfig-paths/node_modules/strip-bom": {
"version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz",
+ "integrity": "sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA==",
"dev": true,
- "license": "MIT",
"engines": {
"node": ">=4"
}
@@ -16647,9 +16549,10 @@
"license": "ISC"
},
"node_modules/yaml": {
- "version": "2.2.2",
+ "version": "2.3.1",
+ "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.3.1.tgz",
+ "integrity": "sha512-2eHWfjaoXgTBC2jNM1LRef62VQa0umtvRiDSk6HSzW7RvS5YtkabJrwYLLEKWBc8a5U2PTSCs+dJjUTJdlHsWQ==",
"dev": true,
- "license": "ISC",
"engines": {
"node": ">= 14"
}
diff --git a/package.json b/package.json
index fd50fbe6fa51..3e04ce695ddc 100644
--- a/package.json
+++ b/package.json
@@ -58,11 +58,11 @@
"dependencies": {
"@elastic/elasticsearch": "7.11.0",
"@github/failbot": "0.8.3",
- "@primer/behaviors": "^1.3.3",
- "@primer/css": "^21.0.1",
- "@primer/octicons": "^19.1.0",
- "@primer/octicons-react": "^19.1.0",
- "@primer/react": "35.27.0",
+ "@primer/behaviors": "^1.3.5",
+ "@primer/css": "^21.0.7",
+ "@primer/octicons": "^19.5.0",
+ "@primer/octicons-react": "^19.5.0",
+ "@primer/react": "35.27.1",
"accept-language-parser": "^1.5.0",
"ajv": "^8.11.0",
"ajv-errors": "^3.0.0",
@@ -163,14 +163,14 @@
"cross-env": "^7.0.3",
"csp-parse": "0.0.2",
"dedent": "^1.0.1",
- "eslint": "8.46.0",
+ "eslint": "8.47.0",
"eslint-config-prettier": "9.0.0",
- "eslint-config-standard": "^17.0.0",
+ "eslint-config-standard": "17.1.0",
"eslint-import-resolver-typescript": "^3.5.5",
- "eslint-plugin-import": "^2.27.5",
+ "eslint-plugin-import": "2.28.0",
"eslint-plugin-jsx-a11y": "^6.5.1",
- "eslint-plugin-node": "^11.1.0",
- "eslint-plugin-promise": "^6.0.0",
+ "eslint-plugin-n": "16.0.1",
+ "eslint-plugin-promise": "6.1.1",
"event-to-promise": "^0.8.0",
"graphql": "^16.5.0",
"http-status-code": "^2.1.0",
@@ -182,7 +182,7 @@
"jest-slow-test-reporter": "^1.0.0",
"json-schema-merge-allof": "^0.8.1",
"kill-port": "2.0.1",
- "lint-staged": "^13.0.1",
+ "lint-staged": "^14.0.0",
"make-promises-safe": "^5.1.0",
"markdownlint": "^0.28.2",
"markdownlint-rule-helpers": "^0.19.0",
diff --git a/script/find-orphaned-assets.js b/script/find-orphaned-assets.js
index efb9f19882a0..3cf09262a440 100755
--- a/script/find-orphaned-assets.js
+++ b/script/find-orphaned-assets.js
@@ -101,7 +101,7 @@ async function main(opts) {
'script',
'stylesheets',
'contributing',
- 'pages',
+ 'src',
'.github/actions-scripts',
]
diff --git a/script/update-tocs.js b/script/update-tocs.js
index 761da1e0bce5..7964ad1a2157 100755
--- a/script/update-tocs.js
+++ b/script/update-tocs.js
@@ -3,7 +3,7 @@
// [start-readme]
//
// This script creates or updates an index.md file for a given directory.
-// It will add `children` frontmatter in alphabetical order and create versions: '*'.
+// It will add `children` frontmatter in alphabetical order and create versions: { fpt: '*', ghes: '*', ghae: '*', ghec: '*' }.
// It also prints a helpful message to update those values manually if needed.
//
// [end-readme]
@@ -52,7 +52,7 @@ function updateOrCreateToc(directory) {
content = ''
data = {
title: sentenceCase(path.basename(directory)), // fake the title of the index.md from the directory name
- versions: '*', // default to all versions
+ versions: { fpt: '*', ghes: '*', ghae: '*', ghec: '*' }, // default to all versions
}
}
diff --git a/src/audit-logs/scripts/sync.js b/src/audit-logs/scripts/sync.js
new file mode 100755
index 000000000000..4c75cc8c4307
--- /dev/null
+++ b/src/audit-logs/scripts/sync.js
@@ -0,0 +1,154 @@
+#!/usr/bin/env node
+
+/**
+ * Required env variables:
+ *
+ * GITHUB_TOKEN
+ *
+ * Gets latest audit log event data, extracts the data we need for rendering on
+ * the 3 different audit log pages, and writes out the data to files versioned
+ * per page.
+ */
+import { existsSync } from 'fs'
+import { writeFile } from 'fs/promises'
+import { mkdirp } from 'mkdirp'
+import path from 'path'
+
+import { getContents } from '../../../script/helpers/git-utils.js'
+
+if (!process.env.GITHUB_TOKEN) {
+ throw new Error('GITHUB_TOKEN environment variable must be set to run this script')
+}
+
+const AUDIT_LOG_DATA_DIR = 'src/audit-logs/data'
+
+// the 3 different audit log types which correspond to audit log event pages
+const auditLogTypes = ['user', 'organization', 'enterprise']
+const versions = ['fpt', 'ghec', 'ghes']
+
+// store an array of audit log event data keyed by version and audit log type,
+// array will look like:
+//
+// [
+// {
+// "action": "repo.create",
+// "description": "description",
+// "docs_reference_link": "reference link",
+// },
+// ...
+// ]
+const auditLogData = {}
+versions.forEach((version) => {
+ auditLogData[version] = {}
+
+ auditLogTypes.forEach((type) => {
+ auditLogData[version][type] = []
+ })
+})
+
+async function main() {
+ // get latest audit log data
+ //
+ // an array of event objects that look like this (omitting fields we won't
+ // use):
+ //
+ // {
+ // "account.billing_date_change": {
+ // "description": "Event description",
+ // "docs_reference_links": "Event reference link (can be space or comma-space separated list of links)",
+ // }
+ // }
+ const owner = 'github'
+ const repo = 'audit-log-allowlists'
+ const ref = 'main'
+ const schemaFilePath = 'data/schema.json'
+ const schemaEvents = JSON.parse(await getContents(owner, repo, ref, schemaFilePath))
+
+ // translate allowLists values into the versions and audit log page the event
+ // belongs to -- for versions:
+ //
+ // * user => fpt
+ // * business => ghec
+ // * business_server => ghes
+ // * organization => fpt
+ //
+ // for audit log pages:
+ //
+ // * user => user page
+ // * business_server => enterprise page
+ // * organization => organization page
+ schemaEvents
+ .filter((event) => event._allowlists !== null)
+ .forEach((event) => {
+ const minimalEvent = {
+ action: event.action,
+ description: event.description,
+ docs_reference_links: event.docs_reference_links,
+ }
+
+ // FPT events
+ if (event._allowlists.includes('user')) {
+ auditLogData.fpt.user.push(minimalEvent)
+ }
+ if (event._allowlists.includes('organization')) {
+ auditLogData.fpt.organization.push(minimalEvent)
+ }
+
+ // GHES events
+ if (event._allowlists.includes('business_server')) {
+ auditLogData.ghes.enterprise.push(minimalEvent)
+
+ if (event._allowlists.includes('user')) {
+ auditLogData.ghes.user.push(minimalEvent)
+ }
+
+ if (event._allowlists.includes('organization')) {
+ auditLogData.ghes.organization.push(minimalEvent)
+ }
+ }
+
+ // GHEC events
+ if (event._allowlists.includes('business')) {
+ // If an event is on the business and business_server allowlist,
+ // it is an enterprise type event
+ if (event._allowlists.includes('business_server')) {
+ auditLogData.ghec.enterprise.push(minimalEvent)
+ }
+
+ if (event._allowlists.includes('organization')) {
+ auditLogData.ghec.organization.push(minimalEvent)
+ }
+
+ if (event._allowlists.includes('user')) {
+ auditLogData.ghec.user.push(minimalEvent)
+ }
+ }
+ })
+
+ // write out audit log event data to page event files per version e.g.:
+ //
+ // fpt/
+ // |- enterprise.json
+ // |- organization.json
+ // |- user.json
+ for (const version of Object.keys(auditLogData)) {
+ const auditLogVersionDirPath = path.join(AUDIT_LOG_DATA_DIR, version)
+
+ if (!existsSync(auditLogVersionDirPath)) {
+ await mkdirp(auditLogVersionDirPath)
+ }
+
+ auditLogTypes.forEach(async (type) => {
+ const auditLogSchemaFilePath = path.join(auditLogVersionDirPath, `${type}.json`)
+
+ if (auditLogData[version][type]) {
+ await writeFile(
+ auditLogSchemaFilePath,
+ JSON.stringify(auditLogData[version][type], null, 2),
+ )
+ }
+ })
+ }
+}
+
+main()
diff --git a/src/content-render/unified/rewrite-local-links.js b/src/content-render/unified/rewrite-local-links.js
index 424886d7c9fc..69d3167a106f 100644
--- a/src/content-render/unified/rewrite-local-links.js
+++ b/src/content-render/unified/rewrite-local-links.js
@@ -42,14 +42,20 @@ const matcherAnchorLinks = (node) =>
// Content authors write links like `/some/article/path`, but they need to be
// rewritten on the fly to match the current language and page version
export default function rewriteLocalLinks(context) {
- const { currentLanguage, currentVersion } = context
+ const { currentLanguage, autotitleLanguage, currentVersion } = context
// There's no languageCode or version passed, so nothing to do
if (!currentLanguage || !currentVersion) return
return async function (tree) {
const nodes = []
visit(tree, matcherInternalLinks, (node) => {
- const newHref = getNewHref(node, currentLanguage, currentVersion)
+ // The context *might* have a `autotitleLanguage` which can be
+ // different from the regular `currentLanguage`.
+ // This means that AUTOTITLE links should be different from how,
+ // for example, reusables or other `{% data ... %}` Liquid tags work.
+ // Our release notes, for example, prefer to force the rendered text
+ // in English, but all AUTOTITLE links in the current language.
+ const newHref = getNewHref(node, autotitleLanguage || currentLanguage, currentVersion)
if (newHref) {
node.properties.href = newHref
}
diff --git a/src/events/components/events.ts b/src/events/components/events.ts
index a450a1239bb7..78a7a12e80cd 100644
--- a/src/events/components/events.ts
+++ b/src/events/components/events.ts
@@ -65,38 +65,56 @@ export enum EventType {
}
type SendEventProps = {
- type: EventType
- version?: string
- exit_render_duration?: number
- exit_first_paint?: number
- exit_dom_interactive?: number
- exit_dom_complete?: number
- exit_visit_duration?: number
- exit_scroll_length?: number
- exit_scroll_flip?: number
- link_url?: string
- link_samesite?: boolean
- link_container?: string
- hover_url?: string
- hover_samesite?: boolean
- search_query?: string
- search_context?: string
- search_result_query?: string
- search_result_index?: number
- search_result_total?: number
- search_result_rank?: number
- search_result_url?: string
- survey_token?: string // Honeypot, doesn't exist in schema
- survey_vote?: boolean
- survey_comment?: string
- survey_email?: string
- experiment_name?: string
- experiment_variation?: string
- experiment_success?: boolean
- clipboard_operation?: string
- clipboard_target?: string
- preference_name?: string
- preference_value?: string
+ [EventType.clipboard]: {
+ clipboard_operation: string
+ clipboard_target?: string
+ }
+ [EventType.exit]: {
+ exit_render_duration?: number
+ exit_first_paint?: number
+ exit_dom_interactive?: number
+ exit_dom_complete?: number
+ exit_visit_duration?: number
+ exit_scroll_length?: number
+ exit_scroll_flip?: number
+ }
+ [EventType.experiment]: {
+ experiment_name: string
+ experiment_variation: string
+ experiment_success?: boolean
+ }
+ [EventType.hover]: {
+ hover_url: string
+ hover_samesite?: boolean
+ }
+ [EventType.link]: {
+ link_url: string
+ link_samesite?: boolean
+ link_container?: string
+ }
+ [EventType.page]: {}
+ [EventType.preference]: {
+ preference_name: string
+ preference_value: string
+ }
+ [EventType.print]: {}
+ [EventType.search]: {
+ search_query: string
+ search_context?: string
+ }
+ [EventType.searchResult]: {
+ search_result_query: string
+ search_result_index: number
+ search_result_total: number
+ search_result_rank: number
+ search_result_url: string
+ }
+ [EventType.survey]: {
+ survey_token?: string // Honeypot, doesn't exist in schema
+ survey_vote: boolean
+ survey_comment?: string
+ survey_email?: string
+ }
}
function getMetaContent(name: string) {
@@ -104,7 +122,14 @@ function getMetaContent(name: string) {
return metaTag?.content
}
-export function sendEvent({ type, version = '1.0.0', ...props }: SendEventProps) {
+export function sendEvent<T extends EventType>({
+ type,
+ version = '1.0.0',
+ ...props
+}: {
+ type: T
+ version?: string
+} & SendEventProps[T]) {
const body = {
type,
diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
index 063dea8b4eb5..909fafb98cd2 100644
--- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
@@ -2189,7 +2189,7 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
"additional-permissions": [],
- "access": "write"
+ "access": "read"
},
{
"category": "repos",
@@ -2761,6 +2761,24 @@
],
"access": "write"
},
+ {
+ "category": "repos",
+ "slug": "enable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting",
+ "additional-permissions": [],
+ "access": "write"
+ },
+ {
+ "category": "repos",
+ "slug": "disable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting",
+ "additional-permissions": [],
+ "access": "write"
+ },
{
"category": "repos",
"slug": "create-a-repository-ruleset",
@@ -6309,6 +6327,15 @@
"title": "Repository security advisories",
"displayTitle": "Repository permissions for \"Repository security advisories\"",
"permissions": [
+ {
+ "category": "security-advisories",
+ "slug": "list-repository-security-advisories-for-an-organization",
+ "subcategory": "repository-advisories",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/security-advisories",
+ "additional-permissions": [],
+ "access": "write"
+ },
{
"category": "security-advisories",
"slug": "list-repository-security-advisories",
diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
index 53e34bdce4e0..a2931295d830 100644
--- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
+++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
@@ -3848,6 +3848,18 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/languages"
},
+ {
+ "slug": "enable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting"
+ },
+ {
+ "slug": "disable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting"
+ },
{
"slug": "get-rules-for-a-branch",
"subcategory": "rules",
@@ -4070,6 +4082,12 @@
"verb": "get",
"requestPath": "/advisories/{ghsa_id}"
},
+ {
+ "slug": "list-repository-security-advisories-for-an-organization",
+ "subcategory": "repository-advisories",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/security-advisories"
+ },
{
"slug": "list-repository-security-advisories",
"subcategory": "repository-advisories",
diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json
index 94ad2f198340..defa3c93abfb 100644
--- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json
@@ -2736,7 +2736,7 @@
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
- "access": "write",
+ "access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": []
@@ -3435,6 +3435,28 @@
"pages"
]
},
+ {
+ "category": "repos",
+ "slug": "enable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting",
+ "access": "write",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": []
+ },
+ {
+ "category": "repos",
+ "slug": "disable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting",
+ "access": "write",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": []
+ },
{
"category": "repos",
"slug": "create-a-repository-ruleset",
@@ -7722,6 +7744,17 @@
"title": "Repository security advisories",
"displayTitle": "Repository permissions for \"Repository security advisories\"",
"permissions": [
+ {
+ "category": "security-advisories",
+ "slug": "list-repository-security-advisories-for-an-organization",
+ "subcategory": "repository-advisories",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/security-advisories",
+ "access": "write",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": []
+ },
{
"category": "security-advisories",
"slug": "list-repository-security-advisories",
diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
index 17477f750d98..79523d632133 100644
--- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
+++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
@@ -3484,6 +3484,18 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/languages"
},
+ {
+ "slug": "enable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting"
+ },
+ {
+ "slug": "disable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting"
+ },
{
"slug": "get-rules-for-a-branch",
"subcategory": "rules",
@@ -3682,6 +3694,12 @@
"verb": "get",
"requestPath": "/advisories/{ghsa_id}"
},
+ {
+ "slug": "list-repository-security-advisories-for-an-organization",
+ "subcategory": "repository-advisories",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/security-advisories"
+ },
{
"slug": "list-repository-security-advisories",
"subcategory": "repository-advisories",
diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json
index edd214d8ecd6..799e1de274f1 100644
--- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json
+++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json
@@ -3914,6 +3914,18 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/languages"
},
+ {
+ "slug": "enable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting"
+ },
+ {
+ "slug": "disable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting"
+ },
{
"slug": "get-rules-for-a-branch",
"subcategory": "rules",
@@ -4136,6 +4148,12 @@
"verb": "get",
"requestPath": "/advisories/{ghsa_id}"
},
+ {
+ "slug": "list-repository-security-advisories-for-an-organization",
+ "subcategory": "repository-advisories",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/security-advisories"
+ },
{
"slug": "list-repository-security-advisories",
"subcategory": "repository-advisories",
diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
index 8fc6bbd33852..d0974e9a549f 100644
--- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
@@ -2748,7 +2748,7 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
"additional-permissions": [],
- "access": "write"
+ "access": "read"
},
{
"category": "repos",
@@ -3320,6 +3320,24 @@
],
"access": "write"
},
+ {
+ "category": "repos",
+ "slug": "enable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting",
+ "additional-permissions": [],
+ "access": "write"
+ },
+ {
+ "category": "repos",
+ "slug": "disable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting",
+ "additional-permissions": [],
+ "access": "write"
+ },
{
"category": "repos",
"slug": "create-a-repository-ruleset",
@@ -6890,6 +6908,15 @@
"title": "Repository security advisories",
"displayTitle": "Repository permissions for \"Repository security advisories\"",
"permissions": [
+ {
+ "category": "security-advisories",
+ "slug": "list-repository-security-advisories-for-an-organization",
+ "subcategory": "repository-advisories",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/security-advisories",
+ "additional-permissions": [],
+ "access": "write"
+ },
{
"category": "security-advisories",
"slug": "list-repository-security-advisories",
diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
index d691c2761acb..3eb91fbabf94 100644
--- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
+++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
@@ -4098,6 +4098,18 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/languages"
},
+ {
+ "slug": "enable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting"
+ },
+ {
+ "slug": "disable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting"
+ },
{
"slug": "get-rules-for-a-branch",
"subcategory": "rules",
@@ -4358,6 +4370,12 @@
"verb": "get",
"requestPath": "/advisories/{ghsa_id}"
},
+ {
+ "slug": "list-repository-security-advisories-for-an-organization",
+ "subcategory": "repository-advisories",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/security-advisories"
+ },
{
"slug": "list-repository-security-advisories",
"subcategory": "repository-advisories",
diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
index be8efd050f39..92dd294aa0a5 100644
--- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
@@ -3426,7 +3426,7 @@
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
- "access": "write",
+ "access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": []
@@ -4125,6 +4125,28 @@
"pages"
]
},
+ {
+ "category": "repos",
+ "slug": "enable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting",
+ "access": "write",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": []
+ },
+ {
+ "category": "repos",
+ "slug": "disable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting",
+ "access": "write",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": []
+ },
{
"category": "repos",
"slug": "create-a-repository-ruleset",
@@ -8438,6 +8460,17 @@
"title": "Repository security advisories",
"displayTitle": "Repository permissions for \"Repository security advisories\"",
"permissions": [
+ {
+ "category": "security-advisories",
+ "slug": "list-repository-security-advisories-for-an-organization",
+ "subcategory": "repository-advisories",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/security-advisories",
+ "access": "write",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": []
+ },
{
"category": "security-advisories",
"slug": "list-repository-security-advisories",
diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
index e073e8c3b5f0..e706fa18e012 100644
--- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
+++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
@@ -3734,6 +3734,18 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/languages"
},
+ {
+ "slug": "enable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting"
+ },
+ {
+ "slug": "disable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting"
+ },
{
"slug": "get-rules-for-a-branch",
"subcategory": "rules",
@@ -3970,6 +3982,12 @@
"verb": "get",
"requestPath": "/advisories/{ghsa_id}"
},
+ {
+ "slug": "list-repository-security-advisories-for-an-organization",
+ "subcategory": "repository-advisories",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/security-advisories"
+ },
{
"slug": "list-repository-security-advisories",
"subcategory": "repository-advisories",
diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
index 51bb15d68951..9e87831ac118 100644
--- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
+++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
@@ -4164,6 +4164,18 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/languages"
},
+ {
+ "slug": "enable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting"
+ },
+ {
+ "slug": "disable-private-vulnerability-reporting-for-a-repository",
+ "subcategory": "repos",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting"
+ },
{
"slug": "get-rules-for-a-branch",
"subcategory": "rules",
@@ -4424,6 +4436,12 @@
"verb": "get",
"requestPath": "/advisories/{ghsa_id}"
},
+ {
+ "slug": "list-repository-security-advisories-for-an-organization",
+ "subcategory": "repository-advisories",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/security-advisories"
+ },
{
"slug": "list-repository-security-advisories",
"subcategory": "repository-advisories",
diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json
index 1b561ff739e8..edf08f498e5c 100644
--- a/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghes-3.10-2022-11-28/fine-grained-pat-permissions.json
@@ -2286,7 +2286,7 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
"additional-permissions": [],
- "access": "write"
+ "access": "read"
},
{
"category": "branches",
diff --git a/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json
index 45c31460d284..0c9438858ab3 100644
--- a/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghes-3.10-2022-11-28/server-to-server-permissions.json
@@ -2872,7 +2872,7 @@
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
- "access": "write",
+ "access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": []
diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json
index 26b76624f8eb..b7756be36a92 100644
--- a/src/github-apps/lib/config.json
+++ b/src/github-apps/lib/config.json
@@ -60,5 +60,5 @@
"2022-11-28"
]
},
- "sha": "45ba714d4fde4f522d5cad95427eea033423da8f"
+ "sha": "da33840287fe37f6173edf958b888e02ca2b4110"
}
\ No newline at end of file
diff --git a/src/graphql/components/Table.tsx b/src/graphql/components/Table.tsx
index 794a0ff47e1e..231ea65653db 100644
--- a/src/graphql/components/Table.tsx
+++ b/src/graphql/components/Table.tsx
@@ -31,7 +31,11 @@ export function Table({ fields }: Props) {
<p>
<code>{field.name}</code> (
<code>
- <Link href={field.href} locale={locale}>
+ <Link
+ href={field.href}
+ locale={locale}
+ aria-label={[field.name, field.type, 'type definition'].join(' ')}
+ >
{field.type}
</Link>
</code>
diff --git a/src/graphql/data/fpt/changelog.json b/src/graphql/data/fpt/changelog.json
index f3490ae1d8a4..fb22e8a85d68 100644
--- a/src/graphql/data/fpt/changelog.json
+++ b/src/graphql/data/fpt/changelog.json
@@ -1,4 +1,22 @@
[
+ {
+ "schemaChanges": [
+ {
+ "title": "The GraphQL schema includes these changes:",
+ "changes": [
+ "<p>Type <code>AddPullRequestReviewThreadReplyInput</code> was added</p>",
+ "<p>Type <code>AddPullRequestReviewThreadReplyPayload</code> was added</p>",
+ "<p>Type <code>PullRequestBranchUpdateMethod</code> was added</p>",
+ "<p>Field <code>githubEnterpriseImporterIpAddresses</code> was added to object type <code>GitHubMetadata</code></p>",
+ "<p>Field <code>addPullRequestReviewThreadReply</code> was added to object type <code>Mutation</code></p>",
+ "<p>Input field <code>updateMethod</code> of type <code>PullRequestBranchUpdateMethod</code> was added to input object type <code>UpdatePullRequestBranchInput</code></p>"
+ ]
+ }
+ ],
+ "previewChanges": [],
+ "upcomingChanges": [],
+ "date": "2023-08-14"
+ },
{
"schemaChanges": [
{
diff --git a/src/graphql/data/fpt/schema.json b/src/graphql/data/fpt/schema.json
index 84f603046ed6..7d4e6ebcd264 100644
--- a/src/graphql/data/fpt/schema.json
+++ b/src/graphql/data/fpt/schema.json
@@ -1492,6 +1492,40 @@
}
]
},
+ {
+ "name": "addPullRequestReviewThreadReply",
+ "kind": "mutations",
+ "id": "addpullrequestreviewthreadreply",
+ "href": "/graphql/reference/mutations#addpullrequestreviewthreadreply",
+ "description": "<p>Adds a reply to an existing Pull Request Review Thread.</p>",
+ "inputFields": [
+ {
+ "name": "input",
+ "type": "AddPullRequestReviewThreadReplyInput!",
+ "id": "addpullrequestreviewthreadreplyinput",
+ "kind": "input-objects",
+ "href": "/graphql/reference/input-objects#addpullrequestreviewthreadreplyinput"
+ }
+ ],
+ "returnFields": [
+ {
+ "name": "clientMutationId",
+ "type": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string",
+ "description": "<p>A unique identifier for the client performing the mutation.</p>"
+ },
+ {
+ "name": "comment",
+ "type": "PullRequestReviewComment",
+ "id": "pullrequestreviewcomment",
+ "kind": "objects",
+ "href": "/graphql/reference/objects#pullrequestreviewcomment",
+ "description": "<p>The newly created reply.</p>"
+ }
+ ]
+ },
{
"name": "addReaction",
"kind": "mutations",
@@ -26039,6 +26073,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
+ {
+ "name": "githubEnterpriseImporterIpAddresses",
+ "description": "<p>IP addresses that GitHub Enterprise Importer uses for outbound connections.</p>",
+ "type": "[String!]",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ },
{
"name": "hookIpAddresses",
"description": "<p>IP addresses that service hooks are sent from.</p>",
@@ -81436,6 +81478,23 @@
}
]
},
+ {
+ "name": "PullRequestBranchUpdateMethod",
+ "kind": "enums",
+ "id": "pullrequestbranchupdatemethod",
+ "href": "/graphql/reference/enums#pullrequestbranchupdatemethod",
+ "description": "<p>The possible methods for updating a pull request's head branch with the base branch.</p>",
+ "values": [
+ {
+ "name": "MERGE",
+ "description": "<p>Update branch via merge.</p>"
+ },
+ {
+ "name": "REBASE",
+ "description": "<p>Update branch via rebase.</p>"
+ }
+ ]
+ },
{
"name": "PullRequestMergeMethod",
"kind": "enums",
@@ -87312,6 +87371,49 @@
}
]
},
+ {
+ "name": "AddPullRequestReviewThreadReplyInput",
+ "kind": "inputObjects",
+ "id": "addpullrequestreviewthreadreplyinput",
+ "href": "/graphql/reference/input-objects#addpullrequestreviewthreadreplyinput",
+ "description": "<p>Autogenerated input type of AddPullRequestReviewThreadReply.</p>",
+ "inputFields": [
+ {
+ "name": "body",
+ "description": "<p>The text of the reply.</p>",
+ "type": "String!",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ },
+ {
+ "name": "clientMutationId",
+ "description": "<p>A unique identifier for the client performing the mutation.</p>",
+ "type": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ },
+ {
+ "name": "pullRequestReviewId",
+ "description": "<p>The Node ID of the pending review to which the reply will belong.</p>",
+ "type": "ID",
+ "id": "id",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#id",
+ "isDeprecated": false
+ },
+ {
+ "name": "pullRequestReviewThreadId",
+ "description": "<p>The Node ID of the thread to which this reply is being written.</p>",
+ "type": "ID!",
+ "id": "id",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#id",
+ "isDeprecated": false
+ }
+ ]
+ },
{
"name": "AddReactionInput",
"kind": "inputObjects",
@@ -95610,7 +95712,7 @@
},
{
"name": "continueOnError",
- "description": "<p>Whether to continue the migration on error. Defaults to <code>false</code>. We strongly\nrecommend setting this to <code>true</code> for the smoothest migration experience.</p>",
+ "description": "<p>Whether to continue the migration on error. Defaults to <code>false</code>. We strongly\nrecommend setting this to <code>true</code> for the smoothest migration experience. <em>This\ndefault will change to <code>true</code> on September 4, 2023.</em>.</p>",
"type": "Boolean",
"id": "boolean",
"kind": "scalars",
@@ -98466,6 +98568,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#id",
"isDeprecated": false
+ },
+ {
+ "name": "updateMethod",
+ "description": "<p>The update branch method to use. If omitted, defaults to 'MERGE'.</p>",
+ "type": "PullRequestBranchUpdateMethod",
+ "id": "pullrequestbranchupdatemethod",
+ "kind": "enums",
+ "href": "/graphql/reference/enums#pullrequestbranchupdatemethod"
}
]
},
diff --git a/src/graphql/data/ghae/schema.json b/src/graphql/data/ghae/schema.json
index 25bfd53b2bcc..6ce0f79756c7 100644
--- a/src/graphql/data/ghae/schema.json
+++ b/src/graphql/data/ghae/schema.json
@@ -1077,6 +1077,40 @@
}
]
},
+ {
+ "name": "addPullRequestReviewThreadReply",
+ "kind": "mutations",
+ "id": "addpullrequestreviewthreadreply",
+ "href": "/graphql/reference/mutations#addpullrequestreviewthreadreply",
+ "description": "<p>Adds a reply to an existing Pull Request Review Thread.</p>",
+ "inputFields": [
+ {
+ "name": "input",
+ "type": "AddPullRequestReviewThreadReplyInput!",
+ "id": "addpullrequestreviewthreadreplyinput",
+ "kind": "input-objects",
+ "href": "/graphql/reference/input-objects#addpullrequestreviewthreadreplyinput"
+ }
+ ],
+ "returnFields": [
+ {
+ "name": "clientMutationId",
+ "type": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string",
+ "description": "<p>A unique identifier for the client performing the mutation.</p>"
+ },
+ {
+ "name": "comment",
+ "type": "PullRequestReviewComment",
+ "id": "pullrequestreviewcomment",
+ "kind": "objects",
+ "href": "/graphql/reference/objects#pullrequestreviewcomment",
+ "description": "<p>The newly created reply.</p>"
+ }
+ ]
+ },
{
"name": "addReaction",
"kind": "mutations",
@@ -67334,6 +67368,23 @@
}
]
},
+ {
+ "name": "PullRequestBranchUpdateMethod",
+ "kind": "enums",
+ "id": "pullrequestbranchupdatemethod",
+ "href": "/graphql/reference/enums#pullrequestbranchupdatemethod",
+ "description": "<p>The possible methods for updating a pull request's head branch with the base branch.</p>",
+ "values": [
+ {
+ "name": "MERGE",
+ "description": "<p>Update branch via merge.</p>"
+ },
+ {
+ "name": "REBASE",
+ "description": "<p>Update branch via rebase.</p>"
+ }
+ ]
+ },
{
"name": "PullRequestMergeMethod",
"kind": "enums",
@@ -71412,6 +71463,49 @@
}
]
},
+ {
+ "name": "AddPullRequestReviewThreadReplyInput",
+ "kind": "inputObjects",
+ "id": "addpullrequestreviewthreadreplyinput",
+ "href": "/graphql/reference/input-objects#addpullrequestreviewthreadreplyinput",
+ "description": "<p>Autogenerated input type of AddPullRequestReviewThreadReply.</p>",
+ "inputFields": [
+ {
+ "name": "body",
+ "description": "<p>The text of the reply.</p>",
+ "type": "String!",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ },
+ {
+ "name": "clientMutationId",
+ "description": "<p>A unique identifier for the client performing the mutation.</p>",
+ "type": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ },
+ {
+ "name": "pullRequestReviewId",
+ "description": "<p>The Node ID of the pending review to which the reply will belong.</p>",
+ "type": "ID",
+ "id": "id",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#id",
+ "isDeprecated": false
+ },
+ {
+ "name": "pullRequestReviewThreadId",
+ "description": "<p>The Node ID of the thread to which this reply is being written.</p>",
+ "type": "ID!",
+ "id": "id",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#id",
+ "isDeprecated": false
+ }
+ ]
+ },
{
"name": "AddReactionInput",
"kind": "inputObjects",
@@ -77480,7 +77574,7 @@
},
{
"name": "continueOnError",
- "description": "<p>Whether to continue the migration on error. Defaults to <code>false</code>. We strongly\nrecommend setting this to <code>true</code> for the smoothest migration experience.</p>",
+ "description": "<p>Whether to continue the migration on error. Defaults to <code>false</code>. We strongly\nrecommend setting this to <code>true</code> for the smoothest migration experience. <em>This\ndefault will change to <code>true</code> on September 4, 2023.</em>.</p>",
"type": "Boolean",
"id": "boolean",
"kind": "scalars",
@@ -79847,6 +79941,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#id",
"isDeprecated": false
+ },
+ {
+ "name": "updateMethod",
+ "description": "<p>The update branch method to use. If omitted, defaults to 'MERGE'.</p>",
+ "type": "PullRequestBranchUpdateMethod",
+ "id": "pullrequestbranchupdatemethod",
+ "kind": "enums",
+ "href": "/graphql/reference/enums#pullrequestbranchupdatemethod"
}
]
},
diff --git a/src/graphql/data/ghec/schema.json b/src/graphql/data/ghec/schema.json
index 84f603046ed6..7d4e6ebcd264 100644
--- a/src/graphql/data/ghec/schema.json
+++ b/src/graphql/data/ghec/schema.json
@@ -1492,6 +1492,40 @@
}
]
},
+ {
+ "name": "addPullRequestReviewThreadReply",
+ "kind": "mutations",
+ "id": "addpullrequestreviewthreadreply",
+ "href": "/graphql/reference/mutations#addpullrequestreviewthreadreply",
+ "description": "<p>Adds a reply to an existing Pull Request Review Thread.</p>",
+ "inputFields": [
+ {
+ "name": "input",
+ "type": "AddPullRequestReviewThreadReplyInput!",
+ "id": "addpullrequestreviewthreadreplyinput",
+ "kind": "input-objects",
+ "href": "/graphql/reference/input-objects#addpullrequestreviewthreadreplyinput"
+ }
+ ],
+ "returnFields": [
+ {
+ "name": "clientMutationId",
+ "type": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string",
+ "description": "<p>A unique identifier for the client performing the mutation.</p>"
+ },
+ {
+ "name": "comment",
+ "type": "PullRequestReviewComment",
+ "id": "pullrequestreviewcomment",
+ "kind": "objects",
+ "href": "/graphql/reference/objects#pullrequestreviewcomment",
+ "description": "<p>The newly created reply.</p>"
+ }
+ ]
+ },
{
"name": "addReaction",
"kind": "mutations",
@@ -26039,6 +26073,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
+ {
+ "name": "githubEnterpriseImporterIpAddresses",
+ "description": "<p>IP addresses that GitHub Enterprise Importer uses for outbound connections.</p>",
+ "type": "[String!]",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ },
{
"name": "hookIpAddresses",
"description": "<p>IP addresses that service hooks are sent from.</p>",
@@ -81436,6 +81478,23 @@
}
]
},
+ {
+ "name": "PullRequestBranchUpdateMethod",
+ "kind": "enums",
+ "id": "pullrequestbranchupdatemethod",
+ "href": "/graphql/reference/enums#pullrequestbranchupdatemethod",
+ "description": "<p>The possible methods for updating a pull request's head branch with the base branch.</p>",
+ "values": [
+ {
+ "name": "MERGE",
+ "description": "<p>Update branch via merge.</p>"
+ },
+ {
+ "name": "REBASE",
+ "description": "<p>Update branch via rebase.</p>"
+ }
+ ]
+ },
{
"name": "PullRequestMergeMethod",
"kind": "enums",
@@ -87312,6 +87371,49 @@
}
]
},
+ {
+ "name": "AddPullRequestReviewThreadReplyInput",
+ "kind": "inputObjects",
+ "id": "addpullrequestreviewthreadreplyinput",
+ "href": "/graphql/reference/input-objects#addpullrequestreviewthreadreplyinput",
+ "description": "<p>Autogenerated input type of AddPullRequestReviewThreadReply.</p>",
+ "inputFields": [
+ {
+ "name": "body",
+ "description": "<p>The text of the reply.</p>",
+ "type": "String!",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ },
+ {
+ "name": "clientMutationId",
+ "description": "<p>A unique identifier for the client performing the mutation.</p>",
+ "type": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ },
+ {
+ "name": "pullRequestReviewId",
+ "description": "<p>The Node ID of the pending review to which the reply will belong.</p>",
+ "type": "ID",
+ "id": "id",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#id",
+ "isDeprecated": false
+ },
+ {
+ "name": "pullRequestReviewThreadId",
+ "description": "<p>The Node ID of the thread to which this reply is being written.</p>",
+ "type": "ID!",
+ "id": "id",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#id",
+ "isDeprecated": false
+ }
+ ]
+ },
{
"name": "AddReactionInput",
"kind": "inputObjects",
@@ -95610,7 +95712,7 @@
},
{
"name": "continueOnError",
- "description": "<p>Whether to continue the migration on error. Defaults to <code>false</code>. We strongly\nrecommend setting this to <code>true</code> for the smoothest migration experience.</p>",
+ "description": "<p>Whether to continue the migration on error. Defaults to <code>false</code>. We strongly\nrecommend setting this to <code>true</code> for the smoothest migration experience. <em>This\ndefault will change to <code>true</code> on September 4, 2023.</em>.</p>",
"type": "Boolean",
"id": "boolean",
"kind": "scalars",
@@ -98466,6 +98568,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#id",
"isDeprecated": false
+ },
+ {
+ "name": "updateMethod",
+ "description": "<p>The update branch method to use. If omitted, defaults to 'MERGE'.</p>",
+ "type": "PullRequestBranchUpdateMethod",
+ "id": "pullrequestbranchupdatemethod",
+ "kind": "enums",
+ "href": "/graphql/reference/enums#pullrequestbranchupdatemethod"
}
]
},
diff --git a/src/graphql/data/ghes-3.10/previews.json b/src/graphql/data/ghes-3.10/previews.json
index 95e2ab937b08..67698a38a72e 100644
--- a/src/graphql/data/ghes-3.10/previews.json
+++ b/src/graphql/data/ghes-3.10/previews.json
@@ -51,7 +51,7 @@
"RefUpdate"
],
"owning_teams": [
- "@github/reponauts"
+ "@github/repos"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview-update-multiple-refs-in-a-single-operation-preview"
diff --git a/src/graphql/data/ghes-3.10/schema.json b/src/graphql/data/ghes-3.10/schema.json
index 34de948ca9c4..d5cda860f910 100644
--- a/src/graphql/data/ghes-3.10/schema.json
+++ b/src/graphql/data/ghes-3.10/schema.json
@@ -218,7 +218,7 @@
"kind": "objects",
"id": "query",
"href": "/graphql/reference/objects#query",
- "description": "<p>Hack to workaround <a href=\"https://github.com/facebook/relay/issues/112\">https://github.com/facebook/relay/issues/112</a> re-exposing the root query object.</p>",
+ "description": "<p>Workaround for re-exposing the root query object. (Refer to\n<a href=\"https://github.com/facebook/relay/issues/112\">https://github.com/facebook/relay/issues/112</a> for more information.).</p>",
"args": []
},
{
@@ -4089,6 +4089,40 @@
}
]
},
+ {
+ "name": "markProjectV2AsTemplate",
+ "kind": "mutations",
+ "id": "markprojectv2astemplate",
+ "href": "/graphql/reference/mutations#markprojectv2astemplate",
+ "description": "<p>Mark a project as a template. Note that only projects which are owned by an Organization can be marked as a template.</p>",
+ "inputFields": [
+ {
+ "name": "input",
+ "type": "MarkProjectV2AsTemplateInput!",
+ "id": "markprojectv2astemplateinput",
+ "kind": "input-objects",
+ "href": "/graphql/reference/input-objects#markprojectv2astemplateinput"
+ }
+ ],
+ "returnFields": [
+ {
+ "name": "clientMutationId",
+ "type": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string",
+ "description": "<p>A unique identifier for the client performing the mutation.</p>"
+ },
+ {
+ "name": "projectV2",
+ "type": "ProjectV2",
+ "id": "projectv2",
+ "kind": "objects",
+ "href": "/graphql/reference/objects#projectv2",
+ "description": "<p>The project.</p>"
+ }
+ ]
+ },
{
"name": "markPullRequestReadyForReview",
"kind": "mutations",
@@ -5537,6 +5571,40 @@
}
]
},
+ {
+ "name": "unmarkProjectV2AsTemplate",
+ "kind": "mutations",
+ "id": "unmarkprojectv2astemplate",
+ "href": "/graphql/reference/mutations#unmarkprojectv2astemplate",
+ "description": "<p>Unmark a project as a template.</p>",
+ "inputFields": [
+ {
+ "name": "input",
+ "type": "UnmarkProjectV2AsTemplateInput!",
+ "id": "unmarkprojectv2astemplateinput",
+ "kind": "input-objects",
+ "href": "/graphql/reference/input-objects#unmarkprojectv2astemplateinput"
+ }
+ ],
+ "returnFields": [
+ {
+ "name": "clientMutationId",
+ "type": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string",
+ "description": "<p>A unique identifier for the client performing the mutation.</p>"
+ },
+ {
+ "name": "projectV2",
+ "type": "ProjectV2",
+ "id": "projectv2",
+ "kind": "objects",
+ "href": "/graphql/reference/objects#projectv2",
+ "description": "<p>The project.</p>"
+ }
+ ]
+ },
{
"name": "unminimizeComment",
"kind": "mutations",
@@ -6981,6 +7049,40 @@
}
]
},
+ {
+ "name": "updateProjectV2Collaborators",
+ "kind": "mutations",
+ "id": "updateprojectv2collaborators",
+ "href": "/graphql/reference/mutations#updateprojectv2collaborators",
+ "description": "<p>Update the collaborators on a team or a project.</p>",
+ "inputFields": [
+ {
+ "name": "input",
+ "type": "UpdateProjectV2CollaboratorsInput!",
+ "id": "updateprojectv2collaboratorsinput",
+ "kind": "input-objects",
+ "href": "/graphql/reference/input-objects#updateprojectv2collaboratorsinput"
+ }
+ ],
+ "returnFields": [
+ {
+ "name": "clientMutationId",
+ "type": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string",
+ "description": "<p>A unique identifier for the client performing the mutation.</p>"
+ },
+ {
+ "name": "collaborators",
+ "type": "ProjectV2ActorConnection",
+ "id": "projectv2actorconnection",
+ "kind": "objects",
+ "href": "/graphql/reference/objects#projectv2actorconnection",
+ "description": "<p>The collaborators granted a role.</p>"
+ }
+ ]
+ },
{
"name": "updateProjectV2DraftIssue",
"kind": "mutations",
@@ -7278,7 +7380,7 @@
"RefUpdate"
],
"owning_teams": [
- "@github/reponauts"
+ "@github/repos"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview-update-multiple-refs-in-a-single-operation-preview"
@@ -11357,7 +11459,7 @@
},
{
"name": "changedFiles",
- "description": "<p>We recommend using the <code>changedFielsIfAvailable</code> field instead of\n<code>changedFiles</code>, as <code>changedFiles</code> will cause your request to return an error\nif GitHub is unable to calculate the number of changed files.</p>",
+ "description": "<p>We recommend using the <code>changedFilesIfAvailable</code> field instead of\n<code>changedFiles</code>, as <code>changedFiles</code> will cause your request to return an error\nif GitHub is unable to calculate the number of changed files.</p>",
"type": "Int!",
"id": "int",
"kind": "scalars",
@@ -15087,7 +15189,7 @@
},
{
"name": "packageName",
- "description": "<p>The name of the package in the canonical form used by the package manager.\nThis may differ from the original textual form (see packageLabel), for example\nin a package manager that uses case-insensitive comparisons.</p>",
+ "description": "<p>The name of the package in the canonical form used by the package manager.</p>",
"type": "String!",
"id": "string",
"kind": "scalars",
@@ -18873,7 +18975,7 @@
},
{
"name": "ownerInfo",
- "description": "<p>Enterprise information only visible to enterprise owners.</p>",
+ "description": "<p>Enterprise information visible to enterprise owners or enterprise owners'\npersonal access tokens (classic) with read:enterprise or admin:enterprise scope.</p>",
"type": "EnterpriseOwnerInfo",
"id": "enterpriseownerinfo",
"kind": "objects",
@@ -19293,7 +19395,7 @@
"kind": "objects",
"id": "enterpriseidentityprovider",
"href": "/graphql/reference/objects#enterpriseidentityprovider",
- "description": "<p>An identity provider configured to provision identities for an enterprise.</p>",
+ "description": "<p>An identity provider configured to provision identities for an enterprise.\nVisible to enterprise owners or enterprise owners' personal access tokens\n(classic) with read:enterprise or admin:enterprise scope.</p>",
"implements": [
{
"name": "Node",
@@ -19711,7 +19813,7 @@
"kind": "objects",
"id": "enterpriseownerinfo",
"href": "/graphql/reference/objects#enterpriseownerinfo",
- "description": "<p>Enterprise information only visible to enterprise owners.</p>",
+ "description": "<p>Enterprise information visible to enterprise owners or enterprise owners'\npersonal access tokens (classic) with read:enterprise or admin:enterprise scope.</p>",
"fields": [
{
"name": "admins",
@@ -20037,7 +20139,7 @@
},
{
"name": "domains",
- "description": "<p>A list of domains owned by the enterprise.</p>",
+ "description": "<p>A list of domains owned by the enterprise. Visible to enterprise owners or\nenterprise owners' personal access tokens (classic) with admin:enterprise scope.</p>",
"type": "VerifiableDomainConnection!",
"id": "verifiabledomainconnection",
"kind": "objects",
@@ -20185,7 +20287,7 @@
},
{
"name": "ipAllowListEntries",
- "description": "<p>The IP addresses that are allowed to access resources owned by the enterprise.</p>",
+ "description": "<p>The IP addresses that are allowed to access resources owned by the enterprise.\nVisible to enterprise owners or enterprise owners' personal access tokens\n(classic) with admin:enterprise scope.</p>",
"type": "IpAllowListEntryConnection!",
"id": "ipallowlistentryconnection",
"kind": "objects",
@@ -21351,7 +21453,7 @@
},
{
"name": "samlIdentityProvider",
- "description": "<p>The SAML Identity Provider for the enterprise. When used by a GitHub App,\nrequires an installation token with read and write access to members.</p>",
+ "description": "<p>The SAML Identity Provider for the enterprise.</p>",
"type": "EnterpriseIdentityProvider",
"id": "enterpriseidentityprovider",
"kind": "objects",
@@ -22891,7 +22993,7 @@
"kind": "objects",
"id": "externalidentity",
"href": "/graphql/reference/objects#externalidentity",
- "description": "<p>An external identity provisioned by SAML SSO or SCIM.</p>",
+ "description": "<p>An external identity provisioned by SAML SSO or SCIM. If SAML is configured on\nthe organization, the external identity is visible to (1) organization owners,\n(2) organization owners' personal access tokens (classic) with read:org or\nadmin:org scope, (3) GitHub App with an installation token with read or write\naccess to members. If SAML is configured on the enterprise, the external\nidentity is visible to (1) enterprise owners, (2) enterprise owners' personal\naccess tokens (classic) with read:enterprise or admin:enterprise scope.</p>",
"implements": [
{
"name": "Node",
@@ -24637,6 +24739,11 @@
"id": "comment",
"href": "/graphql/reference/interfaces#comment"
},
+ {
+ "name": "Deletable",
+ "id": "deletable",
+ "href": "/graphql/reference/interfaces#deletable"
+ },
{
"name": "Labelable",
"id": "labelable",
@@ -25656,6 +25763,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
},
+ {
+ "name": "viewerCanDelete",
+ "description": "<p>Check if the current viewer can delete this object.</p>",
+ "type": "Boolean!",
+ "id": "boolean",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#boolean"
+ },
{
"name": "viewerCanReact",
"description": "<p>Can user react to this subject.</p>",
@@ -26333,6 +26448,56 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
+ {
+ "name": "assignees",
+ "description": "<p>The suggested assignees.</p>",
+ "type": "UserConnection!",
+ "id": "userconnection",
+ "kind": "objects",
+ "href": "/graphql/reference/objects#userconnection",
+ "arguments": [
+ {
+ "name": "after",
+ "description": "<p>Returns the elements in the list that come after the specified cursor.</p>",
+ "type": {
+ "name": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ }
+ },
+ {
+ "name": "before",
+ "description": "<p>Returns the elements in the list that come before the specified cursor.</p>",
+ "type": {
+ "name": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ }
+ },
+ {
+ "name": "first",
+ "description": "<p>Returns the first <em>n</em> elements from the list.</p>",
+ "type": {
+ "name": "Int",
+ "id": "int",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#int"
+ }
+ },
+ {
+ "name": "last",
+ "description": "<p>Returns the last <em>n</em> elements from the list.</p>",
+ "type": {
+ "name": "Int",
+ "id": "int",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#int"
+ }
+ }
+ ]
+ },
{
"name": "body",
"description": "<p>The suggested issue body.</p>",
@@ -26349,6 +26514,66 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
+ {
+ "name": "labels",
+ "description": "<p>The suggested issue labels.</p>",
+ "type": "LabelConnection",
+ "id": "labelconnection",
+ "kind": "objects",
+ "href": "/graphql/reference/objects#labelconnection",
+ "arguments": [
+ {
+ "name": "after",
+ "description": "<p>Returns the elements in the list that come after the specified cursor.</p>",
+ "type": {
+ "name": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ }
+ },
+ {
+ "name": "before",
+ "description": "<p>Returns the elements in the list that come before the specified cursor.</p>",
+ "type": {
+ "name": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ }
+ },
+ {
+ "name": "first",
+ "description": "<p>Returns the first <em>n</em> elements from the list.</p>",
+ "type": {
+ "name": "Int",
+ "id": "int",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#int"
+ }
+ },
+ {
+ "name": "last",
+ "description": "<p>Returns the last <em>n</em> elements from the list.</p>",
+ "type": {
+ "name": "Int",
+ "id": "int",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#int"
+ }
+ },
+ {
+ "name": "orderBy",
+ "description": "<p>Ordering options for labels returned from the connection.</p>",
+ "type": {
+ "name": "LabelOrder",
+ "id": "labelorder",
+ "kind": "input-objects",
+ "href": "/graphql/reference/input-objects#labelorder"
+ }
+ }
+ ]
+ },
{
"name": "name",
"description": "<p>The template name.</p>",
@@ -29055,7 +29280,7 @@
},
{
"name": "applicationUrl",
- "description": "<p>The application URL of the OAuth Application.</p>",
+ "description": "<p>The application URL of the OAuth application.</p>",
"type": "URI",
"id": "uri",
"kind": "scalars",
@@ -29063,7 +29288,7 @@
},
{
"name": "callbackUrl",
- "description": "<p>The callback URL of the OAuth Application.</p>",
+ "description": "<p>The callback URL of the OAuth application.</p>",
"type": "URI",
"id": "uri",
"kind": "scalars",
@@ -29079,7 +29304,7 @@
},
{
"name": "oauthApplicationName",
- "description": "<p>The name of the OAuth Application.</p>",
+ "description": "<p>The name of the OAuth application.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
@@ -29087,7 +29312,7 @@
},
{
"name": "oauthApplicationResourcePath",
- "description": "<p>The HTTP path for the OAuth Application.</p>",
+ "description": "<p>The HTTP path for the OAuth application.</p>",
"type": "URI",
"id": "uri",
"kind": "scalars",
@@ -29095,7 +29320,7 @@
},
{
"name": "oauthApplicationUrl",
- "description": "<p>The HTTP URL for the OAuth Application.</p>",
+ "description": "<p>The HTTP URL for the OAuth application.</p>",
"type": "URI",
"id": "uri",
"kind": "scalars",
@@ -29143,7 +29368,7 @@
},
{
"name": "rateLimit",
- "description": "<p>The rate limit of the OAuth Application.</p>",
+ "description": "<p>The rate limit of the OAuth application.</p>",
"type": "Int",
"id": "int",
"kind": "scalars",
@@ -29151,7 +29376,7 @@
},
{
"name": "state",
- "description": "<p>The state of the OAuth Application.</p>",
+ "description": "<p>The state of the OAuth application.</p>",
"type": "OauthApplicationCreateAuditEntryState",
"id": "oauthapplicationcreateauditentrystate",
"kind": "enums",
@@ -31719,7 +31944,7 @@
},
{
"name": "oauthApplicationName",
- "description": "<p>The name of the OAuth Application.</p>",
+ "description": "<p>The name of the OAuth application.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
@@ -31727,7 +31952,7 @@
},
{
"name": "oauthApplicationResourcePath",
- "description": "<p>The HTTP path for the OAuth Application.</p>",
+ "description": "<p>The HTTP path for the OAuth application.</p>",
"type": "URI",
"id": "uri",
"kind": "scalars",
@@ -31735,7 +31960,7 @@
},
{
"name": "oauthApplicationUrl",
- "description": "<p>The HTTP URL for the OAuth Application.</p>",
+ "description": "<p>The HTTP URL for the OAuth application.</p>",
"type": "URI",
"id": "uri",
"kind": "scalars",
@@ -31910,7 +32135,7 @@
},
{
"name": "oauthApplicationName",
- "description": "<p>The name of the OAuth Application.</p>",
+ "description": "<p>The name of the OAuth application.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
@@ -31918,7 +32143,7 @@
},
{
"name": "oauthApplicationResourcePath",
- "description": "<p>The HTTP path for the OAuth Application.</p>",
+ "description": "<p>The HTTP path for the OAuth application.</p>",
"type": "URI",
"id": "uri",
"kind": "scalars",
@@ -31926,7 +32151,7 @@
},
{
"name": "oauthApplicationUrl",
- "description": "<p>The HTTP URL for the OAuth Application.</p>",
+ "description": "<p>The HTTP URL for the OAuth application.</p>",
"type": "URI",
"id": "uri",
"kind": "scalars",
@@ -32101,7 +32326,7 @@
},
{
"name": "oauthApplicationName",
- "description": "<p>The name of the OAuth Application.</p>",
+ "description": "<p>The name of the OAuth application.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
@@ -32109,7 +32334,7 @@
},
{
"name": "oauthApplicationResourcePath",
- "description": "<p>The HTTP path for the OAuth Application.</p>",
+ "description": "<p>The HTTP path for the OAuth application.</p>",
"type": "URI",
"id": "uri",
"kind": "scalars",
@@ -32117,7 +32342,7 @@
},
{
"name": "oauthApplicationUrl",
- "description": "<p>The HTTP URL for the OAuth Application.</p>",
+ "description": "<p>The HTTP URL for the OAuth application.</p>",
"type": "URI",
"id": "uri",
"kind": "scalars",
@@ -35641,7 +35866,7 @@
},
{
"name": "samlIdentityProvider",
- "description": "<p>The Organization's SAML identity providers.</p>",
+ "description": "<p>The Organization's SAML identity provider. Visible to (1) organization owners,\n(2) organization owners' personal access tokens (classic) with read:org or\nadmin:org scope, (3) GitHub App with an installation token with read or write\naccess to members.</p>",
"type": "OrganizationIdentityProvider",
"id": "organizationidentityprovider",
"kind": "objects",
@@ -35725,6 +35950,16 @@
"href": "/graphql/reference/scalars#boolean"
}
},
+ {
+ "name": "notificationSetting",
+ "description": "<p>If non-null, filters teams according to notification setting.</p>",
+ "type": {
+ "name": "TeamNotificationSetting",
+ "id": "teamnotificationsetting",
+ "kind": "enums",
+ "href": "/graphql/reference/enums#teamnotificationsetting"
+ }
+ },
{
"name": "orderBy",
"description": "<p>Ordering options for teams returned from the connection.</p>",
@@ -36113,7 +36348,7 @@
"kind": "objects",
"id": "organizationidentityprovider",
"href": "/graphql/reference/objects#organizationidentityprovider",
- "description": "<p>An Identity Provider configured to provision SAML and SCIM identities for Organizations.</p>",
+ "description": "<p>An Identity Provider configured to provision SAML and SCIM identities for\nOrganizations. Visible to (1) organization owners, (2) organization owners'\npersonal access tokens (classic) with read:org or admin:org scope, (3) GitHub\nApp with an installation token with read or write access to members.</p>",
"implements": [
{
"name": "Node",
@@ -39763,6 +39998,72 @@
}
]
},
+ {
+ "name": "ProjectV2ActorConnection",
+ "kind": "objects",
+ "id": "projectv2actorconnection",
+ "href": "/graphql/reference/objects#projectv2actorconnection",
+ "description": "<p>The connection type for ProjectV2Actor.</p>",
+ "fields": [
+ {
+ "name": "edges",
+ "description": "<p>A list of edges.</p>",
+ "type": "[ProjectV2ActorEdge]",
+ "id": "projectv2actoredge",
+ "kind": "objects",
+ "href": "/graphql/reference/objects#projectv2actoredge"
+ },
+ {
+ "name": "nodes",
+ "description": "<p>A list of nodes.</p>",
+ "type": "[ProjectV2Actor]",
+ "id": "projectv2actor",
+ "kind": "unions",
+ "href": "/graphql/reference/unions#projectv2actor"
+ },
+ {
+ "name": "pageInfo",
+ "description": "<p>Information to aid in pagination.</p>",
+ "type": "PageInfo!",
+ "id": "pageinfo",
+ "kind": "objects",
+ "href": "/graphql/reference/objects#pageinfo"
+ },
+ {
+ "name": "totalCount",
+ "description": "<p>Identifies the total count of items in the connection.</p>",
+ "type": "Int!",
+ "id": "int",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#int"
+ }
+ ]
+ },
+ {
+ "name": "ProjectV2ActorEdge",
+ "kind": "objects",
+ "id": "projectv2actoredge",
+ "href": "/graphql/reference/objects#projectv2actoredge",
+ "description": "<p>An edge in a connection.</p>",
+ "fields": [
+ {
+ "name": "cursor",
+ "description": "<p>A cursor for use in pagination.</p>",
+ "type": "String!",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ },
+ {
+ "name": "node",
+ "description": "<p>The item at the end of the edge.</p>",
+ "type": "ProjectV2Actor",
+ "id": "projectv2actor",
+ "kind": "unions",
+ "href": "/graphql/reference/unions#projectv2actor"
+ }
+ ]
+ },
{
"name": "ProjectV2Connection",
"kind": "objects",
@@ -40078,7 +40379,7 @@
},
{
"name": "fieldValueByName",
- "description": "<p>A specific field value given a field name.</p>",
+ "description": "<p>The field value of the first project field which matches the<code>name</code>argument that is set on the item.</p>",
"type": "ProjectV2ItemFieldValue",
"id": "projectv2itemfieldvalue",
"kind": "unions",
@@ -40098,7 +40399,7 @@
},
{
"name": "fieldValues",
- "description": "<p>List of field values.</p>",
+ "description": "<p>The field values that are set on the item.</p>",
"type": "ProjectV2ItemFieldValueConnection!",
"id": "projectv2itemfieldvalueconnection",
"kind": "objects",
@@ -41307,7 +41608,19 @@
"type": "[ProjectV2SingleSelectFieldOption!]!",
"id": "projectv2singleselectfieldoption",
"kind": "objects",
- "href": "/graphql/reference/objects#projectv2singleselectfieldoption"
+ "href": "/graphql/reference/objects#projectv2singleselectfieldoption",
+ "arguments": [
+ {
+ "name": "names",
+ "description": "<p>Filter returned options to only those matching these names, case insensitive.</p>",
+ "type": {
+ "name": "[String!]",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ }
+ }
+ ]
},
{
"name": "project",
@@ -52542,6 +52855,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#boolean"
},
+ {
+ "name": "archivedAt",
+ "description": "<p>Identifies the date and time when the repository was archived.</p>",
+ "type": "DateTime",
+ "id": "datetime",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#datetime"
+ },
{
"name": "assignableUsers",
"description": "<p>A list of users that can be assigned to issues in this repository.</p>",
@@ -54640,7 +54961,7 @@
},
{
"name": "pushedAt",
- "description": "<p>Identifies when the repository was last pushed to.</p>",
+ "description": "<p>Identifies the date and time when the repository was last pushed to.</p>",
"type": "DateTime",
"id": "datetime",
"kind": "scalars",
@@ -55902,6 +56223,14 @@
"id": "migrationstate",
"kind": "enums",
"href": "/graphql/reference/enums#migrationstate"
+ },
+ {
+ "name": "warningsCount",
+ "description": "<p>The number of warnings encountered for this migration. To review the warnings,\ncheck the <a href=\"https://docs.github.com/en/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer\">Migration Log</a>.</p>",
+ "type": "Int!",
+ "id": "int",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#int"
}
]
},
@@ -56539,16 +56868,6 @@
"kind": "objects",
"href": "/graphql/reference/objects#user"
},
- {
- "name": "fixReason",
- "description": "<p>The reason the alert was marked as fixed.</p>",
- "type": "String",
- "id": "string",
- "kind": "scalars",
- "href": "/graphql/reference/scalars#string",
- "isDeprecated": true,
- "deprecationReason": "<p>The <code>fixReason</code> field is being removed. You can still use <code>fixedAt</code> and <code>dismissReason</code>. Removal on 2023-04-01 UTC.</p>"
- },
{
"name": "fixedAt",
"description": "<p>When was the alert fixed?.</p>",
@@ -59780,6 +60099,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#uri"
},
+ {
+ "name": "notificationSetting",
+ "description": "<p>The notification setting that the team has set.</p>",
+ "type": "TeamNotificationSetting!",
+ "id": "teamnotificationsetting",
+ "kind": "enums",
+ "href": "/graphql/reference/enums#teamnotificationsetting"
+ },
{
"name": "organization",
"description": "<p>The organization that owns this team.</p>",
@@ -63902,7 +64229,7 @@
},
{
"name": "isFollowingViewer",
- "description": "<p>Whether or not this user is following the viewer. Inverse of viewer_is_following.</p>",
+ "description": "<p>Whether or not this user is following the viewer. Inverse of viewerIsFollowing.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
@@ -65580,7 +65907,7 @@
},
{
"name": "viewerIsFollowing",
- "description": "<p>Whether or not this user is followed by the viewer. Inverse of is_following_viewer.</p>",
+ "description": "<p>Whether or not this user is followed by the viewer. Inverse of isFollowingViewer.</p>",
"type": "Boolean!",
"id": "boolean",
"kind": "scalars",
@@ -66380,6 +66707,11 @@
"name": "Node",
"id": "node",
"href": "/graphql/reference/interfaces#node"
+ },
+ {
+ "name": "UniformResourceLocatable",
+ "id": "uniformresourcelocatable",
+ "href": "/graphql/reference/interfaces#uniformresourcelocatable"
}
],
"fields": [
@@ -66407,6 +66739,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
+ {
+ "name": "resourcePath",
+ "description": "<p>The HTTP path for this workflow.</p>",
+ "type": "URI!",
+ "id": "uri",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#uri"
+ },
{
"name": "runs",
"description": "<p>The runs of the workflow.</p>",
@@ -66482,6 +66822,14 @@
"id": "datetime",
"kind": "scalars",
"href": "/graphql/reference/scalars#datetime"
+ },
+ {
+ "name": "url",
+ "description": "<p>The HTTP URL for this workflow.</p>",
+ "type": "URI!",
+ "id": "uri",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#uri"
}
]
},
@@ -66586,6 +66934,14 @@
"kind": "scalars",
"href": "/graphql/reference/scalars#string"
},
+ {
+ "name": "file",
+ "description": "<p>The workflow file.</p>",
+ "type": "WorkflowRunFile",
+ "id": "workflowrunfile",
+ "kind": "objects",
+ "href": "/graphql/reference/objects#workflowrunfile"
+ },
{
"name": "pendingDeploymentRequests",
"description": "<p>The pending deployment requests of all check runs in this workflow run.</p>",
@@ -66743,6 +67099,91 @@
"href": "/graphql/reference/objects#workflowrun"
}
]
+ },
+ {
+ "name": "WorkflowRunFile",
+ "kind": "objects",
+ "id": "workflowrunfile",
+ "href": "/graphql/reference/objects#workflowrunfile",
+ "description": "<p>An executed workflow file for a workflow run.</p>",
+ "implements": [
+ {
+ "name": "Node",
+ "id": "node",
+ "href": "/graphql/reference/interfaces#node"
+ },
+ {
+ "name": "UniformResourceLocatable",
+ "id": "uniformresourcelocatable",
+ "href": "/graphql/reference/interfaces#uniformresourcelocatable"
+ }
+ ],
+ "fields": [
+ {
+ "name": "path",
+ "description": "<p>The path of the workflow file relative to its repository.</p>",
+ "type": "String!",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ },
+ {
+ "name": "repositoryFileUrl",
+ "description": "<p>The direct link to the file in the repository which stores the workflow file.</p>",
+ "type": "URI!",
+ "id": "uri",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#uri"
+ },
+ {
+ "name": "repositoryName",
+ "description": "<p>The repository name and owner which stores the workflow file.</p>",
+ "type": "URI!",
+ "id": "uri",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#uri"
+ },
+ {
+ "name": "resourcePath",
+ "description": "<p>The HTTP path for this workflow run file.</p>",
+ "type": "URI!",
+ "id": "uri",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#uri"
+ },
+ {
+ "name": "run",
+ "description": "<p>The parent workflow run execution for this file.</p>",
+ "type": "WorkflowRun!",
+ "id": "workflowrun",
+ "kind": "objects",
+ "href": "/graphql/reference/objects#workflowrun"
+ },
+ {
+ "name": "url",
+ "description": "<p>The HTTP URL for this workflow run file.</p>",
+ "type": "URI!",
+ "id": "uri",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#uri"
+ },
+ {
+ "name": "viewerCanPushRepository",
+ "description": "<p>If the viewer has permissions to push to the repository which stores the workflow.</p>",
+ "type": "Boolean!",
+ "id": "boolean",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#boolean"
+ },
+ {
+ "name": "viewerCanReadRepository",
+ "description": "<p>If the viewer has permissions to read the repository which stores the workflow.</p>",
+ "type": "Boolean!",
+ "id": "boolean",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#boolean"
+ }
+ ]
}
],
"interfaces": [
@@ -67687,6 +68128,14 @@
"id": "migrationstate",
"kind": "enums",
"href": "/graphql/reference/enums#migrationstate"
+ },
+ {
+ "name": "warningsCount",
+ "description": "<p>The number of warnings encountered for this migration. To review the warnings,\ncheck the <a href=\"https://docs.github.com/en/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/accessing-your-migration-logs-for-github-enterprise-importer\">Migration Log</a>.</p>",
+ "type": "Int!",
+ "id": "int",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#int"
}
]
},
@@ -67749,7 +68198,7 @@
"fields": [
{
"name": "oauthApplicationName",
- "description": "<p>The name of the OAuth Application.</p>",
+ "description": "<p>The name of the OAuth application.</p>",
"type": "String",
"id": "string",
"kind": "scalars",
@@ -67757,7 +68206,7 @@
},
{
"name": "oauthApplicationResourcePath",
- "description": "<p>The HTTP path for the OAuth Application.</p>",
+ "description": "<p>The HTTP path for the OAuth application.</p>",
"type": "URI",
"id": "uri",
"kind": "scalars",
@@ -67765,7 +68214,7 @@
},
{
"name": "oauthApplicationUrl",
- "description": "<p>The HTTP URL for the OAuth Application.</p>",
+ "description": "<p>The HTTP URL for the OAuth application.</p>",
"type": "URI",
"id": "uri",
"kind": "scalars",
@@ -68861,6 +69310,14 @@
"href": "/graphql/reference/interfaces#repositoryinfo",
"description": "<p>A subset of repository info.</p>",
"fields": [
+ {
+ "name": "archivedAt",
+ "description": "<p>Identifies the date and time when the repository was archived.</p>",
+ "type": "DateTime",
+ "id": "datetime",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#datetime"
+ },
{
"name": "createdAt",
"description": "<p>Identifies the date and time when the object was created.</p>",
@@ -69055,7 +69512,7 @@
},
{
"name": "pushedAt",
- "description": "<p>Identifies when the repository was last pushed to.</p>",
+ "description": "<p>Identifies the date and time when the repository was last pushed to.</p>",
"type": "DateTime",
"id": "datetime",
"kind": "scalars",
@@ -71374,19 +71831,19 @@
"kind": "enums",
"id": "oauthapplicationcreateauditentrystate",
"href": "/graphql/reference/enums#oauthapplicationcreateauditentrystate",
- "description": "<p>The state of an OAuth Application when it was created.</p>",
+ "description": "<p>The state of an OAuth application when it was created.</p>",
"values": [
{
"name": "ACTIVE",
- "description": "<p>The OAuth Application was active and allowed to have OAuth Accesses.</p>"
+ "description": "<p>The OAuth application was active and allowed to have OAuth Accesses.</p>"
},
{
"name": "PENDING_DELETION",
- "description": "<p>The OAuth Application was in the process of being deleted.</p>"
+ "description": "<p>The OAuth application was in the process of being deleted.</p>"
},
{
"name": "SUSPENDED",
- "description": "<p>The OAuth Application was suspended from generating OAuth Accesses due to abuse or security concerns.</p>"
+ "description": "<p>The OAuth application was suspended from generating OAuth Accesses due to abuse or security concerns.</p>"
}
]
},
@@ -71823,6 +72280,10 @@
"name": "FAILED",
"description": "<p>The Octoshift migration has failed.</p>"
},
+ {
+ "name": "FAILED_VALIDATION",
+ "description": "<p>The Octoshift migration has invalid credentials.</p>"
+ },
{
"name": "IN_PROGRESS",
"description": "<p>The Octoshift migration is in progress.</p>"
@@ -71831,6 +72292,10 @@
"name": "NOT_STARTED",
"description": "<p>The Octoshift migration has not started.</p>"
},
+ {
+ "name": "PENDING_VALIDATION",
+ "description": "<p>The Octoshift migration needs to have its credentials validated.</p>"
+ },
{
"name": "POST_REPO_MIGRATION",
"description": "<p>The Octoshift migration is performing post repository migrations.</p>"
@@ -72391,6 +72856,31 @@
}
]
},
+ {
+ "name": "ProjectV2Roles",
+ "kind": "enums",
+ "id": "projectv2roles",
+ "href": "/graphql/reference/enums#projectv2roles",
+ "description": "<p>The possible roles of a collaborator on a project.</p>",
+ "values": [
+ {
+ "name": "ADMIN",
+ "description": "<p>The collaborator can view, edit, and maange the settings of the project.</p>"
+ },
+ {
+ "name": "NONE",
+ "description": "<p>The collaborator has no direct access to the project.</p>"
+ },
+ {
+ "name": "READER",
+ "description": "<p>The collaborator can view the project.</p>"
+ },
+ {
+ "name": "WRITER",
+ "description": "<p>The collaborator can view and edit the project.</p>"
+ }
+ ]
+ },
{
"name": "ProjectV2SingleSelectFieldOptionColor",
"kind": "enums",
@@ -72674,10 +73164,6 @@
"href": "/graphql/reference/enums#pullrequesttimelineitemsitemtype",
"description": "<p>The possible item types found in a timeline.</p>",
"values": [
- {
- "name": "ADDED_TO_MERGE_QUEUE_EVENT",
- "description": "<p>Represents an<code>added_to_merge_queue</code>event on a given pull request.</p>"
- },
{
"name": "ADDED_TO_PROJECT_EVENT",
"description": "<p>Represents a<code>added_to_project</code>event on a given issue or pull request.</p>"
@@ -72842,10 +73328,6 @@
"name": "REFERENCED_EVENT",
"description": "<p>Represents a<code>referenced</code>event on a given <code>ReferencedSubject</code>.</p>"
},
- {
- "name": "REMOVED_FROM_MERGE_QUEUE_EVENT",
- "description": "<p>Represents a<code>removed_from_merge_queue</code>event on a given pull request.</p>"
- },
{
"name": "REMOVED_FROM_PROJECT_EVENT",
"description": "<p>Represents a<code>removed_from_project</code>event on a given issue or pull request.</p>"
@@ -73646,6 +74128,10 @@
{
"name": "RUST",
"description": "<p>Rust crates.</p>"
+ },
+ {
+ "name": "SWIFT",
+ "description": "<p>Swift packages.</p>"
}
]
},
@@ -73905,6 +74391,23 @@
}
]
},
+ {
+ "name": "TeamNotificationSetting",
+ "kind": "enums",
+ "id": "teamnotificationsetting",
+ "href": "/graphql/reference/enums#teamnotificationsetting",
+ "description": "<p>The possible team notification values.</p>",
+ "values": [
+ {
+ "name": "NOTIFICATIONS_DISABLED",
+ "description": "<p>No one will receive notifications.</p>"
+ },
+ {
+ "name": "NOTIFICATIONS_ENABLED",
+ "description": "<p>Everyone will receive notifications when the team is @mentioned.</p>"
+ }
+ ]
+ },
{
"name": "TeamOrderField",
"kind": "enums",
@@ -75068,6 +75571,25 @@
}
]
},
+ {
+ "name": "ProjectV2Actor",
+ "kind": "unions",
+ "id": "projectv2actor",
+ "href": "/graphql/reference/unions#projectv2actor",
+ "description": "<p>Possible collaborators for a project.</p>",
+ "possibleTypes": [
+ {
+ "name": "Team",
+ "id": "team",
+ "href": "/graphql/reference/objects#team"
+ },
+ {
+ "name": "User",
+ "id": "user",
+ "href": "/graphql/reference/objects#user"
+ }
+ ]
+ },
{
"name": "ProjectV2FieldConfiguration",
"kind": "unions",
@@ -81167,6 +81689,32 @@
}
]
},
+ {
+ "name": "MarkProjectV2AsTemplateInput",
+ "kind": "inputObjects",
+ "id": "markprojectv2astemplateinput",
+ "href": "/graphql/reference/input-objects#markprojectv2astemplateinput",
+ "description": "<p>Autogenerated input type of MarkProjectV2AsTemplate.</p>",
+ "inputFields": [
+ {
+ "name": "clientMutationId",
+ "description": "<p>A unique identifier for the client performing the mutation.</p>",
+ "type": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ },
+ {
+ "name": "projectId",
+ "description": "<p>The ID of the Project to mark as a template.</p>",
+ "type": "ID!",
+ "id": "id",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#id",
+ "isDeprecated": false
+ }
+ ]
+ },
{
"name": "MarkPullRequestReadyForReviewInput",
"kind": "inputObjects",
@@ -81681,6 +82229,41 @@
}
]
},
+ {
+ "name": "ProjectV2Collaborator",
+ "kind": "inputObjects",
+ "id": "projectv2collaborator",
+ "href": "/graphql/reference/input-objects#projectv2collaborator",
+ "description": "<p>A collaborator to update on a project. Only one of the userId or teamId should be provided.</p>",
+ "inputFields": [
+ {
+ "name": "role",
+ "description": "<p>The role to grant the collaborator.</p>",
+ "type": "ProjectV2Roles!",
+ "id": "projectv2roles",
+ "kind": "enums",
+ "href": "/graphql/reference/enums#projectv2roles"
+ },
+ {
+ "name": "teamId",
+ "description": "<p>The ID of the team as a collaborator.</p>",
+ "type": "ID",
+ "id": "id",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#id",
+ "isDeprecated": false
+ },
+ {
+ "name": "userId",
+ "description": "<p>The ID of the user as a collaborator.</p>",
+ "type": "ID",
+ "id": "id",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#id",
+ "isDeprecated": false
+ }
+ ]
+ },
{
"name": "ProjectV2FieldOrder",
"kind": "inputObjects",
@@ -82005,7 +82588,7 @@
"RefUpdate"
],
"owning_teams": [
- "@github/reponauts"
+ "@github/repos"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview-update-multiple-refs-in-a-single-operation-preview"
@@ -83553,6 +84136,32 @@
}
]
},
+ {
+ "name": "UnmarkProjectV2AsTemplateInput",
+ "kind": "inputObjects",
+ "id": "unmarkprojectv2astemplateinput",
+ "href": "/graphql/reference/input-objects#unmarkprojectv2astemplateinput",
+ "description": "<p>Autogenerated input type of UnmarkProjectV2AsTemplate.</p>",
+ "inputFields": [
+ {
+ "name": "clientMutationId",
+ "description": "<p>A unique identifier for the client performing the mutation.</p>",
+ "type": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ },
+ {
+ "name": "projectId",
+ "description": "<p>The ID of the Project to unmark as a template.</p>",
+ "type": "ID!",
+ "id": "id",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#id",
+ "isDeprecated": false
+ }
+ ]
+ },
{
"name": "UnminimizeCommentInput",
"kind": "inputObjects",
@@ -85297,6 +85906,40 @@
}
]
},
+ {
+ "name": "UpdateProjectV2CollaboratorsInput",
+ "kind": "inputObjects",
+ "id": "updateprojectv2collaboratorsinput",
+ "href": "/graphql/reference/input-objects#updateprojectv2collaboratorsinput",
+ "description": "<p>Autogenerated input type of UpdateProjectV2Collaborators.</p>",
+ "inputFields": [
+ {
+ "name": "clientMutationId",
+ "description": "<p>A unique identifier for the client performing the mutation.</p>",
+ "type": "String",
+ "id": "string",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#string"
+ },
+ {
+ "name": "collaborators",
+ "description": "<p>The collaborators to update.</p>",
+ "type": "[ProjectV2Collaborator!]!",
+ "id": "projectv2collaborator",
+ "kind": "input-objects",
+ "href": "/graphql/reference/input-objects#projectv2collaborator"
+ },
+ {
+ "name": "projectId",
+ "description": "<p>The ID of the project to update the collaborators for.</p>",
+ "type": "ID!",
+ "id": "id",
+ "kind": "scalars",
+ "href": "/graphql/reference/scalars#id",
+ "isDeprecated": false
+ }
+ ]
+ },
{
"name": "UpdateProjectV2DraftIssueInput",
"kind": "inputObjects",
@@ -85772,7 +86415,7 @@
"RefUpdate"
],
"owning_teams": [
- "@github/reponauts"
+ "@github/repos"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview-update-multiple-refs-in-a-single-operation-preview"
@@ -86393,7 +87036,7 @@
"RefUpdate"
],
"owning_teams": [
- "@github/reponauts"
+ "@github/repos"
],
"accept_header": "application/vnd.github.update-refs-preview+json",
"href": "/graphql/overview/schema-previews#update-refs-preview-update-multiple-refs-in-a-single-operation-preview"
diff --git a/src/graphql/data/ghes-3.10/upcoming-changes.json b/src/graphql/data/ghes-3.10/upcoming-changes.json
index 001ce54ac03d..7f980690de97 100644
--- a/src/graphql/data/ghes-3.10/upcoming-changes.json
+++ b/src/graphql/data/ghes-3.10/upcoming-changes.json
@@ -90,86 +90,6 @@
"criticality": "breaking",
"owner": "stevepopovich"
},
- {
- "location": "MergeQueueEntry.isSolo",
- "description": "<p><code>isSolo</code> will be removed. Use <code>solo</code> instead.</p>",
- "reason": "<p><code>isSolo</code> will be removed.</p>",
- "date": "2023-07-01",
- "criticality": "breaking",
- "owner": "github/merge_queue"
- },
- {
- "location": "MergeQueueEntry.headOid",
- "description": "<p><code>headOid</code> will be removed. Use <code>headCommit</code> instead.</p>",
- "reason": "<p><code>headOid</code> will be removed.</p>",
- "date": "2023-07-01",
- "criticality": "breaking",
- "owner": "github/merge_queue"
- },
- {
- "location": "MergeQueueEntry.hasJumpedQueue",
- "description": "<p><code>hasJumpedQueue</code> will be removed. Use <code>jump</code> instead.</p>",
- "reason": "<p><code>hasJumpedQueue</code> will be removed.</p>",
- "date": "2023-07-01",
- "criticality": "breaking",
- "owner": "github/merge_queue"
- },
- {
- "location": "MergeQueueEntry.checkStatus",
- "description": "<p><code>checkStatus</code> will be removed. Use <code>state</code> instead.</p>",
- "reason": "<p><code>checkStatus</code> will be removed.</p>",
- "date": "2023-07-01",
- "criticality": "breaking",
- "owner": "github/merge_queue"
- },
- {
- "location": "MergeQueueEntry.blockedByMergeConflicts",
- "description": "<p><code>blockedByMergeConflicts</code> will be removed. Use <code>state</code> instead.</p>",
- "reason": "<p><code>blockedByMergeConflicts</code> will be removed.</p>",
- "date": "2023-07-01",
- "criticality": "breaking",
- "owner": "github/merge_queue"
- },
- {
- "location": "MergeQueueEntry.baseOid",
- "description": "<p><code>baseOid</code> will be removed. Use <code>baseCommit</code> instead.</p>",
- "reason": "<p><code>baseOid</code> will be removed.</p>",
- "date": "2023-07-01",
- "criticality": "breaking",
- "owner": "github/merge_queue"
- },
- {
- "location": "MergeQueue.pendingRemovalEntries",
- "description": "<p><code>pendingRemovalEntries</code> will be removed.</p>",
- "reason": "<p><code>pendingRemovalEntries</code> will be removed.</p>",
- "date": "2023-07-01",
- "criticality": "breaking",
- "owner": "github/merge_queue"
- },
- {
- "location": "MergeQueue.mergingEntries",
- "description": "<p><code>mergingEntries</code> will be removed.</p>",
- "reason": "<p><code>mergingEntries</code> will be removed.</p>",
- "date": "2023-07-01",
- "criticality": "breaking",
- "owner": "github/merge_queue"
- },
- {
- "location": "MergeQueue.mergeMethod",
- "description": "<p><code>mergeMethod</code> will be removed. Use <code>configuration.merge_method</code> instead.</p>",
- "reason": "<p><code>mergeMethod</code> will be removed.</p>",
- "date": "2023-07-01",
- "criticality": "breaking",
- "owner": "github/merge_queue"
- },
- {
- "location": "MergeQueue.headOid",
- "description": "<p><code>headOid</code> will be removed. Use <code>entry.headOid</code> instead.</p>",
- "reason": "<p><code>headOid</code> will be removed.</p>",
- "date": "2023-07-01",
- "criticality": "breaking",
- "owner": "github/merge_queue"
- },
{
"location": "Commit.pushedDate",
"description": "<p><code>pushedDate</code> will be removed.</p>",
@@ -180,14 +100,6 @@
}
],
"2023-04-01": [
- {
- "location": "RepositoryVulnerabilityAlert.fixReason",
- "description": "<p><code>fixReason</code> will be removed.</p>",
- "reason": "<p>The <code>fixReason</code> field is being removed. You can still use <code>fixedAt</code> and <code>dismissReason</code>.</p>",
- "date": "2023-04-01",
- "criticality": "breaking",
- "owner": "jamestran201"
- },
{
"location": "Repository.squashPrTitleUsedAsDefault",
"description": "<p><code>squashPrTitleUsedAsDefault</code> will be removed. Use <code>Repository.squashMergeCommitTitle</code> instead.</p>",
@@ -221,16 +133,6 @@
"owner": "alcere"
}
],
- "2023-02-10": [
- {
- "location": "PackageType.MAVEN",
- "description": "<p><code>MAVEN</code> will be removed.</p>",
- "reason": "<p>MAVEN will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
- "date": "2023-02-10",
- "criticality": "breaking",
- "owner": "ankitkaushal01"
- }
- ],
"2023-01-01": [
{
"location": "ProjectV2View.visibleFields",
@@ -249,34 +151,6 @@
"owner": "adamshwert"
}
],
- "2022-12-28": [
- {
- "location": "PackageType.RUBYGEMS",
- "description": "<p><code>RUBYGEMS</code> will be removed.</p>",
- "reason": "<p>RUBYGEMS will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
- "date": "2022-12-28",
- "criticality": "breaking",
- "owner": "ankitkaushal01"
- }
- ],
- "2022-11-21": [
- {
- "location": "PackageType.NUGET",
- "description": "<p><code>NUGET</code> will be removed.</p>",
- "reason": "<p>NUGET will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
- "date": "2022-11-21",
- "criticality": "breaking",
- "owner": "s-anupam"
- },
- {
- "location": "PackageType.NPM",
- "description": "<p><code>NPM</code> will be removed.</p>",
- "reason": "<p>NPM will be removed from this enum as this type will be migrated to only be used by the Packages REST API.</p>",
- "date": "2022-11-21",
- "criticality": "breaking",
- "owner": "s-anupam"
- }
- ],
"2022-10-01": [
{
"location": "RemovePullRequestFromMergeQueueInput.branch",
diff --git a/src/graphql/pages/explorer.tsx b/src/graphql/pages/explorer.tsx
index 900d3ac964e4..c6e382504a5f 100644
--- a/src/graphql/pages/explorer.tsx
+++ b/src/graphql/pages/explorer.tsx
@@ -33,6 +33,7 @@ export default function GQLExplorer({ mainContext, graphqlExplorerUrl }: Props)
className="border width-full"
scrolling="no"
src={graphqlExplorerUrl}
+ title="GitHub GraphQL API"
>
<p>You must have iframes enabled to use this feature.</p>
</iframe>
diff --git a/src/landings/components/ArticleCards.tsx b/src/landings/components/ArticleCards.tsx
index 3b7935e7bda0..02b1390751c3 100644
--- a/src/landings/components/ArticleCards.tsx
+++ b/src/landings/components/ArticleCards.tsx
@@ -1,53 +1,17 @@
-import React, { useEffect, useRef, useState } from 'react'
+import React, { useRef } from 'react'
-import { ArticleGuide, useProductGuidesContext } from 'src/landings/components/ProductGuidesContext'
+import { useProductGuidesContext } from 'src/landings/components/ProductGuidesContext'
import { useTranslation } from 'components/hooks/useTranslation'
import { ArticleCard } from './ArticleCard'
-import { ActionList, ActionMenu } from '@primer/react'
import { ItemInput } from '@primer/react/lib/deprecated/ActionList/List'
-const PAGE_SIZE = 9
export const ArticleCards = () => {
const { t } = useTranslation('product_guides')
const guideTypes: Record<string, string> = t('guide_types')
const { allTopics, includeGuides } = useProductGuidesContext()
- const [numVisible, setNumVisible] = useState(PAGE_SIZE)
- const [typeFilter, setTypeFilter] = useState<ItemInput | undefined>()
- const [topicFilter, setTopicFilter] = useState<ItemInput | undefined>()
- const [filteredResults, setFilteredResults] = useState<Array<ArticleGuide>>([])
- const typesRef = useRef<HTMLDivElement>(null)
- const topicsRef = useRef<HTMLDivElement>(null)
const articleCardRef = useRef<HTMLUListElement>(null)
- useEffect(() => {
- setNumVisible(PAGE_SIZE)
- setFilteredResults(
- (includeGuides || []).filter((card) => {
- const matchesType = card.type === typeFilter?.key
- const matchesTopic = card.topics.some((key) => key === topicFilter?.key)
- return (typeFilter?.key ? matchesType : true) && (topicFilter?.key ? matchesTopic : true)
- }),
- )
- }, [typeFilter, topicFilter])
-
- const clickDropdown = (e: React.RefObject<HTMLDivElement>) => {
- if (e === typesRef && typesRef.current) typesRef.current.focus()
- if (e === topicsRef && topicsRef.current) topicsRef.current.focus()
- }
-
- const loadMore = () => {
- if (articleCardRef.current) {
- const childListLength = articleCardRef.current.childElementCount
- // Leading semi-colon due to prettier to prevent possible ASI failures
- // Need to explicitly type assert as HTMLDivElement as focus property missing from dom type definitions for Element.
- ;(articleCardRef.current.childNodes.item(childListLength - 1) as HTMLDivElement).focus()
- }
- setNumVisible(numVisible + PAGE_SIZE)
- }
-
- const isUserFiltering = typeFilter !== undefined || topicFilter !== undefined
-
- const guides = isUserFiltering ? filteredResults : includeGuides || []
+ const guides = includeGuides || []
const types = Object.entries(guideTypes).map(([key, val]) => {
return { text: val, key }
@@ -64,65 +28,6 @@ export const ArticleCards = () => {
return (
<div>
<div data-search="hide">
- <label htmlFor="guide-filter-form">{t('filter_instructions')}</label>
- <form name="guide-filter-form" className="mt-2 mb-5 d-flex d-flex">
- <div data-testid="card-filter-types">
- <div
- onClick={() => clickDropdown(typesRef)}
- onKeyDown={() => clickDropdown(typesRef)}
- role="button"
- tabIndex={-1}
- className="text-uppercase f6 color-fg-muted d-block"
- >
- {t('filters.type')}
- </div>
- <ActionMenu anchorRef={typesRef}>
- <ActionMenu.Button>
- {typeFilter ? typeFilter.text : t('filters.all')}
- </ActionMenu.Button>
- <ActionMenu.Overlay aria-label="types" data-testid="types-dropdown">
- <ActionList selectionVariant="single">
- {types.map((type) => {
- return (
- <ActionList.Item onSelect={() => setTypeFilter(type)} key={type.text}>
- {type.text}
- </ActionList.Item>
- )
- })}
- </ActionList>
- </ActionMenu.Overlay>
- </ActionMenu>
- </div>
-
- <div data-testid="card-filter-topics" className="mx-4">
- <div
- onClick={() => clickDropdown(topicsRef)}
- onKeyDown={() => clickDropdown(topicsRef)}
- role="button"
- tabIndex={-1}
- className="text-uppercase f6 color-fg-muted d-block"
- >
- {t('filters.topic')}
- </div>
- <ActionMenu anchorRef={topicsRef}>
- <ActionMenu.Button>
- {topicFilter ? topicFilter.text : t('filters.all')}
- </ActionMenu.Button>
- <ActionMenu.Overlay aria-label="topics" data-testid="topics-dropdown">
- <ActionList selectionVariant="single">
- {topics.map((topic) => {
- return (
- <ActionList.Item onSelect={() => setTopicFilter(topic)} key={topic.text}>
- {topic.text}
- </ActionList.Item>
- )
- })}
- </ActionList>
- </ActionMenu.Overlay>
- </ActionMenu>
- </div>
- </form>
-
<div role="status" className="color-fg-muted">
{guides.length === 0
? t('guides_found.none')
@@ -137,7 +42,7 @@ export const ArticleCards = () => {
ref={articleCardRef}
className="d-flex flex-wrap mr-0 mr-md-n6 mr-lg-n8"
>
- {guides.slice(0, numVisible).map((card, i) => {
+ {guides.map((card, i) => {
return (
<ArticleCard
tabIndex={-1}
@@ -148,16 +53,6 @@ export const ArticleCards = () => {
)
})}
</ul>
-
- {guides.length > numVisible && (
- <button
- className="col-12 mt-5 text-center text-bold color-fg-accent btn-link"
- data-search="hide"
- onClick={loadMore}
- >
- {t('load_more')}
- </button>
- )}
</div>
)
}
diff --git a/src/landings/components/ArticleList.tsx b/src/landings/components/ArticleList.tsx
index 3d0bed18ce1f..99d24dc93a1c 100644
--- a/src/landings/components/ArticleList.tsx
+++ b/src/landings/components/ArticleList.tsx
@@ -6,7 +6,6 @@ import { Link } from 'components/Link'
import { ArrowRightIcon } from '@primer/octicons-react'
import { FeaturedLink } from 'src/landings/components/ProductLandingContext'
import { useMainContext } from 'components/context/MainContext'
-import { TruncateLines } from 'components/ui/TruncateLines'
import { BumpLink } from 'components/ui/BumpLink'
export type ArticleListPropsT = {
@@ -73,9 +72,9 @@ export const ArticleList = ({
}
>
{link.intro && (
- <TruncateLines as="p" maxLines={2} className="color-fg-muted mb-0 mt-1">
- <span data-testid="link-with-intro-intro">{link.intro}</span>
- </TruncateLines>
+ <p className="color-fg-muted mb-0 mt-1" data-testid="link-with-intro-intro">
+ {link.intro}
+ </p>
)}
{link.date && (
<time
diff --git a/src/landings/components/CommunityExamples.tsx b/src/landings/components/CommunityExamples.tsx
index 16bb9e870b8a..884b2a285225 100644
--- a/src/landings/components/CommunityExamples.tsx
+++ b/src/landings/components/CommunityExamples.tsx
@@ -1,14 +1,8 @@
-import { useState } from 'react'
-import { ArrowRightIcon } from '@primer/octicons-react'
-
import { useProductLandingContext } from 'src/landings/components/ProductLandingContext'
-import { useTranslation } from 'components/hooks/useTranslation'
import { RepoCard } from 'src/landings/components/RepoCard'
export const CommunityExamples = () => {
const { productCommunityExamples } = useProductLandingContext()
- const { t } = useTranslation('product_landing')
- const [numVisible, setNumVisible] = useState(6)
if (!productCommunityExamples) {
return null
@@ -17,7 +11,7 @@ export const CommunityExamples = () => {
return (
<div>
<div className="d-flex flex-wrap gutter">
- {productCommunityExamples.slice(0, numVisible).map((repo) => {
+ {productCommunityExamples.map((repo) => {
return (
<div key={repo.repo} className="col-12 col-xl-4 col-lg-6 mb-4">
<RepoCard repo={repo} />
@@ -25,14 +19,6 @@ export const CommunityExamples = () => {
)
})}
</div>
- {numVisible < productCommunityExamples.length && (
- <button
- className="btn btn-outline float-right"
- onClick={() => setNumVisible(productCommunityExamples.length)}
- >
- {t('show_more')} <ArrowRightIcon />
- </button>
- )}
</div>
)
}
diff --git a/src/landings/components/LandingSection.tsx b/src/landings/components/LandingSection.tsx
index f33758ff6dc7..5ea7992a36a1 100644
--- a/src/landings/components/LandingSection.tsx
+++ b/src/landings/components/LandingSection.tsx
@@ -11,14 +11,16 @@ type Props = {
export const LandingSection = ({ title, children, className, sectionLink, description }: Props) => {
return (
<div className={cx('container-xl px-3 px-md-6 mt-6', className)}>
- {title && (
- <HeadingLink as="h2" slug={sectionLink} className="mb-4">
- {title}
- </HeadingLink>
- )}
- {description && (
- <div className="color-fg-muted f4" dangerouslySetInnerHTML={{ __html: description }} />
- )}
+ <div className="mb-4">
+ {title && (
+ <HeadingLink as="h2" slug={sectionLink}>
+ {title}
+ </HeadingLink>
+ )}
+ {description && (
+ <div className="color-fg-muted f4" dangerouslySetInnerHTML={{ __html: description }} />
+ )}
+ </div>
{children}
</div>
)
diff --git a/src/landings/components/ProductArticlesList.tsx b/src/landings/components/ProductArticlesList.tsx
index 19885e3e2958..188abe9fb367 100644
--- a/src/landings/components/ProductArticlesList.tsx
+++ b/src/landings/components/ProductArticlesList.tsx
@@ -14,13 +14,11 @@ export const ProductArticlesList = () => {
return (
<div className="d-flex gutter flex-wrap" data-testid="product-articles-list">
- {currentProductTree.childPages.map((treeNode, i) => {
- if (treeNode.childPages.length === 0) {
- return null
- }
-
- return <ProductTreeNodeList key={treeNode.href + i} treeNode={treeNode} />
- })}
+ {currentProductTree.childPages
+ .filter((treeNode) => treeNode.childPages.length)
+ .map((treeNode) => {
+ return <ProductTreeNodeList key={treeNode.href} treeNode={treeNode} />
+ })}
</div>
)
}
@@ -48,7 +46,7 @@ const ProductTreeNodeList = ({ treeNode }: { treeNode: ProductTreeNode }) => {
},
}}
>
- <Link className="d-block width-full" href={childNode.href}>
+ <Link className="d-block width-full text-underline" href={childNode.href}>
{childNode.title}
{childNode.childPages.length > 0 ? (
<small className="color-fg-muted d-inline-block">
diff --git a/src/landings/components/RepoCard.tsx b/src/landings/components/RepoCard.tsx
index 008dd5f75fba..8a046d4d2e90 100644
--- a/src/landings/components/RepoCard.tsx
+++ b/src/landings/components/RepoCard.tsx
@@ -19,7 +19,7 @@ export const RepoCard = ({ repo, href }: Props) => {
/>
</div>
<div className="flex-auto">
- <h4>{repo.repo}</h4>
+ <h3 className="wb-break-word">{repo.repo}</h3>
<p className="mt-1 color-fg-muted">{repo.description}</p>
</div>
</a>
diff --git a/src/landings/components/SidebarProduct.tsx b/src/landings/components/SidebarProduct.tsx
index 479e1677e64f..d49903130ab3 100644
--- a/src/landings/components/SidebarProduct.tsx
+++ b/src/landings/components/SidebarProduct.tsx
@@ -4,7 +4,6 @@ import { TreeView } from '@primer/react'
import cx from 'classnames'
import { useMainContext } from 'components/context/MainContext'
-import { useTranslation } from 'components/hooks/useTranslation'
import { Link } from 'components/Link'
import { RestCollapsibleSection } from 'src/rest/components/RestCollapsibleSection'
import { ProductCollapsibleSection } from 'components/sidebar/ProductCollapsibleSection'
@@ -19,7 +18,6 @@ export const SidebarProduct = () => {
// more "compressed" tree that is as light as possible.
sidebarTree,
} = useMainContext()
- const { t } = useTranslation(['products'])
const isRestPage = currentProduct && currentProduct.id === 'rest'
useEffect(() => {
@@ -164,17 +162,9 @@ export const SidebarProduct = () => {
})}
</TreeView>
</div>
- <div className="my-3">
- <div
- role="separator"
- aria-hidden="true"
- data-view-component="true"
- className="mb-3"
- ></div>
- <span data-testid="rest-sidebar-reference" className={cx('f6 pl-3 color-fg-muted')}>
- {t('rest.reference.api_reference')}
- </span>
- </div>
+
+ <hr data-testid="rest-sidebar-reference" />
+
<TreeView>
{restPages.map((childPage, i) => {
const childTitle = childPage.title
diff --git a/src/landings/components/SponsorsExamples.tsx b/src/landings/components/SponsorsExamples.tsx
index 25ce7102b852..a6c549d26abf 100644
--- a/src/landings/components/SponsorsExamples.tsx
+++ b/src/landings/components/SponsorsExamples.tsx
@@ -1,13 +1,8 @@
-import { ArrowRightIcon } from '@primer/octicons-react'
-
-import { Link } from 'components/Link'
import { useProductLandingContext } from 'src/landings/components/ProductLandingContext'
-import { useTranslation } from 'components/hooks/useTranslation'
import { UserCard } from 'src/landings/components/UserCard'
export const SponsorsExamples = () => {
const { productUserExamples } = useProductLandingContext()
- const { t } = useTranslation('product_landing')
if (!productUserExamples) {
return null
@@ -16,7 +11,7 @@ export const SponsorsExamples = () => {
return (
<div>
<div className="d-flex flex-wrap gutter">
- {productUserExamples.slice(0, 6).map((user) => {
+ {productUserExamples.map((user) => {
return (
<div key={user.username} className="col-12 col-xl-4 col-lg-6 mb-4">
<UserCard href={`https://github.com/sponsors/${user.username}`} user={user} />
@@ -24,9 +19,6 @@ export const SponsorsExamples = () => {
)
})}
</div>
- <Link href={`https://github.com/sponsors/community`} className="btn btn-outline float-right">
- {t('explore_people_and_projects')} <ArrowRightIcon />
- </Link>
</div>
)
}
diff --git a/src/landings/components/UserCard.tsx b/src/landings/components/UserCard.tsx
index ac3b727a533c..f36b43e63bcc 100644
--- a/src/landings/components/UserCard.tsx
+++ b/src/landings/components/UserCard.tsx
@@ -19,7 +19,7 @@ export const UserCard = ({ user, href }: Props) => {
/>
</div>
<div className="flex-auto">
- <h4>{user.username}</h4>
+ <h3 className="wb-break-word">{user.username}</h3>
<p className="mt-1 color-fg-muted">{user.description}</p>
</div>
</a>
diff --git a/src/learning-track/components/article/LearningTrackCard.tsx b/src/learning-track/components/article/LearningTrackCard.tsx
index 3feb4c4e607c..353c0ca5c089 100644
--- a/src/learning-track/components/article/LearningTrackCard.tsx
+++ b/src/learning-track/components/article/LearningTrackCard.tsx
@@ -18,9 +18,11 @@ export function LearningTrackCard({ track }: Props) {
className="py-3 px-4 rounded color-bg-default border d-flex flex-justify-between mb-4 mx-2"
>
<div className="d-flex flex-column width-full">
- <Link href={`/${locale}/${trackProduct}/guides`} className="h4 color-fg-default mb-1">
- {trackTitle}
- </Link>
+ <h2 className="h4">
+ <Link href={`/${locale}/${trackProduct}/guides`} className="mb-1 text-underline">
+ {trackTitle}
+ </Link>
+ </h2>
<span className="f5 color-fg-muted">
{t('current_progress')
.replace('{n}', numberOfGuides)
diff --git a/src/learning-track/components/guides/LearningTrack.module.scss b/src/learning-track/components/guides/LearningTrack.module.scss
deleted file mode 100644
index 9a798b42d000..000000000000
--- a/src/learning-track/components/guides/LearningTrack.module.scss
+++ /dev/null
@@ -1,7 +0,0 @@
-.fadeBottom {
- background: linear-gradient(to top, var(--color-canvas-default), transparent);
-}
-
-.removeHoverEvents {
- pointer-events: none;
-}
diff --git a/src/learning-track/components/guides/LearningTrack.tsx b/src/learning-track/components/guides/LearningTrack.tsx
index d2b834e40b56..d5dc2d2bc0e8 100644
--- a/src/learning-track/components/guides/LearningTrack.tsx
+++ b/src/learning-track/components/guides/LearningTrack.tsx
@@ -1,130 +1,48 @@
-import cx from 'classnames'
import { useTranslation } from 'components/hooks/useTranslation'
import { ArrowRightIcon } from '@primer/octicons-react'
-import { ActionList } from '@primer/react'
-import { useState } from 'react'
import { LearningTrack as LearningTrackT } from 'src/landings/components/ProductGuidesContext'
-import { TruncateLines } from 'components/ui/TruncateLines'
-import { slug } from 'github-slugger'
-import styles from './LearningTrack.module.scss'
import { Link } from 'components/Link'
+import { HeadingLink } from 'components/article/HeadingLink'
+
type Props = {
track: LearningTrackT
}
-const DEFAULT_VISIBLE_GUIDES = 4
export const LearningTrack = ({ track }: Props) => {
- const [numVisible, setNumVisible] = useState(DEFAULT_VISIBLE_GUIDES)
+ if (!track) return <div />
const { t } = useTranslation('product_guides')
- const titleSlug = track?.title ? slug(track?.title) : ''
- const showAll = () => {
- setNumVisible(track?.guides?.length || 0)
- }
return (
- <div data-testid="learning-track" className="my-3 px-4 col-12 col-md-6">
- <div className="Box d-flex flex-column">
- <div className="Box-header color-bg-subtle p-4 d-flex flex-1 flex-items-start flex-wrap">
- <div className="d-flex flex-auto flex-items-start col-7 col-md-7 col-xl-7">
- <div className="my-xl-0 mr-xl-3">
- <h3 id={titleSlug} className="mb-3 color-text f3 text-semibold">
- <a className="color-unset" href={`#${titleSlug}`}>
- {track?.title}
- </a>
- </h3>
- <TruncateLines as="p" maxLines={3} className="color-text">
- {track?.description}
- </TruncateLines>
- </div>
- </div>
- <Link
- {...{ 'aria-label': `${track?.title} - ${t('start_path')}` }}
- className="d-inline-flex btn no-wrap mt-3 mt-md-0 flex-items-center flex-justify-center"
- href={`${
- track?.guides && track?.guides[0].href
- }?learn=${track?.trackName}&learnProduct=${track?.trackProduct}`}
- >
- <span>{t('start_path')}</span>
- <ArrowRightIcon size={20} className="ml-2" />
- </Link>
- </div>
+ <div data-testid="learning-track" className="col-12 col-md-6 my-3 px-4">
+ <HeadingLink as="h3">{track.title}</HeadingLink>
+ <p className="color-text f4 color-fg-muted">{track.description}</p>
+
+ <Link
+ {...{ 'aria-label': `${track?.title} - ${t('start_path')}` }}
+ className="d-inline-flex btn"
+ href={`${track.guides?.[0].href}?learn=${track.trackName}&learnProduct=${track.trackProduct}`}
+ >
+ <span>{t('start_path')}</span>
+ <ArrowRightIcon size={20} className="ml-2" />
+ </Link>
- {track && track.guides && (
- <div style={{ counterReset: 'li' }}>
- <ActionList as="ol" variant="full">
- {track?.guides?.slice(0, numVisible).map((guide) => {
- return (
- <ActionList.Item
- as="li"
- key={guide.href + track?.trackName}
- className="width-full p-0"
- sx={{
- position: 'relative',
- borderRadius: 0,
- ':hover': {
- borderRadius: 0,
- },
- ':before': {
- width: 'calc(1.5rem - 0px)',
- height: 'calc(1.5rem - 0px)',
- fontSize: 'calc(1rem - 1px)',
- margin: '22px 0 0 1rem',
- content: 'counter(li)',
- counterIncrement: 'li',
- position: 'absolute',
- left: 0,
- color: 'var(--color-canvas-default)',
- fontWeight: 500,
- textAlign: 'center',
- borderRadius: '50%',
- backgroundColor: 'var(--color-fg-default)',
- },
- }}
- >
- <Link
- className="rounded-0 pl-7 py-4 width-full d-block Box-row d-flex flex-items-center color-fg-default no-underline"
- href={`${guide.href}?learn=${track?.trackName}&learnProduct=${track?.trackProduct}`}
- >
- <h4
- className="flex-auto pr-2 f5"
- dangerouslySetInnerHTML={{ __html: guide.title }}
- />
- <div className="color-fg-muted h6 text-uppercase flex-shrink-0">
- {t('guide_types')[guide.page?.type || '']}
- </div>
- </Link>
- </ActionList.Item>
- )
- })}
- </ActionList>
- </div>
- )}
- {
- <button
- data-search="hide"
- className={
- 'Box-footer btn-link border-top-0 position-relative text-center text-bold color-fg-accent pt-1 pb-3 col-12 ' +
- ((track?.guides?.length || 0) <= numVisible && cx(styles.removeHoverEvents))
- }
- onClick={showAll}
- >
- {(track?.guides?.length || 0) > numVisible ? (
- <div>
- <div
- className={cx('position-absolute left-0 right-0 py-5', styles.fadeBottom)}
- style={{ bottom: '50px' }}
- />
- <span>
- Show {(track?.guides?.length || 0) - numVisible} {t(`more_guides`)}
- </span>
- </div>
- ) : (
- <span className="color-fg-default">All guides shown</span>
- )}
- </button>
- }
- </div>
+ {track.guides && (
+ <ol className="pl-4 my-3 f4">
+ {track.guides.map((guide) => (
+ <li key={guide.href + track.trackName}>
+ <span className="color-fg-muted mr-2">
+ {t('guide_types')[guide.page?.type || '']}
+ </span>
+ <Link
+ href={`${guide.href}?learn=${track.trackName}&learnProduct=${track.trackProduct}`}
+ >
+ {guide.title}
+ </Link>
+ </li>
+ ))}
+ </ol>
+ )}
</div>
)
}
diff --git a/src/redirects/lib/static/redirect-exceptions.txt b/src/redirects/lib/static/redirect-exceptions.txt
index 10d1981fe052..b6b7d7e67fa2 100644
--- a/src/redirects/lib/static/redirect-exceptions.txt
+++ b/src/redirects/lib/static/redirect-exceptions.txt
@@ -37,3 +37,6 @@
/github-ae@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-advanced-setup-for-code-scanning
- /github-ae@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository
+
+/billing/managing-your-github-billing-settings/redeeming-a-coupon
+- /enterprise-cloud@latest/billing/managing-your-github-billing-settings/redeeming-a-coupon
\ No newline at end of file
diff --git a/src/release-notes/components/GHAEReleaseNotePatch.tsx b/src/release-notes/components/GHAEReleaseNotePatch.tsx
index e0167c5d90dc..d6dc0bb73aaf 100644
--- a/src/release-notes/components/GHAEReleaseNotePatch.tsx
+++ b/src/release-notes/components/GHAEReleaseNotePatch.tsx
@@ -15,7 +15,7 @@ export function GHAEReleaseNotePatch({ patch, currentVersion }: Props) {
<div ref={containerRef} className="mb-10 pb-6" id={patch.release}>
<header
style={{ zIndex: 1, marginTop: -1 }}
- className="container-xl border-top border-bottom px-3 pt-4 pb-2"
+ className="container-md border-top border-bottom px-3 pt-4 pb-2"
>
<div className="d-flex flex-items-center">
<h2 className="border-bottom-0 m-0 p-0">
@@ -36,7 +36,7 @@ export function GHAEReleaseNotePatch({ patch, currentVersion }: Props) {
</p>
</header>
- <div className="container-xl px-3">
+ <div className="container-md px-3">
<div className="mt-3" dangerouslySetInnerHTML={{ __html: patch.intro }} />
<PatchNotes patch={patch} />
diff --git a/src/release-notes/components/GHESReleaseNotePatch.tsx b/src/release-notes/components/GHESReleaseNotePatch.tsx
index e75a4dc75513..434df0cae049 100644
--- a/src/release-notes/components/GHESReleaseNotePatch.tsx
+++ b/src/release-notes/components/GHESReleaseNotePatch.tsx
@@ -27,7 +27,7 @@ export function GHESReleaseNotePatch({
<div ref={containerRef} className="mb-10 pb-6" id={patch.version}>
<header
style={{ zIndex: 1, marginTop: -1 }}
- className="container-xl border-top border-bottom px-3 pt-4 pb-2"
+ className="container-md border-top border-bottom px-3 pt-4 pb-2"
>
<div className="d-flex flex-justify-between flex-wrap">
<h2 className="border-bottom-0 m-0 p-0 mt-2">
@@ -85,7 +85,7 @@ export function GHESReleaseNotePatch({
)}
</header>
- <div className="container-xl px-3">
+ <div className="container-md px-3">
<div className="mt-3" dangerouslySetInnerHTML={{ __html: patch.intro }} />
<PatchNotes patch={patch} />
diff --git a/src/release-notes/components/PatchNotes.module.scss b/src/release-notes/components/PatchNotes.module.scss
index ec203991c069..47d81ef5376c 100644
--- a/src/release-notes/components/PatchNotes.module.scss
+++ b/src/release-notes/components/PatchNotes.module.scss
@@ -1,4 +1,5 @@
-@import "@primer/css/support/index.scss";
+@import "@primer/css/support/variables/layout.scss";
+@import "@primer/css/support/mixins/layout.scss";
@import "stylesheets/breakpoint-xxl.scss";
.aside {
diff --git a/src/release-notes/middleware/ghae-release-notes.js b/src/release-notes/middleware/ghae-release-notes.js
index b1e6065ce4e7..ba6c2793f4c5 100644
--- a/src/release-notes/middleware/ghae-release-notes.js
+++ b/src/release-notes/middleware/ghae-release-notes.js
@@ -15,7 +15,18 @@ export default async function ghaeReleaseNotesContext(req, res, next) {
)
return next()
- const ghaeReleaseNotes = getReleaseNotes('github-ae', req.language)
+ // (This applies to ghes release notes too)
+ // We deliberately force the language to be English for now.
+ // The underlying reason is that the content (in data/release-notes/**/*.yml)
+ // is Markdown that does NOT use variables controlled by English-only
+ // things like product names.
+ // Therefore, the **nouns (like product names) get translated** instead
+ // of left as is. For example. "Le GitHubbe Cöpilotte" instead
+ // of "GitHub Copilot".
+ // Until the Markdown sources used for release notes have Liquid
+ // variables (like `{% data variables.product.prodname_ghe_cloud %}}`)
+ // we'll force the text to be that from English.
+ const ghaeReleaseNotes = getReleaseNotes('github-ae', 'en')
// internalLatestRelease is set in lib/all-versions, e.g., '3.5' but UI still displays '@latest'.
let requestedRelease = req.context.currentVersionObj.internalLatestRelease
@@ -29,16 +40,29 @@ export default async function ghaeReleaseNotesContext(req, res, next) {
// Returns [{version, patches: [ {version, patchVersion, intro, date, sections: { features: [], bugs: []...}} ] }]
req.context.ghaeReleases = formatReleases(ghaeReleaseNotes)
+ // This means the AUTOTITLE links are in the current language, but
+ // since we're already force the source of the release notes from English
+ // exclusively, by doing this we can force all reusables to be in English
+ // too and leave links as is.
+ const originalLanguage = req.context.currentLanguage
+ req.context.autotitleLanguage = originalLanguage
+ req.context.currentLanguage = 'en'
+
// Run _all_ the GHAE patches through the markdown rendering pipeline.
// This is different from req.context.ghesReleaseNotes, which renders one release at a time.
// Returns all patches: [{version, patchVersion, intro, date, sections}]
- req.context.ghaeReleaseNotes = (
- await Promise.all(
- req.context.ghaeReleases.map(
- async (release) => await renderPatchNotes(release.patches, req.context),
- ),
- )
- ).flat()
+ try {
+ req.context.ghaeReleaseNotes = (
+ await Promise.all(
+ req.context.ghaeReleases.map(
+ async (release) => await renderPatchNotes(release.patches, req.context),
+ ),
+ )
+ ).flat()
+ } finally {
+ // Restore the original language
+ req.context.currentLanguage = originalLanguage
+ }
return next()
}
diff --git a/src/release-notes/middleware/ghes-release-notes.js b/src/release-notes/middleware/ghes-release-notes.js
index aa73b87ed145..d1c6ee617512 100644
--- a/src/release-notes/middleware/ghes-release-notes.js
+++ b/src/release-notes/middleware/ghes-release-notes.js
@@ -8,7 +8,18 @@ export default async function ghesReleaseNotesContext(req, res, next) {
const [requestedPlan, requestedRelease] = req.context.currentVersion.split('@')
if (requestedPlan !== 'enterprise-server') return next()
- const ghesReleaseNotes = getReleaseNotes('enterprise-server', req.language)
+ // (This applies to ghae release notes too)
+ // We deliberately force the language to be English for now.
+ // The underlying reason is that the content (in data/release-notes/**/*.yml)
+ // is Markdown that does NOT use variables controlled by English-only
+ // things like product names.
+ // Therefore, the **nouns (like product names) get translated** instead
+ // of left as is. For example. "Le GitHubbe Cöpilotte" instead
+ // of "GitHub Copilot".
+ // Until the Markdown sources used for release notes have Liquid
+ // variables (like `{% data variables.product.prodname_ghe_cloud %}}`)
+ // we'll force the text to be that from English.
+ const ghesReleaseNotes = getReleaseNotes('enterprise-server', 'en')
// If the requested GHES release isn't found in data/release-notes/enterprise-server/*,
// and it IS a valid GHES release, try being helpful and redirecting to the old location.
@@ -32,23 +43,35 @@ export default async function ghesReleaseNotesContext(req, res, next) {
(r) => r.version === requestedRelease,
).patches
- // Run the current release notes through the markdown rendering pipeline.
- // Returns the current release's patches array: [{version, patchVersion, intro, date, sections}]
- req.context.ghesReleaseNotes = await executeWithFallback(
- req.context,
- () => renderPatchNotes(currentReleaseNotes, req.context),
- (enContext) => {
- // Something in the release notes ultimately caused a Liquid
- // rendering error. Let's start over and gather the English release
- // notes instead.
- const ghesReleaseNotes = getReleaseNotes('enterprise-server', 'en')
- enContext.ghesReleases = formatReleases(ghesReleaseNotes)
- const currentReleaseNotes = enContext.ghesReleases.find(
- (r) => r.version === requestedRelease,
- ).patches
- return renderPatchNotes(currentReleaseNotes, enContext)
- },
- )
+ // This means the AUTOTITLE links are in the current language, but
+ // since we're already force the source of the release notes from English
+ // exclusively, by doing this we can force all reusables to be in English
+ // too and leave links as is.
+ const originalLanguage = req.context.currentLanguage
+ req.context.autotitleLanguage = originalLanguage
+ req.context.currentLanguage = 'en'
+
+ try {
+ // Run the current release notes through the markdown rendering pipeline.
+ // Returns the current release's patches array: [{version, patchVersion, intro, date, sections}]
+ req.context.ghesReleaseNotes = await executeWithFallback(
+ req.context,
+ () => renderPatchNotes(currentReleaseNotes, req.context),
+ (enContext) => {
+ // Something in the release notes ultimately caused a Liquid
+ // rendering error. Let's start over and gather the English release
+ // notes instead.
+ enContext.ghesReleases = formatReleases(ghesReleaseNotes)
+ const currentReleaseNotes = enContext.ghesReleases.find(
+ (r) => r.version === requestedRelease,
+ ).patches
+ return renderPatchNotes(currentReleaseNotes, enContext)
+ },
+ )
+ } finally {
+ // Restore the original language
+ req.context.currentLanguage = originalLanguage
+ }
// GHES release notes on docs started with 2.20 but older release notes exist on enterprise.github.com.
// So we want to use _all_ GHES versions when calculating next and previous releases.
diff --git a/src/rest/components/RestCodeSamples.module.scss b/src/rest/components/RestCodeSamples.module.scss
index 3b11325e0694..a7b6ee1e4f0b 100644
--- a/src/rest/components/RestCodeSamples.module.scss
+++ b/src/rest/components/RestCodeSamples.module.scss
@@ -1,4 +1,5 @@
-@import "@primer/css/support/index.scss";
+@import "@primer/css/support/variables/layout.scss";
+@import "@primer/css/support/mixins/layout.scss";
.codeBlock {
overflow-y: auto;
@@ -9,8 +10,8 @@
code {
background-color: transparent;
- padding: 8px 8px 16px;
- max-width: 90vw;
+ padding: 0.5rem 0.5rem 1rem;
+ max-width: calc(100vw - 2.5rem);
@include breakpoint(lg) {
max-width: 40vw;
diff --git a/src/rest/components/RestCodeSamples.tsx b/src/rest/components/RestCodeSamples.tsx
index 6d9a6304f210..c85c972aa011 100644
--- a/src/rest/components/RestCodeSamples.tsx
+++ b/src/rest/components/RestCodeSamples.tsx
@@ -261,8 +261,8 @@ export function RestCodeSamples({ operation, slug, heading }: Props) {
}
}}
tabIndex={0}
- selected={optionKey === selectedLanguage}
- className="pr-3 mr-0"
+ aria-current={optionKey === selectedLanguage}
+ className={cx('pr-3 mr-0', optionKey === selectedLanguage && 'PRC-selected')}
sx={{
cursor: 'pointer',
}}
@@ -303,12 +303,12 @@ export function RestCodeSamples({ operation, slug, heading }: Props) {
</div>
{/* Response section */}
- <div
+ <h4
className="mt-5 mb-2 h5"
dangerouslySetInnerHTML={{
__html: displayedExample.response.description || t('rest.reference.response'),
}}
- ></div>
+ ></h4>
<div className="border rounded-1">
{displayedExample.response.schema ? (
@@ -328,8 +328,8 @@ export function RestCodeSamples({ operation, slug, heading }: Props) {
}
}}
tabIndex={0}
- selected={optionKey === selectedResponse}
- className="pr-3 mr-0 ml-2"
+ aria-current={optionKey === selectedResponse}
+ className={cx('pr-3 mr-0 ml-2', optionKey === selectedResponse && 'PRC-selected')}
sx={{
cursor: 'pointer',
}}
diff --git a/src/rest/components/RestMethod.tsx b/src/rest/components/RestMethod.tsx
index 9b47f4d1a9a4..4ee69c19b672 100644
--- a/src/rest/components/RestMethod.tsx
+++ b/src/rest/components/RestMethod.tsx
@@ -10,7 +10,10 @@ type RestMethodT = {
export function RestMethod({ verb, requestPath }: RestMethodT) {
// If the path is long, we want to break it up into multiple lines,
// breaking before the / character.
- const displayPath = requestPath.length > 25 ? requestPath.replaceAll('/', '<wbr/>/') : requestPath
+ const displayPath =
+ requestPath.length > 25
+ ? requestPath.replaceAll('/', '<wbr/>/').replaceAll('_', '_<wbr/>')
+ : requestPath
return (
<div className={cx(styles.method, 'my-0 text-mono d-flex flex-row flex-items-start ')}>
<span className="IssueLabel IssueLabel--big color-bg-accent-emphasis color-fg-on-emphasis text-uppercase mr-2">
diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json
index e5ae33ed1672..0d1feafc00b2 100644
--- a/src/rest/data/fpt-2022-11-28/schema.json
+++ b/src/rest/data/fpt-2022-11-28/schema.json
@@ -90008,7 +90008,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/rest/reference/apps/#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -98725,7 +98725,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/rest/reference/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -130933,7 +130933,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -134775,7 +134775,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. See the <a href=\"https://docs.github.com/rest/reference/checks#actions-object\"><code>actions</code> object</a> description. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -142510,7 +142510,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/rest/reference/checks#check-runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/rest/checks/runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -152471,7 +152471,8 @@
"python"
],
"query_suite": "default",
- "updated_at": "2023-01-19T11:21:34Z"
+ "updated_at": "2023-01-19T11:21:34Z",
+ "schedule": "weekly"
},
"schema": {
"description": "Configuration for code scanning default setup.",
@@ -152522,6 +152523,17 @@
"examples": [
"2023-12-06T14:20:20.000Z"
]
+ },
+ "schedule": {
+ "description": "The frequency of the periodic analysis.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "enum": [
+ "weekly",
+ null
+ ]
}
}
}
@@ -152797,7 +152809,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the <code>security_events</code> scope to use this endpoint for private repositories. You can also use tokens with the <code>public_repo</code> scope for public repositories only. GitHub Apps must have the <code>security_events</code> write permission to use this endpoint.</p>\n<p>There are two places where you can upload code scanning results.</p>\n<ul>\n<li>If you upload to a pull request, for example <code>--ref refs/pull/42/merge</code> or <code>--ref refs/pull/42/head</code>, then the results appear as alerts in a pull request check. For more information, see \"<a href=\"/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests\">Triaging code scanning alerts in pull requests</a>.\"</li>\n<li>If you upload to a branch, for example <code>--ref refs/heads/my-branch</code>, then the results appear in the <strong>Security</strong> tab for your repository. For more information, see \"<a href=\"/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository\">Managing code scanning alerts for your repository</a>.\"</li>\n</ul>\n<p>You must compress the SARIF-formatted analysis data that you want to upload, using <code>gzip</code>, and then encode it as a Base64 format string. For example:</p>\n<pre><code>gzip -c analysis-data.sarif | base64 -w0\n</code></pre>\n<br>\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\"><strong>SARIF data</strong></th><th align=\"center\" scope=\"col\"><strong>Maximum values</strong></th><th scope=\"col\"><strong>Additional limits</strong></th></tr></thead><tbody><tr><td>Runs per file</td><td align=\"center\">20</td><td></td></tr><tr><td>Results per run</td><td align=\"center\">25,000</td><td>Only the top 5,000 results will be included, prioritized by severity.</td></tr><tr><td>Rules per run</td><td align=\"center\">25,000</td><td></td></tr><tr><td>Tool extensions per run</td><td align=\"center\">100</td><td></td></tr><tr><td>Thread Flow Locations per result</td><td align=\"center\">10,000</td><td>Only the top 1,000 Thread Flow Locations will be included, using prioritization.</td></tr><tr><td>Location per result</td><td align=\"center\">1,000</td><td>Only 100 locations will be included.</td></tr><tr><td>Tags per rule</td><td align=\"center\">20</td><td>Only 10 tags will be included.</td></tr></tbody></table>\n<p>The <code>202 Accepted</code> response includes an <code>id</code> value.\nYou can use this ID to check the status of the upload by using it in the <code>/sarifs/{sarif_id}</code> endpoint.\nFor more information, see \"<a href=\"/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload\">Get information about a SARIF upload</a>.\"</p>",
+ "descriptionHTML": "<p>Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the <code>security_events</code> scope to use this endpoint for private repositories. You can also use tokens with the <code>public_repo</code> scope for public repositories only. GitHub Apps must have the <code>security_events</code> write permission to use this endpoint. For troubleshooting information, see \"<a href=\"https://docs.github.com/code-security/code-scanning/troubleshooting-sarif\">Troubleshooting SARIF uploads</a>.\"</p>\n<p>There are two places where you can upload code scanning results.</p>\n<ul>\n<li>If you upload to a pull request, for example <code>--ref refs/pull/42/merge</code> or <code>--ref refs/pull/42/head</code>, then the results appear as alerts in a pull request check. For more information, see \"<a href=\"/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests\">Triaging code scanning alerts in pull requests</a>.\"</li>\n<li>If you upload to a branch, for example <code>--ref refs/heads/my-branch</code>, then the results appear in the <strong>Security</strong> tab for your repository. For more information, see \"<a href=\"/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository\">Managing code scanning alerts for your repository</a>.\"</li>\n</ul>\n<p>You must compress the SARIF-formatted analysis data that you want to upload, using <code>gzip</code>, and then encode it as a Base64 format string. For example:</p>\n<pre><code>gzip -c analysis-data.sarif | base64 -w0\n</code></pre>\n<br>\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\"><strong>SARIF data</strong></th><th align=\"center\" scope=\"col\"><strong>Maximum values</strong></th><th scope=\"col\"><strong>Additional limits</strong></th></tr></thead><tbody><tr><td>Runs per file</td><td align=\"center\">20</td><td></td></tr><tr><td>Results per run</td><td align=\"center\">25,000</td><td>Only the top 5,000 results will be included, prioritized by severity.</td></tr><tr><td>Rules per run</td><td align=\"center\">25,000</td><td></td></tr><tr><td>Tool extensions per run</td><td align=\"center\">100</td><td></td></tr><tr><td>Thread Flow Locations per result</td><td align=\"center\">10,000</td><td>Only the top 1,000 Thread Flow Locations will be included, using prioritization.</td></tr><tr><td>Location per result</td><td align=\"center\">1,000</td><td>Only 100 locations will be included.</td></tr><tr><td>Tags per rule</td><td align=\"center\">20</td><td>Only 10 tags will be included.</td></tr></tbody></table>\n<p>The <code>202 Accepted</code> response includes an <code>id</code> value.\nYou can use this ID to check the status of the upload by using it in the <code>/sarifs/{sarif_id}</code> endpoint.\nFor more information, see \"<a href=\"/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload\">Get information about a SARIF upload</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -191440,7 +191452,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
- "description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/reference/codespaces#get-the-public-key-for-the-authenticated-user\">Get the public key for the authenticated user</a> endpoint.</p>"
+ "description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user\">Get the public key for the authenticated user</a> endpoint.</p>"
},
{
"type": "string",
@@ -194720,7 +194732,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/rest/collaborators/invitations\">API</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -210127,7 +210139,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/rest/reference/repos#custom-media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
+ "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/rest/overview/media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -231393,7 +231405,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/reference/actions#secrets\">Secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
+ "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/actions/secrets\">GitHub Actions secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -251819,10 +251831,10 @@
},
{
"name": "ref",
- "description": "<p>The name of the fully qualified reference to update. For example, <code>refs/heads/master</code>. If the value doesn't start with <code>refs</code> and have at least two slashes, it will be rejected.</p>",
+ "description": "<p>The name of the reference to update (for example, <code>heads/featureA</code>). Can be a branch name (<code>heads/BRANCH_NAME</code>) or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
- "example": "refs/head/master",
+ "example": "heads/featureA",
"schema": {
"type": "string"
},
@@ -329038,8 +329050,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Lists the most commonly used licenses on GitHub. For more information, see \"<a href=\"https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -329234,8 +329246,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Gets information about a specific license. For more information, see \"<a href=\"https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -330262,7 +330274,7 @@
},
"response": {
"statusCode": "200",
- "contentType": "text/plain",
+ "contentType": "application/json",
"description": "<p>Example response</p>",
"example": "Responsive is better than fast",
"schema": {
@@ -365678,7 +365690,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/rest/reference/orgs#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -366137,7 +366149,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/rest/reference/orgs#update-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -403071,7 +403083,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/rest/reference/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/rest/reference/pulls#update-a-pull-request\">edit</a> a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
+ "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/rest/pulls/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/rest/pulls/pulls#update-a-pull-request\">edit</a> a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -407804,7 +407816,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/rest/reference/repos#list-commits\">List commits</a> endpoint.</p>",
+ "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/rest/commits/commits#list-commits\">List commits</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -408278,7 +408290,7 @@
"type": "string",
"name": "expected_head_sha",
"in": "body",
- "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/rest/reference/repos#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
+ "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/rest/commits/commits#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
}
],
"enabledForGitHubApps": false,
@@ -424838,7 +424850,7 @@
"type": "string",
"name": "event",
"in": "body",
- "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
+ "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -425260,7 +425272,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -427595,7 +427607,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/rest/reference/repos#branches\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/rest/branches/branch-protection\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -428038,7 +428050,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
+ "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -428087,40 +428099,70 @@
"resources": {
"core": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1691591363
},
"search": {
"limit": 30,
+ "used": 12,
"remaining": 18,
- "reset": 1372697452,
- "used": 12
+ "reset": 1691591091
},
"graphql": {
"limit": 5000,
+ "used": 7,
"remaining": 4993,
- "reset": 1372700389,
- "used": 7
+ "reset": 1691593228
},
"integration_manifest": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "source_import": {
+ "limit": 100,
+ "used": 1,
+ "remaining": 99,
+ "reset": 1691591091
},
"code_scanning_upload": {
"limit": 500,
+ "used": 1,
"remaining": 499,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "actions_runner_registration": {
+ "limit": 10000,
+ "used": 0,
+ "remaining": 10000,
+ "reset": 1691594631
+ },
+ "scim": {
+ "limit": 15000,
+ "used": 0,
+ "remaining": 15000,
+ "reset": 1691594631
+ },
+ "dependency_snapshots": {
+ "limit": 100,
+ "used": 0,
+ "remaining": 100,
+ "reset": 1691591091
+ },
+ "code_search": {
+ "limit": 10,
+ "used": 0,
+ "remaining": 10,
+ "reset": 1691591091
}
},
"rate": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1372700873
}
},
"schema": {
@@ -428411,7 +428453,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p>Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under <code>resources</code>, you'll see objects relating to different categories:</p>\n<ul>\n<li>The <code>core</code> object provides your rate limit status for all non-search-related resources in the REST API.</li>\n<li>The <code>search</code> object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"<a href=\"https://docs.github.com/rest/search\">Search</a>.\"</li>\n<li>The <code>code_search</code> object provides your rate limit status for the REST API for searching code. For more information, see \"<a href=\"https://docs.github.com/rest/search/search#search-code\">Search code</a>.\"</li>\n<li>The <code>graphql</code> object provides your rate limit status for the GraphQL API. For more information, see \"<a href=\"https://docs.github.com/graphql/overview/resource-limitations#rate-limit\">Resource limitations</a>.\"</li>\n<li>The <code>integration_manifest</code> object provides your rate limit status for the <code>POST /app-manifests/{code}/conversions</code> operation. For more information, see \"<a href=\"https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration\">Creating a GitHub App from a manifest</a>.\"</li>\n<li>The <code>dependency_snapshots</code> object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"<a href=\"https://docs.github.com/rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>code_scanning_upload</code> object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"<a href=\"https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github\">Uploading a SARIF file to GitHub</a>.\"</li>\n<li>The <code>actions_runner_registration</code> object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"<a href=\"https://docs.github.com/rest/actions/self-hosted-runners\">Self-hosted runners</a>.\"</li>\n<li>The <code>source_import</code> object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"<a href=\"https://docs.github.com/rest/overview/api-versions\">API Versions</a>.\"</li>\n</ul>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -428477,7 +428519,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -428785,7 +428827,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/rest/reference/teams#discussion-comments/\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -428843,7 +428885,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -429393,7 +429435,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -429482,7 +429524,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -429527,7 +429569,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -429834,7 +429876,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -429883,7 +429925,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -430431,7 +430473,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -430510,7 +430552,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -430555,7 +430597,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -430862,7 +430904,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -430915,7 +430957,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a> to add to the commit comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the commit comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -431463,7 +431505,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/rest/reference/repos#comments\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/rest/commits/comments#get-a-commit-comment\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -431546,7 +431588,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -431591,7 +431633,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -431898,7 +431940,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -431951,7 +431993,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -432499,7 +432541,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/rest/reference/issues#comments\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/rest/issues/comments#get-an-issue-comment\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -432582,7 +432624,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -432627,7 +432669,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
"in": "query",
"required": false,
"schema": {
@@ -432934,7 +432976,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/rest/reference/issues\">issue</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -432991,7 +433033,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -433539,7 +433581,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/rest/reference/issues/\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -433622,7 +433664,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/rest/reference/issues/\">issue</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -433667,7 +433709,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -433974,7 +434016,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -434027,7 +434069,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a> to add to the pull request review comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the pull request review comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -434575,7 +434617,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/rest/reference/pulls#comments\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -434658,7 +434700,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -434703,7 +434745,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
"in": "query",
"required": false,
"schema": {
@@ -435008,7 +435050,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -435061,7 +435103,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a> to add to the release.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the release.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -435607,7 +435649,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/rest/reference/repos#releases\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/rest/releases/releases#get-a-release\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -435690,7 +435732,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -435735,7 +435777,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -436042,7 +436084,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -436091,7 +436133,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -436374,7 +436416,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -436410,7 +436452,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -436716,7 +436758,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -436756,7 +436798,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -437038,7 +437080,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -438690,7 +438732,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/rest/reference/repos#releases\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
+ "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/rest/releases/releases#get-a-release\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -443223,7 +443265,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
+ "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -459947,9 +459989,9 @@
},
{
"serverUrl": "https://api.github.com",
- "verb": "get",
- "requestPath": "/repos/{owner}/{repo}/tags",
- "title": "List repository tags",
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting",
+ "title": "Enable private vulnerability reporting for a repository",
"category": "repos",
"subcategory": "repos",
"parameters": [
@@ -459970,24 +460012,6 @@
"schema": {
"type": "string"
}
- },
- {
- "name": "per_page",
- "description": "<p>The number of results per page (max 100).</p>",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "<p>Page number of the results to fetch.</p>",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
}
],
"bodyParameters": [],
@@ -460004,94 +460028,29 @@
}
},
"response": {
- "statusCode": "200",
- "contentType": "application/json",
- "description": "<p>Response</p>",
- "example": [
- {
- "name": "v0.1",
- "commit": {
- "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc",
- "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"
- },
- "zipball_url": "https://github.com/octocat/Hello-World/zipball/v0.1",
- "tarball_url": "https://github.com/octocat/Hello-World/tarball/v0.1",
- "node_id": "MDQ6VXNlcjE="
- }
- ],
- "schema": {
- "type": "array",
- "items": {
- "title": "Tag",
- "description": "Tag",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "examples": [
- "v0.1"
- ]
- },
- "commit": {
- "type": "object",
- "properties": {
- "sha": {
- "type": "string"
- },
- "url": {
- "type": "string",
- "format": "uri"
- }
- },
- "required": [
- "sha",
- "url"
- ]
- },
- "zipball_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat/Hello-World/zipball/v0.1"
- ]
- },
- "tarball_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat/Hello-World/tarball/v0.1"
- ]
- },
- "node_id": {
- "type": "string"
- }
- },
- "required": [
- "name",
- "node_id",
- "commit",
- "zipball_url",
- "tarball_url"
- ]
- }
- }
+ "statusCode": "204",
+ "description": "<p>A header with no content is returned.</p>"
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"<a href=\"https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability\">Privately reporting a security vulnerability</a>.\"</p>",
"statusCodes": [
{
- "httpStatusCode": "200",
- "description": "<p>OK</p>"
+ "httpStatusCode": "204",
+ "description": "<p>A header with no content is returned.</p>"
+ },
+ {
+ "httpStatusCode": "422",
+ "description": "<p>Bad Request</p>"
}
]
},
{
"serverUrl": "https://api.github.com",
- "verb": "get",
- "requestPath": "/repos/{owner}/{repo}/teams",
- "title": "List repository teams",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting",
+ "title": "Disable private vulnerability reporting for a repository",
"category": "repos",
"subcategory": "repos",
"parameters": [
@@ -460112,24 +460071,6 @@
"schema": {
"type": "string"
}
- },
- {
- "name": "per_page",
- "description": "<p>The number of results per page (max 100).</p>",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "<p>Page number of the results to fetch.</p>",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
}
],
"bodyParameters": [],
@@ -460146,260 +460087,479 @@
}
},
"response": {
- "statusCode": "200",
- "contentType": "application/json",
- "description": "<p>Response</p>",
- "example": [
- {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos",
- "parent": null
- }
- ],
- "schema": {
- "type": "array",
- "items": {
- "title": "Team",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "node_id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "slug": {
- "type": "string"
- },
- "description": {
- "type": [
- "string",
- "null"
- ]
- },
- "privacy": {
- "type": "string"
- },
- "notification_setting": {
- "type": "string"
- },
- "permission": {
- "type": "string"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "pull": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- },
- "admin": {
- "type": "boolean"
- }
- },
- "required": [
- "pull",
- "triage",
- "push",
- "maintain",
- "admin"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "members_url": {
- "type": "string"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri"
- },
- "parent": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Team Simple",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Justice League"
- ]
- },
- "description": {
- "description": "Description of the team",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "admin"
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "examples": [
- "notifications_enabled"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "type": "string",
- "examples": [
- "uid=example,ou=users,dc=github,dc=com"
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug"
- ]
- }
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "parent"
- ]
- }
- }
+ "statusCode": "204",
+ "description": "<p>A header with no content is returned.</p>"
}
}
],
"previews": [],
- "descriptionHTML": "<p>Lists the teams that have access to the specified repository and that are also visible to the authenticated user.</p>\n<p>For a public repository, a team is listed only if that team added the public repository explicitly.</p>\n<p>Personal access tokens require the following scopes:</p>\n<ul>\n<li><code>public_repo</code> to call this endpoint on a public repository</li>\n<li><code>repo</code> to call this endpoint on a private repository (this scope also includes public repositories)</li>\n</ul>\n<p>This endpoint is not compatible with fine-grained personal access tokens.</p>",
+ "descriptionHTML": "<p>Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"<a href=\"https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability\">Privately reporting a security vulnerability</a>\".</p>",
"statusCodes": [
{
- "httpStatusCode": "200",
- "description": "<p>OK</p>"
+ "httpStatusCode": "204",
+ "description": "<p>A header with no content is returned.</p>"
},
{
- "httpStatusCode": "404",
- "description": "<p>Resource not found</p>"
+ "httpStatusCode": "422",
+ "description": "<p>Bad Request</p>"
}
]
},
{
"serverUrl": "https://api.github.com",
"verb": "get",
- "requestPath": "/repos/{owner}/{repo}/topics",
- "title": "Get all repository topics",
+ "requestPath": "/repos/{owner}/{repo}/tags",
+ "title": "List repository tags",
+ "category": "repos",
+ "subcategory": "repos",
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "<p>The account owner of the repository. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "<p>The name of the repository without the <code>.git</code> extension. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "<p>The number of results per page (max 100).</p>",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "<p>Page number of the results to fetch.</p>",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "bodyParameters": [],
+ "enabledForGitHubApps": true,
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "parameters": {
+ "owner": "OWNER",
+ "repo": "REPO"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "<p>Response</p>",
+ "example": [
+ {
+ "name": "v0.1",
+ "commit": {
+ "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc",
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"
+ },
+ "zipball_url": "https://github.com/octocat/Hello-World/zipball/v0.1",
+ "tarball_url": "https://github.com/octocat/Hello-World/tarball/v0.1",
+ "node_id": "MDQ6VXNlcjE="
+ }
+ ],
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Tag",
+ "description": "Tag",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "examples": [
+ "v0.1"
+ ]
+ },
+ "commit": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "url"
+ ]
+ },
+ "zipball_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat/Hello-World/zipball/v0.1"
+ ]
+ },
+ "tarball_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat/Hello-World/tarball/v0.1"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "node_id",
+ "commit",
+ "zipball_url",
+ "tarball_url"
+ ]
+ }
+ }
+ }
+ }
+ ],
+ "descriptionHTML": "",
+ "previews": [],
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "<p>OK</p>"
+ }
+ ]
+ },
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/teams",
+ "title": "List repository teams",
+ "category": "repos",
+ "subcategory": "repos",
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "<p>The account owner of the repository. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "<p>The name of the repository without the <code>.git</code> extension. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "<p>The number of results per page (max 100).</p>",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "<p>Page number of the results to fetch.</p>",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "bodyParameters": [],
+ "enabledForGitHubApps": true,
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "parameters": {
+ "owner": "OWNER",
+ "repo": "REPO"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "<p>Response</p>",
+ "example": [
+ {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ ],
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VGVhbTE="
+ ]
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1"
+ ]
+ },
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/members{/member}"
+ ]
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "examples": [
+ "Justice League"
+ ]
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great team."
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "examples": [
+ "admin"
+ ]
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "examples": [
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "examples": [
+ "notifications_enabled"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/repos"
+ ]
+ },
+ "slug": {
+ "type": "string",
+ "examples": [
+ "justice-league"
+ ]
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "type": "string",
+ "examples": [
+ "uid=example,ou=users,dc=github,dc=com"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ }
+ }
+ }
+ }
+ ],
+ "previews": [],
+ "descriptionHTML": "<p>Lists the teams that have access to the specified repository and that are also visible to the authenticated user.</p>\n<p>For a public repository, a team is listed only if that team added the public repository explicitly.</p>\n<p>Personal access tokens require the following scopes:</p>\n<ul>\n<li><code>public_repo</code> to call this endpoint on a public repository</li>\n<li><code>repo</code> to call this endpoint on a private repository (this scope also includes public repositories)</li>\n</ul>\n<p>This endpoint is not compatible with fine-grained personal access tokens.</p>",
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "<p>OK</p>"
+ },
+ {
+ "httpStatusCode": "404",
+ "description": "<p>Resource not found</p>"
+ }
+ ]
+ },
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/topics",
+ "title": "Get all repository topics",
"category": "repos",
"subcategory": "repos",
"parameters": [
@@ -471829,7 +471989,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
+ "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -472443,7 +472603,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/rest/reference/repos/#delete-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/rest/repos/contents/#delete-a-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -472788,7 +472948,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/rest/reference/repos/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/rest/repos/contents/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -472997,7 +473157,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -473209,7 +473369,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -480590,127 +480750,6 @@
]
}
],
- "lfs": [
- {
- "serverUrl": "https://api.github.com",
- "verb": "put",
- "requestPath": "/repos/{owner}/{repo}/lfs",
- "title": "Enable Git LFS for a repository",
- "category": "repos",
- "subcategory": "lfs",
- "parameters": [
- {
- "name": "owner",
- "description": "<p>The account owner of the repository. The name is not case sensitive.</p>",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "repo",
- "description": "<p>The name of the repository without the <code>.git</code> extension. The name is not case sensitive.</p>",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "bodyParameters": [],
- "enabledForGitHubApps": false,
- "codeExamples": [
- {
- "key": "default",
- "request": {
- "description": "Example",
- "acceptHeader": "application/vnd.github.v3+json",
- "parameters": {
- "owner": "OWNER",
- "repo": "REPO"
- }
- },
- "response": {
- "statusCode": "202",
- "contentType": "application/json",
- "description": "<p>Accepted</p>",
- "example": null,
- "schema": {
- "type": "object"
- }
- }
- }
- ],
- "previews": [],
- "descriptionHTML": "<p>Enables Git LFS for a repository. Access tokens must have the <code>admin:enterprise</code> scope.</p>",
- "statusCodes": [
- {
- "httpStatusCode": "202",
- "description": "<p>Accepted</p>"
- },
- {
- "httpStatusCode": "403",
- "description": "<p>We will return a 403 with one of the following messages:</p>\n<ul>\n<li>Git LFS support not enabled because Git LFS is globally disabled.</li>\n<li>Git LFS support not enabled because Git LFS is disabled for the root repository in the network.</li>\n<li>Git LFS support not enabled because Git LFS is disabled for <owner>.</owner></li>\n</ul>"
- }
- ]
- },
- {
- "serverUrl": "https://api.github.com",
- "verb": "delete",
- "requestPath": "/repos/{owner}/{repo}/lfs",
- "title": "Disable Git LFS for a repository",
- "category": "repos",
- "subcategory": "lfs",
- "parameters": [
- {
- "name": "owner",
- "description": "<p>The account owner of the repository. The name is not case sensitive.</p>",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "repo",
- "description": "<p>The name of the repository without the <code>.git</code> extension. The name is not case sensitive.</p>",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "bodyParameters": [],
- "enabledForGitHubApps": false,
- "codeExamples": [
- {
- "key": "default",
- "request": {
- "description": "Example",
- "acceptHeader": "application/vnd.github.v3+json",
- "parameters": {
- "owner": "OWNER",
- "repo": "REPO"
- }
- },
- "response": {
- "statusCode": "204",
- "description": "<p>Response</p>"
- }
- }
- ],
- "previews": [],
- "descriptionHTML": "<p>Disables Git LFS for a repository. Access tokens must have the <code>admin:enterprise</code> scope.</p>",
- "statusCodes": [
- {
- "httpStatusCode": "204",
- "description": "<p>No Content</p>"
- }
- ]
- }
- ],
"rules": [
{
"serverUrl": "https://api.github.com",
@@ -486987,7 +487026,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>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 <a href=\"https://docs.github.com/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>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 <a href=\"https://docs.github.com/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -486997,7 +487036,7 @@
{
"name": "sort",
"deprecated": true,
- "description": "<p><strong>This field is deprecated.</strong> Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: <a href=\"https://docs.github.com/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p><strong>This field is deprecated.</strong> Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: <a href=\"https://docs.github.com/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -488068,7 +488107,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>\n<p>This endpoint requires you to authenticate and limits you to 10 requests per minute.</p>",
+ "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>\n<p>This endpoint requires you to authenticate and limits you to 10 requests per minute.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -488102,7 +488141,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>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 <a href=\"https://docs.github.com/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>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 <a href=\"https://docs.github.com/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -488111,7 +488150,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -489543,7 +489582,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/reference/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
+ "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/search/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -489565,7 +489604,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>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 <a href=\"https://docs.github.com/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>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 <a href=\"https://docs.github.com/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -489574,7 +489613,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -492691,7 +492730,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
+ "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -492734,7 +492773,7 @@
},
{
"name": "q",
- "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -492743,7 +492782,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -492935,7 +492974,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -492969,7 +493008,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>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 <a href=\"https://docs.github.com/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>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 <a href=\"https://docs.github.com/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -492978,7 +493017,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -493845,7 +493884,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -493875,7 +493914,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>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 <a href=\"https://docs.github.com/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>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 <a href=\"https://docs.github.com/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -494201,7 +494240,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -494223,7 +494262,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>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 <a href=\"https://docs.github.com/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>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 <a href=\"https://docs.github.com/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -494232,7 +494271,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub. Default: <a href=\"https://docs.github.com/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub. Default: <a href=\"https://docs.github.com/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -494547,7 +494586,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/rest/reference/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
+ "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/rest/search/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -499448,7 +499487,7 @@
{
"name": "cwes",
"in": "query",
- "description": "<p>If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.</p>",
+ "description": "<p>If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.</p>\n<p>Example: <code>cwes=79,284,22</code> or <code>cwes[]=79&cwes[]=284&cwes[]=22</code></p>",
"schema": {
"oneOf": [
{
@@ -499474,7 +499513,7 @@
{
"name": "affects",
"in": "query",
- "description": "<p>If specified, return advisories that affect any of <code>package</code> or <code>package@version</code>. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.</p>",
+ "description": "<p>If specified, only return advisories that affect any of <code>package</code> or <code>package@version</code>. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.</p>\n<p>Example: <code>affects=package1,package2@1.0.0,package3@^2.0.0</code> or <code>affects[]=package1&affects[]=package2@1.0.0</code></p>",
"schema": {
"oneOf": [
{
@@ -499812,7 +499851,7 @@
"null"
],
"format": "date-time",
- "description": "The date and time of when the advisory was published in the National Vulnerability Database, in ISO 8601 format.",
+ "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.",
"readOnly": true
},
"withdrawn_at": {
@@ -500183,7 +500222,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List global security advisories and filter using parameters such as ecosystem, GHSA ID, CVE ID, etc.</p>",
+ "descriptionHTML": "<p>Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.</p>\n<p>By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the <code>type</code> parameter in your request, with the value <code>malware</code>. For more information about the different types of security advisories, see \"<a href=\"https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories\">About the GitHub Advisory database</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -500455,7 +500494,7 @@
"null"
],
"format": "date-time",
- "description": "The date and time of when the advisory was published in the National Vulnerability Database, in ISO 8601 format.",
+ "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.",
"readOnly": true
},
"withdrawn_at": {
@@ -500839,6 +500878,2332 @@
}
],
"repository-advisories": [
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/security-advisories",
+ "title": "List repository security advisories for an organization",
+ "category": "security-advisories",
+ "subcategory": "repository-advisories",
+ "parameters": [
+ {
+ "name": "org",
+ "description": "<p>The organization name. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "<p>The direction to sort the results by.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "<p>The property to sort the results by.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "published"
+ ],
+ "default": "created"
+ }
+ },
+ {
+ "name": "before",
+ "description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers\">Link header</a>. If specified, the query only searches for results before this cursor.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "after",
+ "description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers\">Link header</a>. If specified, the query only searches for results after this cursor.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "<p>The number of advisories to return per page.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100,
+ "default": 30
+ }
+ },
+ {
+ "name": "state",
+ "description": "<p>Filter by the state of the repository advisories. Only advisories of this state will be returned.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "triage",
+ "draft",
+ "published",
+ "closed"
+ ]
+ }
+ }
+ ],
+ "bodyParameters": [],
+ "enabledForGitHubApps": true,
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "parameters": {
+ "org": "ORG"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "<p>Response</p>",
+ "example": [
+ {
+ "ghsa_id": "GHSA-abcd-1234-efgh",
+ "cve_id": "CVE-2050-00000",
+ "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh",
+ "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh",
+ "summary": "A short summary of the advisory.",
+ "description": "A detailed description of what the advisory entails.",
+ "severity": "critical",
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "publisher": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-abcd-1234-efgh"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2050-00000"
+ }
+ ],
+ "state": "published",
+ "created_at": "2020-01-01T00:00:00Z",
+ "updated_at": "2020-01-02T00:00:00Z",
+ "published_at": "2020-01-03T00:00:00Z",
+ "closed_at": null,
+ "withdrawn_at": null,
+ "submission": null,
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "a-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.1",
+ "patched_versions": "1.0.1",
+ "vulnerable_functions": [
+ "function1"
+ ]
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "another-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.2",
+ "patched_versions": "1.0.2",
+ "vulnerable_functions": [
+ "function2"
+ ]
+ }
+ ],
+ "cvss": {
+ "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
+ "score": 9.8
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-123",
+ "name": "A CWE"
+ }
+ ],
+ "cwe_ids": [
+ "CWE-123"
+ ],
+ "credits": [
+ {
+ "login": "octocat",
+ "type": "analyst"
+ }
+ ],
+ "credits_detailed": [
+ {
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "type": "analyst",
+ "state": "accepted"
+ }
+ ],
+ "collaborating_users": [
+ {
+ "login": "octokitten",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octokitten_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octokitten",
+ "html_url": "https://github.com/octokitten",
+ "followers_url": "https://api.github.com/users/octokitten/followers",
+ "following_url": "https://api.github.com/users/octokitten/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions",
+ "organizations_url": "https://api.github.com/users/octokitten/orgs",
+ "repos_url": "https://api.github.com/users/octokitten/repos",
+ "events_url": "https://api.github.com/users/octokitten/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octokitten/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "collaborating_teams": [
+ {
+ "name": "Justice League",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "permission": "admin",
+ "parent": null
+ }
+ ]
+ },
+ {
+ "ghsa_id": "GHSA-1234-5678-9012",
+ "cve_id": "CVE-2051-0000",
+ "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012",
+ "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012",
+ "summary": "A short summary of the advisory.",
+ "description": "A detailed description of what the advisory entails.",
+ "severity": "low",
+ "author": {
+ "login": "monauser",
+ "id": 2,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monauser",
+ "html_url": "https://github.com/monauser",
+ "followers_url": "https://api.github.com/users/monauser/followers",
+ "following_url": "https://api.github.com/users/monauser/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monauser/subscriptions",
+ "organizations_url": "https://api.github.com/users/monauser/orgs",
+ "repos_url": "https://api.github.com/users/monauser/repos",
+ "events_url": "https://api.github.com/users/monauser/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monauser/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "publisher": {
+ "login": "monalisa",
+ "id": 3,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-1234-5678-9012"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2051-00000"
+ }
+ ],
+ "state": "published",
+ "created_at": "2020-01-03T00:00:00Z",
+ "updated_at": "2020-01-04T00:00:00Z",
+ "published_at": "2020-01-04T00:00:00Z",
+ "closed_at": null,
+ "withdrawn_at": null,
+ "submission": [
+ {
+ "accepted": true
+ }
+ ],
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "a-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.1",
+ "patched_versions": "1.0.1",
+ "vulnerable_functions": [
+ "function1"
+ ]
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "another-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.2",
+ "patched_versions": "1.0.2",
+ "vulnerable_functions": [
+ "function2"
+ ]
+ }
+ ],
+ "cvss": {
+ "vector_string": "AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N",
+ "score": 1.6
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-456",
+ "name": "A CWE 2.0"
+ }
+ ],
+ "cwe_ids": [
+ "CWE-456"
+ ],
+ "credits": [
+ {
+ "login": "monauser",
+ "type": "reporter"
+ }
+ ],
+ "credits_detailed": [
+ {
+ "user": {
+ "login": "monauser",
+ "id": 2,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monauser",
+ "html_url": "https://github.com/monauser",
+ "followers_url": "https://api.github.com/users/monauser/followers",
+ "following_url": "https://api.github.com/users/monauser/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monauser/subscriptions",
+ "organizations_url": "https://api.github.com/users/monauser/orgs",
+ "repos_url": "https://api.github.com/users/monauser/repos",
+ "events_url": "https://api.github.com/users/monauser/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monauser/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "type": "reporter",
+ "state": "accepted"
+ }
+ ],
+ "collaborating_users": [
+ {
+ "login": "octokitten",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octokitten_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octokitten",
+ "html_url": "https://github.com/octokitten",
+ "followers_url": "https://api.github.com/users/octokitten/followers",
+ "following_url": "https://api.github.com/users/octokitten/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions",
+ "organizations_url": "https://api.github.com/users/octokitten/orgs",
+ "repos_url": "https://api.github.com/users/octokitten/repos",
+ "events_url": "https://api.github.com/users/octokitten/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octokitten/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "collaborating_teams": [
+ {
+ "name": "Justice League",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "permission": "admin",
+ "parent": null
+ }
+ ]
+ }
+ ],
+ "schema": {
+ "type": "array",
+ "items": {
+ "description": "A repository security advisory.",
+ "type": "object",
+ "properties": {
+ "ghsa_id": {
+ "type": "string",
+ "description": "The GitHub Security Advisory ID.",
+ "readOnly": true
+ },
+ "cve_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The Common Vulnerabilities and Exposures (CVE) ID."
+ },
+ "url": {
+ "type": "string",
+ "description": "The API URL for the advisory."
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The URL for the advisory.",
+ "readOnly": true
+ },
+ "summary": {
+ "type": "string",
+ "description": "A short summary of the advisory.",
+ "maxLength": 1024
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "A detailed description of what the advisory entails.",
+ "maxLength": 65535
+ },
+ "severity": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The severity of the advisory.",
+ "enum": [
+ "critical",
+ "high",
+ "medium",
+ "low",
+ null
+ ]
+ },
+ "author": {
+ "readOnly": true,
+ "description": "The author of the advisory.",
+ "allOf": [
+ {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ ],
+ "type": [
+ "null"
+ ]
+ },
+ "publisher": {
+ "readOnly": true,
+ "description": "The publisher of the advisory.",
+ "allOf": [
+ {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ ],
+ "type": [
+ "null"
+ ]
+ },
+ "identifiers": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The type of identifier.",
+ "enum": [
+ "CVE",
+ "GHSA"
+ ]
+ },
+ "value": {
+ "type": "string",
+ "description": "The identifier value."
+ }
+ },
+ "required": [
+ "type",
+ "value"
+ ]
+ },
+ "readOnly": true
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the advisory.",
+ "enum": [
+ "published",
+ "closed",
+ "withdrawn",
+ "draft",
+ "triage"
+ ]
+ },
+ "created_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time",
+ "description": "The date and time of when the advisory was created, in ISO 8601 format.",
+ "readOnly": true
+ },
+ "updated_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time",
+ "description": "The date and time of when the advisory was last updated, in ISO 8601 format.",
+ "readOnly": true
+ },
+ "published_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time",
+ "description": "The date and time of when the advisory was published, in ISO 8601 format.",
+ "readOnly": true
+ },
+ "closed_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time",
+ "description": "The date and time of when the advisory was closed, in ISO 8601 format.",
+ "readOnly": true
+ },
+ "withdrawn_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time",
+ "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.",
+ "readOnly": true
+ },
+ "submission": {
+ "type": [
+ "object",
+ "null"
+ ],
+ "readOnly": true,
+ "properties": {
+ "accepted": {
+ "type": "boolean",
+ "description": "Whether a private vulnerability report was accepted by the repository's administrators.",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "accepted"
+ ]
+ },
+ "vulnerabilities": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "description": "A product affected by the vulnerability detailed in a repository security advisory.",
+ "type": "object",
+ "properties": {
+ "package": {
+ "description": "The name of the package affected by the vulnerability.",
+ "type": [
+ "object",
+ "null"
+ ],
+ "properties": {
+ "ecosystem": {
+ "type": "string",
+ "description": "The package's language or package management ecosystem.",
+ "enum": [
+ "rubygems",
+ "npm",
+ "pip",
+ "maven",
+ "nuget",
+ "composer",
+ "go",
+ "rust",
+ "erlang",
+ "actions",
+ "pub",
+ "other",
+ "swift"
+ ]
+ },
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The unique package name within its ecosystem."
+ }
+ },
+ "required": [
+ "ecosystem",
+ "name"
+ ]
+ },
+ "vulnerable_version_range": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The range of the package versions affected by the vulnerability."
+ },
+ "patched_versions": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The package version(s) that resolve the vulnerability."
+ },
+ "vulnerable_functions": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "The functions in the package that are affected.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "package",
+ "vulnerable_version_range",
+ "patched_versions",
+ "vulnerable_functions"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "cvss": {
+ "type": [
+ "object",
+ "null"
+ ],
+ "properties": {
+ "vector_string": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The CVSS vector."
+ },
+ "score": {
+ "type": [
+ "number",
+ "null"
+ ],
+ "description": "The CVSS score.",
+ "minimum": 0,
+ "maximum": 10,
+ "readOnly": true
+ }
+ },
+ "required": [
+ "vector_string",
+ "score"
+ ]
+ },
+ "cwes": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "cwe_id": {
+ "type": "string",
+ "description": "The Common Weakness Enumeration (CWE) identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the CWE.",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "cwe_id",
+ "name"
+ ]
+ },
+ "readOnly": true
+ },
+ "cwe_ids": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "A list of only the CWE IDs.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "credits": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "The username of the user credited."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of credit the user is receiving.",
+ "enum": [
+ "analyst",
+ "finder",
+ "reporter",
+ "coordinator",
+ "remediation_developer",
+ "remediation_reviewer",
+ "remediation_verifier",
+ "tool",
+ "sponsor",
+ "other"
+ ]
+ }
+ }
+ }
+ },
+ "credits_detailed": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "description": "A credit given to a user for a repository security advisory.",
+ "type": "object",
+ "properties": {
+ "user": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of credit the user is receiving.",
+ "enum": [
+ "analyst",
+ "finder",
+ "reporter",
+ "coordinator",
+ "remediation_developer",
+ "remediation_reviewer",
+ "remediation_verifier",
+ "tool",
+ "sponsor",
+ "other"
+ ]
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the user's acceptance of the credit.",
+ "enum": [
+ "accepted",
+ "declined",
+ "pending"
+ ]
+ }
+ },
+ "required": [
+ "user",
+ "type",
+ "state"
+ ],
+ "additionalProperties": false
+ },
+ "readOnly": true
+ },
+ "collaborating_users": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "A list of users that collaborate on the advisory.",
+ "items": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ },
+ "collaborating_teams": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "A list of teams that collaborate on the advisory.",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VGVhbTE="
+ ]
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1"
+ ]
+ },
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/members{/member}"
+ ]
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "examples": [
+ "Justice League"
+ ]
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great team."
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "examples": [
+ "admin"
+ ]
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "examples": [
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "examples": [
+ "notifications_enabled"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/repos"
+ ]
+ },
+ "slug": {
+ "type": "string",
+ "examples": [
+ "justice-league"
+ ]
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "type": "string",
+ "examples": [
+ "uid=example,ou=users,dc=github,dc=com"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ }
+ },
+ "private_fork": {
+ "readOnly": true,
+ "description": "A temporary private fork of the advisory's repository for collaborating on a fix.",
+ "allOf": [
+ {
+ "title": "Simple Repository",
+ "description": "A GitHub repository.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "A unique identifier of the repository.",
+ "examples": [
+ 1296269
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "description": "The GraphQL identifier of the repository.",
+ "examples": [
+ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the repository.",
+ "examples": [
+ "Hello-World"
+ ]
+ },
+ "full_name": {
+ "type": "string",
+ "description": "The full, globally unique, name of the repository.",
+ "examples": [
+ "octocat/Hello-World"
+ ]
+ },
+ "owner": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ }
+ },
+ "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": {
+ "type": "boolean",
+ "description": "Whether the repository is private."
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The URL to view the repository on GitHub.com.",
+ "examples": [
+ "https://github.com/octocat/Hello-World"
+ ]
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The repository description.",
+ "examples": [
+ "This your first repo!"
+ ]
+ },
+ "fork": {
+ "type": "boolean",
+ "description": "Whether the repository is a fork."
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The URL to get more information about the repository from the GitHub API.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World"
+ ]
+ },
+ "archive_url": {
+ "type": "string",
+ "description": "A template for the API URL to download the repository as an archive.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ ]
+ },
+ "assignees_url": {
+ "type": "string",
+ "description": "A template for the API URL to list the available assignees for issues in the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ ]
+ },
+ "blobs_url": {
+ "type": "string",
+ "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ ]
+ },
+ "branches_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about branches in the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ ]
+ },
+ "collaborators_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about collaborators of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ ]
+ },
+ "comments_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about comments on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ ]
+ },
+ "commits_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about commits on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ ]
+ },
+ "compare_url": {
+ "type": "string",
+ "description": "A template for the API URL to compare two commits or refs.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ ]
+ },
+ "contents_url": {
+ "type": "string",
+ "description": "A template for the API URL to get the contents of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ ]
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "A template for the API URL to list the contributors to the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/contributors"
+ ]
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the deployments of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/deployments"
+ ]
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the downloads on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/downloads"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the events of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/events"
+ ]
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the forks of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/forks"
+ ]
+ },
+ "git_commits_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about Git commits of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ ]
+ },
+ "git_refs_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about Git refs of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ ]
+ },
+ "git_tags_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about Git tags of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ ]
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about issue comments on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ ]
+ },
+ "issue_events_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about issue events on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ ]
+ },
+ "issues_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about issues on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ ]
+ },
+ "keys_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about deploy keys on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ ]
+ },
+ "labels_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about labels of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ ]
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to get information about the languages of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/languages"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to merge branches in the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/merges"
+ ]
+ },
+ "milestones_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about milestones of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ ]
+ },
+ "notifications_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about notifications on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ ]
+ },
+ "pulls_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about pull requests on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about releases on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ ]
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the stargazers on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/stargazers"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about statuses of a commit.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ ]
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the subscribers on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/subscribers"
+ ]
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to subscribe to notifications for this repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/subscription"
+ ]
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to get information about tags on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/tags"
+ ]
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the teams on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/teams"
+ ]
+ },
+ "trees_url": {
+ "type": "string",
+ "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ ]
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the hooks on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/hooks"
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ ],
+ "type": [
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "ghsa_id",
+ "cve_id",
+ "url",
+ "html_url",
+ "summary",
+ "description",
+ "severity",
+ "author",
+ "publisher",
+ "identifiers",
+ "state",
+ "created_at",
+ "updated_at",
+ "published_at",
+ "closed_at",
+ "withdrawn_at",
+ "submission",
+ "vulnerabilities",
+ "cvss",
+ "cwes",
+ "cwe_ids",
+ "credits",
+ "credits_detailed",
+ "collaborating_users",
+ "collaborating_teams",
+ "private_fork"
+ ],
+ "additionalProperties": false
+ }
+ }
+ }
+ }
+ ],
+ "previews": [],
+ "descriptionHTML": "<p>Lists repository security advisories for an organization.</p>\n<p>To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the <code>repo</code> scope or <code>repository_advisories:write</code> permission.</p>",
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "<p>OK</p>"
+ },
+ {
+ "httpStatusCode": "400",
+ "description": "<p>Bad Request</p>"
+ },
+ {
+ "httpStatusCode": "404",
+ "description": "<p>Resource not found</p>"
+ }
+ ]
+ },
{
"serverUrl": "https://api.github.com",
"verb": "get",
@@ -529452,7 +531817,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/rest/reference/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
+ "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -529541,7 +531906,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/rest/reference/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -529614,7 +531979,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/rest/reference/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -543654,7 +546019,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub. For more information, see <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/rest/reference/users#emails\">Emails API</a>\".</p>",
+ "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub. For more information, see <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/rest/users/emails\">Emails API</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -548808,7 +551173,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
+ "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -548953,7 +551318,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
+ "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -549936,7 +552301,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -550559,7 +552924,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/repos#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -550612,7 +552977,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -550934,7 +553299,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/repos#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json
index e0d83c12a3e4..4cc1061cc821 100644
--- a/src/rest/data/ghae/schema.json
+++ b/src/rest/data/ghae/schema.json
@@ -62125,7 +62125,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/apps/#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/github-ae@latest/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -69314,7 +69314,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/github-ae@latest/rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -95759,7 +95759,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -99601,7 +99601,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. See the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/checks#actions-object\"><code>actions</code> object</a> description. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -107336,7 +107336,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/github-ae@latest/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/github-ae@latest/rest/checks/runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/github-ae@latest/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -118716,7 +118716,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/github-ae@latest/rest/collaborators/invitations\">API</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -133952,7 +133952,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
+ "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -143278,7 +143278,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/reference/actions#secrets\">Secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
+ "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/actions/secrets\">GitHub Actions secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -147914,6 +147914,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_commit_comments": 5000,
+ "total_gist_comments": 400,
+ "total_issue_comments": 10900,
+ "total_pull_request_comments": 9900
+ },
"schema": {
"title": "Enterprise Comment Stats",
"type": "object",
@@ -147971,6 +147977,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_gists": 500,
+ "private_gists": 30,
+ "public_gists": 470
+ },
"schema": {
"title": "Enterprise Gist Stats",
"type": "object",
@@ -148024,6 +148035,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_hooks": 50,
+ "active_hooks": 47,
+ "inactive_hooks": 3
+ },
"schema": {
"title": "Hooks Enterprise Stats",
"type": "object",
@@ -148077,6 +148093,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_issues": 5000,
+ "open_issues": 300,
+ "closed_issues": 4700
+ },
"schema": {
"title": "Enterprise Issue Stats",
"type": "object",
@@ -148130,6 +148151,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_milestones": 90,
+ "open_milestones": 10,
+ "closed_milestones": 80
+ },
"schema": {
"title": "Enterprise Milestone Stats",
"type": "object",
@@ -148183,6 +148209,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_orgs": 50,
+ "disabled_orgs": 1,
+ "total_teams": 70,
+ "total_team_members": 700
+ },
"schema": {
"title": "Enterprise Organization Stats",
"type": "object",
@@ -148240,6 +148272,9 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_pages": 20
+ },
"schema": {
"title": "Enterprise Pages Stats",
"type": "object",
@@ -148285,6 +148320,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_pulls": 1200,
+ "merged_pulls": 1100,
+ "mergeable_pulls": 90,
+ "unmergeable_pulls": 10
+ },
"schema": {
"title": "Enterprise Pull Request Stats",
"type": "object",
@@ -148342,6 +148383,14 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_repos": 200,
+ "root_repos": 1,
+ "fork_repos": 10,
+ "org_repos": 150,
+ "total_pushes": 39000,
+ "total_wikis": 5
+ },
"schema": {
"title": "Repository Enterprise Stats",
"type": "object",
@@ -148407,6 +148456,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_users": 100,
+ "admin_users": 3,
+ "suspended_users": 1
+ },
"schema": {
"title": "Enterprise User Stats",
"type": "object",
@@ -169131,10 +169185,10 @@
},
{
"name": "ref",
- "description": "<p>The name of the fully qualified reference to update. For example, <code>refs/heads/master</code>. If the value doesn't start with <code>refs</code> and have at least two slashes, it will be rejected.</p>",
+ "description": "<p>The name of the reference to update (for example, <code>heads/featureA</code>). Can be a branch name (<code>heads/BRANCH_NAME</code>) or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
- "example": "refs/head/master",
+ "example": "heads/featureA",
"schema": {
"type": "string"
},
@@ -244528,8 +244582,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Lists the most commonly used licenses on GitHub. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -244724,8 +244778,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Gets information about a specific license. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -245686,7 +245740,7 @@
},
"response": {
"statusCode": "200",
- "contentType": "text/plain",
+ "contentType": "application/json",
"description": "<p>Example response</p>",
"example": "Responsive is better than fast",
"schema": {
@@ -264896,7 +264950,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/github-ae@latest/rest/reference/orgs#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -265355,7 +265409,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/github-ae@latest/rest/reference/orgs#update-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -288131,7 +288185,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#update-a-pull-request\">edit</a> a pull request, GitHub AE creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub AE has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
+ "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/github-ae@latest/rest/pulls/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/github-ae@latest/rest/pulls/pulls#update-a-pull-request\">edit</a> a pull request, GitHub AE creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub AE has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -292864,7 +292918,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#list-commits\">List commits</a> endpoint.</p>",
+ "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/github-ae@latest/rest/commits/commits#list-commits\">List commits</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -293338,7 +293392,7 @@
"type": "string",
"name": "expected_head_sha",
"in": "body",
- "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
+ "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/commits/commits#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
}
],
"enabledForGitHubApps": false,
@@ -309548,7 +309602,7 @@
"type": "string",
"name": "event",
"in": "body",
- "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/github-ae@latest/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
+ "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/github-ae@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -309970,7 +310024,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/github-ae@latest/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/github-ae@latest/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -312305,7 +312359,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#branches\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/github-ae@latest/rest/branches/branch-protection\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -312748,7 +312802,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
+ "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/pulls/reviews#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -312797,40 +312851,70 @@
"resources": {
"core": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1691591363
},
"search": {
"limit": 30,
+ "used": 12,
"remaining": 18,
- "reset": 1372697452,
- "used": 12
+ "reset": 1691591091
},
"graphql": {
"limit": 5000,
+ "used": 7,
"remaining": 4993,
- "reset": 1372700389,
- "used": 7
+ "reset": 1691593228
},
"integration_manifest": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "source_import": {
+ "limit": 100,
+ "used": 1,
+ "remaining": 99,
+ "reset": 1691591091
},
"code_scanning_upload": {
"limit": 500,
+ "used": 1,
"remaining": 499,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "actions_runner_registration": {
+ "limit": 10000,
+ "used": 0,
+ "remaining": 10000,
+ "reset": 1691594631
+ },
+ "scim": {
+ "limit": 15000,
+ "used": 0,
+ "remaining": 15000,
+ "reset": 1691594631
+ },
+ "dependency_snapshots": {
+ "limit": 100,
+ "used": 0,
+ "remaining": 100,
+ "reset": 1691591091
+ },
+ "code_search": {
+ "limit": 10,
+ "used": 0,
+ "remaining": 10,
+ "reset": 1691591091
}
},
"rate": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1372700873
}
},
"schema": {
@@ -313097,7 +313181,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p>Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under <code>resources</code>, you'll see objects relating to different categories:</p>\n<ul>\n<li>The <code>core</code> object provides your rate limit status for all non-search-related resources in the REST API.</li>\n<li>The <code>search</code> object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/search\">Search</a>.\"</li>\n<li>The <code>code_search</code> object provides your rate limit status for the REST API for searching code. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/search/search#search-code\">Search code</a>.\"</li>\n<li>The <code>graphql</code> object provides your rate limit status for the GraphQL API. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/graphql/overview/resource-limitations#rate-limit\">Resource limitations</a>.\"</li>\n<li>The <code>integration_manifest</code> object provides your rate limit status for the <code>POST /app-manifests/{code}/conversions</code> operation. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration\">Creating a GitHub App from a manifest</a>.\"</li>\n<li>The <code>dependency_snapshots</code> object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>code_scanning_upload</code> object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github\">Uploading a SARIF file to GitHub</a>.\"</li>\n<li>The <code>actions_runner_registration</code> object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/actions/self-hosted-runners\">Self-hosted runners</a>.\"</li>\n<li>The <code>source_import</code> object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/api-versions\">API Versions</a>.\"</li>\n</ul>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -313163,7 +313247,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -313470,7 +313554,7 @@
}
}
],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments/\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -313478,7 +313562,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -313531,7 +313615,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -314080,7 +314164,7 @@
}
}
],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -314092,7 +314176,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -314171,7 +314255,7 @@
}
}
],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -314179,7 +314263,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -314219,7 +314303,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -314525,7 +314609,7 @@
}
}
],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/github-ae@latest/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -314533,7 +314617,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -314577,7 +314661,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -315124,7 +315208,7 @@
}
}
],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -315136,7 +315220,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -315205,7 +315289,7 @@
}
}
],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -315213,7 +315297,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -315253,7 +315337,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -315559,7 +315643,7 @@
}
}
],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/github-ae@latest/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -315571,7 +315655,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -315615,7 +315699,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a> to add to the commit comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the commit comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -316162,7 +316246,7 @@
}
}
],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#comments\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/commits/comments#get-a-commit-comment\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -316182,7 +316266,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -316251,7 +316335,7 @@
}
}
],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -316259,7 +316343,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -316299,7 +316383,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -316605,7 +316689,7 @@
}
}
],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/github-ae@latest/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -316617,7 +316701,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -316661,7 +316745,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -317208,7 +317292,7 @@
}
}
],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues#comments\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/github-ae@latest/rest/issues/comments#get-an-issue-comment\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -317224,7 +317308,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -317293,7 +317377,7 @@
}
}
],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/github-ae@latest/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -317301,7 +317385,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -317341,7 +317425,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
"in": "query",
"required": false,
"schema": {
@@ -317647,7 +317731,7 @@
}
}
],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -317663,7 +317747,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -317707,7 +317791,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -318254,7 +318338,7 @@
}
}
],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues/\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -318270,7 +318354,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -318339,7 +318423,7 @@
}
}
],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues/\">issue</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -318347,7 +318431,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -318387,7 +318471,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -318693,7 +318777,7 @@
}
}
],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/github-ae@latest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -318705,7 +318789,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -318749,7 +318833,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a> to add to the pull request review comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the pull request review comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -319296,7 +319380,7 @@
}
}
],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#comments\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -319312,7 +319396,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -319381,7 +319465,7 @@
}
}
],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -319389,7 +319473,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -319429,7 +319513,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
"in": "query",
"required": false,
"schema": {
@@ -319733,7 +319817,7 @@
}
}
],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -319749,7 +319833,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -319793,7 +319877,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types\">reaction type</a> to add to the release.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the release.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -320338,7 +320422,7 @@
}
}
],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#releases\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases#get-a-release\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -320354,7 +320438,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
},
{
@@ -320423,7 +320507,7 @@
}
}
],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -320431,7 +320515,7 @@
}
],
"previews": [
- "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reference/reactions\">listing and creating</a> reactions.</p>"
+ "<p>An additional <code>reactions</code> object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the <a href=\"https://developer.github.com/changes/2016-05-12-reactions-api-preview\">blog post</a> for full details.</p>\n<p>To access the API you must provide a custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.squirrel-girl-preview\n</code></pre>\n<p>The <code>reactions</code> key will have the following payload where <code>url</code> can be used to construct the API location for <a href=\"https://docs.github.com/github-ae@latest/rest/reactions/reactions\">listing and creating</a> reactions.</p>"
]
}
]
@@ -326440,7 +326524,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub AE expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub AE renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub AE Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
+ "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub AE expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub AE renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/github-ae@latest/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub AE Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -352347,7 +352431,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/github-ae@latest/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. </p>\n</li>\n<li>\n<p>This API supports files up to 1 megabyte in size.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
+ "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. </p>\n</li>\n<li>\n<p>This API supports files up to 1 megabyte in size.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -352961,7 +353045,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos/#delete-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/github-ae@latest/rest/repos/contents/#delete-a-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -353306,7 +353390,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/github-ae@latest/rest/repos/contents/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -353515,7 +353599,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -353727,7 +353811,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -360929,7 +361013,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/github-ae@latest/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/github-ae@latest/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -360939,7 +361023,7 @@
{
"name": "sort",
"deprecated": true,
- "description": "<p><strong>This field is deprecated.</strong> Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub AE search infrastructure. Default: <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p><strong>This field is deprecated.</strong> Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub AE search infrastructure. Default: <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -362010,7 +362094,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>\n<p>This endpoint requires you to authenticate and limits you to 10 requests per minute.</p>",
+ "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>\n<p>This endpoint requires you to authenticate and limits you to 10 requests per minute.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -362044,7 +362128,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/github-ae@latest/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/github-ae@latest/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -362053,7 +362137,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -363485,7 +363569,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
+ "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -363507,7 +363591,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/github-ae@latest/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/github-ae@latest/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -363516,7 +363600,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -366548,7 +366632,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/github-ae@latest/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
+ "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/github-ae@latest/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -366591,7 +366675,7 @@
},
{
"name": "q",
- "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -366600,7 +366684,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -366792,7 +366876,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -366826,7 +366910,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/github-ae@latest/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/github-ae@latest/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -366835,7 +366919,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -367702,7 +367786,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -367732,7 +367816,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -368058,7 +368142,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/github-ae@latest/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/github-ae@latest/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -368080,7 +368164,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/github-ae@latest/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/github-ae@latest/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -368089,7 +368173,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub AE. Default: <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub AE. Default: <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -368404,7 +368488,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
+ "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -386404,7 +386488,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/github-ae@latest/rest/reference/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
+ "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/github-ae@latest/rest/teams/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -386493,7 +386577,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/github-ae@latest/rest/teams/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -386566,7 +386650,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/github-ae@latest/rest/reference/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/github-ae@latest/rest/teams/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -400560,7 +400644,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub AE plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/github-ae@latest/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub AE plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub AE <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub AE. For more information, see <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/users#emails\">Emails API</a>\".</p>",
+ "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub AE plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/github-ae@latest/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub AE plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub AE <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub AE. For more information, see <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/users/emails\">Emails API</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -403858,7 +403942,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
+ "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -404003,7 +404087,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
+ "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -404985,7 +405069,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -405608,7 +405692,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/repos#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -405661,7 +405745,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -405983,7 +406067,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/repos#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json
index 34b4ce286a8a..269300159b10 100644
--- a/src/rest/data/ghec-2022-11-28/schema.json
+++ b/src/rest/data/ghec-2022-11-28/schema.json
@@ -100138,7 +100138,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/apps/#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -108855,7 +108855,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -141227,7 +141227,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -145069,7 +145069,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. See the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#actions-object\"><code>actions</code> object</a> description. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -152804,7 +152804,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#check-runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/checks/runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -164170,7 +164170,8 @@
"python"
],
"query_suite": "default",
- "updated_at": "2023-01-19T11:21:34Z"
+ "updated_at": "2023-01-19T11:21:34Z",
+ "schedule": "weekly"
},
"schema": {
"description": "Configuration for code scanning default setup.",
@@ -164221,6 +164222,17 @@
"examples": [
"2023-12-06T14:20:20.000Z"
]
+ },
+ "schedule": {
+ "description": "The frequency of the periodic analysis.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "enum": [
+ "weekly",
+ null
+ ]
}
}
}
@@ -164496,7 +164508,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the <code>security_events</code> scope to use this endpoint for private repositories. You can also use tokens with the <code>public_repo</code> scope for public repositories only. GitHub Apps must have the <code>security_events</code> write permission to use this endpoint.</p>\n<p>There are two places where you can upload code scanning results.</p>\n<ul>\n<li>If you upload to a pull request, for example <code>--ref refs/pull/42/merge</code> or <code>--ref refs/pull/42/head</code>, then the results appear as alerts in a pull request check. For more information, see \"<a href=\"/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests\">Triaging code scanning alerts in pull requests</a>.\"</li>\n<li>If you upload to a branch, for example <code>--ref refs/heads/my-branch</code>, then the results appear in the <strong>Security</strong> tab for your repository. For more information, see \"<a href=\"/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository\">Managing code scanning alerts for your repository</a>.\"</li>\n</ul>\n<p>You must compress the SARIF-formatted analysis data that you want to upload, using <code>gzip</code>, and then encode it as a Base64 format string. For example:</p>\n<pre><code>gzip -c analysis-data.sarif | base64 -w0\n</code></pre>\n<br>\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\"><strong>SARIF data</strong></th><th align=\"center\" scope=\"col\"><strong>Maximum values</strong></th><th scope=\"col\"><strong>Additional limits</strong></th></tr></thead><tbody><tr><td>Runs per file</td><td align=\"center\">20</td><td></td></tr><tr><td>Results per run</td><td align=\"center\">25,000</td><td>Only the top 5,000 results will be included, prioritized by severity.</td></tr><tr><td>Rules per run</td><td align=\"center\">25,000</td><td></td></tr><tr><td>Tool extensions per run</td><td align=\"center\">100</td><td></td></tr><tr><td>Thread Flow Locations per result</td><td align=\"center\">10,000</td><td>Only the top 1,000 Thread Flow Locations will be included, using prioritization.</td></tr><tr><td>Location per result</td><td align=\"center\">1,000</td><td>Only 100 locations will be included.</td></tr><tr><td>Tags per rule</td><td align=\"center\">20</td><td>Only 10 tags will be included.</td></tr></tbody></table>\n<p>The <code>202 Accepted</code> response includes an <code>id</code> value.\nYou can use this ID to check the status of the upload by using it in the <code>/sarifs/{sarif_id}</code> endpoint.\nFor more information, see \"<a href=\"/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload\">Get information about a SARIF upload</a>.\"</p>",
+ "descriptionHTML": "<p>Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the <code>security_events</code> scope to use this endpoint for private repositories. You can also use tokens with the <code>public_repo</code> scope for public repositories only. GitHub Apps must have the <code>security_events</code> write permission to use this endpoint. For troubleshooting information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif\">Troubleshooting SARIF uploads</a>.\"</p>\n<p>There are two places where you can upload code scanning results.</p>\n<ul>\n<li>If you upload to a pull request, for example <code>--ref refs/pull/42/merge</code> or <code>--ref refs/pull/42/head</code>, then the results appear as alerts in a pull request check. For more information, see \"<a href=\"/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests\">Triaging code scanning alerts in pull requests</a>.\"</li>\n<li>If you upload to a branch, for example <code>--ref refs/heads/my-branch</code>, then the results appear in the <strong>Security</strong> tab for your repository. For more information, see \"<a href=\"/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository\">Managing code scanning alerts for your repository</a>.\"</li>\n</ul>\n<p>You must compress the SARIF-formatted analysis data that you want to upload, using <code>gzip</code>, and then encode it as a Base64 format string. For example:</p>\n<pre><code>gzip -c analysis-data.sarif | base64 -w0\n</code></pre>\n<br>\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\"><strong>SARIF data</strong></th><th align=\"center\" scope=\"col\"><strong>Maximum values</strong></th><th scope=\"col\"><strong>Additional limits</strong></th></tr></thead><tbody><tr><td>Runs per file</td><td align=\"center\">20</td><td></td></tr><tr><td>Results per run</td><td align=\"center\">25,000</td><td>Only the top 5,000 results will be included, prioritized by severity.</td></tr><tr><td>Rules per run</td><td align=\"center\">25,000</td><td></td></tr><tr><td>Tool extensions per run</td><td align=\"center\">100</td><td></td></tr><tr><td>Thread Flow Locations per result</td><td align=\"center\">10,000</td><td>Only the top 1,000 Thread Flow Locations will be included, using prioritization.</td></tr><tr><td>Location per result</td><td align=\"center\">1,000</td><td>Only 100 locations will be included.</td></tr><tr><td>Tags per rule</td><td align=\"center\">20</td><td>Only 10 tags will be included.</td></tr></tbody></table>\n<p>The <code>202 Accepted</code> response includes an <code>id</code> value.\nYou can use this ID to check the status of the upload by using it in the <code>/sarifs/{sarif_id}</code> endpoint.\nFor more information, see \"<a href=\"/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload\">Get information about a SARIF upload</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -203139,7 +203151,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
- "description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/codespaces#get-the-public-key-for-the-authenticated-user\">Get the public key for the authenticated user</a> endpoint.</p>"
+ "description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/codespaces/secrets#get-public-key-for-the-authenticated-user\">Get the public key for the authenticated user</a> endpoint.</p>"
},
{
"type": "string",
@@ -206419,7 +206431,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations\">API</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -221826,7 +221838,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#custom-media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
+ "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -243092,7 +243104,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/reference/actions#secrets\">Secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
+ "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/actions/secrets\">GitHub Actions secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -265374,10 +265386,10 @@
},
{
"name": "ref",
- "description": "<p>The name of the fully qualified reference to update. For example, <code>refs/heads/master</code>. If the value doesn't start with <code>refs</code> and have at least two slashes, it will be rejected.</p>",
+ "description": "<p>The name of the reference to update (for example, <code>heads/featureA</code>). Can be a branch name (<code>heads/BRANCH_NAME</code>) or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
- "example": "refs/head/master",
+ "example": "heads/featureA",
"schema": {
"type": "string"
},
@@ -342593,8 +342605,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Lists the most commonly used licenses on GitHub. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -342789,8 +342801,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Gets information about a specific license. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -343817,7 +343829,7 @@
},
"response": {
"statusCode": "200",
- "contentType": "text/plain",
+ "contentType": "application/json",
"description": "<p>Example response</p>",
"example": "Responsive is better than fast",
"schema": {
@@ -368680,7 +368692,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note</strong>: This operation is deprecated and will be removed after September 6th 2023.\nUse the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization\">List fine-grained repository permissions</a>\" endpoint instead.</p>\n<p>Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the <code>admin:org</code> or <code>repo</code> scope.\nGitHub Apps must have the <code>organization_custom_roles:read</code> or <code>organization_administration:read</code> organization permission to use this endpoint.</p>",
+ "descriptionHTML": "<p><strong>Note</strong>: This operation is deprecated and will be removed after September 6th 2023.\nUse the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization\">List fine-grained repository permissions</a>\" endpoint instead.</p>\n<p>Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization and must use an access token with the <code>admin:org</code> or <code>repo</code> scope.\nGitHub Apps must have the <code>organization_custom_roles:read</code> or <code>organization_administration:read</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -382718,7 +382730,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/orgs#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -383177,7 +383189,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/orgs#update-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -420117,7 +420129,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#update-a-pull-request\">edit</a> a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
+ "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request\">edit</a> a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -424850,7 +424862,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#list-commits\">List commits</a> endpoint.</p>",
+ "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits\">List commits</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -425324,7 +425336,7 @@
"type": "string",
"name": "expected_head_sha",
"in": "body",
- "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
+ "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
}
],
"enabledForGitHubApps": false,
@@ -441884,7 +441896,7 @@
"type": "string",
"name": "event",
"in": "body",
- "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
+ "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -442306,7 +442318,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -444641,7 +444653,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#branches\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -445084,7 +445096,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
+ "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -445133,40 +445145,70 @@
"resources": {
"core": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1691591363
},
"search": {
"limit": 30,
+ "used": 12,
"remaining": 18,
- "reset": 1372697452,
- "used": 12
+ "reset": 1691591091
},
"graphql": {
"limit": 5000,
+ "used": 7,
"remaining": 4993,
- "reset": 1372700389,
- "used": 7
+ "reset": 1691593228
},
"integration_manifest": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "source_import": {
+ "limit": 100,
+ "used": 1,
+ "remaining": 99,
+ "reset": 1691591091
},
"code_scanning_upload": {
"limit": 500,
+ "used": 1,
"remaining": 499,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "actions_runner_registration": {
+ "limit": 10000,
+ "used": 0,
+ "remaining": 10000,
+ "reset": 1691594631
+ },
+ "scim": {
+ "limit": 15000,
+ "used": 0,
+ "remaining": 15000,
+ "reset": 1691594631
+ },
+ "dependency_snapshots": {
+ "limit": 100,
+ "used": 0,
+ "remaining": 100,
+ "reset": 1691591091
+ },
+ "code_search": {
+ "limit": 10,
+ "used": 0,
+ "remaining": 10,
+ "reset": 1691591091
}
},
"rate": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1372700873
}
},
"schema": {
@@ -445457,7 +445499,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p>Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under <code>resources</code>, you'll see objects relating to different categories:</p>\n<ul>\n<li>The <code>core</code> object provides your rate limit status for all non-search-related resources in the REST API.</li>\n<li>The <code>search</code> object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search\">Search</a>.\"</li>\n<li>The <code>code_search</code> object provides your rate limit status for the REST API for searching code. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code\">Search code</a>.\"</li>\n<li>The <code>graphql</code> object provides your rate limit status for the GraphQL API. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit\">Resource limitations</a>.\"</li>\n<li>The <code>integration_manifest</code> object provides your rate limit status for the <code>POST /app-manifests/{code}/conversions</code> operation. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration\">Creating a GitHub App from a manifest</a>.\"</li>\n<li>The <code>dependency_snapshots</code> object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>code_scanning_upload</code> object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github\">Uploading a SARIF file to GitHub</a>.\"</li>\n<li>The <code>actions_runner_registration</code> object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners\">Self-hosted runners</a>.\"</li>\n<li>The <code>source_import</code> object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/api-versions\">API Versions</a>.\"</li>\n</ul>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -445523,7 +445565,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -445831,7 +445873,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/teams#discussion-comments/\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -445889,7 +445931,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -446439,7 +446481,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -446528,7 +446570,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -446573,7 +446615,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -446880,7 +446922,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -446929,7 +446971,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -447477,7 +447519,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -447556,7 +447598,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -447601,7 +447643,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -447908,7 +447950,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -447961,7 +448003,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a> to add to the commit comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a> to add to the commit comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -448509,7 +448551,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#comments\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -448592,7 +448634,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -448637,7 +448679,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -448944,7 +448986,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -448997,7 +449039,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -449545,7 +449587,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues#comments\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -449628,7 +449670,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -449673,7 +449715,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
"in": "query",
"required": false,
"schema": {
@@ -449980,7 +450022,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -450037,7 +450079,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -450585,7 +450627,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues/\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -450668,7 +450710,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues/\">issue</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -450713,7 +450755,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -451020,7 +451062,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -451073,7 +451115,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a> to add to the pull request review comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a> to add to the pull request review comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -451621,7 +451663,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#comments\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -451704,7 +451746,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -451749,7 +451791,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
"in": "query",
"required": false,
"schema": {
@@ -452054,7 +452096,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -452107,7 +452149,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a> to add to the release.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a> to add to the release.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -452653,7 +452695,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#releases\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -452736,7 +452778,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -452781,7 +452823,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -453088,7 +453130,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -453137,7 +453179,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -453420,7 +453462,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -453456,7 +453498,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -453762,7 +453804,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -453802,7 +453844,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -454084,7 +454126,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -455736,7 +455778,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#releases\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
+ "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -460269,7 +460311,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Cloud Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
+ "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Cloud Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -476994,9 +477036,9 @@
},
{
"serverUrl": "https://api.github.com",
- "verb": "get",
- "requestPath": "/repos/{owner}/{repo}/tags",
- "title": "List repository tags",
+ "verb": "put",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting",
+ "title": "Enable private vulnerability reporting for a repository",
"category": "repos",
"subcategory": "repos",
"parameters": [
@@ -477017,24 +477059,6 @@
"schema": {
"type": "string"
}
- },
- {
- "name": "per_page",
- "description": "<p>The number of results per page (max 100).</p>",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "<p>Page number of the results to fetch.</p>",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
}
],
"bodyParameters": [],
@@ -477051,94 +477075,29 @@
}
},
"response": {
- "statusCode": "200",
- "contentType": "application/json",
- "description": "<p>Response</p>",
- "example": [
- {
- "name": "v0.1",
- "commit": {
- "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc",
- "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"
- },
- "zipball_url": "https://github.com/octocat/Hello-World/zipball/v0.1",
- "tarball_url": "https://github.com/octocat/Hello-World/tarball/v0.1",
- "node_id": "MDQ6VXNlcjE="
- }
- ],
- "schema": {
- "type": "array",
- "items": {
- "title": "Tag",
- "description": "Tag",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "examples": [
- "v0.1"
- ]
- },
- "commit": {
- "type": "object",
- "properties": {
- "sha": {
- "type": "string"
- },
- "url": {
- "type": "string",
- "format": "uri"
- }
- },
- "required": [
- "sha",
- "url"
- ]
- },
- "zipball_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat/Hello-World/zipball/v0.1"
- ]
- },
- "tarball_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/octocat/Hello-World/tarball/v0.1"
- ]
- },
- "node_id": {
- "type": "string"
- }
- },
- "required": [
- "name",
- "node_id",
- "commit",
- "zipball_url",
- "tarball_url"
- ]
- }
- }
+ "statusCode": "204",
+ "description": "<p>A header with no content is returned.</p>"
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability\">Privately reporting a security vulnerability</a>.\"</p>",
"statusCodes": [
{
- "httpStatusCode": "200",
- "description": "<p>OK</p>"
+ "httpStatusCode": "204",
+ "description": "<p>A header with no content is returned.</p>"
+ },
+ {
+ "httpStatusCode": "422",
+ "description": "<p>Bad Request</p>"
}
]
},
{
"serverUrl": "https://api.github.com",
- "verb": "get",
- "requestPath": "/repos/{owner}/{repo}/teams",
- "title": "List repository teams",
+ "verb": "delete",
+ "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting",
+ "title": "Disable private vulnerability reporting for a repository",
"category": "repos",
"subcategory": "repos",
"parameters": [
@@ -477159,24 +477118,6 @@
"schema": {
"type": "string"
}
- },
- {
- "name": "per_page",
- "description": "<p>The number of results per page (max 100).</p>",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 30
- }
- },
- {
- "name": "page",
- "description": "<p>Page number of the results to fetch.</p>",
- "in": "query",
- "schema": {
- "type": "integer",
- "default": 1
- }
}
],
"bodyParameters": [],
@@ -477193,260 +477134,479 @@
}
},
"response": {
- "statusCode": "200",
- "contentType": "application/json",
- "description": "<p>Response</p>",
- "example": [
- {
- "id": 1,
- "node_id": "MDQ6VGVhbTE=",
- "url": "https://api.github.com/teams/1",
- "html_url": "https://github.com/orgs/github/teams/justice-league",
- "name": "Justice League",
- "slug": "justice-league",
- "description": "A great team.",
- "privacy": "closed",
- "notification_setting": "notifications_enabled",
- "permission": "admin",
- "members_url": "https://api.github.com/teams/1/members{/member}",
- "repositories_url": "https://api.github.com/teams/1/repos",
- "parent": null
- }
- ],
- "schema": {
- "type": "array",
- "items": {
- "title": "Team",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "node_id": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "slug": {
- "type": "string"
- },
- "description": {
- "type": [
- "string",
- "null"
- ]
- },
- "privacy": {
- "type": "string"
- },
- "notification_setting": {
- "type": "string"
- },
- "permission": {
- "type": "string"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "pull": {
- "type": "boolean"
- },
- "triage": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "maintain": {
- "type": "boolean"
- },
- "admin": {
- "type": "boolean"
- }
- },
- "required": [
- "pull",
- "triage",
- "push",
- "maintain",
- "admin"
- ]
- },
- "url": {
- "type": "string",
- "format": "uri"
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "members_url": {
- "type": "string"
- },
- "repositories_url": {
- "type": "string",
- "format": "uri"
- },
- "parent": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "title": "Team Simple",
- "description": "Groups of organization members that gives permissions on specified repositories.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Unique identifier of the team",
- "type": "integer",
- "examples": [
- 1
- ]
- },
- "node_id": {
- "type": "string",
- "examples": [
- "MDQ6VGVhbTE="
- ]
- },
- "url": {
- "description": "URL for the team",
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1"
- ]
- },
- "members_url": {
- "type": "string",
- "examples": [
- "https://api.github.com/organizations/1/team/1/members{/member}"
- ]
- },
- "name": {
- "description": "Name of the team",
- "type": "string",
- "examples": [
- "Justice League"
- ]
- },
- "description": {
- "description": "Description of the team",
- "type": [
- "string",
- "null"
- ],
- "examples": [
- "A great team."
- ]
- },
- "permission": {
- "description": "Permission that the team will have for its repositories",
- "type": "string",
- "examples": [
- "admin"
- ]
- },
- "privacy": {
- "description": "The level of privacy this team should have",
- "type": "string",
- "examples": [
- "closed"
- ]
- },
- "notification_setting": {
- "description": "The notification setting the team has set",
- "type": "string",
- "examples": [
- "notifications_enabled"
- ]
- },
- "html_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://github.com/orgs/rails/teams/core"
- ]
- },
- "repositories_url": {
- "type": "string",
- "format": "uri",
- "examples": [
- "https://api.github.com/organizations/1/team/1/repos"
- ]
- },
- "slug": {
- "type": "string",
- "examples": [
- "justice-league"
- ]
- },
- "ldap_dn": {
- "description": "Distinguished Name (DN) that team maps to within LDAP environment",
- "type": "string",
- "examples": [
- "uid=example,ou=users,dc=github,dc=com"
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug"
- ]
- }
- ]
- }
- },
- "required": [
- "id",
- "node_id",
- "url",
- "members_url",
- "name",
- "description",
- "permission",
- "html_url",
- "repositories_url",
- "slug",
- "parent"
- ]
- }
- }
+ "statusCode": "204",
+ "description": "<p>A header with no content is returned.</p>"
}
}
],
"previews": [],
- "descriptionHTML": "<p>Lists the teams that have access to the specified repository and that are also visible to the authenticated user.</p>\n<p>For a public repository, a team is listed only if that team added the public repository explicitly.</p>\n<p>Personal access tokens require the following scopes:</p>\n<ul>\n<li><code>public_repo</code> to call this endpoint on a public repository</li>\n<li><code>repo</code> to call this endpoint on a private repository (this scope also includes public repositories)</li>\n</ul>\n<p>This endpoint is not compatible with fine-grained personal access tokens.</p>",
+ "descriptionHTML": "<p>Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability\">Privately reporting a security vulnerability</a>\".</p>",
"statusCodes": [
{
- "httpStatusCode": "200",
- "description": "<p>OK</p>"
+ "httpStatusCode": "204",
+ "description": "<p>A header with no content is returned.</p>"
},
{
- "httpStatusCode": "404",
- "description": "<p>Resource not found</p>"
+ "httpStatusCode": "422",
+ "description": "<p>Bad Request</p>"
}
]
},
{
"serverUrl": "https://api.github.com",
"verb": "get",
- "requestPath": "/repos/{owner}/{repo}/topics",
- "title": "Get all repository topics",
+ "requestPath": "/repos/{owner}/{repo}/tags",
+ "title": "List repository tags",
+ "category": "repos",
+ "subcategory": "repos",
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "<p>The account owner of the repository. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "<p>The name of the repository without the <code>.git</code> extension. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "<p>The number of results per page (max 100).</p>",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "<p>Page number of the results to fetch.</p>",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "bodyParameters": [],
+ "enabledForGitHubApps": true,
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "parameters": {
+ "owner": "OWNER",
+ "repo": "REPO"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "<p>Response</p>",
+ "example": [
+ {
+ "name": "v0.1",
+ "commit": {
+ "sha": "c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc",
+ "url": "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"
+ },
+ "zipball_url": "https://github.com/octocat/Hello-World/zipball/v0.1",
+ "tarball_url": "https://github.com/octocat/Hello-World/tarball/v0.1",
+ "node_id": "MDQ6VXNlcjE="
+ }
+ ],
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Tag",
+ "description": "Tag",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "examples": [
+ "v0.1"
+ ]
+ },
+ "commit": {
+ "type": "object",
+ "properties": {
+ "sha": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ "required": [
+ "sha",
+ "url"
+ ]
+ },
+ "zipball_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat/Hello-World/zipball/v0.1"
+ ]
+ },
+ "tarball_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat/Hello-World/tarball/v0.1"
+ ]
+ },
+ "node_id": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "node_id",
+ "commit",
+ "zipball_url",
+ "tarball_url"
+ ]
+ }
+ }
+ }
+ }
+ ],
+ "descriptionHTML": "",
+ "previews": [],
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "<p>OK</p>"
+ }
+ ]
+ },
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/teams",
+ "title": "List repository teams",
+ "category": "repos",
+ "subcategory": "repos",
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "<p>The account owner of the repository. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "<p>The name of the repository without the <code>.git</code> extension. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "<p>The number of results per page (max 100).</p>",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "<p>Page number of the results to fetch.</p>",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "bodyParameters": [],
+ "enabledForGitHubApps": true,
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "parameters": {
+ "owner": "OWNER",
+ "repo": "REPO"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "<p>Response</p>",
+ "example": [
+ {
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "name": "Justice League",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "permission": "admin",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "parent": null
+ }
+ ],
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VGVhbTE="
+ ]
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1"
+ ]
+ },
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/members{/member}"
+ ]
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "examples": [
+ "Justice League"
+ ]
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great team."
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "examples": [
+ "admin"
+ ]
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "examples": [
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "examples": [
+ "notifications_enabled"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/repos"
+ ]
+ },
+ "slug": {
+ "type": "string",
+ "examples": [
+ "justice-league"
+ ]
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "type": "string",
+ "examples": [
+ "uid=example,ou=users,dc=github,dc=com"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ }
+ }
+ }
+ }
+ ],
+ "previews": [],
+ "descriptionHTML": "<p>Lists the teams that have access to the specified repository and that are also visible to the authenticated user.</p>\n<p>For a public repository, a team is listed only if that team added the public repository explicitly.</p>\n<p>Personal access tokens require the following scopes:</p>\n<ul>\n<li><code>public_repo</code> to call this endpoint on a public repository</li>\n<li><code>repo</code> to call this endpoint on a private repository (this scope also includes public repositories)</li>\n</ul>\n<p>This endpoint is not compatible with fine-grained personal access tokens.</p>",
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "<p>OK</p>"
+ },
+ {
+ "httpStatusCode": "404",
+ "description": "<p>Resource not found</p>"
+ }
+ ]
+ },
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/topics",
+ "title": "Get all repository topics",
"category": "repos",
"subcategory": "repos",
"parameters": [
@@ -488876,7 +489036,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
+ "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -489490,7 +489650,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos/#delete-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -489835,7 +489995,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -490044,7 +490204,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -490256,7 +490416,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -506520,7 +506680,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -506530,7 +506690,7 @@
{
"name": "sort",
"deprecated": true,
- "description": "<p><strong>This field is deprecated.</strong> Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p><strong>This field is deprecated.</strong> Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -507601,7 +507761,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>\n<p>This endpoint requires you to authenticate and limits you to 10 requests per minute.</p>",
+ "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>\n<p>This endpoint requires you to authenticate and limits you to 10 requests per minute.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -507635,7 +507795,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -507644,7 +507804,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -509076,7 +509236,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
+ "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -509098,7 +509258,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -509107,7 +509267,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -512224,7 +512384,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
+ "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -512267,7 +512427,7 @@
},
{
"name": "q",
- "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -512276,7 +512436,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -512468,7 +512628,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -512502,7 +512662,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -512511,7 +512671,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -513378,7 +513538,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -513408,7 +513568,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -513734,7 +513894,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -513756,7 +513916,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -513765,7 +513925,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub Enterprise Cloud. Default: <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub Enterprise Cloud. Default: <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -514080,7 +514240,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
+ "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -518981,7 +519141,7 @@
{
"name": "cwes",
"in": "query",
- "description": "<p>If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.</p>",
+ "description": "<p>If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.</p>\n<p>Example: <code>cwes=79,284,22</code> or <code>cwes[]=79&cwes[]=284&cwes[]=22</code></p>",
"schema": {
"oneOf": [
{
@@ -519007,7 +519167,7 @@
{
"name": "affects",
"in": "query",
- "description": "<p>If specified, return advisories that affect any of <code>package</code> or <code>package@version</code>. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.</p>",
+ "description": "<p>If specified, only return advisories that affect any of <code>package</code> or <code>package@version</code>. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.</p>\n<p>Example: <code>affects=package1,package2@1.0.0,package3@^2.0.0</code> or <code>affects[]=package1&affects[]=package2@1.0.0</code></p>",
"schema": {
"oneOf": [
{
@@ -519345,7 +519505,7 @@
"null"
],
"format": "date-time",
- "description": "The date and time of when the advisory was published in the National Vulnerability Database, in ISO 8601 format.",
+ "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.",
"readOnly": true
},
"withdrawn_at": {
@@ -519716,7 +519876,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List global security advisories and filter using parameters such as ecosystem, GHSA ID, CVE ID, etc.</p>",
+ "descriptionHTML": "<p>Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.</p>\n<p>By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the <code>type</code> parameter in your request, with the value <code>malware</code>. For more information about the different types of security advisories, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories\">About the GitHub Advisory database</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -519988,7 +520148,7 @@
"null"
],
"format": "date-time",
- "description": "The date and time of when the advisory was published in the National Vulnerability Database, in ISO 8601 format.",
+ "description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.",
"readOnly": true
},
"withdrawn_at": {
@@ -520372,6 +520532,2332 @@
}
],
"repository-advisories": [
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/security-advisories",
+ "title": "List repository security advisories for an organization",
+ "category": "security-advisories",
+ "subcategory": "repository-advisories",
+ "parameters": [
+ {
+ "name": "org",
+ "description": "<p>The organization name. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "direction",
+ "description": "<p>The direction to sort the results by.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "default": "desc"
+ }
+ },
+ {
+ "name": "sort",
+ "description": "<p>The property to sort the results by.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "created",
+ "updated",
+ "published"
+ ],
+ "default": "created"
+ }
+ },
+ {
+ "name": "before",
+ "description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers\">Link header</a>. If specified, the query only searches for results before this cursor.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "after",
+ "description": "<p>A cursor, as given in the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers\">Link header</a>. If specified, the query only searches for results after this cursor.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "<p>The number of advisories to return per page.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100,
+ "default": 30
+ }
+ },
+ {
+ "name": "state",
+ "description": "<p>Filter by the state of the repository advisories. Only advisories of this state will be returned.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "triage",
+ "draft",
+ "published",
+ "closed"
+ ]
+ }
+ }
+ ],
+ "bodyParameters": [],
+ "enabledForGitHubApps": true,
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "parameters": {
+ "org": "ORG"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "<p>Response</p>",
+ "example": [
+ {
+ "ghsa_id": "GHSA-abcd-1234-efgh",
+ "cve_id": "CVE-2050-00000",
+ "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh",
+ "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh",
+ "summary": "A short summary of the advisory.",
+ "description": "A detailed description of what the advisory entails.",
+ "severity": "critical",
+ "author": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "publisher": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-abcd-1234-efgh"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2050-00000"
+ }
+ ],
+ "state": "published",
+ "created_at": "2020-01-01T00:00:00Z",
+ "updated_at": "2020-01-02T00:00:00Z",
+ "published_at": "2020-01-03T00:00:00Z",
+ "closed_at": null,
+ "withdrawn_at": null,
+ "submission": null,
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "a-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.1",
+ "patched_versions": "1.0.1",
+ "vulnerable_functions": [
+ "function1"
+ ]
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "another-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.2",
+ "patched_versions": "1.0.2",
+ "vulnerable_functions": [
+ "function2"
+ ]
+ }
+ ],
+ "cvss": {
+ "vector_string": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
+ "score": 9.8
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-123",
+ "name": "A CWE"
+ }
+ ],
+ "cwe_ids": [
+ "CWE-123"
+ ],
+ "credits": [
+ {
+ "login": "octocat",
+ "type": "analyst"
+ }
+ ],
+ "credits_detailed": [
+ {
+ "user": {
+ "login": "octocat",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octocat",
+ "html_url": "https://github.com/octocat",
+ "followers_url": "https://api.github.com/users/octocat/followers",
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
+ "repos_url": "https://api.github.com/users/octocat/repos",
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "type": "analyst",
+ "state": "accepted"
+ }
+ ],
+ "collaborating_users": [
+ {
+ "login": "octokitten",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octokitten_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octokitten",
+ "html_url": "https://github.com/octokitten",
+ "followers_url": "https://api.github.com/users/octokitten/followers",
+ "following_url": "https://api.github.com/users/octokitten/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions",
+ "organizations_url": "https://api.github.com/users/octokitten/orgs",
+ "repos_url": "https://api.github.com/users/octokitten/repos",
+ "events_url": "https://api.github.com/users/octokitten/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octokitten/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "collaborating_teams": [
+ {
+ "name": "Justice League",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "permission": "admin",
+ "parent": null
+ }
+ ]
+ },
+ {
+ "ghsa_id": "GHSA-1234-5678-9012",
+ "cve_id": "CVE-2051-0000",
+ "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012",
+ "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-1234-5678-9012",
+ "summary": "A short summary of the advisory.",
+ "description": "A detailed description of what the advisory entails.",
+ "severity": "low",
+ "author": {
+ "login": "monauser",
+ "id": 2,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monauser",
+ "html_url": "https://github.com/monauser",
+ "followers_url": "https://api.github.com/users/monauser/followers",
+ "following_url": "https://api.github.com/users/monauser/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monauser/subscriptions",
+ "organizations_url": "https://api.github.com/users/monauser/orgs",
+ "repos_url": "https://api.github.com/users/monauser/repos",
+ "events_url": "https://api.github.com/users/monauser/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monauser/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "publisher": {
+ "login": "monalisa",
+ "id": 3,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monalisa",
+ "html_url": "https://github.com/monalisa",
+ "followers_url": "https://api.github.com/users/monalisa/followers",
+ "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
+ "organizations_url": "https://api.github.com/users/monalisa/orgs",
+ "repos_url": "https://api.github.com/users/monalisa/repos",
+ "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monalisa/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "identifiers": [
+ {
+ "type": "GHSA",
+ "value": "GHSA-1234-5678-9012"
+ },
+ {
+ "type": "CVE",
+ "value": "CVE-2051-00000"
+ }
+ ],
+ "state": "published",
+ "created_at": "2020-01-03T00:00:00Z",
+ "updated_at": "2020-01-04T00:00:00Z",
+ "published_at": "2020-01-04T00:00:00Z",
+ "closed_at": null,
+ "withdrawn_at": null,
+ "submission": [
+ {
+ "accepted": true
+ }
+ ],
+ "vulnerabilities": [
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "a-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.1",
+ "patched_versions": "1.0.1",
+ "vulnerable_functions": [
+ "function1"
+ ]
+ },
+ {
+ "package": {
+ "ecosystem": "pip",
+ "name": "another-package"
+ },
+ "vulnerable_version_range": ">= 1.0.0, < 1.0.2",
+ "patched_versions": "1.0.2",
+ "vulnerable_functions": [
+ "function2"
+ ]
+ }
+ ],
+ "cvss": {
+ "vector_string": "AV:P/AC:H/PR:H/UI:R/S:U/C:N/I:L/A:N",
+ "score": 1.6
+ },
+ "cwes": [
+ {
+ "cwe_id": "CWE-456",
+ "name": "A CWE 2.0"
+ }
+ ],
+ "cwe_ids": [
+ "CWE-456"
+ ],
+ "credits": [
+ {
+ "login": "monauser",
+ "type": "reporter"
+ }
+ ],
+ "credits_detailed": [
+ {
+ "user": {
+ "login": "monauser",
+ "id": 2,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/monauser",
+ "html_url": "https://github.com/monauser",
+ "followers_url": "https://api.github.com/users/monauser/followers",
+ "following_url": "https://api.github.com/users/monauser/following{/other_user}",
+ "gists_url": "https://api.github.com/users/monauser/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/monauser/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/monauser/subscriptions",
+ "organizations_url": "https://api.github.com/users/monauser/orgs",
+ "repos_url": "https://api.github.com/users/monauser/repos",
+ "events_url": "https://api.github.com/users/monauser/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/monauser/received_events",
+ "type": "User",
+ "site_admin": false
+ },
+ "type": "reporter",
+ "state": "accepted"
+ }
+ ],
+ "collaborating_users": [
+ {
+ "login": "octokitten",
+ "id": 1,
+ "node_id": "MDQ6VXNlcjE=",
+ "avatar_url": "https://github.com/images/error/octokitten_happy.gif",
+ "gravatar_id": "",
+ "url": "https://api.github.com/users/octokitten",
+ "html_url": "https://github.com/octokitten",
+ "followers_url": "https://api.github.com/users/octokitten/followers",
+ "following_url": "https://api.github.com/users/octokitten/following{/other_user}",
+ "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}",
+ "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}",
+ "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions",
+ "organizations_url": "https://api.github.com/users/octokitten/orgs",
+ "repos_url": "https://api.github.com/users/octokitten/repos",
+ "events_url": "https://api.github.com/users/octokitten/events{/privacy}",
+ "received_events_url": "https://api.github.com/users/octokitten/received_events",
+ "type": "User",
+ "site_admin": false
+ }
+ ],
+ "collaborating_teams": [
+ {
+ "name": "Justice League",
+ "id": 1,
+ "node_id": "MDQ6VGVhbTE=",
+ "slug": "justice-league",
+ "description": "A great team.",
+ "privacy": "closed",
+ "notification_setting": "notifications_enabled",
+ "url": "https://api.github.com/teams/1",
+ "html_url": "https://github.com/orgs/github/teams/justice-league",
+ "members_url": "https://api.github.com/teams/1/members{/member}",
+ "repositories_url": "https://api.github.com/teams/1/repos",
+ "permission": "admin",
+ "parent": null
+ }
+ ]
+ }
+ ],
+ "schema": {
+ "type": "array",
+ "items": {
+ "description": "A repository security advisory.",
+ "type": "object",
+ "properties": {
+ "ghsa_id": {
+ "type": "string",
+ "description": "The GitHub Security Advisory ID.",
+ "readOnly": true
+ },
+ "cve_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The Common Vulnerabilities and Exposures (CVE) ID."
+ },
+ "url": {
+ "type": "string",
+ "description": "The API URL for the advisory."
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The URL for the advisory.",
+ "readOnly": true
+ },
+ "summary": {
+ "type": "string",
+ "description": "A short summary of the advisory.",
+ "maxLength": 1024
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "A detailed description of what the advisory entails.",
+ "maxLength": 65535
+ },
+ "severity": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The severity of the advisory.",
+ "enum": [
+ "critical",
+ "high",
+ "medium",
+ "low",
+ null
+ ]
+ },
+ "author": {
+ "readOnly": true,
+ "description": "The author of the advisory.",
+ "allOf": [
+ {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ ],
+ "type": [
+ "null"
+ ]
+ },
+ "publisher": {
+ "readOnly": true,
+ "description": "The publisher of the advisory.",
+ "allOf": [
+ {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ ],
+ "type": [
+ "null"
+ ]
+ },
+ "identifiers": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "The type of identifier.",
+ "enum": [
+ "CVE",
+ "GHSA"
+ ]
+ },
+ "value": {
+ "type": "string",
+ "description": "The identifier value."
+ }
+ },
+ "required": [
+ "type",
+ "value"
+ ]
+ },
+ "readOnly": true
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the advisory.",
+ "enum": [
+ "published",
+ "closed",
+ "withdrawn",
+ "draft",
+ "triage"
+ ]
+ },
+ "created_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time",
+ "description": "The date and time of when the advisory was created, in ISO 8601 format.",
+ "readOnly": true
+ },
+ "updated_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time",
+ "description": "The date and time of when the advisory was last updated, in ISO 8601 format.",
+ "readOnly": true
+ },
+ "published_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time",
+ "description": "The date and time of when the advisory was published, in ISO 8601 format.",
+ "readOnly": true
+ },
+ "closed_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time",
+ "description": "The date and time of when the advisory was closed, in ISO 8601 format.",
+ "readOnly": true
+ },
+ "withdrawn_at": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "format": "date-time",
+ "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.",
+ "readOnly": true
+ },
+ "submission": {
+ "type": [
+ "object",
+ "null"
+ ],
+ "readOnly": true,
+ "properties": {
+ "accepted": {
+ "type": "boolean",
+ "description": "Whether a private vulnerability report was accepted by the repository's administrators.",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "accepted"
+ ]
+ },
+ "vulnerabilities": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "description": "A product affected by the vulnerability detailed in a repository security advisory.",
+ "type": "object",
+ "properties": {
+ "package": {
+ "description": "The name of the package affected by the vulnerability.",
+ "type": [
+ "object",
+ "null"
+ ],
+ "properties": {
+ "ecosystem": {
+ "type": "string",
+ "description": "The package's language or package management ecosystem.",
+ "enum": [
+ "rubygems",
+ "npm",
+ "pip",
+ "maven",
+ "nuget",
+ "composer",
+ "go",
+ "rust",
+ "erlang",
+ "actions",
+ "pub",
+ "other",
+ "swift"
+ ]
+ },
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The unique package name within its ecosystem."
+ }
+ },
+ "required": [
+ "ecosystem",
+ "name"
+ ]
+ },
+ "vulnerable_version_range": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The range of the package versions affected by the vulnerability."
+ },
+ "patched_versions": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The package version(s) that resolve the vulnerability."
+ },
+ "vulnerable_functions": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "The functions in the package that are affected.",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "package",
+ "vulnerable_version_range",
+ "patched_versions",
+ "vulnerable_functions"
+ ],
+ "additionalProperties": false
+ }
+ },
+ "cvss": {
+ "type": [
+ "object",
+ "null"
+ ],
+ "properties": {
+ "vector_string": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The CVSS vector."
+ },
+ "score": {
+ "type": [
+ "number",
+ "null"
+ ],
+ "description": "The CVSS score.",
+ "minimum": 0,
+ "maximum": 10,
+ "readOnly": true
+ }
+ },
+ "required": [
+ "vector_string",
+ "score"
+ ]
+ },
+ "cwes": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "cwe_id": {
+ "type": "string",
+ "description": "The Common Weakness Enumeration (CWE) identifier."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the CWE.",
+ "readOnly": true
+ }
+ },
+ "required": [
+ "cwe_id",
+ "name"
+ ]
+ },
+ "readOnly": true
+ },
+ "cwe_ids": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "A list of only the CWE IDs.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "credits": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "type": "object",
+ "properties": {
+ "login": {
+ "type": "string",
+ "description": "The username of the user credited."
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of credit the user is receiving.",
+ "enum": [
+ "analyst",
+ "finder",
+ "reporter",
+ "coordinator",
+ "remediation_developer",
+ "remediation_reviewer",
+ "remediation_verifier",
+ "tool",
+ "sponsor",
+ "other"
+ ]
+ }
+ }
+ }
+ },
+ "credits_detailed": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "items": {
+ "description": "A credit given to a user for a repository security advisory.",
+ "type": "object",
+ "properties": {
+ "user": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ }
+ },
+ "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"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of credit the user is receiving.",
+ "enum": [
+ "analyst",
+ "finder",
+ "reporter",
+ "coordinator",
+ "remediation_developer",
+ "remediation_reviewer",
+ "remediation_verifier",
+ "tool",
+ "sponsor",
+ "other"
+ ]
+ },
+ "state": {
+ "type": "string",
+ "description": "The state of the user's acceptance of the credit.",
+ "enum": [
+ "accepted",
+ "declined",
+ "pending"
+ ]
+ }
+ },
+ "required": [
+ "user",
+ "type",
+ "state"
+ ],
+ "additionalProperties": false
+ },
+ "readOnly": true
+ },
+ "collaborating_users": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "A list of users that collaborate on the advisory.",
+ "items": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ },
+ "collaborating_teams": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "A list of teams that collaborate on the advisory.",
+ "items": {
+ "title": "Team",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer"
+ },
+ "node_id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slug": {
+ "type": "string"
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "privacy": {
+ "type": "string"
+ },
+ "notification_setting": {
+ "type": "string"
+ },
+ "permission": {
+ "type": "string"
+ },
+ "permissions": {
+ "type": "object",
+ "properties": {
+ "pull": {
+ "type": "boolean"
+ },
+ "triage": {
+ "type": "boolean"
+ },
+ "push": {
+ "type": "boolean"
+ },
+ "maintain": {
+ "type": "boolean"
+ },
+ "admin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "pull",
+ "triage",
+ "push",
+ "maintain",
+ "admin"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "members_url": {
+ "type": "string"
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri"
+ },
+ "parent": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "title": "Team Simple",
+ "description": "Groups of organization members that gives permissions on specified repositories.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Unique identifier of the team",
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VGVhbTE="
+ ]
+ },
+ "url": {
+ "description": "URL for the team",
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1"
+ ]
+ },
+ "members_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/members{/member}"
+ ]
+ },
+ "name": {
+ "description": "Name of the team",
+ "type": "string",
+ "examples": [
+ "Justice League"
+ ]
+ },
+ "description": {
+ "description": "Description of the team",
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "A great team."
+ ]
+ },
+ "permission": {
+ "description": "Permission that the team will have for its repositories",
+ "type": "string",
+ "examples": [
+ "admin"
+ ]
+ },
+ "privacy": {
+ "description": "The level of privacy this team should have",
+ "type": "string",
+ "examples": [
+ "closed"
+ ]
+ },
+ "notification_setting": {
+ "description": "The notification setting the team has set",
+ "type": "string",
+ "examples": [
+ "notifications_enabled"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/orgs/rails/teams/core"
+ ]
+ },
+ "repositories_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/organizations/1/team/1/repos"
+ ]
+ },
+ "slug": {
+ "type": "string",
+ "examples": [
+ "justice-league"
+ ]
+ },
+ "ldap_dn": {
+ "description": "Distinguished Name (DN) that team maps to within LDAP environment",
+ "type": "string",
+ "examples": [
+ "uid=example,ou=users,dc=github,dc=com"
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug"
+ ]
+ }
+ ]
+ }
+ },
+ "required": [
+ "id",
+ "node_id",
+ "url",
+ "members_url",
+ "name",
+ "description",
+ "permission",
+ "html_url",
+ "repositories_url",
+ "slug",
+ "parent"
+ ]
+ }
+ },
+ "private_fork": {
+ "readOnly": true,
+ "description": "A temporary private fork of the advisory's repository for collaborating on a fix.",
+ "allOf": [
+ {
+ "title": "Simple Repository",
+ "description": "A GitHub repository.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "A unique identifier of the repository.",
+ "examples": [
+ 1296269
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "description": "The GraphQL identifier of the repository.",
+ "examples": [
+ "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the repository.",
+ "examples": [
+ "Hello-World"
+ ]
+ },
+ "full_name": {
+ "type": "string",
+ "description": "The full, globally unique, name of the repository.",
+ "examples": [
+ "octocat/Hello-World"
+ ]
+ },
+ "owner": {
+ "title": "Simple User",
+ "description": "A GitHub user.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "email": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "login": {
+ "type": "string",
+ "examples": [
+ "octocat"
+ ]
+ },
+ "id": {
+ "type": "integer",
+ "examples": [
+ 1
+ ]
+ },
+ "node_id": {
+ "type": "string",
+ "examples": [
+ "MDQ6VXNlcjE="
+ ]
+ },
+ "avatar_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/images/error/octocat_happy.gif"
+ ]
+ },
+ "gravatar_id": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "examples": [
+ "41d064eb2195891e12d0413f63227ea7"
+ ]
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octocat"
+ ]
+ },
+ "followers_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/followers"
+ ]
+ },
+ "following_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/following{/other_user}"
+ ]
+ },
+ "gists_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/gists{/gist_id}"
+ ]
+ },
+ "starred_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+ ]
+ },
+ "subscriptions_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/subscriptions"
+ ]
+ },
+ "organizations_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/orgs"
+ ]
+ },
+ "repos_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/repos"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "examples": [
+ "https://api.github.com/users/octocat/events{/privacy}"
+ ]
+ },
+ "received_events_url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/users/octocat/received_events"
+ ]
+ },
+ "type": {
+ "type": "string",
+ "examples": [
+ "User"
+ ]
+ },
+ "site_admin": {
+ "type": "boolean"
+ },
+ "starred_at": {
+ "type": "string",
+ "examples": [
+ "\"2020-07-09T00:17:55Z\""
+ ]
+ }
+ },
+ "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": {
+ "type": "boolean",
+ "description": "Whether the repository is private."
+ },
+ "html_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The URL to view the repository on GitHub.com.",
+ "examples": [
+ "https://github.com/octocat/Hello-World"
+ ]
+ },
+ "description": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The repository description.",
+ "examples": [
+ "This your first repo!"
+ ]
+ },
+ "fork": {
+ "type": "boolean",
+ "description": "Whether the repository is a fork."
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The URL to get more information about the repository from the GitHub API.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World"
+ ]
+ },
+ "archive_url": {
+ "type": "string",
+ "description": "A template for the API URL to download the repository as an archive.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
+ ]
+ },
+ "assignees_url": {
+ "type": "string",
+ "description": "A template for the API URL to list the available assignees for issues in the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/assignees{/user}"
+ ]
+ },
+ "blobs_url": {
+ "type": "string",
+ "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
+ ]
+ },
+ "branches_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about branches in the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/branches{/branch}"
+ ]
+ },
+ "collaborators_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about collaborators of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
+ ]
+ },
+ "comments_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about comments on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/comments{/number}"
+ ]
+ },
+ "commits_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about commits on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/commits{/sha}"
+ ]
+ },
+ "compare_url": {
+ "type": "string",
+ "description": "A template for the API URL to compare two commits or refs.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
+ ]
+ },
+ "contents_url": {
+ "type": "string",
+ "description": "A template for the API URL to get the contents of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/contents/{+path}"
+ ]
+ },
+ "contributors_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "A template for the API URL to list the contributors to the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/contributors"
+ ]
+ },
+ "deployments_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the deployments of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/deployments"
+ ]
+ },
+ "downloads_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the downloads on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/downloads"
+ ]
+ },
+ "events_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the events of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/events"
+ ]
+ },
+ "forks_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the forks of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/forks"
+ ]
+ },
+ "git_commits_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about Git commits of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
+ ]
+ },
+ "git_refs_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about Git refs of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
+ ]
+ },
+ "git_tags_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about Git tags of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
+ ]
+ },
+ "issue_comment_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about issue comments on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
+ ]
+ },
+ "issue_events_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about issue events on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
+ ]
+ },
+ "issues_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about issues on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/issues{/number}"
+ ]
+ },
+ "keys_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about deploy keys on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
+ ]
+ },
+ "labels_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about labels of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/labels{/name}"
+ ]
+ },
+ "languages_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to get information about the languages of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/languages"
+ ]
+ },
+ "merges_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to merge branches in the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/merges"
+ ]
+ },
+ "milestones_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about milestones of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/milestones{/number}"
+ ]
+ },
+ "notifications_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about notifications on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
+ ]
+ },
+ "pulls_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about pull requests on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/pulls{/number}"
+ ]
+ },
+ "releases_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about releases on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/releases{/id}"
+ ]
+ },
+ "stargazers_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the stargazers on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/stargazers"
+ ]
+ },
+ "statuses_url": {
+ "type": "string",
+ "description": "A template for the API URL to get information about statuses of a commit.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
+ ]
+ },
+ "subscribers_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the subscribers on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/subscribers"
+ ]
+ },
+ "subscription_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to subscribe to notifications for this repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/subscription"
+ ]
+ },
+ "tags_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to get information about tags on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/tags"
+ ]
+ },
+ "teams_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the teams on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/teams"
+ ]
+ },
+ "trees_url": {
+ "type": "string",
+ "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
+ ]
+ },
+ "hooks_url": {
+ "type": "string",
+ "format": "uri",
+ "description": "The API URL to list the hooks on the repository.",
+ "examples": [
+ "https://api.github.com/repos/octocat/Hello-World/hooks"
+ ]
+ }
+ },
+ "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"
+ ]
+ }
+ ],
+ "type": [
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "ghsa_id",
+ "cve_id",
+ "url",
+ "html_url",
+ "summary",
+ "description",
+ "severity",
+ "author",
+ "publisher",
+ "identifiers",
+ "state",
+ "created_at",
+ "updated_at",
+ "published_at",
+ "closed_at",
+ "withdrawn_at",
+ "submission",
+ "vulnerabilities",
+ "cvss",
+ "cwes",
+ "cwe_ids",
+ "credits",
+ "credits_detailed",
+ "collaborating_users",
+ "collaborating_teams",
+ "private_fork"
+ ],
+ "additionalProperties": false
+ }
+ }
+ }
+ }
+ ],
+ "previews": [],
+ "descriptionHTML": "<p>Lists repository security advisories for an organization.</p>\n<p>To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the <code>repo</code> scope or <code>repository_advisories:write</code> permission.</p>",
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "<p>OK</p>"
+ },
+ {
+ "httpStatusCode": "400",
+ "description": "<p>Bad Request</p>"
+ },
+ {
+ "httpStatusCode": "404",
+ "description": "<p>Resource not found</p>"
+ }
+ ]
+ },
{
"serverUrl": "https://api.github.com",
"verb": "get",
@@ -548985,7 +551471,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
+ "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -549074,7 +551560,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -549147,7 +551633,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -564755,7 +567241,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Cloud plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Cloud plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Cloud <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/users#emails\">Emails API</a>\".</p>",
+ "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Cloud plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Cloud plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Cloud <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/users/emails\">Emails API</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -569909,7 +572395,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
+ "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -570054,7 +572540,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
+ "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -571037,7 +573523,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -571660,7 +574146,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/repos#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -571713,7 +574199,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -572035,7 +574521,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/repos#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json
index f899d73768e1..81ecc359b3ad 100644
--- a/src/rest/data/ghes-3.10-2022-11-28/schema.json
+++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json
@@ -99675,7 +99675,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/apps/#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -108392,7 +108392,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -137356,7 +137356,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -141198,7 +141198,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. See the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/checks#actions-object\"><code>actions</code> object</a> description. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -148933,7 +148933,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/checks#check-runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/checks/runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -159946,7 +159946,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the <code>security_events</code> scope to use this endpoint for private repositories. You can also use tokens with the <code>public_repo</code> scope for public repositories only. GitHub Apps must have the <code>security_events</code> write permission to use this endpoint.</p>\n<p>There are two places where you can upload code scanning results.</p>\n<ul>\n<li>If you upload to a pull request, for example <code>--ref refs/pull/42/merge</code> or <code>--ref refs/pull/42/head</code>, then the results appear as alerts in a pull request check. For more information, see \"<a href=\"/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests\">Triaging code scanning alerts in pull requests</a>.\"</li>\n<li>If you upload to a branch, for example <code>--ref refs/heads/my-branch</code>, then the results appear in the <strong>Security</strong> tab for your repository. For more information, see \"<a href=\"/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository\">Managing code scanning alerts for your repository</a>.\"</li>\n</ul>\n<p>You must compress the SARIF-formatted analysis data that you want to upload, using <code>gzip</code>, and then encode it as a Base64 format string. For example:</p>\n<pre><code>gzip -c analysis-data.sarif | base64 -w0\n</code></pre>\n<br>\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\"><strong>SARIF data</strong></th><th align=\"center\" scope=\"col\"><strong>Maximum values</strong></th><th scope=\"col\"><strong>Additional limits</strong></th></tr></thead><tbody><tr><td>Runs per file</td><td align=\"center\">20</td><td></td></tr><tr><td>Results per run</td><td align=\"center\">25,000</td><td>Only the top 5,000 results will be included, prioritized by severity.</td></tr><tr><td>Rules per run</td><td align=\"center\">25,000</td><td></td></tr><tr><td>Tool extensions per run</td><td align=\"center\">100</td><td></td></tr><tr><td>Thread Flow Locations per result</td><td align=\"center\">10,000</td><td>Only the top 1,000 Thread Flow Locations will be included, using prioritization.</td></tr><tr><td>Location per result</td><td align=\"center\">1,000</td><td>Only 100 locations will be included.</td></tr><tr><td>Tags per rule</td><td align=\"center\">20</td><td>Only 10 tags will be included.</td></tr></tbody></table>\n<p>The <code>202 Accepted</code> response includes an <code>id</code> value.\nYou can use this ID to check the status of the upload by using it in the <code>/sarifs/{sarif_id}</code> endpoint.\nFor more information, see \"<a href=\"/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload\">Get information about a SARIF upload</a>.\"</p>",
+ "descriptionHTML": "<p>Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the <code>security_events</code> scope to use this endpoint for private repositories. You can also use tokens with the <code>public_repo</code> scope for public repositories only. GitHub Apps must have the <code>security_events</code> write permission to use this endpoint. For troubleshooting information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/troubleshooting-sarif\">Troubleshooting SARIF uploads</a>.\"</p>\n<p>There are two places where you can upload code scanning results.</p>\n<ul>\n<li>If you upload to a pull request, for example <code>--ref refs/pull/42/merge</code> or <code>--ref refs/pull/42/head</code>, then the results appear as alerts in a pull request check. For more information, see \"<a href=\"/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests\">Triaging code scanning alerts in pull requests</a>.\"</li>\n<li>If you upload to a branch, for example <code>--ref refs/heads/my-branch</code>, then the results appear in the <strong>Security</strong> tab for your repository. For more information, see \"<a href=\"/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository\">Managing code scanning alerts for your repository</a>.\"</li>\n</ul>\n<p>You must compress the SARIF-formatted analysis data that you want to upload, using <code>gzip</code>, and then encode it as a Base64 format string. For example:</p>\n<pre><code>gzip -c analysis-data.sarif | base64 -w0\n</code></pre>\n<br>\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\"><strong>SARIF data</strong></th><th align=\"center\" scope=\"col\"><strong>Maximum values</strong></th><th scope=\"col\"><strong>Additional limits</strong></th></tr></thead><tbody><tr><td>Runs per file</td><td align=\"center\">20</td><td></td></tr><tr><td>Results per run</td><td align=\"center\">25,000</td><td>Only the top 5,000 results will be included, prioritized by severity.</td></tr><tr><td>Rules per run</td><td align=\"center\">25,000</td><td></td></tr><tr><td>Tool extensions per run</td><td align=\"center\">100</td><td></td></tr><tr><td>Thread Flow Locations per result</td><td align=\"center\">10,000</td><td>Only the top 1,000 Thread Flow Locations will be included, using prioritization.</td></tr><tr><td>Location per result</td><td align=\"center\">1,000</td><td>Only 100 locations will be included.</td></tr><tr><td>Tags per rule</td><td align=\"center\">20</td><td>Only 10 tags will be included.</td></tr></tbody></table>\n<p>The <code>202 Accepted</code> response includes an <code>id</code> value.\nYou can use this ID to check the status of the upload by using it in the <code>/sarifs/{sarif_id}</code> endpoint.\nFor more information, see \"<a href=\"/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload\">Get information about a SARIF upload</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -162093,7 +162093,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/collaborators/invitations\">API</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -177499,7 +177499,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#custom-media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
+ "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -196316,7 +196316,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/reference/actions#secrets\">Secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
+ "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/actions/secrets\">GitHub Actions secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -201699,6 +201699,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_commit_comments": 5000,
+ "total_gist_comments": 400,
+ "total_issue_comments": 10900,
+ "total_pull_request_comments": 9900
+ },
"schema": {
"title": "Enterprise Comment Stats",
"type": "object",
@@ -201756,6 +201762,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_gists": 500,
+ "private_gists": 30,
+ "public_gists": 470
+ },
"schema": {
"title": "Enterprise Gist Stats",
"type": "object",
@@ -201809,6 +201820,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_hooks": 50,
+ "active_hooks": 47,
+ "inactive_hooks": 3
+ },
"schema": {
"title": "Hooks Enterprise Stats",
"type": "object",
@@ -201862,6 +201878,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_issues": 5000,
+ "open_issues": 300,
+ "closed_issues": 4700
+ },
"schema": {
"title": "Enterprise Issue Stats",
"type": "object",
@@ -201915,6 +201936,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_milestones": 90,
+ "open_milestones": 10,
+ "closed_milestones": 80
+ },
"schema": {
"title": "Enterprise Milestone Stats",
"type": "object",
@@ -201968,6 +201994,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_orgs": 50,
+ "disabled_orgs": 1,
+ "total_teams": 70,
+ "total_team_members": 700
+ },
"schema": {
"title": "Enterprise Organization Stats",
"type": "object",
@@ -202025,6 +202057,9 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_pages": 20
+ },
"schema": {
"title": "Enterprise Pages Stats",
"type": "object",
@@ -202070,6 +202105,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_pulls": 1200,
+ "merged_pulls": 1100,
+ "mergeable_pulls": 90,
+ "unmergeable_pulls": 10
+ },
"schema": {
"title": "Enterprise Pull Request Stats",
"type": "object",
@@ -202127,6 +202168,14 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_repos": 200,
+ "root_repos": 1,
+ "fork_repos": 10,
+ "org_repos": 150,
+ "total_pushes": 39000,
+ "total_wikis": 5
+ },
"schema": {
"title": "Repository Enterprise Stats",
"type": "object",
@@ -202293,6 +202342,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_users": 100,
+ "admin_users": 3,
+ "suspended_users": 1
+ },
"schema": {
"title": "Enterprise User Stats",
"type": "object",
@@ -204182,7 +204236,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>",
+ "descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -233619,10 +233673,10 @@
},
{
"name": "ref",
- "description": "<p>The name of the fully qualified reference to update. For example, <code>refs/heads/master</code>. If the value doesn't start with <code>refs</code> and have at least two slashes, it will be rejected.</p>",
+ "description": "<p>The name of the reference to update (for example, <code>heads/featureA</code>). Can be a branch name (<code>heads/BRANCH_NAME</code>) or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
- "example": "refs/head/master",
+ "example": "heads/featureA",
"schema": {
"type": "string"
},
@@ -310036,8 +310090,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Lists the most commonly used licenses on GitHub. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -310232,8 +310286,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Gets information about a specific license. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -311082,7 +311136,7 @@
},
"response": {
"statusCode": "200",
- "contentType": "text/plain",
+ "contentType": "application/json",
"description": "<p>Example response</p>",
"example": "Responsive is better than fast",
"schema": {
@@ -324426,7 +324480,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -324741,7 +324795,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -324798,7 +324852,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -325690,7 +325744,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -326589,7 +326643,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates OAuth tokens using <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use <code>fingerprint</code> to differentiate between them.</p>\n<p>You can also create tokens on GitHub Enterprise Server from the <a href=\"https://github.com/settings/tokens\">personal access tokens settings</a> page. Read more about these tokens in <a href=\"https://docs.github.com/enterprise-server@3.10/articles/creating-an-access-token-for-command-line-use\">the GitHub Help documentation</a>.</p>\n<p>Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in <a href=\"https://docs.github.com/enterprise-server@3.10/articles/about-identity-and-access-management-with-saml-single-sign-on\">the GitHub Help documentation</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates OAuth tokens using <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use <code>fingerprint</code> to differentiate between them.</p>\n<p>You can also create tokens on GitHub Enterprise Server from the <a href=\"https://github.com/settings/tokens\">personal access tokens settings</a> page. Read more about these tokens in <a href=\"https://docs.github.com/enterprise-server@3.10/articles/creating-an-access-token-for-command-line-use\">the GitHub Help documentation</a>.</p>\n<p>Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in <a href=\"https://docs.github.com/enterprise-server@3.10/articles/about-identity-and-access-management-with-saml-single-sign-on\">the GitHub Help documentation</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -327523,7 +327577,7 @@
"response": {
"statusCode": "201",
"contentType": "application/json",
- "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"example": {
"id": 1,
"url": "https://api.github.com/authorizations/1",
@@ -328331,7 +328385,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -328339,7 +328393,7 @@
},
{
"httpStatusCode": "201",
- "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>"
+ "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>"
},
{
"httpStatusCode": "304",
@@ -330078,7 +330132,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. <code>fingerprint</code> is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. <code>fingerprint</code> is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -330935,7 +330989,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -331843,7 +331897,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -331892,7 +331946,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -344468,7 +344522,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/orgs#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -344927,7 +344981,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/orgs#update-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -381431,7 +381485,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/pulls#update-a-pull-request\">edit</a> a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
+ "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#update-a-pull-request\">edit</a> a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -386164,7 +386218,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#list-commits\">List commits</a> endpoint.</p>",
+ "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/commits/commits#list-commits\">List commits</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -386638,7 +386692,7 @@
"type": "string",
"name": "expected_head_sha",
"in": "body",
- "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
+ "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/commits/commits#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
}
],
"enabledForGitHubApps": false,
@@ -403198,7 +403252,7 @@
"type": "string",
"name": "event",
"in": "body",
- "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
+ "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -403620,7 +403674,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -405955,7 +406009,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#branches\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -406398,7 +406452,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
+ "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -406447,40 +406501,70 @@
"resources": {
"core": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1691591363
},
"search": {
"limit": 30,
+ "used": 12,
"remaining": 18,
- "reset": 1372697452,
- "used": 12
+ "reset": 1691591091
},
"graphql": {
"limit": 5000,
+ "used": 7,
"remaining": 4993,
- "reset": 1372700389,
- "used": 7
+ "reset": 1691593228
},
"integration_manifest": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "source_import": {
+ "limit": 100,
+ "used": 1,
+ "remaining": 99,
+ "reset": 1691591091
},
"code_scanning_upload": {
"limit": 500,
+ "used": 1,
"remaining": 499,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "actions_runner_registration": {
+ "limit": 10000,
+ "used": 0,
+ "remaining": 10000,
+ "reset": 1691594631
+ },
+ "scim": {
+ "limit": 15000,
+ "used": 0,
+ "remaining": 15000,
+ "reset": 1691594631
+ },
+ "dependency_snapshots": {
+ "limit": 100,
+ "used": 0,
+ "remaining": 100,
+ "reset": 1691591091
+ },
+ "code_search": {
+ "limit": 10,
+ "used": 0,
+ "remaining": 10,
+ "reset": 1691591091
}
},
"rate": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1372700873
}
},
"schema": {
@@ -406747,7 +406831,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p>Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under <code>resources</code>, you'll see objects relating to different categories:</p>\n<ul>\n<li>The <code>core</code> object provides your rate limit status for all non-search-related resources in the REST API.</li>\n<li>The <code>search</code> object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/search\">Search</a>.\"</li>\n<li>The <code>code_search</code> object provides your rate limit status for the REST API for searching code. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#search-code\">Search code</a>.\"</li>\n<li>The <code>graphql</code> object provides your rate limit status for the GraphQL API. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/graphql/overview/resource-limitations#rate-limit\">Resource limitations</a>.\"</li>\n<li>The <code>integration_manifest</code> object provides your rate limit status for the <code>POST /app-manifests/{code}/conversions</code> operation. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration\">Creating a GitHub App from a manifest</a>.\"</li>\n<li>The <code>dependency_snapshots</code> object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>code_scanning_upload</code> object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github\">Uploading a SARIF file to GitHub</a>.\"</li>\n<li>The <code>actions_runner_registration</code> object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners\">Self-hosted runners</a>.\"</li>\n<li>The <code>source_import</code> object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/api-versions\">API Versions</a>.\"</li>\n</ul>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -406813,7 +406897,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -407121,7 +407205,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams#discussion-comments/\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -407179,7 +407263,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -407729,7 +407813,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -407818,7 +407902,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -407863,7 +407947,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -408170,7 +408254,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -408219,7 +408303,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -408767,7 +408851,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -408846,7 +408930,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -408891,7 +408975,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -409198,7 +409282,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -409251,7 +409335,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a> to add to the commit comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the commit comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -409799,7 +409883,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#comments\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -409882,7 +409966,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -409927,7 +410011,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -410234,7 +410318,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -410287,7 +410371,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -410835,7 +410919,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues#comments\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -410918,7 +411002,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -410963,7 +411047,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
"in": "query",
"required": false,
"schema": {
@@ -411270,7 +411354,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -411327,7 +411411,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -411875,7 +411959,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues/\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -411958,7 +412042,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues/\">issue</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -412003,7 +412087,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -412310,7 +412394,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -412363,7 +412447,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a> to add to the pull request review comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the pull request review comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -412911,7 +412995,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/pulls#comments\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -412994,7 +413078,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -413039,7 +413123,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
"in": "query",
"required": false,
"schema": {
@@ -413344,7 +413428,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -413397,7 +413481,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a> to add to the release.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the release.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -413943,7 +414027,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#releases\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -414026,7 +414110,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -414071,7 +414155,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -414378,7 +414462,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -414427,7 +414511,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -414710,7 +414794,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -414746,7 +414830,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -415052,7 +415136,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -415092,7 +415176,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -415374,7 +415458,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -417006,7 +417090,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#releases\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
+ "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -421509,7 +421593,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
+ "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -437009,7 +437093,7 @@
}
],
"previews": [
- "<p>You can set the visibility of a repository using the new <code>visibility</code> parameter in the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos/\">Repositories API</a>, and get a repository's visibility with a new response key. For more information, see the <a href=\"https://developer.github.com/changes/2019-12-03-internal-visibility-changes/\">blog post</a>.</p>\n<p>To access repository visibility during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.nebula-preview+json\n</code></pre>",
+ "<p>You can set the visibility of a repository using the new <code>visibility</code> parameter in the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/repos\">Repositories API</a>, and get a repository's visibility with a new response key. For more information, see the <a href=\"https://developer.github.com/changes/2019-12-03-internal-visibility-changes/\">blog post</a>.</p>\n<p>To access repository visibility during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.nebula-preview+json\n</code></pre>",
"<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json\n</code></pre>"
]
},
@@ -449745,7 +449829,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.10/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
+ "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.10/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -450359,7 +450443,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos/#delete-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#delete-a-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -450704,7 +450788,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -450913,7 +450997,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -451125,7 +451209,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -458947,7 +459031,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -458956,7 +459040,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -460026,7 +460110,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>",
+ "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -460060,7 +460144,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -460069,7 +460153,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -461501,7 +461585,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
+ "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -461523,7 +461607,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -461532,7 +461616,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -464649,7 +464733,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
+ "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -464692,7 +464776,7 @@
},
{
"name": "q",
- "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -464701,7 +464785,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -464893,7 +464977,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -464927,7 +465011,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -464936,7 +465020,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -465803,7 +465887,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -465833,7 +465917,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -466159,7 +466243,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -466181,7 +466265,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -466190,7 +466274,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub Enterprise Server. Default: <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub Enterprise Server. Default: <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -466505,7 +466589,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
+ "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -486657,7 +486741,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
+ "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -486746,7 +486830,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -486819,7 +486903,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -500925,7 +501009,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Server <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/users#emails\">Emails API</a>\".</p>",
+ "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Server <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/users/emails\">Emails API</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -505515,7 +505599,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
+ "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -505660,7 +505744,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
+ "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -506643,7 +506727,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -507266,7 +507350,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/repos#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -507319,7 +507403,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -507641,7 +507725,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/repos#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
diff --git a/src/rest/data/ghes-3.6/schema.json b/src/rest/data/ghes-3.6/schema.json
index f01b572c31fe..55a1c7175dbd 100644
--- a/src/rest/data/ghes-3.6/schema.json
+++ b/src/rest/data/ghes-3.6/schema.json
@@ -93651,7 +93651,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/apps/#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -102236,7 +102236,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -130707,7 +130707,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -134549,7 +134549,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. See the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/checks#actions-object\"><code>actions</code> object</a> description. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -142162,7 +142162,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/checks#check-runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/checks/runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -153335,7 +153335,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.6/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.6/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/collaborators/invitations\">API</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -168531,7 +168531,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
+ "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -180139,7 +180139,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/reference/actions#secrets\">Secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
+ "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/actions/secrets\">GitHub Actions secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -184775,6 +184775,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_commit_comments": 5000,
+ "total_gist_comments": 400,
+ "total_issue_comments": 10900,
+ "total_pull_request_comments": 9900
+ },
"schema": {
"title": "Enterprise Comment Stats",
"type": "object",
@@ -184832,6 +184838,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_gists": 500,
+ "private_gists": 30,
+ "public_gists": 470
+ },
"schema": {
"title": "Enterprise Gist Stats",
"type": "object",
@@ -184885,6 +184896,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_hooks": 50,
+ "active_hooks": 47,
+ "inactive_hooks": 3
+ },
"schema": {
"title": "Hooks Enterprise Stats",
"type": "object",
@@ -184938,6 +184954,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_issues": 5000,
+ "open_issues": 300,
+ "closed_issues": 4700
+ },
"schema": {
"title": "Enterprise Issue Stats",
"type": "object",
@@ -184991,6 +185012,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_milestones": 90,
+ "open_milestones": 10,
+ "closed_milestones": 80
+ },
"schema": {
"title": "Enterprise Milestone Stats",
"type": "object",
@@ -185044,6 +185070,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_orgs": 50,
+ "disabled_orgs": 1,
+ "total_teams": 70,
+ "total_team_members": 700
+ },
"schema": {
"title": "Enterprise Organization Stats",
"type": "object",
@@ -185101,6 +185133,9 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_pages": 20
+ },
"schema": {
"title": "Enterprise Pages Stats",
"type": "object",
@@ -185146,6 +185181,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_pulls": 1200,
+ "merged_pulls": 1100,
+ "mergeable_pulls": 90,
+ "unmergeable_pulls": 10
+ },
"schema": {
"title": "Enterprise Pull Request Stats",
"type": "object",
@@ -185203,6 +185244,14 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_repos": 200,
+ "root_repos": 1,
+ "fork_repos": 10,
+ "org_repos": 150,
+ "total_pushes": 39000,
+ "total_wikis": 5
+ },
"schema": {
"title": "Repository Enterprise Stats",
"type": "object",
@@ -185268,6 +185317,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_users": 100,
+ "admin_users": 3,
+ "suspended_users": 1
+ },
"schema": {
"title": "Enterprise User Stats",
"type": "object",
@@ -186870,7 +186924,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.6/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>",
+ "descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.6/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -215551,10 +215605,10 @@
},
{
"name": "ref",
- "description": "<p>The name of the fully qualified reference to update. For example, <code>refs/heads/master</code>. If the value doesn't start with <code>refs</code> and have at least two slashes, it will be rejected.</p>",
+ "description": "<p>The name of the reference to update (for example, <code>heads/featureA</code>). Can be a branch name (<code>heads/BRANCH_NAME</code>) or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
- "example": "refs/head/master",
+ "example": "heads/featureA",
"schema": {
"type": "string"
},
@@ -291812,8 +291866,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Lists the most commonly used licenses on GitHub. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -292008,8 +292062,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Gets information about a specific license. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -292858,7 +292912,7 @@
},
"response": {
"statusCode": "200",
- "contentType": "text/plain",
+ "contentType": "application/json",
"description": "<p>Example response</p>",
"example": "Responsive is better than fast",
"schema": {
@@ -306018,7 +306072,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -306333,7 +306387,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -306390,7 +306444,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -307266,7 +307320,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -308149,7 +308203,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates OAuth tokens using <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use <code>fingerprint</code> to differentiate between them.</p>\n<p>You can also create tokens on GitHub Enterprise Server from the <a href=\"https://github.com/settings/tokens\">personal access tokens settings</a> page. Read more about these tokens in <a href=\"https://docs.github.com/enterprise-server@3.6/articles/creating-an-access-token-for-command-line-use\">the GitHub Help documentation</a>.</p>\n<p>Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in <a href=\"https://docs.github.com/enterprise-server@3.6/articles/about-identity-and-access-management-with-saml-single-sign-on\">the GitHub Help documentation</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates OAuth tokens using <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use <code>fingerprint</code> to differentiate between them.</p>\n<p>You can also create tokens on GitHub Enterprise Server from the <a href=\"https://github.com/settings/tokens\">personal access tokens settings</a> page. Read more about these tokens in <a href=\"https://docs.github.com/enterprise-server@3.6/articles/creating-an-access-token-for-command-line-use\">the GitHub Help documentation</a>.</p>\n<p>Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in <a href=\"https://docs.github.com/enterprise-server@3.6/articles/about-identity-and-access-management-with-saml-single-sign-on\">the GitHub Help documentation</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -309067,7 +309121,7 @@
"response": {
"statusCode": "201",
"contentType": "application/json",
- "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"example": {
"id": 1,
"url": "https://api.github.com/authorizations/1",
@@ -309859,7 +309913,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -309867,7 +309921,7 @@
},
{
"httpStatusCode": "201",
- "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>"
+ "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>"
},
{
"httpStatusCode": "304",
@@ -311574,7 +311628,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. <code>fingerprint</code> is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. <code>fingerprint</code> is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -312415,7 +312469,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -313307,7 +313361,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -313356,7 +313410,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -320314,7 +320368,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -320773,7 +320827,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#update-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -343675,7 +343729,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#update-a-pull-request\">edit</a> a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/enterprise-server@3.6/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/enterprise-server@3.6/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/enterprise-server@3.6/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
+ "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls/pulls#update-a-pull-request\">edit</a> a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/enterprise-server@3.6/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/enterprise-server@3.6/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/enterprise-server@3.6/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -348399,7 +348453,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-commits\">List commits</a> endpoint.</p>",
+ "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/commits/commits#list-commits\">List commits</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -348873,7 +348927,7 @@
"type": "string",
"name": "expected_head_sha",
"in": "body",
- "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
+ "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/commits/commits#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
}
],
"enabledForGitHubApps": false,
@@ -365352,7 +365406,7 @@
"type": "string",
"name": "event",
"in": "body",
- "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
+ "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls/reviews#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -365774,7 +365828,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.6/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.6/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls/reviews#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -368109,7 +368163,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#branches\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -368552,7 +368606,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
+ "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls/reviews#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -368601,40 +368655,70 @@
"resources": {
"core": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1691591363
},
"search": {
"limit": 30,
+ "used": 12,
"remaining": 18,
- "reset": 1372697452,
- "used": 12
+ "reset": 1691591091
},
"graphql": {
"limit": 5000,
+ "used": 7,
"remaining": 4993,
- "reset": 1372700389,
- "used": 7
+ "reset": 1691593228
},
"integration_manifest": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "source_import": {
+ "limit": 100,
+ "used": 1,
+ "remaining": 99,
+ "reset": 1691591091
},
"code_scanning_upload": {
"limit": 500,
+ "used": 1,
"remaining": 499,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "actions_runner_registration": {
+ "limit": 10000,
+ "used": 0,
+ "remaining": 10000,
+ "reset": 1691594631
+ },
+ "scim": {
+ "limit": 15000,
+ "used": 0,
+ "remaining": 15000,
+ "reset": 1691594631
+ },
+ "dependency_snapshots": {
+ "limit": 100,
+ "used": 0,
+ "remaining": 100,
+ "reset": 1691591091
+ },
+ "code_search": {
+ "limit": 10,
+ "used": 0,
+ "remaining": 10,
+ "reset": 1691591091
}
},
"rate": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1372700873
}
},
"schema": {
@@ -368901,7 +368985,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p>Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under <code>resources</code>, you'll see objects relating to different categories:</p>\n<ul>\n<li>The <code>core</code> object provides your rate limit status for all non-search-related resources in the REST API.</li>\n<li>The <code>search</code> object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/search\">Search</a>.\"</li>\n<li>The <code>code_search</code> object provides your rate limit status for the REST API for searching code. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#search-code\">Search code</a>.\"</li>\n<li>The <code>graphql</code> object provides your rate limit status for the GraphQL API. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/graphql/overview/resource-limitations#rate-limit\">Resource limitations</a>.\"</li>\n<li>The <code>integration_manifest</code> object provides your rate limit status for the <code>POST /app-manifests/{code}/conversions</code> operation. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration\">Creating a GitHub App from a manifest</a>.\"</li>\n<li>The <code>dependency_snapshots</code> object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>code_scanning_upload</code> object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github\">Uploading a SARIF file to GitHub</a>.\"</li>\n<li>The <code>actions_runner_registration</code> object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/actions/self-hosted-runners\">Self-hosted runners</a>.\"</li>\n<li>The <code>source_import</code> object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/api-versions\">API Versions</a>.\"</li>\n</ul>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -368967,7 +369051,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -369275,7 +369359,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams#discussion-comments/\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -369333,7 +369417,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -369883,7 +369967,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -369972,7 +370056,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -370017,7 +370101,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -370324,7 +370408,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -370373,7 +370457,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -370921,7 +371005,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -371000,7 +371084,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -371045,7 +371129,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -371352,7 +371436,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -371405,7 +371489,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a> to add to the commit comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the commit comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -371953,7 +372037,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#comments\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/commits/comments#get-a-commit-comment\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -372036,7 +372120,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -372081,7 +372165,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -372388,7 +372472,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.6/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -372441,7 +372525,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -372989,7 +373073,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/issues#comments\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.6/rest/issues/comments#get-an-issue-comment\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -373072,7 +373156,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.6/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -373117,7 +373201,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
"in": "query",
"required": false,
"schema": {
@@ -373424,7 +373508,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/issues\">issue</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.6/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -373481,7 +373565,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -374029,7 +374113,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/issues/\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.6/rest/issues/issues#get-an-issue\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -374112,7 +374196,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/issues/\">issue</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.6/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -374157,7 +374241,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -374464,7 +374548,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -374517,7 +374601,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a> to add to the pull request review comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the pull request review comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -375065,7 +375149,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#comments\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -375148,7 +375232,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -375193,7 +375277,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
"in": "query",
"required": false,
"schema": {
@@ -375498,7 +375582,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -375551,7 +375635,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a> to add to the release.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the release.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -376097,7 +376181,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#releases\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/releases#get-a-release\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -376180,7 +376264,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -376225,7 +376309,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -376532,7 +376616,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -376581,7 +376665,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -376864,7 +376948,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -376900,7 +376984,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -377206,7 +377290,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -377246,7 +377330,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -377528,7 +377612,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -379148,7 +379232,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#releases\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
+ "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/releases#get-a-release\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -383639,7 +383723,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
+ "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -398971,7 +399055,7 @@
}
],
"previews": [
- "<p>You can set the visibility of a repository using the new <code>visibility</code> parameter in the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos/\">Repositories API</a>, and get a repository's visibility with a new response key. For more information, see the <a href=\"https://developer.github.com/changes/2019-12-03-internal-visibility-changes/\">blog post</a>.</p>\n<p>To access repository visibility during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.nebula-preview+json\n</code></pre>",
+ "<p>You can set the visibility of a repository using the new <code>visibility</code> parameter in the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/repos\">Repositories API</a>, and get a repository's visibility with a new response key. For more information, see the <a href=\"https://developer.github.com/changes/2019-12-03-internal-visibility-changes/\">blog post</a>.</p>\n<p>To access repository visibility during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.nebula-preview+json\n</code></pre>",
"<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@3.6/rest/repos/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json\n</code></pre>"
]
},
@@ -411186,7 +411270,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.6/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
+ "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.6/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.6/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -411800,7 +411884,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos/#delete-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/repos/contents/#delete-a-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -412145,7 +412229,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/repos/contents/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -412354,7 +412438,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -412566,7 +412650,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -420271,7 +420355,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -420280,7 +420364,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -421289,7 +421373,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>",
+ "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -421323,7 +421407,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -421332,7 +421416,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -422703,7 +422787,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
+ "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -422725,7 +422809,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -422734,7 +422818,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -425843,7 +425927,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
+ "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -425886,7 +425970,7 @@
},
{
"name": "q",
- "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -425895,7 +425979,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -426087,7 +426171,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -426121,7 +426205,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -426130,7 +426214,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -426994,7 +427078,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -427024,7 +427108,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -427350,7 +427434,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -427372,7 +427456,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -427381,7 +427465,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub Enterprise Server. Default: <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub Enterprise Server. Default: <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -427696,7 +427780,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
+ "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -447357,7 +447441,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
+ "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -447446,7 +447530,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -447519,7 +447603,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.6/rest/teams/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -461596,7 +461680,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Server <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/users#emails\">Emails API</a>\".</p>",
+ "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Server <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/users/emails\">Emails API</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -465336,7 +465420,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
+ "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -465481,7 +465565,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
+ "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -466464,7 +466548,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -467087,7 +467171,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/repos#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -467140,7 +467224,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -467462,7 +467546,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/repos#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
diff --git a/src/rest/data/ghes-3.7/schema.json b/src/rest/data/ghes-3.7/schema.json
index a0da2be63c20..8ae8fbab251f 100644
--- a/src/rest/data/ghes-3.7/schema.json
+++ b/src/rest/data/ghes-3.7/schema.json
@@ -94598,7 +94598,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/apps/#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -103199,7 +103199,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -131678,7 +131678,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/enterprise-server@3.7/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/enterprise-server@3.7/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -135520,7 +135520,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. See the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/checks#actions-object\"><code>actions</code> object</a> description. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -143139,7 +143139,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/checks#check-runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/checks/runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -155756,7 +155756,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.7/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.7/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/collaborators/invitations\">API</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -170977,7 +170977,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#custom-media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
+ "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -182948,7 +182948,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/reference/actions#secrets\">Secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
+ "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/actions/secrets\">GitHub Actions secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -187584,6 +187584,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_commit_comments": 5000,
+ "total_gist_comments": 400,
+ "total_issue_comments": 10900,
+ "total_pull_request_comments": 9900
+ },
"schema": {
"title": "Enterprise Comment Stats",
"type": "object",
@@ -187641,6 +187647,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_gists": 500,
+ "private_gists": 30,
+ "public_gists": 470
+ },
"schema": {
"title": "Enterprise Gist Stats",
"type": "object",
@@ -187694,6 +187705,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_hooks": 50,
+ "active_hooks": 47,
+ "inactive_hooks": 3
+ },
"schema": {
"title": "Hooks Enterprise Stats",
"type": "object",
@@ -187747,6 +187763,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_issues": 5000,
+ "open_issues": 300,
+ "closed_issues": 4700
+ },
"schema": {
"title": "Enterprise Issue Stats",
"type": "object",
@@ -187800,6 +187821,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_milestones": 90,
+ "open_milestones": 10,
+ "closed_milestones": 80
+ },
"schema": {
"title": "Enterprise Milestone Stats",
"type": "object",
@@ -187853,6 +187879,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_orgs": 50,
+ "disabled_orgs": 1,
+ "total_teams": 70,
+ "total_team_members": 700
+ },
"schema": {
"title": "Enterprise Organization Stats",
"type": "object",
@@ -187910,6 +187942,9 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_pages": 20
+ },
"schema": {
"title": "Enterprise Pages Stats",
"type": "object",
@@ -187955,6 +187990,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_pulls": 1200,
+ "merged_pulls": 1100,
+ "mergeable_pulls": 90,
+ "unmergeable_pulls": 10
+ },
"schema": {
"title": "Enterprise Pull Request Stats",
"type": "object",
@@ -188012,6 +188053,14 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_repos": 200,
+ "root_repos": 1,
+ "fork_repos": 10,
+ "org_repos": 150,
+ "total_pushes": 39000,
+ "total_wikis": 5
+ },
"schema": {
"title": "Repository Enterprise Stats",
"type": "object",
@@ -188077,6 +188126,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_users": 100,
+ "admin_users": 3,
+ "suspended_users": 1
+ },
"schema": {
"title": "Enterprise User Stats",
"type": "object",
@@ -189679,7 +189733,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.7/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>",
+ "descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.7/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -218380,10 +218434,10 @@
},
{
"name": "ref",
- "description": "<p>The name of the fully qualified reference to update. For example, <code>refs/heads/master</code>. If the value doesn't start with <code>refs</code> and have at least two slashes, it will be rejected.</p>",
+ "description": "<p>The name of the reference to update (for example, <code>heads/featureA</code>). Can be a branch name (<code>heads/BRANCH_NAME</code>) or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
- "example": "refs/head/master",
+ "example": "heads/featureA",
"schema": {
"type": "string"
},
@@ -294737,8 +294791,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Lists the most commonly used licenses on GitHub. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -294933,8 +294987,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Gets information about a specific license. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -295783,7 +295837,7 @@
},
"response": {
"statusCode": "200",
- "contentType": "text/plain",
+ "contentType": "application/json",
"description": "<p>Example response</p>",
"example": "Responsive is better than fast",
"schema": {
@@ -308989,7 +309043,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -309304,7 +309358,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -309361,7 +309415,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -310237,7 +310291,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -311120,7 +311174,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates OAuth tokens using <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use <code>fingerprint</code> to differentiate between them.</p>\n<p>You can also create tokens on GitHub Enterprise Server from the <a href=\"https://github.com/settings/tokens\">personal access tokens settings</a> page. Read more about these tokens in <a href=\"https://docs.github.com/enterprise-server@3.7/articles/creating-an-access-token-for-command-line-use\">the GitHub Help documentation</a>.</p>\n<p>Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in <a href=\"https://docs.github.com/enterprise-server@3.7/articles/about-identity-and-access-management-with-saml-single-sign-on\">the GitHub Help documentation</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates OAuth tokens using <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use <code>fingerprint</code> to differentiate between them.</p>\n<p>You can also create tokens on GitHub Enterprise Server from the <a href=\"https://github.com/settings/tokens\">personal access tokens settings</a> page. Read more about these tokens in <a href=\"https://docs.github.com/enterprise-server@3.7/articles/creating-an-access-token-for-command-line-use\">the GitHub Help documentation</a>.</p>\n<p>Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in <a href=\"https://docs.github.com/enterprise-server@3.7/articles/about-identity-and-access-management-with-saml-single-sign-on\">the GitHub Help documentation</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -312038,7 +312092,7 @@
"response": {
"statusCode": "201",
"contentType": "application/json",
- "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"example": {
"id": 1,
"url": "https://api.github.com/authorizations/1",
@@ -312830,7 +312884,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -312838,7 +312892,7 @@
},
{
"httpStatusCode": "201",
- "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>"
+ "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>"
},
{
"httpStatusCode": "304",
@@ -314545,7 +314599,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. <code>fingerprint</code> is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. <code>fingerprint</code> is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -315386,7 +315440,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -316278,7 +316332,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -316327,7 +316381,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -323783,7 +323837,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/orgs#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -324242,7 +324296,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/orgs#update-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -347305,7 +347359,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.7/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/pulls#update-a-pull-request\">edit</a> a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/enterprise-server@3.7/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/enterprise-server@3.7/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/enterprise-server@3.7/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
+ "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.7/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls#update-a-pull-request\">edit</a> a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/enterprise-server@3.7/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/enterprise-server@3.7/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/enterprise-server@3.7/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -352029,7 +352083,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#list-commits\">List commits</a> endpoint.</p>",
+ "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/commits/commits#list-commits\">List commits</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -352503,7 +352557,7 @@
"type": "string",
"name": "expected_head_sha",
"in": "body",
- "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
+ "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/commits/commits#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
}
],
"enabledForGitHubApps": false,
@@ -369014,7 +369068,7 @@
"type": "string",
"name": "event",
"in": "body",
- "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
+ "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/reviews#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -369436,7 +369490,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.7/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.7/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/reviews#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -371771,7 +371825,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#branches\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -372214,7 +372268,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
+ "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/reviews#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -372263,40 +372317,70 @@
"resources": {
"core": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1691591363
},
"search": {
"limit": 30,
+ "used": 12,
"remaining": 18,
- "reset": 1372697452,
- "used": 12
+ "reset": 1691591091
},
"graphql": {
"limit": 5000,
+ "used": 7,
"remaining": 4993,
- "reset": 1372700389,
- "used": 7
+ "reset": 1691593228
},
"integration_manifest": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "source_import": {
+ "limit": 100,
+ "used": 1,
+ "remaining": 99,
+ "reset": 1691591091
},
"code_scanning_upload": {
"limit": 500,
+ "used": 1,
"remaining": 499,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "actions_runner_registration": {
+ "limit": 10000,
+ "used": 0,
+ "remaining": 10000,
+ "reset": 1691594631
+ },
+ "scim": {
+ "limit": 15000,
+ "used": 0,
+ "remaining": 15000,
+ "reset": 1691594631
+ },
+ "dependency_snapshots": {
+ "limit": 100,
+ "used": 0,
+ "remaining": 100,
+ "reset": 1691591091
+ },
+ "code_search": {
+ "limit": 10,
+ "used": 0,
+ "remaining": 10,
+ "reset": 1691591091
}
},
"rate": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1372700873
}
},
"schema": {
@@ -372563,7 +372647,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p>Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under <code>resources</code>, you'll see objects relating to different categories:</p>\n<ul>\n<li>The <code>core</code> object provides your rate limit status for all non-search-related resources in the REST API.</li>\n<li>The <code>search</code> object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/search\">Search</a>.\"</li>\n<li>The <code>code_search</code> object provides your rate limit status for the REST API for searching code. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#search-code\">Search code</a>.\"</li>\n<li>The <code>graphql</code> object provides your rate limit status for the GraphQL API. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/graphql/overview/resource-limitations#rate-limit\">Resource limitations</a>.\"</li>\n<li>The <code>integration_manifest</code> object provides your rate limit status for the <code>POST /app-manifests/{code}/conversions</code> operation. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration\">Creating a GitHub App from a manifest</a>.\"</li>\n<li>The <code>dependency_snapshots</code> object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>code_scanning_upload</code> object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github\">Uploading a SARIF file to GitHub</a>.\"</li>\n<li>The <code>actions_runner_registration</code> object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/actions/self-hosted-runners\">Self-hosted runners</a>.\"</li>\n<li>The <code>source_import</code> object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/api-versions\">API Versions</a>.\"</li>\n</ul>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -372629,7 +372713,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -372937,7 +373021,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams#discussion-comments/\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -372995,7 +373079,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -373545,7 +373629,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -373634,7 +373718,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -373679,7 +373763,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -373986,7 +374070,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -374035,7 +374119,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -374583,7 +374667,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -374662,7 +374746,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -374707,7 +374791,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -375014,7 +375098,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -375067,7 +375151,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a> to add to the commit comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the commit comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -375615,7 +375699,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#comments\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/commits/comments#get-a-commit-comment\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -375698,7 +375782,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -375743,7 +375827,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -376050,7 +376134,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -376103,7 +376187,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -376651,7 +376735,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues#comments\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/comments#get-an-issue-comment\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -376734,7 +376818,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -376779,7 +376863,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
"in": "query",
"required": false,
"schema": {
@@ -377086,7 +377170,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -377143,7 +377227,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -377691,7 +377775,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues/\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -377774,7 +377858,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues/\">issue</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -377819,7 +377903,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -378126,7 +378210,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -378179,7 +378263,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a> to add to the pull request review comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the pull request review comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -378727,7 +378811,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/pulls#comments\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -378810,7 +378894,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -378855,7 +378939,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
"in": "query",
"required": false,
"schema": {
@@ -379160,7 +379244,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -379213,7 +379297,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a> to add to the release.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the release.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -379759,7 +379843,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#releases\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases#get-a-release\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -379842,7 +379926,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -379887,7 +379971,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -380194,7 +380278,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -380243,7 +380327,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -380526,7 +380610,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -380562,7 +380646,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -380868,7 +380952,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -380908,7 +380992,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -381190,7 +381274,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -382810,7 +382894,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#releases\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
+ "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases#get-a-release\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -387301,7 +387385,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
+ "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -402704,7 +402788,7 @@
}
],
"previews": [
- "<p>You can set the visibility of a repository using the new <code>visibility</code> parameter in the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos/\">Repositories API</a>, and get a repository's visibility with a new response key. For more information, see the <a href=\"https://developer.github.com/changes/2019-12-03-internal-visibility-changes/\">blog post</a>.</p>\n<p>To access repository visibility during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.nebula-preview+json\n</code></pre>",
+ "<p>You can set the visibility of a repository using the new <code>visibility</code> parameter in the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/repos\">Repositories API</a>, and get a repository's visibility with a new response key. For more information, see the <a href=\"https://developer.github.com/changes/2019-12-03-internal-visibility-changes/\">blog post</a>.</p>\n<p>To access repository visibility during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.nebula-preview+json\n</code></pre>",
"<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@3.7/rest/repos/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json\n</code></pre>"
]
},
@@ -414986,7 +415070,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.7/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
+ "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.7/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -415600,7 +415684,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos/#delete-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/repos/contents/#delete-a-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -415945,7 +416029,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/repos/contents/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -416154,7 +416238,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -416366,7 +416450,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -424116,7 +424200,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -424125,7 +424209,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -425137,7 +425221,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>",
+ "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -425171,7 +425255,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -425180,7 +425264,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -426554,7 +426638,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
+ "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -426576,7 +426660,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -426585,7 +426669,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -429702,7 +429786,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
+ "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -429745,7 +429829,7 @@
},
{
"name": "q",
- "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -429754,7 +429838,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -429946,7 +430030,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -429980,7 +430064,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -429989,7 +430073,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -430856,7 +430940,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -430886,7 +430970,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -431212,7 +431296,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -431234,7 +431318,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -431243,7 +431327,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub Enterprise Server. Default: <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub Enterprise Server. Default: <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -431558,7 +431642,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
+ "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -451277,7 +451361,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
+ "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -451366,7 +451450,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -451439,7 +451523,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -465516,7 +465600,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Server <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/users#emails\">Emails API</a>\".</p>",
+ "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/enterprise-server@3.7/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Server <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/users/emails\">Emails API</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -469741,7 +469825,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
+ "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -469886,7 +469970,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
+ "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -470869,7 +470953,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -471492,7 +471576,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/repos#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -471545,7 +471629,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -471867,7 +471951,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/repos#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json
index 4dc76f3a2003..25803dc49521 100644
--- a/src/rest/data/ghes-3.8/schema.json
+++ b/src/rest/data/ghes-3.8/schema.json
@@ -97645,7 +97645,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/apps/#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -106304,7 +106304,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -135009,7 +135009,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/enterprise-server@3.8/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/enterprise-server@3.8/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -138851,7 +138851,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. See the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/checks#actions-object\"><code>actions</code> object</a> description. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -146470,7 +146470,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/checks#check-runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/checks/runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -159143,7 +159143,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.8/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.8/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/collaborators/invitations\">API</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -174364,7 +174364,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#custom-media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
+ "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -192734,7 +192734,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/reference/actions#secrets\">Secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
+ "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/actions/secrets\">GitHub Actions secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -197370,6 +197370,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_commit_comments": 5000,
+ "total_gist_comments": 400,
+ "total_issue_comments": 10900,
+ "total_pull_request_comments": 9900
+ },
"schema": {
"title": "Enterprise Comment Stats",
"type": "object",
@@ -197427,6 +197433,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_gists": 500,
+ "private_gists": 30,
+ "public_gists": 470
+ },
"schema": {
"title": "Enterprise Gist Stats",
"type": "object",
@@ -197480,6 +197491,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_hooks": 50,
+ "active_hooks": 47,
+ "inactive_hooks": 3
+ },
"schema": {
"title": "Hooks Enterprise Stats",
"type": "object",
@@ -197533,6 +197549,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_issues": 5000,
+ "open_issues": 300,
+ "closed_issues": 4700
+ },
"schema": {
"title": "Enterprise Issue Stats",
"type": "object",
@@ -197586,6 +197607,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_milestones": 90,
+ "open_milestones": 10,
+ "closed_milestones": 80
+ },
"schema": {
"title": "Enterprise Milestone Stats",
"type": "object",
@@ -197639,6 +197665,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_orgs": 50,
+ "disabled_orgs": 1,
+ "total_teams": 70,
+ "total_team_members": 700
+ },
"schema": {
"title": "Enterprise Organization Stats",
"type": "object",
@@ -197696,6 +197728,9 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_pages": 20
+ },
"schema": {
"title": "Enterprise Pages Stats",
"type": "object",
@@ -197741,6 +197776,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_pulls": 1200,
+ "merged_pulls": 1100,
+ "mergeable_pulls": 90,
+ "unmergeable_pulls": 10
+ },
"schema": {
"title": "Enterprise Pull Request Stats",
"type": "object",
@@ -197798,6 +197839,14 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_repos": 200,
+ "root_repos": 1,
+ "fork_repos": 10,
+ "org_repos": 150,
+ "total_pushes": 39000,
+ "total_wikis": 5
+ },
"schema": {
"title": "Repository Enterprise Stats",
"type": "object",
@@ -197863,6 +197912,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_users": 100,
+ "admin_users": 3,
+ "suspended_users": 1
+ },
"schema": {
"title": "Enterprise User Stats",
"type": "object",
@@ -199692,7 +199746,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.8/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>",
+ "descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.8/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -228417,10 +228471,10 @@
},
{
"name": "ref",
- "description": "<p>The name of the fully qualified reference to update. For example, <code>refs/heads/master</code>. If the value doesn't start with <code>refs</code> and have at least two slashes, it will be rejected.</p>",
+ "description": "<p>The name of the reference to update (for example, <code>heads/featureA</code>). Can be a branch name (<code>heads/BRANCH_NAME</code>) or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
- "example": "refs/head/master",
+ "example": "heads/featureA",
"schema": {
"type": "string"
},
@@ -304774,8 +304828,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Lists the most commonly used licenses on GitHub. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -304970,8 +305024,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Gets information about a specific license. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -305820,7 +305874,7 @@
},
"response": {
"statusCode": "200",
- "contentType": "text/plain",
+ "contentType": "application/json",
"description": "<p>Example response</p>",
"example": "Responsive is better than fast",
"schema": {
@@ -319026,7 +319080,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -319341,7 +319395,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -319398,7 +319452,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -320282,7 +320336,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -321173,7 +321227,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates OAuth tokens using <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use <code>fingerprint</code> to differentiate between them.</p>\n<p>You can also create tokens on GitHub Enterprise Server from the <a href=\"https://github.com/settings/tokens\">personal access tokens settings</a> page. Read more about these tokens in <a href=\"https://docs.github.com/enterprise-server@3.8/articles/creating-an-access-token-for-command-line-use\">the GitHub Help documentation</a>.</p>\n<p>Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in <a href=\"https://docs.github.com/enterprise-server@3.8/articles/about-identity-and-access-management-with-saml-single-sign-on\">the GitHub Help documentation</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates OAuth tokens using <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use <code>fingerprint</code> to differentiate between them.</p>\n<p>You can also create tokens on GitHub Enterprise Server from the <a href=\"https://github.com/settings/tokens\">personal access tokens settings</a> page. Read more about these tokens in <a href=\"https://docs.github.com/enterprise-server@3.8/articles/creating-an-access-token-for-command-line-use\">the GitHub Help documentation</a>.</p>\n<p>Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in <a href=\"https://docs.github.com/enterprise-server@3.8/articles/about-identity-and-access-management-with-saml-single-sign-on\">the GitHub Help documentation</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -322099,7 +322153,7 @@
"response": {
"statusCode": "201",
"contentType": "application/json",
- "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"example": {
"id": 1,
"url": "https://api.github.com/authorizations/1",
@@ -322899,7 +322953,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -322907,7 +322961,7 @@
},
{
"httpStatusCode": "201",
- "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>"
+ "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>"
},
{
"httpStatusCode": "304",
@@ -324630,7 +324684,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. <code>fingerprint</code> is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. <code>fingerprint</code> is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -325479,7 +325533,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -326379,7 +326433,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -326428,7 +326482,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -333942,7 +333996,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/orgs#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -334401,7 +334455,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/orgs#update-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -357470,7 +357524,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.8/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/pulls#update-a-pull-request\">edit</a> a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/enterprise-server@3.8/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/enterprise-server@3.8/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/enterprise-server@3.8/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
+ "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.8/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/pulls#update-a-pull-request\">edit</a> a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/enterprise-server@3.8/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/enterprise-server@3.8/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/enterprise-server@3.8/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -362194,7 +362248,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#list-commits\">List commits</a> endpoint.</p>",
+ "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/commits/commits#list-commits\">List commits</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -362668,7 +362722,7 @@
"type": "string",
"name": "expected_head_sha",
"in": "body",
- "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
+ "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/commits/commits#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
}
],
"enabledForGitHubApps": false,
@@ -379179,7 +379233,7 @@
"type": "string",
"name": "event",
"in": "body",
- "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
+ "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/reviews#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -379601,7 +379655,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.8/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.8/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/reviews#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -381936,7 +381990,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#branches\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/branches/branch-protection\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -382379,7 +382433,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
+ "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/reviews#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -382428,40 +382482,70 @@
"resources": {
"core": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1691591363
},
"search": {
"limit": 30,
+ "used": 12,
"remaining": 18,
- "reset": 1372697452,
- "used": 12
+ "reset": 1691591091
},
"graphql": {
"limit": 5000,
+ "used": 7,
"remaining": 4993,
- "reset": 1372700389,
- "used": 7
+ "reset": 1691593228
},
"integration_manifest": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "source_import": {
+ "limit": 100,
+ "used": 1,
+ "remaining": 99,
+ "reset": 1691591091
},
"code_scanning_upload": {
"limit": 500,
+ "used": 1,
"remaining": 499,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "actions_runner_registration": {
+ "limit": 10000,
+ "used": 0,
+ "remaining": 10000,
+ "reset": 1691594631
+ },
+ "scim": {
+ "limit": 15000,
+ "used": 0,
+ "remaining": 15000,
+ "reset": 1691594631
+ },
+ "dependency_snapshots": {
+ "limit": 100,
+ "used": 0,
+ "remaining": 100,
+ "reset": 1691591091
+ },
+ "code_search": {
+ "limit": 10,
+ "used": 0,
+ "remaining": 10,
+ "reset": 1691591091
}
},
"rate": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1372700873
}
},
"schema": {
@@ -382728,7 +382812,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p>Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under <code>resources</code>, you'll see objects relating to different categories:</p>\n<ul>\n<li>The <code>core</code> object provides your rate limit status for all non-search-related resources in the REST API.</li>\n<li>The <code>search</code> object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/search\">Search</a>.\"</li>\n<li>The <code>code_search</code> object provides your rate limit status for the REST API for searching code. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#search-code\">Search code</a>.\"</li>\n<li>The <code>graphql</code> object provides your rate limit status for the GraphQL API. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/graphql/overview/resource-limitations#rate-limit\">Resource limitations</a>.\"</li>\n<li>The <code>integration_manifest</code> object provides your rate limit status for the <code>POST /app-manifests/{code}/conversions</code> operation. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration\">Creating a GitHub App from a manifest</a>.\"</li>\n<li>The <code>dependency_snapshots</code> object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>code_scanning_upload</code> object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github\">Uploading a SARIF file to GitHub</a>.\"</li>\n<li>The <code>actions_runner_registration</code> object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/self-hosted-runners\">Self-hosted runners</a>.\"</li>\n<li>The <code>source_import</code> object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/api-versions\">API Versions</a>.\"</li>\n</ul>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -382794,7 +382878,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -383102,7 +383186,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams#discussion-comments/\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -383160,7 +383244,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -383710,7 +383794,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -383799,7 +383883,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -383844,7 +383928,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -384151,7 +384235,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -384200,7 +384284,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -384748,7 +384832,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -384827,7 +384911,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -384872,7 +384956,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -385179,7 +385263,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -385232,7 +385316,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a> to add to the commit comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the commit comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -385780,7 +385864,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#comments\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/commits/comments#get-a-commit-comment\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -385863,7 +385947,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -385908,7 +385992,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -386215,7 +386299,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -386268,7 +386352,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -386816,7 +386900,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues#comments\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/comments#get-an-issue-comment\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -386899,7 +386983,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -386944,7 +387028,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
"in": "query",
"required": false,
"schema": {
@@ -387251,7 +387335,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -387308,7 +387392,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -387856,7 +387940,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues/\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -387939,7 +388023,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues/\">issue</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -387984,7 +388068,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -388291,7 +388375,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -388344,7 +388428,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a> to add to the pull request review comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the pull request review comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -388892,7 +388976,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/pulls#comments\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -388975,7 +389059,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -389020,7 +389104,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
"in": "query",
"required": false,
"schema": {
@@ -389325,7 +389409,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -389378,7 +389462,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a> to add to the release.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the release.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -389924,7 +390008,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#releases\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases#get-a-release\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -390007,7 +390091,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -390052,7 +390136,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -390359,7 +390443,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -390408,7 +390492,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -390691,7 +390775,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -390727,7 +390811,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -391033,7 +391117,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -391073,7 +391157,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -391355,7 +391439,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -392987,7 +393071,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#releases\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
+ "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases#get-a-release\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -397490,7 +397574,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
+ "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -412893,7 +412977,7 @@
}
],
"previews": [
- "<p>You can set the visibility of a repository using the new <code>visibility</code> parameter in the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos/\">Repositories API</a>, and get a repository's visibility with a new response key. For more information, see the <a href=\"https://developer.github.com/changes/2019-12-03-internal-visibility-changes/\">blog post</a>.</p>\n<p>To access repository visibility during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.nebula-preview+json\n</code></pre>",
+ "<p>You can set the visibility of a repository using the new <code>visibility</code> parameter in the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/repos\">Repositories API</a>, and get a repository's visibility with a new response key. For more information, see the <a href=\"https://developer.github.com/changes/2019-12-03-internal-visibility-changes/\">blog post</a>.</p>\n<p>To access repository visibility during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.nebula-preview+json\n</code></pre>",
"<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@3.8/rest/repos/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json\n</code></pre>"
]
},
@@ -425175,7 +425259,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.8/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
+ "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.8/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -425789,7 +425873,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos/#delete-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/repos/contents/#delete-a-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -426134,7 +426218,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/repos/contents/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -426343,7 +426427,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -426555,7 +426639,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -434305,7 +434389,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -434314,7 +434398,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -435326,7 +435410,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>",
+ "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -435360,7 +435444,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -435369,7 +435453,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -436743,7 +436827,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
+ "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -436765,7 +436849,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -436774,7 +436858,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -439891,7 +439975,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
+ "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -439934,7 +440018,7 @@
},
{
"name": "q",
- "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -439943,7 +440027,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -440135,7 +440219,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -440169,7 +440253,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -440178,7 +440262,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -441045,7 +441129,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -441075,7 +441159,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -441401,7 +441485,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -441423,7 +441507,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -441432,7 +441516,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub Enterprise Server. Default: <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub Enterprise Server. Default: <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -441747,7 +441831,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
+ "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -461570,7 +461654,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
+ "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -461659,7 +461743,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -461732,7 +461816,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -475809,7 +475893,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Server <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/users#emails\">Emails API</a>\".</p>",
+ "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Server <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/users/emails\">Emails API</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -480034,7 +480118,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
+ "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -480179,7 +480263,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
+ "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -481162,7 +481246,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -481785,7 +481869,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/repos#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -481838,7 +481922,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -482160,7 +482244,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/repos#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json
index 2dce4e455908..a68bf7677025 100644
--- a/src/rest/data/ghes-3.9-2022-11-28/schema.json
+++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json
@@ -98693,7 +98693,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/apps/#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/apps/apps#suspend-an-app-installation\">Suspend an app installation</a>\" endpoint.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -107410,7 +107410,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
+ "descriptionHTML": "<p>Revokes the installation token you're using to authenticate as an installation and access this endpoint.</p>\n<p>Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/apps/apps#create-an-installation-access-token-for-an-app\">Create an installation access token for an app</a>\" endpoint.</p>\n<p>You must use an <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -136163,7 +136163,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the <a href=\"https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_run\"><code>check_run.requested_action</code> webhook</a> to your app. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -140005,7 +140005,7 @@
"type": "array of objects",
"name": "actions",
"in": "body",
- "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. See the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/checks#actions-object\"><code>actions</code> object</a> description. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
+ "description": "<p>Possible further actions the integrator can perform, which a user may trigger. Each action includes a <code>label</code>, <code>identifier</code> and <code>description</code>. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions\">Check runs and requested actions</a>.\"</p>",
"childParamsGroups": [
{
"type": "string",
@@ -147712,7 +147712,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/checks#check-runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n<p>By default, check suites are automatically created when you create a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/checks/runs\">check run</a>. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/checks/suites#update-repository-preferences-for-check-suites\">Update repository preferences for check suites</a>\". Your GitHub App must have the <code>checks:write</code> permission to create check suites.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -158677,7 +158677,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the <code>security_events</code> scope to use this endpoint for private repositories. You can also use tokens with the <code>public_repo</code> scope for public repositories only. GitHub Apps must have the <code>security_events</code> write permission to use this endpoint.</p>\n<p>There are two places where you can upload code scanning results.</p>\n<ul>\n<li>If you upload to a pull request, for example <code>--ref refs/pull/42/merge</code> or <code>--ref refs/pull/42/head</code>, then the results appear as alerts in a pull request check. For more information, see \"<a href=\"/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests\">Triaging code scanning alerts in pull requests</a>.\"</li>\n<li>If you upload to a branch, for example <code>--ref refs/heads/my-branch</code>, then the results appear in the <strong>Security</strong> tab for your repository. For more information, see \"<a href=\"/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository\">Managing code scanning alerts for your repository</a>.\"</li>\n</ul>\n<p>You must compress the SARIF-formatted analysis data that you want to upload, using <code>gzip</code>, and then encode it as a Base64 format string. For example:</p>\n<pre><code>gzip -c analysis-data.sarif | base64 -w0\n</code></pre>\n<br>\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\"><strong>SARIF data</strong></th><th align=\"center\" scope=\"col\"><strong>Maximum values</strong></th><th scope=\"col\"><strong>Additional limits</strong></th></tr></thead><tbody><tr><td>Runs per file</td><td align=\"center\">20</td><td></td></tr><tr><td>Results per run</td><td align=\"center\">25,000</td><td>Only the top 5,000 results will be included, prioritized by severity.</td></tr><tr><td>Rules per run</td><td align=\"center\">25,000</td><td></td></tr><tr><td>Tool extensions per run</td><td align=\"center\">100</td><td></td></tr><tr><td>Thread Flow Locations per result</td><td align=\"center\">10,000</td><td>Only the top 1,000 Thread Flow Locations will be included, using prioritization.</td></tr><tr><td>Location per result</td><td align=\"center\">1,000</td><td>Only 100 locations will be included.</td></tr><tr><td>Tags per rule</td><td align=\"center\">20</td><td>Only 10 tags will be included.</td></tr></tbody></table>\n<p>The <code>202 Accepted</code> response includes an <code>id</code> value.\nYou can use this ID to check the status of the upload by using it in the <code>/sarifs/{sarif_id}</code> endpoint.\nFor more information, see \"<a href=\"/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload\">Get information about a SARIF upload</a>.\"</p>",
+ "descriptionHTML": "<p>Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the <code>security_events</code> scope to use this endpoint for private repositories. You can also use tokens with the <code>public_repo</code> scope for public repositories only. GitHub Apps must have the <code>security_events</code> write permission to use this endpoint. For troubleshooting information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif\">Troubleshooting SARIF uploads</a>.\"</p>\n<p>There are two places where you can upload code scanning results.</p>\n<ul>\n<li>If you upload to a pull request, for example <code>--ref refs/pull/42/merge</code> or <code>--ref refs/pull/42/head</code>, then the results appear as alerts in a pull request check. For more information, see \"<a href=\"/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests\">Triaging code scanning alerts in pull requests</a>.\"</li>\n<li>If you upload to a branch, for example <code>--ref refs/heads/my-branch</code>, then the results appear in the <strong>Security</strong> tab for your repository. For more information, see \"<a href=\"/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository\">Managing code scanning alerts for your repository</a>.\"</li>\n</ul>\n<p>You must compress the SARIF-formatted analysis data that you want to upload, using <code>gzip</code>, and then encode it as a Base64 format string. For example:</p>\n<pre><code>gzip -c analysis-data.sarif | base64 -w0\n</code></pre>\n<br>\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit).\"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\"><strong>SARIF data</strong></th><th align=\"center\" scope=\"col\"><strong>Maximum values</strong></th><th scope=\"col\"><strong>Additional limits</strong></th></tr></thead><tbody><tr><td>Runs per file</td><td align=\"center\">20</td><td></td></tr><tr><td>Results per run</td><td align=\"center\">25,000</td><td>Only the top 5,000 results will be included, prioritized by severity.</td></tr><tr><td>Rules per run</td><td align=\"center\">25,000</td><td></td></tr><tr><td>Tool extensions per run</td><td align=\"center\">100</td><td></td></tr><tr><td>Thread Flow Locations per result</td><td align=\"center\">10,000</td><td>Only the top 1,000 Thread Flow Locations will be included, using prioritization.</td></tr><tr><td>Location per result</td><td align=\"center\">1,000</td><td>Only 100 locations will be included.</td></tr><tr><td>Tags per rule</td><td align=\"center\">20</td><td>Only 10 tags will be included.</td></tr></tbody></table>\n<p>The <code>202 Accepted</code> response includes an <code>id</code> value.\nYou can use this ID to check the status of the upload by using it in the <code>/sarifs/{sarif_id}</code> endpoint.\nFor more information, see \"<a href=\"/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload\">Get information about a SARIF upload</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -160810,7 +160810,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#invitations\">repository invitations API endpoints</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>\n<p>The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/collaborators/invitations\">API</a>.</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>\n<p><strong>Rate limits</strong></p>\n<p>You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -176163,7 +176163,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#custom-media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
+ "descriptionHTML": "<p>Commit Comments use <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types\">these custom media types</a>. You can read more about the use of media types in the API <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/\">here</a>.</p>\n<p>Comments are ordered by ascending ID.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -194919,7 +194919,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/reference/actions#secrets\">Secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
+ "descriptionHTML": "<p>Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"<a href=\"/actions/reference/environments#environment-protection-rules\">Environments</a>.\"</p>\n<p><strong>Note:</strong> To create or update name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies\">Deployment branch policies</a>.\"</p>\n<p><strong>Note:</strong> To create or update secrets for an environment, see \"<a href=\"/rest/actions/secrets\">GitHub Actions secrets</a>.\"</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration:write</code> permission for the repository to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -199555,6 +199555,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_commit_comments": 5000,
+ "total_gist_comments": 400,
+ "total_issue_comments": 10900,
+ "total_pull_request_comments": 9900
+ },
"schema": {
"title": "Enterprise Comment Stats",
"type": "object",
@@ -199612,6 +199618,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_gists": 500,
+ "private_gists": 30,
+ "public_gists": 470
+ },
"schema": {
"title": "Enterprise Gist Stats",
"type": "object",
@@ -199665,6 +199676,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_hooks": 50,
+ "active_hooks": 47,
+ "inactive_hooks": 3
+ },
"schema": {
"title": "Hooks Enterprise Stats",
"type": "object",
@@ -199718,6 +199734,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_issues": 5000,
+ "open_issues": 300,
+ "closed_issues": 4700
+ },
"schema": {
"title": "Enterprise Issue Stats",
"type": "object",
@@ -199771,6 +199792,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_milestones": 90,
+ "open_milestones": 10,
+ "closed_milestones": 80
+ },
"schema": {
"title": "Enterprise Milestone Stats",
"type": "object",
@@ -199824,6 +199850,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_orgs": 50,
+ "disabled_orgs": 1,
+ "total_teams": 70,
+ "total_team_members": 700
+ },
"schema": {
"title": "Enterprise Organization Stats",
"type": "object",
@@ -199881,6 +199913,9 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_pages": 20
+ },
"schema": {
"title": "Enterprise Pages Stats",
"type": "object",
@@ -199926,6 +199961,12 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_pulls": 1200,
+ "merged_pulls": 1100,
+ "mergeable_pulls": 90,
+ "unmergeable_pulls": 10
+ },
"schema": {
"title": "Enterprise Pull Request Stats",
"type": "object",
@@ -199983,6 +200024,14 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_repos": 200,
+ "root_repos": 1,
+ "fork_repos": 10,
+ "org_repos": 150,
+ "total_pushes": 39000,
+ "total_wikis": 5
+ },
"schema": {
"title": "Repository Enterprise Stats",
"type": "object",
@@ -200048,6 +200097,11 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
+ "example": {
+ "total_users": 100,
+ "admin_users": 3,
+ "suspended_users": 1
+ },
"schema": {
"title": "Enterprise User Stats",
"type": "object",
@@ -201934,7 +201988,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>",
+ "descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -231106,10 +231160,10 @@
},
{
"name": "ref",
- "description": "<p>The name of the fully qualified reference to update. For example, <code>refs/heads/master</code>. If the value doesn't start with <code>refs</code> and have at least two slashes, it will be rejected.</p>",
+ "description": "<p>The name of the reference to update (for example, <code>heads/featureA</code>). Can be a branch name (<code>heads/BRANCH_NAME</code>) or tag name (<code>tags/TAG_NAME</code>). For more information, see \"<a href=\"https://git-scm.com/book/en/v2/Git-Internals-Git-References\">Git References</a>\" in the Git documentation.</p>",
"in": "path",
"required": true,
- "example": "refs/head/master",
+ "example": "heads/featureA",
"schema": {
"type": "string"
},
@@ -307463,8 +307517,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Lists the most commonly used licenses on GitHub. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -307659,8 +307713,8 @@
}
}
],
- "descriptionHTML": "",
"previews": [],
+ "descriptionHTML": "<p>Gets information about a specific license. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository\">Licensing a repository </a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -308509,7 +308563,7 @@
},
"response": {
"statusCode": "200",
- "contentType": "text/plain",
+ "contentType": "application/json",
"description": "<p>Example response</p>",
"example": "Responsive is better than fast",
"schema": {
@@ -321825,7 +321879,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -322140,7 +322194,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -322197,7 +322251,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -323089,7 +323143,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -323988,7 +324042,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates OAuth tokens using <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use <code>fingerprint</code> to differentiate between them.</p>\n<p>You can also create tokens on GitHub Enterprise Server from the <a href=\"https://github.com/settings/tokens\">personal access tokens settings</a> page. Read more about these tokens in <a href=\"https://docs.github.com/enterprise-server@3.9/articles/creating-an-access-token-for-command-line-use\">the GitHub Help documentation</a>.</p>\n<p>Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in <a href=\"https://docs.github.com/enterprise-server@3.9/articles/about-identity-and-access-management-with-saml-single-sign-on\">the GitHub Help documentation</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates OAuth tokens using <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a>. If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use <code>fingerprint</code> to differentiate between them.</p>\n<p>You can also create tokens on GitHub Enterprise Server from the <a href=\"https://github.com/settings/tokens\">personal access tokens settings</a> page. Read more about these tokens in <a href=\"https://docs.github.com/enterprise-server@3.9/articles/creating-an-access-token-for-command-line-use\">the GitHub Help documentation</a>.</p>\n<p>Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in <a href=\"https://docs.github.com/enterprise-server@3.9/articles/about-identity-and-access-management-with-saml-single-sign-on\">the GitHub Help documentation</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -324922,7 +324976,7 @@
"response": {
"statusCode": "201",
"contentType": "application/json",
- "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"example": {
"id": 1,
"url": "https://api.github.com/authorizations/1",
@@ -325730,7 +325784,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -325738,7 +325792,7 @@
},
{
"httpStatusCode": "201",
- "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>"
+ "description": "<p><strong>Deprecation Notice:</strong> GitHub will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>"
},
{
"httpStatusCode": "304",
@@ -327477,7 +327531,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. <code>fingerprint</code> is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p><strong>Warning:</strong> Apps must use the <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a> to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the <a href=\"https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api\">blog post</a>.</p>\n<p>This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. <code>fingerprint</code> is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -328334,7 +328388,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -329242,7 +329296,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication\">Working with two-factor authentication</a>.\"</p>\n<p>You can only send one of these scope keys at a time.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -329291,7 +329345,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -338555,7 +338609,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/orgs#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -339014,7 +339068,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/orgs#update-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -375363,7 +375417,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/pulls#update-a-pull-request\">edit</a> a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
+ "descriptionHTML": "<p>Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists details of a pull request by providing its number.</p>\n<p>When you get, <a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls/#create-a-pull-request\">create</a>, or <a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#update-a-pull-request\">edit</a> a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the <code>mergeable</code> key. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests\">Checking mergeability of pull requests</a>\".</p>\n<p>The value of the <code>mergeable</code> attribute can be <code>true</code>, <code>false</code>, or <code>null</code>. If the value is <code>null</code>, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-<code>null</code> value for the <code>mergeable</code> attribute in the response. If <code>mergeable</code> is <code>true</code>, then <code>merge_commit_sha</code> will be the SHA of the <em>test</em> merge commit.</p>\n<p>The value of the <code>merge_commit_sha</code> attribute changes depending on the state of the pull request. Before merging a pull request, the <code>merge_commit_sha</code> attribute holds the SHA of the <em>test</em> merge commit. After merging a pull request, the <code>merge_commit_sha</code> attribute changes depending on how you merged the pull request:</p>\n<ul>\n<li>If merged as a <a href=\"https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/\">merge commit</a>, <code>merge_commit_sha</code> represents the SHA of the merge commit.</li>\n<li>If merged via a <a href=\"https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#squashing-your-merge-commits\">squash</a>, <code>merge_commit_sha</code> represents the SHA of the squashed commit on the base branch.</li>\n<li>If <a href=\"https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits\">rebased</a>, <code>merge_commit_sha</code> represents the commit that the base branch was updated to.</li>\n</ul>\n<p>Pass the appropriate <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/#commits-commit-comparison-and-pull-requests\">media type</a> to fetch diff and patch formats.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -380087,7 +380141,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#list-commits\">List commits</a> endpoint.</p>",
+ "descriptionHTML": "<p>Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-commits\">List commits</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -380561,7 +380615,7 @@
"type": "string",
"name": "expected_head_sha",
"in": "body",
- "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
+ "description": "<p>The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a <code>422 Unprocessable Entity</code> status. You can use the \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-commits\">List commits</a>\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.</p>"
}
],
"enabledForGitHubApps": false,
@@ -397082,7 +397136,7 @@
"type": "string",
"name": "event",
"in": "body",
- "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
+ "description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -397504,7 +397558,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -399839,7 +399893,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#branches\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> To dismiss a pull request review on a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection\">protected branch</a>, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -400282,7 +400336,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
+ "descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -400331,40 +400385,70 @@
"resources": {
"core": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1691591363
},
"search": {
"limit": 30,
+ "used": 12,
"remaining": 18,
- "reset": 1372697452,
- "used": 12
+ "reset": 1691591091
},
"graphql": {
"limit": 5000,
+ "used": 7,
"remaining": 4993,
- "reset": 1372700389,
- "used": 7
+ "reset": 1691593228
},
"integration_manifest": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "source_import": {
+ "limit": 100,
+ "used": 1,
+ "remaining": 99,
+ "reset": 1691591091
},
"code_scanning_upload": {
"limit": 500,
+ "used": 1,
"remaining": 499,
- "reset": 1551806725,
- "used": 1
+ "reset": 1691594631
+ },
+ "actions_runner_registration": {
+ "limit": 10000,
+ "used": 0,
+ "remaining": 10000,
+ "reset": 1691594631
+ },
+ "scim": {
+ "limit": 15000,
+ "used": 0,
+ "remaining": 15000,
+ "reset": 1691594631
+ },
+ "dependency_snapshots": {
+ "limit": 100,
+ "used": 0,
+ "remaining": 100,
+ "reset": 1691591091
+ },
+ "code_search": {
+ "limit": 10,
+ "used": 0,
+ "remaining": 10,
+ "reset": 1691591091
}
},
"rate": {
"limit": 5000,
+ "used": 1,
"remaining": 4999,
- "reset": 1372700873,
- "used": 1
+ "reset": 1372700873
}
},
"schema": {
@@ -400631,7 +400715,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> Accessing this endpoint does not count against your REST API rate limit.</p>\n<p>Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under <code>resources</code>, you'll see objects relating to different categories:</p>\n<ul>\n<li>The <code>core</code> object provides your rate limit status for all non-search-related resources in the REST API.</li>\n<li>The <code>search</code> object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/search\">Search</a>.\"</li>\n<li>The <code>code_search</code> object provides your rate limit status for the REST API for searching code. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#search-code\">Search code</a>.\"</li>\n<li>The <code>graphql</code> object provides your rate limit status for the GraphQL API. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/graphql/overview/resource-limitations#rate-limit\">Resource limitations</a>.\"</li>\n<li>The <code>integration_manifest</code> object provides your rate limit status for the <code>POST /app-manifests/{code}/conversions</code> operation. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration\">Creating a GitHub App from a manifest</a>.\"</li>\n<li>The <code>dependency_snapshots</code> object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>code_scanning_upload</code> object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github\">Uploading a SARIF file to GitHub</a>.\"</li>\n<li>The <code>actions_runner_registration</code> object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners\">Self-hosted runners</a>.\"</li>\n<li>The <code>source_import</code> object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/api-versions\">API Versions</a>.\"</li>\n</ul>\n<p><strong>Note:</strong> The <code>rate</code> object is deprecated. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -400697,7 +400781,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -401005,7 +401089,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams#discussion-comments/\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -401063,7 +401147,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -401613,7 +401697,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -401702,7 +401786,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -401747,7 +401831,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -402054,7 +402138,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -402103,7 +402187,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -402651,7 +402735,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>\n<p><strong>Note:</strong> You can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -402730,7 +402814,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -402775,7 +402859,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a commit comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -403082,7 +403166,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -403135,7 +403219,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a> to add to the commit comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the commit comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -403683,7 +403767,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#comments\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment\">commit comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this commit comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -403766,7 +403850,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#comments\">commit comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -403811,7 +403895,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -404118,7 +404202,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -404171,7 +404255,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -404719,7 +404803,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues#comments\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment\">issue comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -404802,7 +404886,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues#comments\">issue comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -404847,7 +404931,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to an issue.</p>",
"in": "query",
"required": false,
"schema": {
@@ -405154,7 +405238,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to an <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -405211,7 +405295,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a> to add to the issue.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the issue.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -405759,7 +405843,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues/\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
+ "descriptionHTML": "<p>Create a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this issue.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -405842,7 +405926,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues/\">issue</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -405887,7 +405971,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a pull request review comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -406194,7 +406278,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -406247,7 +406331,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a> to add to the pull request review comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the pull request review comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -406795,7 +406879,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/pulls#comments\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this pull request review comment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -406878,7 +406962,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/pulls#review-comments\">pull request review comment</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -406923,7 +407007,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a release.</p>",
"in": "query",
"required": false,
"schema": {
@@ -407228,7 +407312,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -407281,7 +407365,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a> to add to the release.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the release.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -407827,7 +407911,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#releases\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -407910,7 +407994,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#releases\">release</a>.</p>",
+ "descriptionHTML": "<p><strong>Note:</strong> You can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id</code>.</p>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release\">release</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -407955,7 +408039,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion comment.</p>",
"in": "query",
"required": false,
"schema": {
@@ -408262,7 +408346,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment\"><code>List reactions for a team discussion comment</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -408311,7 +408395,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion comment.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion comment.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -408594,7 +408678,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams#discussion-comments\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment\">Create reaction for a team discussion comment</a>\" endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -408630,7 +408714,7 @@
},
{
"name": "content",
- "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
+ "description": "<p>Returns a single <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a>. Omit this parameter to list all reactions to a team discussion.</p>",
"in": "query",
"required": false,
"schema": {
@@ -408936,7 +409020,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>read:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -408976,7 +409060,7 @@
"type": "string",
"name": "content",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/reactions#reaction-types\">reaction type</a> to add to the team discussion.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions\">reaction type</a> to add to the team discussion.</p>",
"isRequired": true,
"enum": [
"+1",
@@ -409258,7 +409342,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams#discussions\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion\"><code>Create reaction for a team discussion</code></a> endpoint.</p>\n<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion\">team discussion</a>. OAuth access tokens require the <code>write:discussion</code> <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">scope</a>. A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -410890,7 +410974,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#releases\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
+ "descriptionHTML": "<p>Generate a name and body describing a <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release\">release</a>. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -415393,7 +415477,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#list-assets-for-a-release\">List assets for a release</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
+ "descriptionHTML": "<p>This endpoint makes use of <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#hypermedia\">a Hypermedia relation</a> to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the <code>upload_url</code> returned in\nthe response of the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases#create-a-release\">Create a release endpoint</a> to upload a release asset.</p>\n<p>You need to use an HTTP client which supports <a href=\"http://en.wikipedia.org/wiki/Server_Name_Indication\">SNI</a> to make calls to this endpoint.</p>\n<p>Most libraries will set the required <code>Content-Length</code> header automatically. Use the required <code>Content-Type</code> header to provide the media type of the asset. For a list of media types, see <a href=\"https://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. For example: </p>\n<p><code>application/zip</code></p>\n<p>GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.</p>\n<p>When an upstream failure occurs, you will receive a <code>502 Bad Gateway</code> status. This may leave an empty asset with a state of <code>starter</code>. It can be safely deleted.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/assets#list-release-assets\">List release assets</a>\"\nendpoint lists the renamed filenames. For more information and help, contact <a href=\"https://support.github.com/contact?tags=dotcom-rest-api\">GitHub Enterprise Server Support</a>.</li>\n<li>To find the <code>release_id</code> query the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-the-latest-release\"><code>GET /repos/{owner}/{repo}/releases/latest</code> endpoint</a>. </li>\n<li>If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -430851,7 +430935,7 @@
}
],
"previews": [
- "<p>You can set the visibility of a repository using the new <code>visibility</code> parameter in the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos/\">Repositories API</a>, and get a repository's visibility with a new response key. For more information, see the <a href=\"https://developer.github.com/changes/2019-12-03-internal-visibility-changes/\">blog post</a>.</p>\n<p>To access repository visibility during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.nebula-preview+json\n</code></pre>",
+ "<p>You can set the visibility of a repository using the new <code>visibility</code> parameter in the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/repos\">Repositories API</a>, and get a repository's visibility with a new response key. For more information, see the <a href=\"https://developer.github.com/changes/2019-12-03-internal-visibility-changes/\">blog post</a>.</p>\n<p>To access repository visibility during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.nebula-preview+json\n</code></pre>",
"<p>The <code>is_template</code> and <code>template_repository</code> keys are currently available for developer to preview. See <a href=\"https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-using-a-template\">Create a repository using a template</a> to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json\n</code></pre>"
]
},
@@ -443445,7 +443529,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.9/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
+ "descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.9/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -444059,7 +444143,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos/#delete-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the <code>workflow</code> scope to use this endpoint.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#delete-a-file\">Delete a file</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -444404,7 +444488,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
+ "descriptionHTML": "<p>Deletes a file in a repository.</p>\n<p>You can provide an additional <code>committer</code> parameter, which is an object containing information about the committer. Or, you can provide an <code>author</code> parameter, which is an object containing information about the author.</p>\n<p>The <code>author</code> section is optional and is filled in with the <code>committer</code> information if omitted. If the <code>committer</code> information is omitted, the authenticated user's information is used.</p>\n<p>You must provide values for both <code>name</code> and <code>email</code>, whether you choose to use <code>author</code> or <code>committer</code>. Otherwise, you'll receive a <code>422</code> status code.</p>\n<p><strong>Note:</strong> If you use this endpoint and the \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#create-or-update-file-contents\">Create or update file contents</a>\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -444613,7 +444697,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the preferred README for a repository.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -444825,7 +444909,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#custom-media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
+ "descriptionHTML": "<p>Gets the README from a repository directory.</p>\n<p>READMEs support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types\">custom media types</a> for retrieving the raw content or rendered HTML.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -452619,7 +452703,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-code\">Searching code</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -452628,7 +452712,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query. Can only be <code>indexed</code>, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -453684,7 +453768,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>",
+ "descriptionHTML": "<p>Searches for query terms inside of a file. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for code, you can get text match metadata for the file <strong>content</strong> and file <strong>path</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the definition of the <code>addClass</code> function inside <a href=\"https://github.com/jquery/jquery\">jQuery</a> repository, your query would look something like this:</p>\n<p><code>q=addClass+in:file+language:js+repo:jquery/jquery</code></p>\n<p>This query searches for the keyword <code>addClass</code> within a file's contents. The query limits the search to files where the language is JavaScript in the <code>jquery/jquery</code> repository.</p>\n<p>Considerations for code search:</p>\n<p>Due to the complexity of searching code, there are a few restrictions on how searches are performed:</p>\n<ul>\n<li>Only the <em>default branch</em> is considered. In most cases, this will be the <code>master</code> branch.</li>\n<li>Only files smaller than 384 KB are searchable.</li>\n<li>You must always include at least one search term when searching source code. For example, searching for <a href=\"https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code\"><code>language:go</code></a> is not valid, while <a href=\"https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code\"><code>amazing language:go</code></a> is.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -453718,7 +453802,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-commits\">Searching commits</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -453727,7 +453811,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by <code>author-date</code> or <code>committer-date</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -455145,7 +455229,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
+ "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -455167,7 +455251,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-issues-and-pull-requests\">Searching issues and pull requests</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -455176,7 +455260,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by the number of <code>comments</code>, <code>reactions</code>, <code>reactions-+1</code>, <code>reactions--1</code>, <code>reactions-smile</code>, <code>reactions-thinking_face</code>, <code>reactions-heart</code>, <code>reactions-tada</code>, or <code>interactions</code>. You can also sort results by how recently the items were <code>created</code> or <code>updated</code>, Default: <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -458293,7 +458377,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
+ "descriptionHTML": "<p>Find issues by state and keyword. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for issues, you can get text match metadata for the issue <strong>title</strong>, issue <strong>body</strong>, and issue <strong>comment body</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted\nsearch results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.</p>\n<p><code>q=windows+label:bug+language:python+state:open&sort=created&order=asc</code></p>\n<p>This query searches for the keyword <code>windows</code>, within any open issue that is labeled as <code>bug</code>. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.</p>\n<p><strong>Note:</strong> For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the <code>is:issue</code> or <code>is:pull-request</code> qualifier will receive an HTTP <code>422 Unprocessable Entity</code> response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the <code>is</code> qualifier, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests\">Searching only issues or pull requests</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -458336,7 +458420,7 @@
},
{
"name": "q",
- "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -458345,7 +458429,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by when the label was <code>created</code> or <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -458537,7 +458621,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for labels, you can get text match metadata for the label <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to find labels in the <code>linguist</code> repository that match <code>bug</code>, <code>defect</code>, or <code>enhancement</code>. Your query might look like this:</p>\n<p><code>q=bug+defect+enhancement&repository_id=64778136</code></p>\n<p>The labels that best match the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -458571,7 +458655,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/articles/searching-for-repositories/\">Searching for repositories</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -458580,7 +458664,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>stars</code>, <code>forks</code>, or <code>help-wanted-issues</code> or how recently the items were <code>updated</code>. Default: <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -459447,7 +459531,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find repositories via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for repositories, you can get text match metadata for the <strong>name</strong> and <strong>description</strong> fields when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:</p>\n<p><code>q=tetris+language:assembly&sort=stars&order=desc</code></p>\n<p>This query searches for repositories with the word <code>tetris</code> in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -459477,7 +459561,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query\">Constructing a search query</a>.</p>",
"in": "query",
"required": true,
"schema": {
@@ -459803,7 +459887,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
+ "descriptionHTML": "<p>Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/articles/searching-topics/\">Searching topics</a>\" for a detailed list of qualifiers.</p>\n<p>When searching for topics, you can get text match metadata for the topic's <strong>short_description</strong>, <strong>description</strong>, <strong>name</strong>, or <strong>display_name</strong> field when you pass the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you want to search for topics related to Ruby that are featured on <a href=\"https://github.com/topics\">https://github.com/topics</a>. Your query might look like this:</p>\n<p><code>q=ruby+is:featured</code></p>\n<p>This query searches for topics with the keyword <code>ruby</code> and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -459825,7 +459909,7 @@
"parameters": [
{
"name": "q",
- "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
+ "description": "<p>The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query\">Constructing a search query</a>. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/search-github/searching-on-github/searching-users\">Searching users</a>\" for a detailed list of qualifiers.</p>",
"in": "query",
"required": true,
"schema": {
@@ -459834,7 +459918,7 @@
},
{
"name": "sort",
- "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub Enterprise Server. Default: <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#ranking-search-results\">best match</a></p>",
+ "description": "<p>Sorts the results of your query by number of <code>followers</code> or <code>repositories</code>, or when the person <code>joined</code> GitHub Enterprise Server. Default: <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results\">best match</a></p>",
"in": "query",
"required": false,
"schema": {
@@ -460149,7 +460233,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
+ "descriptionHTML": "<p>Find users via various criteria. This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#pagination\">per page</a>.</p>\n<p>When searching for users, you can get text match metadata for the issue <strong>login</strong>, public <strong>email</strong>, and <strong>name</strong> fields when you pass the <code>text-match</code> media type. For more details about highlighting search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata\">Text match metadata</a>. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata\">Text match metadata</a>.</p>\n<p>For example, if you're looking for a list of popular users, you might try this query:</p>\n<p><code>q=tom+repos:%3E42+followers:%3E1000</code></p>\n<p>This query searches for users with the name <code>tom</code>. The results are restricted to users with more than 42 repositories and over 1,000 followers.</p>\n<p>This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/queries#search\">GraphQL Queries</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -480082,7 +480166,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
+ "descriptionHTML": "<p><strong>Note</strong>: Repositories inherited through a parent team will also be checked.</p>\n<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-repository\">Check team permissions for a repository</a> endpoint.</p>\n<p>You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/\">media type</a> via the <code>Accept</code> header:</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -480171,7 +480255,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-repository-permissions\">Add or update team repository permissions</a>\" endpoint.</p>\n<p>To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a <code>422 Unprocessable Entity</code> status if you attempt to add a repository to a team that is not owned by the organization.</p>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#http-verbs\">HTTP verbs</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -480244,7 +480328,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
+ "descriptionHTML": "<p><strong>Deprecation Notice:</strong> This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-repository-from-a-team\">Remove a repository from a team</a> endpoint.</p>\n<p>If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -494321,7 +494405,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Server <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/users#emails\">Emails API</a>\".</p>",
+ "descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account.</p>\n<p>GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See \"<a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/\">Identifying and authorizing users for GitHub Apps</a>\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Server <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/overview/resources-in-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/users/emails\">Emails API</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -498911,7 +498995,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
+ "descriptionHTML": "<p>Returns the webhook configuration for a repository. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#get-a-repository-webhook\">Get a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>read:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -499056,7 +499140,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
+ "descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>Access tokens must have the <code>write:repo_hook</code> or <code>repo</code> scope, and GitHub Apps must have the <code>repository_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -500039,7 +500123,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -500662,7 +500746,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/repos#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Returns a webhook configured in a repository. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository\">Get a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -500715,7 +500799,7 @@
"type": "object",
"name": "config",
"in": "body",
- "description": "<p>Key/value pairs to provide settings for this webhook. <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#create-hook-config-params\">These are defined below</a>.</p>",
+ "description": "<p>Key/value pairs to provide settings for this webhook.</p>",
"childParamsGroups": [
{
"type": "string",
@@ -501037,7 +501121,7 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/repos#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
+ "descriptionHTML": "<p>Updates a webhook configured in a repository. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository\">Update a webhook configuration for a repository</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json
index b0c2afa51ab7..c5c18a8f81ff 100644
--- a/src/rest/lib/config.json
+++ b/src/rest/lib/config.json
@@ -36,5 +36,5 @@
]
}
},
- "sha": "45ba714d4fde4f522d5cad95427eea033423da8f"
+ "sha": "da33840287fe37f6173edf958b888e02ca2b4110"
}
\ No newline at end of file
diff --git a/src/tools/lib/all-tools.js b/src/tools/lib/all-tools.js
index ce3cd55a8101..be0702bf7422 100644
--- a/src/tools/lib/all-tools.js
+++ b/src/tools/lib/all-tools.js
@@ -8,7 +8,8 @@ export const allTools = {
desktop: 'Desktop',
importer_cli: 'GitHub Enterprise Importer CLI',
javascript: 'JavaScript',
- jetbrains: 'JetBrains IDEs (Beta)',
+ jetbrains: 'JetBrains IDEs',
+ jetbrains_beta: 'JetBrains IDEs (Beta)',
vimneovim: 'Vim/Neovim',
powershell: 'PowerShell',
visualstudio: 'Visual Studio',
diff --git a/src/webhooks/components/WebhookPayloadExample.module.scss b/src/webhooks/components/WebhookPayloadExample.module.scss
index f8dc9c2ccf23..cbadfb17814d 100644
--- a/src/webhooks/components/WebhookPayloadExample.module.scss
+++ b/src/webhooks/components/WebhookPayloadExample.module.scss
@@ -1,4 +1,5 @@
-@import "@primer/css/support/index.scss";
+@import "@primer/css/support/variables/layout.scss";
+@import "@primer/css/support/mixins/layout.scss";
.payloadExample {
margin-bottom: 1rem;
diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json
index aff46a8a775c..7cb7839b8e8b 100644
--- a/src/webhooks/data/fpt/schema.json
+++ b/src/webhooks/data/fpt/schema.json
@@ -2,7 +2,7 @@
"branch_protection_rule": {
"created": {
"descriptionHtml": "<p>A branch protection rule was created.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -9437,7 +9437,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -10335,7 +10335,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -11231,7 +11231,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -14340,7 +14340,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/repos#get-a-commit-comment\">commit comment</a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/commits/comments#get-a-commit-comment\">commit comment</a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -18939,7 +18939,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -19061,7 +19061,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -19171,7 +19171,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -30006,7 +30006,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -30736,7 +30736,7 @@
"type": "object",
"name": "deployment_status",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/deployments#list-deployment-statuses\">deployment status</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/deployments/statuses#list-deployment-statuses\">deployment status</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -46477,7 +46477,7 @@
"installation": {
"created": {
"descriptionHtml": "<p>Someone installed a GitHub App on a user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -46694,7 +46694,7 @@
},
"deleted": {
"descriptionHtml": "<p>Someone uninstalled a GitHub App from their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -46797,7 +46797,7 @@
},
"new_permissions_accepted": {
"descriptionHtml": "<p>Someone granted new permissions to a GitHub App.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -46900,7 +46900,7 @@
},
"suspend": {
"descriptionHtml": "<p>Someone blocked access by a GitHub App to their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -47003,7 +47003,7 @@
},
"unsuspend": {
"descriptionHtml": "<p>A GitHub App that was blocked from accessing a user or organization account was given access the account again.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -47108,7 +47108,7 @@
"installation_repositories": {
"added": {
"descriptionHtml": "<p>A GitHub App installation was granted access to one or more repositories.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -47372,7 +47372,7 @@
},
"removed": {
"descriptionHtml": "<p>Access to one or more repositories was revoked for a GitHub App installation.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -47641,9 +47641,9 @@
}
},
"installation_target": {
- "default": {
+ "renamed": {
"descriptionHtml": "<p>Somebody renamed the user or organization account that a GitHub App is installed on.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "object",
@@ -47844,6 +47844,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "renamed"
+ ],
"childParamsGroups": []
},
{
@@ -47928,7 +47931,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "renamed",
"category": "installation_target"
}
},
@@ -47952,7 +47955,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -48483,7 +48486,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -48537,7 +48540,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -49069,7 +49072,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -49145,7 +49148,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -49677,7 +49680,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -49867,7 +49870,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -51212,7 +51215,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true
},
{
@@ -51280,7 +51283,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -52947,7 +52950,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -54342,7 +54345,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -56088,7 +56091,7 @@
{
"type": "object or null",
"name": "old_issue",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -58102,7 +58105,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -59445,7 +59448,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -60846,7 +60849,7 @@
{
"type": "object",
"name": "new_issue",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -62872,7 +62875,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -64334,7 +64337,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -65679,7 +65682,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -67142,7 +67145,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -70891,7 +70894,7 @@
},
"removed": {
"descriptionHtml": "<p>An organization member was removed from a team.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the API to manage team memberships, see <a href=\"https://docs.github.com/graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the APIs to manage team memberships, see <a href=\"https://docs.github.com/graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -71579,10 +71582,10 @@
"category": "merge_group"
}
},
- "merge_queue_entry": {
- "default": {
- "descriptionHtml": "<p>A pull request was removed from a merge queue.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"<a href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request\">Automatically merging a pull request</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in limited private beta and subject to change.</p>",
+ "meta": {
+ "deleted": {
+ "descriptionHtml": "<p>The webhook was deleted.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -71590,6 +71593,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "deleted"
+ ],
"childParamsGroups": []
},
{
@@ -71601,39 +71607,64 @@
},
{
"type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "merge_queue",
+ "name": "hook",
"in": "body",
- "description": "",
+ "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
"isRequired": true,
"childParamsGroups": [
{
- "type": "integer",
- "name": "id",
+ "type": "boolean",
+ "name": "active",
"description": "",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "config",
+ "description": "",
+ "isRequired": true,
+ "childParamsGroups": [
+ {
+ "type": "string",
+ "name": "content_type",
+ "description": "",
+ "isRequired": true,
+ "enum": [
+ "json",
+ "form"
+ ]
+ },
+ {
+ "type": "string",
+ "name": "insecure_ssl",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "secret",
+ "description": ""
+ },
+ {
+ "type": "string",
+ "name": "url",
+ "description": "",
+ "isRequired": true
+ }
+ ]
+ },
{
"type": "string",
- "name": "node_id",
+ "name": "created_at",
"description": "",
"isRequired": true
- }
- ]
- },
- {
- "type": "object or null",
- "name": "merge_queue_entry",
- "in": "body",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
+ },
+ {
+ "type": "array of strings",
+ "name": "events",
+ "description": "",
+ "isRequired": true
+ },
{
"type": "integer",
"name": "id",
@@ -71641,26 +71672,39 @@
"isRequired": true
},
{
- "type": "boolean",
- "name": "is_solo",
+ "type": "string",
+ "name": "name",
"description": "",
"isRequired": true
},
{
"type": "string",
- "name": "node_id",
+ "name": "type",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "updated_at",
"description": "",
"isRequired": true
}
]
},
{
- "type": "string or null",
- "name": "message",
+ "type": "integer",
+ "name": "hook_id",
"in": "body",
- "description": "",
+ "description": "<p>The id of the modified webhook.</p>",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
{
"type": "object",
"name": "organization",
@@ -71670,3294 +71714,88 @@
},
{
"type": "object",
- "name": "pull_request",
+ "name": "repository",
+ "in": "body",
+ "description": "<p>A repository on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "sender",
+ "in": "body",
+ "description": "<p>A GitHub user.</p>",
+ "childParamsGroups": []
+ }
+ ],
+ "availability": [
+ "marketplace",
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ],
+ "action": "deleted",
+ "category": "meta"
+ }
+ },
+ "milestone": {
+ "closed": {
+ "descriptionHtml": "<p>A milestone was closed.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "name": "action",
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "closed"
+ ],
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "enterprise",
+ "in": "body",
+ "description": "<p>An enterprise on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "milestone",
+ "in": "body",
+ "description": "<p>A collection of related issues and pull requests.</p>",
+ "isRequired": true,
"childParamsGroups": [
{
- "type": "object",
- "name": "_links",
+ "type": "string or null",
+ "name": "closed_at",
"description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "object",
- "name": "comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "commits",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "html",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "issue",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comment",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "self",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "statuses",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- }
- ]
+ "isRequired": true
},
{
- "type": "string or null",
- "name": "active_lock_reason",
+ "type": "integer",
+ "name": "closed_issues",
"description": "",
- "isRequired": true,
- "enum": [
- "resolved",
- "off-topic",
- "too heated",
- "spam",
- null
- ]
+ "isRequired": true
},
{
- "type": "integer",
- "name": "additions",
- "description": ""
+ "type": "string",
+ "name": "created_at",
+ "description": "",
+ "isRequired": true
},
{
"type": "object or null",
- "name": "assignee",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "array of object,nulls",
- "name": "assignees",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "author_association",
- "description": "<p>How the author is associated with the repository.</p>",
- "isRequired": true,
- "enum": [
- "COLLABORATOR",
- "CONTRIBUTOR",
- "FIRST_TIMER",
- "FIRST_TIME_CONTRIBUTOR",
- "MANNEQUIN",
- "MEMBER",
- "NONE",
- "OWNER"
- ]
- },
- {
- "type": "object or null",
- "name": "auto_merge",
- "description": "<p>The status of auto merging a pull request.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "commit_message",
- "description": "<p>Commit message for the merge commit.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commit_title",
- "description": "<p>Title for the merge commit message.</p>",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "enabled_by",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string",
- "name": "merge_method",
- "description": "<p>The merge method to use.</p>",
- "isRequired": true,
- "enum": [
- "merge",
- "squash",
- "rebase"
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "base",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string or null",
- "name": "body",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "changed_files",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "commits",
- "description": ""
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "deletions",
- "description": ""
- },
- {
- "type": "string",
- "name": "diff_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "draft",
- "description": "<p>Indicates whether or not the pull request is a draft.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "head",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "labels",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "color",
- "description": "<p>6-character hex code, without the leading #, identifying the color</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "default",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the label.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the label</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "boolean",
- "name": "locked",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintainer_can_modify",
- "description": "<p>Indicates whether maintainers can modify the pull request.</p>"
- },
- {
- "type": "string or null",
- "name": "merge_commit_sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "mergeable",
- "description": ""
- },
- {
- "type": "string",
- "name": "mergeable_state",
- "description": ""
- },
- {
- "type": "boolean or null",
- "name": "merged",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "merged_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "merged_by",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object or null",
- "name": "milestone",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "due_on",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>The number of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>The state of the milestone.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>Number uniquely identifying the pull request within its repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "patch_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "rebaseable",
- "description": ""
- },
- {
- "type": "array",
- "name": "requested_reviewers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "requested_teams",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>"
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "parent",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "isRequired": true,
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "slug",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>"
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "slug",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "review_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "review_comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "review_comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>State of this Pull Request. Either <code>open</code> or <code>closed</code>.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the pull request.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "app"
- ],
- "action": "default",
- "category": "merge_queue_entry"
- }
- },
- "meta": {
- "deleted": {
- "descriptionHtml": "<p>The webhook was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "deleted"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "hook",
- "in": "body",
- "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "active",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "config",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "content_type",
- "description": "",
- "isRequired": true,
- "enum": [
- "json",
- "form"
- ]
- },
- {
- "type": "string",
- "name": "insecure_ssl",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "secret",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "events",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "integer",
- "name": "hook_id",
- "in": "body",
- "description": "<p>The id of the modified webhook.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "organization",
- "in": "body",
- "description": "<p>A GitHub organization.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "marketplace",
- "business",
- "repository",
- "organization",
- "app"
- ],
- "action": "deleted",
- "category": "meta"
- }
- },
- "milestone": {
- "closed": {
- "descriptionHtml": "<p>A milestone was closed.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "closed"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "milestone",
- "in": "body",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
+ "name": "creator",
"description": "",
"isRequired": true,
"childParamsGroups": [
@@ -79963,7 +76801,7 @@
"type": "object",
"name": "build",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/repos#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/pages/pages#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -119234,7 +116072,7 @@
},
"reopened": {
"descriptionHtml": "<p>A previously closed pull request was reopened.</p>",
- "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -139354,7 +136192,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -142796,7 +139634,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -146259,7 +143097,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -159386,7 +156224,7 @@
"pull_request_review_thread": {
"resolved": {
"descriptionHtml": "<p>A comment thread on a pull request was marked as resolved.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request review comment threads, see <a href=\"https://docs.github.com/graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/pulls/reviews\">Pull request reviews</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request reviews, see <a href=\"https://docs.github.com/graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/pulls/comments\">Pull request review comments</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -166124,7 +162962,7 @@
"push": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when a commit or tag is pushed.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
+ "summaryHtml": "<p>This event occurs when a commit or tag is pushed, or when a repository is cloned.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
"bodyParameters": [
{
"type": "string",
@@ -166151,7 +162989,7 @@
"type": "array of objects",
"name": "commits",
"in": "body",
- "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/rest/reference/repos#commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
+ "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/rest/commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -167550,9 +164388,9 @@
"action": "published",
"category": "registry_package"
},
- "default": {
+ "updated": {
"descriptionHtml": "<p>A package that was previously published to a registry was updated.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead.</p>",
"bodyParameters": [
{
"type": "string",
@@ -167560,6 +164398,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "updated"
+ ],
"childParamsGroups": []
},
{
@@ -168338,7 +165179,7 @@
"organization",
"app"
],
- "action": "default",
+ "action": "updated",
"category": "registry_package"
}
},
@@ -168383,7 +165224,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -168905,7 +165746,7 @@
},
"deleted": {
"descriptionHtml": "<p>A release, pre-release, or draft release was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -168943,7 +165784,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -169465,7 +166306,7 @@
},
"edited": {
"descriptionHtml": "<p>The details of a release, pre-release, or draft release were edited. For more information, see \"<a href=\"https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release\">Managing releases in a repository</a>.\"</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -169551,7 +166392,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -170072,7 +166913,7 @@
},
"prereleased": {
"descriptionHtml": "<p>A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -170139,7 +166980,7 @@
},
"published": {
"descriptionHtml": "<p>A release, pre-release, or draft of a release was published.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -170206,7 +167047,7 @@
},
"released": {
"descriptionHtml": "<p>A release was published, or a pre-release was changed to a release.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -170244,7 +167085,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -170765,7 +167606,7 @@
},
"unpublished": {
"descriptionHtml": "<p>A release or pre-release was unpublished.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -173415,7 +170256,7 @@
}
},
"repository_dispatch": {
- "default": {
+ "sample.collected": {
"descriptionHtml": "<p>The <code>event_type</code> that was specified in the <code>POST /repos/{owner}/{repo}/dispatches</code> request body.</p>",
"summaryHtml": "<p>This event occurs when a GitHub App sends a <code>POST</code> request to <code>/repos/{owner}/{repo}/dispatches</code>. For more information, see <a href=\"https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event\">the REST API documentation for creating a repository dispatch event</a>.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
@@ -173425,6 +170266,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "sample.collected"
+ ],
"childParamsGroups": []
},
{
@@ -173483,7 +170327,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "sample.collected",
"category": "repository_dispatch"
}
},
@@ -184094,7 +180938,7 @@
"status": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/rest/reference/commits#commit-statuses\">Statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/rest/commits/statuses\">Commit statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
"bodyParameters": [
{
"type": "string or null",
@@ -188163,7 +185007,7 @@
},
"waiting": {
"descriptionHtml": "<p>A job in a workflow run was created and is waiting for approvals.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a job in a GitHub Actions workflow.</p>\n<p>For more information, see \"<a href=\"https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow\">Using jobs in a workflow</a>.\" For information about the API to manage workflow jobs, see <a href=\"https://docs.github.com/rest/actions/workflow-jobs\">the REST API documentation</a>.</p>\n<p>For activity relating to a workflow run instead of a job in a workflow run, see the <code>workflow_run</code> event.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"<a href=\"https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow\">Using jobs in a workflow</a>.\" For information about the API to manage workflow jobs, see \"<a href=\"https://docs.github.com/rest/actions/workflow-jobs\">Workflow jobs</a>\" in the REST API documentation.</p>\n<p>For activity relating to a workflow run instead of a job in a workflow run, use the <code>workflow_run</code> event.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
diff --git a/src/webhooks/data/ghae/schema.json b/src/webhooks/data/ghae/schema.json
index da498ea5ba41..59a7d3ed5198 100644
--- a/src/webhooks/data/ghae/schema.json
+++ b/src/webhooks/data/ghae/schema.json
@@ -2,7 +2,7 @@
"branch_protection_rule": {
"created": {
"descriptionHtml": "<p>A branch protection rule was created.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -9437,7 +9437,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -10335,7 +10335,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -11231,7 +11231,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -14340,7 +14340,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-commit-comment\">commit comment</a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/commits/comments#get-a-commit-comment\">commit comment</a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -18939,7 +18939,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -19061,7 +19061,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -19171,7 +19171,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -30006,7 +30006,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -30736,7 +30736,7 @@
"type": "object",
"name": "deployment_status",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/deployments#list-deployment-statuses\">deployment status</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/deployments/statuses#list-deployment-statuses\">deployment status</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -45234,7 +45234,7 @@
"installation": {
"created": {
"descriptionHtml": "<p>Someone installed a GitHub App on a user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -45451,7 +45451,7 @@
},
"deleted": {
"descriptionHtml": "<p>Someone uninstalled a GitHub App from their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -45554,7 +45554,7 @@
},
"new_permissions_accepted": {
"descriptionHtml": "<p>Someone granted new permissions to a GitHub App.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -45657,7 +45657,7 @@
},
"suspend": {
"descriptionHtml": "<p>Someone blocked access by a GitHub App to their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -45760,7 +45760,7 @@
},
"unsuspend": {
"descriptionHtml": "<p>A GitHub App that was blocked from accessing a user or organization account was given access the account again.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -45865,7 +45865,7 @@
"installation_repositories": {
"added": {
"descriptionHtml": "<p>A GitHub App installation was granted access to one or more repositories.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -46129,7 +46129,7 @@
},
"removed": {
"descriptionHtml": "<p>Access to one or more repositories was revoked for a GitHub App installation.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -46398,9 +46398,9 @@
}
},
"installation_target": {
- "default": {
+ "renamed": {
"descriptionHtml": "<p>Somebody renamed the user or organization account that a GitHub App is installed on.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "object",
@@ -46601,6 +46601,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "renamed"
+ ],
"childParamsGroups": []
},
{
@@ -46685,7 +46688,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "renamed",
"category": "installation_target"
}
},
@@ -46709,7 +46712,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -47240,7 +47243,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -47294,7 +47297,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -47826,7 +47829,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -47902,7 +47905,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -48434,7 +48437,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -48624,7 +48627,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -49969,7 +49972,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true
},
{
@@ -50037,7 +50040,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -51704,7 +51707,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -53099,7 +53102,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -54845,7 +54848,7 @@
{
"type": "object or null",
"name": "old_issue",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -56859,7 +56862,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -58202,7 +58205,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -59603,7 +59606,7 @@
{
"type": "object",
"name": "new_issue",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -61629,7 +61632,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -63091,7 +63094,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -64436,7 +64439,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -65899,7 +65902,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -68576,7 +68579,7 @@
},
"removed": {
"descriptionHtml": "<p>An organization member was removed from a team.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the API to manage team memberships, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the APIs to manage team memberships, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -68941,10 +68944,10 @@
"category": "membership"
}
},
- "merge_queue_entry": {
- "default": {
- "descriptionHtml": "<p>A pull request was removed from a merge queue.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request\">Automatically merging a pull request</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in limited private beta and subject to change.</p>",
+ "meta": {
+ "deleted": {
+ "descriptionHtml": "<p>The webhook was deleted.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -68952,6 +68955,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "deleted"
+ ],
"childParamsGroups": []
},
{
@@ -68963,39 +68969,64 @@
},
{
"type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "merge_queue",
+ "name": "hook",
"in": "body",
- "description": "",
+ "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
"isRequired": true,
"childParamsGroups": [
{
- "type": "integer",
- "name": "id",
+ "type": "boolean",
+ "name": "active",
"description": "",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "config",
+ "description": "",
+ "isRequired": true,
+ "childParamsGroups": [
+ {
+ "type": "string",
+ "name": "content_type",
+ "description": "",
+ "isRequired": true,
+ "enum": [
+ "json",
+ "form"
+ ]
+ },
+ {
+ "type": "string",
+ "name": "insecure_ssl",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "secret",
+ "description": ""
+ },
+ {
+ "type": "string",
+ "name": "url",
+ "description": "",
+ "isRequired": true
+ }
+ ]
+ },
{
"type": "string",
- "name": "node_id",
+ "name": "created_at",
"description": "",
"isRequired": true
- }
- ]
- },
- {
- "type": "object or null",
- "name": "merge_queue_entry",
- "in": "body",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
+ },
+ {
+ "type": "array of strings",
+ "name": "events",
+ "description": "",
+ "isRequired": true
+ },
{
"type": "integer",
"name": "id",
@@ -69003,26 +69034,39 @@
"isRequired": true
},
{
- "type": "boolean",
- "name": "is_solo",
+ "type": "string",
+ "name": "name",
"description": "",
"isRequired": true
},
{
"type": "string",
- "name": "node_id",
+ "name": "type",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "updated_at",
"description": "",
"isRequired": true
}
]
},
{
- "type": "string or null",
- "name": "message",
+ "type": "integer",
+ "name": "hook_id",
"in": "body",
- "description": "",
+ "description": "<p>The id of the modified webhook.</p>",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
{
"type": "object",
"name": "organization",
@@ -69032,3294 +69076,88 @@
},
{
"type": "object",
- "name": "pull_request",
+ "name": "repository",
+ "in": "body",
+ "description": "<p>A repository on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "sender",
+ "in": "body",
+ "description": "<p>A GitHub user.</p>",
+ "childParamsGroups": []
+ }
+ ],
+ "availability": [
+ "marketplace",
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ],
+ "action": "deleted",
+ "category": "meta"
+ }
+ },
+ "milestone": {
+ "closed": {
+ "descriptionHtml": "<p>A milestone was closed.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "name": "action",
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "closed"
+ ],
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "enterprise",
+ "in": "body",
+ "description": "<p>An enterprise on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "milestone",
+ "in": "body",
+ "description": "<p>A collection of related issues and pull requests.</p>",
+ "isRequired": true,
"childParamsGroups": [
{
- "type": "object",
- "name": "_links",
+ "type": "string or null",
+ "name": "closed_at",
"description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "object",
- "name": "comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "commits",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "html",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "issue",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comment",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "self",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "statuses",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- }
- ]
+ "isRequired": true
},
{
- "type": "string or null",
- "name": "active_lock_reason",
+ "type": "integer",
+ "name": "closed_issues",
"description": "",
- "isRequired": true,
- "enum": [
- "resolved",
- "off-topic",
- "too heated",
- "spam",
- null
- ]
+ "isRequired": true
},
{
- "type": "integer",
- "name": "additions",
- "description": ""
+ "type": "string",
+ "name": "created_at",
+ "description": "",
+ "isRequired": true
},
{
"type": "object or null",
- "name": "assignee",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "array of object,nulls",
- "name": "assignees",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "author_association",
- "description": "<p>How the author is associated with the repository.</p>",
- "isRequired": true,
- "enum": [
- "COLLABORATOR",
- "CONTRIBUTOR",
- "FIRST_TIMER",
- "FIRST_TIME_CONTRIBUTOR",
- "MANNEQUIN",
- "MEMBER",
- "NONE",
- "OWNER"
- ]
- },
- {
- "type": "object or null",
- "name": "auto_merge",
- "description": "<p>The status of auto merging a pull request.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "commit_message",
- "description": "<p>Commit message for the merge commit.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commit_title",
- "description": "<p>Title for the merge commit message.</p>",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "enabled_by",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string",
- "name": "merge_method",
- "description": "<p>The merge method to use.</p>",
- "isRequired": true,
- "enum": [
- "merge",
- "squash",
- "rebase"
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "base",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string or null",
- "name": "body",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "changed_files",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "commits",
- "description": ""
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "deletions",
- "description": ""
- },
- {
- "type": "string",
- "name": "diff_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "draft",
- "description": "<p>Indicates whether or not the pull request is a draft.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "head",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "labels",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "color",
- "description": "<p>6-character hex code, without the leading #, identifying the color</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "default",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the label.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the label</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "boolean",
- "name": "locked",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintainer_can_modify",
- "description": "<p>Indicates whether maintainers can modify the pull request.</p>"
- },
- {
- "type": "string or null",
- "name": "merge_commit_sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "mergeable",
- "description": ""
- },
- {
- "type": "string",
- "name": "mergeable_state",
- "description": ""
- },
- {
- "type": "boolean or null",
- "name": "merged",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "merged_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "merged_by",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object or null",
- "name": "milestone",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "due_on",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>The number of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>The state of the milestone.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>Number uniquely identifying the pull request within its repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "patch_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "rebaseable",
- "description": ""
- },
- {
- "type": "array",
- "name": "requested_reviewers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "requested_teams",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>"
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "parent",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "isRequired": true,
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "slug",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>"
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "slug",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "review_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "review_comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "review_comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>State of this Pull Request. Either <code>open</code> or <code>closed</code>.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the pull request.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "app"
- ],
- "action": "default",
- "category": "merge_queue_entry"
- }
- },
- "meta": {
- "deleted": {
- "descriptionHtml": "<p>The webhook was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "deleted"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "hook",
- "in": "body",
- "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "active",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "config",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "content_type",
- "description": "",
- "isRequired": true,
- "enum": [
- "json",
- "form"
- ]
- },
- {
- "type": "string",
- "name": "insecure_ssl",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "secret",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "events",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "integer",
- "name": "hook_id",
- "in": "body",
- "description": "<p>The id of the modified webhook.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "organization",
- "in": "body",
- "description": "<p>A GitHub organization.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "marketplace",
- "business",
- "repository",
- "organization",
- "app"
- ],
- "action": "deleted",
- "category": "meta"
- }
- },
- "milestone": {
- "closed": {
- "descriptionHtml": "<p>A milestone was closed.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "closed"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "milestone",
- "in": "body",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
+ "name": "creator",
"description": "",
"isRequired": true,
"childParamsGroups": [
@@ -76959,7 +73797,7 @@
"type": "object",
"name": "build",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/pages/pages#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -106680,7 +103518,7 @@
},
"reopened": {
"descriptionHtml": "<p>A previously closed pull request was reopened.</p>",
- "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -126800,7 +123638,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -130242,7 +127080,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -133705,7 +130543,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -146832,7 +143670,7 @@
"pull_request_review_thread": {
"resolved": {
"descriptionHtml": "<p>A comment thread on a pull request was marked as resolved.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request review comment threads, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/pulls/reviews\">Pull request reviews</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request reviews, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/pulls/comments\">Pull request review comments</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -153570,7 +150408,7 @@
"push": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when a commit or tag is pushed.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
+ "summaryHtml": "<p>This event occurs when a commit or tag is pushed, or when a repository is cloned.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
"bodyParameters": [
{
"type": "string",
@@ -153597,7 +150435,7 @@
"type": "array of objects",
"name": "commits",
"in": "body",
- "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
+ "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/github-ae@latest/rest/commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -154996,9 +151834,9 @@
"action": "published",
"category": "registry_package"
},
- "default": {
+ "updated": {
"descriptionHtml": "<p>A package that was previously published to a registry was updated.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead.</p>",
"bodyParameters": [
{
"type": "string",
@@ -155006,6 +151844,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "updated"
+ ],
"childParamsGroups": []
},
{
@@ -155784,7 +152625,7 @@
"organization",
"app"
],
- "action": "default",
+ "action": "updated",
"category": "registry_package"
}
},
@@ -155829,7 +152670,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -156351,7 +153192,7 @@
},
"deleted": {
"descriptionHtml": "<p>A release, pre-release, or draft release was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -156389,7 +153230,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -156911,7 +153752,7 @@
},
"edited": {
"descriptionHtml": "<p>The details of a release, pre-release, or draft release were edited. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release\">Managing releases in a repository</a>.\"</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -156984,7 +153825,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -157505,7 +154346,7 @@
},
"prereleased": {
"descriptionHtml": "<p>A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -157572,7 +154413,7 @@
},
"published": {
"descriptionHtml": "<p>A release, pre-release, or draft of a release was published.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -157639,7 +154480,7 @@
},
"released": {
"descriptionHtml": "<p>A release was published, or a pre-release was changed to a release.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -157677,7 +154518,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -158198,7 +155039,7 @@
},
"unpublished": {
"descriptionHtml": "<p>A release or pre-release was unpublished.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -159264,7 +156105,7 @@
}
},
"repository_dispatch": {
- "default": {
+ "sample.collected": {
"descriptionHtml": "<p>The <code>event_type</code> that was specified in the <code>POST /repos/{owner}/{repo}/dispatches</code> request body.</p>",
"summaryHtml": "<p>This event occurs when a GitHub App sends a <code>POST</code> request to <code>/repos/{owner}/{repo}/dispatches</code>. For more information, see <a href=\"https://docs.github.com/github-ae@latest/rest/repos/repos#create-a-repository-dispatch-event\">the REST API documentation for creating a repository dispatch event</a>.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
@@ -159274,6 +156115,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "sample.collected"
+ ],
"childParamsGroups": []
},
{
@@ -159332,7 +156176,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "sample.collected",
"category": "repository_dispatch"
}
},
@@ -164011,7 +160855,7 @@
"status": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/commits#commit-statuses\">Statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/github-ae@latest/graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/github-ae@latest/rest/commits/statuses\">Commit statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
"bodyParameters": [
{
"type": "string or null",
diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json
index 86f63a70f455..86eb50ede5ac 100644
--- a/src/webhooks/data/ghec/schema.json
+++ b/src/webhooks/data/ghec/schema.json
@@ -2,7 +2,7 @@
"branch_protection_rule": {
"created": {
"descriptionHtml": "<p>A branch protection rule was created.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -9437,7 +9437,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -10335,7 +10335,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -11231,7 +11231,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -14340,7 +14340,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#get-a-commit-comment\">commit comment</a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment\">commit comment</a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -18939,7 +18939,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -19061,7 +19061,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -19171,7 +19171,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -30006,7 +30006,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -30736,7 +30736,7 @@
"type": "object",
"name": "deployment_status",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/deployments#list-deployment-statuses\">deployment status</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses\">deployment status</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -46477,7 +46477,7 @@
"installation": {
"created": {
"descriptionHtml": "<p>Someone installed a GitHub App on a user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -46694,7 +46694,7 @@
},
"deleted": {
"descriptionHtml": "<p>Someone uninstalled a GitHub App from their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -46797,7 +46797,7 @@
},
"new_permissions_accepted": {
"descriptionHtml": "<p>Someone granted new permissions to a GitHub App.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -46900,7 +46900,7 @@
},
"suspend": {
"descriptionHtml": "<p>Someone blocked access by a GitHub App to their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -47003,7 +47003,7 @@
},
"unsuspend": {
"descriptionHtml": "<p>A GitHub App that was blocked from accessing a user or organization account was given access the account again.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -47108,7 +47108,7 @@
"installation_repositories": {
"added": {
"descriptionHtml": "<p>A GitHub App installation was granted access to one or more repositories.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -47372,7 +47372,7 @@
},
"removed": {
"descriptionHtml": "<p>Access to one or more repositories was revoked for a GitHub App installation.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -47641,9 +47641,9 @@
}
},
"installation_target": {
- "default": {
+ "renamed": {
"descriptionHtml": "<p>Somebody renamed the user or organization account that a GitHub App is installed on.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "object",
@@ -47844,6 +47844,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "renamed"
+ ],
"childParamsGroups": []
},
{
@@ -47928,7 +47931,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "renamed",
"category": "installation_target"
}
},
@@ -47952,7 +47955,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -48483,7 +48486,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -48537,7 +48540,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -49069,7 +49072,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -49145,7 +49148,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -49677,7 +49680,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -49867,7 +49870,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -51212,7 +51215,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true
},
{
@@ -51280,7 +51283,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -52947,7 +52950,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -54342,7 +54345,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -56088,7 +56091,7 @@
{
"type": "object or null",
"name": "old_issue",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -58102,7 +58105,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -59445,7 +59448,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -60846,7 +60849,7 @@
{
"type": "object",
"name": "new_issue",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -62872,7 +62875,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -64334,7 +64337,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -65679,7 +65682,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -67142,7 +67145,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -70891,7 +70894,7 @@
},
"removed": {
"descriptionHtml": "<p>An organization member was removed from a team.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the API to manage team memberships, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the APIs to manage team memberships, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -71579,10 +71582,10 @@
"category": "merge_group"
}
},
- "merge_queue_entry": {
- "default": {
- "descriptionHtml": "<p>A pull request was removed from a merge queue.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request\">Automatically merging a pull request</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in limited private beta and subject to change.</p>",
+ "meta": {
+ "deleted": {
+ "descriptionHtml": "<p>The webhook was deleted.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -71590,6 +71593,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "deleted"
+ ],
"childParamsGroups": []
},
{
@@ -71601,39 +71607,64 @@
},
{
"type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "merge_queue",
+ "name": "hook",
"in": "body",
- "description": "",
+ "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
"isRequired": true,
"childParamsGroups": [
{
- "type": "integer",
- "name": "id",
+ "type": "boolean",
+ "name": "active",
"description": "",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "config",
+ "description": "",
+ "isRequired": true,
+ "childParamsGroups": [
+ {
+ "type": "string",
+ "name": "content_type",
+ "description": "",
+ "isRequired": true,
+ "enum": [
+ "json",
+ "form"
+ ]
+ },
+ {
+ "type": "string",
+ "name": "insecure_ssl",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "secret",
+ "description": ""
+ },
+ {
+ "type": "string",
+ "name": "url",
+ "description": "",
+ "isRequired": true
+ }
+ ]
+ },
{
"type": "string",
- "name": "node_id",
+ "name": "created_at",
"description": "",
"isRequired": true
- }
- ]
- },
- {
- "type": "object or null",
- "name": "merge_queue_entry",
- "in": "body",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
+ },
+ {
+ "type": "array of strings",
+ "name": "events",
+ "description": "",
+ "isRequired": true
+ },
{
"type": "integer",
"name": "id",
@@ -71641,26 +71672,39 @@
"isRequired": true
},
{
- "type": "boolean",
- "name": "is_solo",
+ "type": "string",
+ "name": "name",
"description": "",
"isRequired": true
},
{
"type": "string",
- "name": "node_id",
+ "name": "type",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "updated_at",
"description": "",
"isRequired": true
}
]
},
{
- "type": "string or null",
- "name": "message",
+ "type": "integer",
+ "name": "hook_id",
"in": "body",
- "description": "",
+ "description": "<p>The id of the modified webhook.</p>",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
{
"type": "object",
"name": "organization",
@@ -71670,3294 +71714,88 @@
},
{
"type": "object",
- "name": "pull_request",
+ "name": "repository",
+ "in": "body",
+ "description": "<p>A repository on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "sender",
+ "in": "body",
+ "description": "<p>A GitHub user.</p>",
+ "childParamsGroups": []
+ }
+ ],
+ "availability": [
+ "marketplace",
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ],
+ "action": "deleted",
+ "category": "meta"
+ }
+ },
+ "milestone": {
+ "closed": {
+ "descriptionHtml": "<p>A milestone was closed.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "name": "action",
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "closed"
+ ],
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "enterprise",
+ "in": "body",
+ "description": "<p>An enterprise on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "milestone",
+ "in": "body",
+ "description": "<p>A collection of related issues and pull requests.</p>",
+ "isRequired": true,
"childParamsGroups": [
{
- "type": "object",
- "name": "_links",
+ "type": "string or null",
+ "name": "closed_at",
"description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "object",
- "name": "comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "commits",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "html",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "issue",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comment",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "self",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "statuses",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- }
- ]
+ "isRequired": true
},
{
- "type": "string or null",
- "name": "active_lock_reason",
+ "type": "integer",
+ "name": "closed_issues",
"description": "",
- "isRequired": true,
- "enum": [
- "resolved",
- "off-topic",
- "too heated",
- "spam",
- null
- ]
+ "isRequired": true
},
{
- "type": "integer",
- "name": "additions",
- "description": ""
+ "type": "string",
+ "name": "created_at",
+ "description": "",
+ "isRequired": true
},
{
"type": "object or null",
- "name": "assignee",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "array of object,nulls",
- "name": "assignees",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "author_association",
- "description": "<p>How the author is associated with the repository.</p>",
- "isRequired": true,
- "enum": [
- "COLLABORATOR",
- "CONTRIBUTOR",
- "FIRST_TIMER",
- "FIRST_TIME_CONTRIBUTOR",
- "MANNEQUIN",
- "MEMBER",
- "NONE",
- "OWNER"
- ]
- },
- {
- "type": "object or null",
- "name": "auto_merge",
- "description": "<p>The status of auto merging a pull request.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "commit_message",
- "description": "<p>Commit message for the merge commit.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commit_title",
- "description": "<p>Title for the merge commit message.</p>",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "enabled_by",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string",
- "name": "merge_method",
- "description": "<p>The merge method to use.</p>",
- "isRequired": true,
- "enum": [
- "merge",
- "squash",
- "rebase"
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "base",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string or null",
- "name": "body",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "changed_files",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "commits",
- "description": ""
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "deletions",
- "description": ""
- },
- {
- "type": "string",
- "name": "diff_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "draft",
- "description": "<p>Indicates whether or not the pull request is a draft.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "head",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "labels",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "color",
- "description": "<p>6-character hex code, without the leading #, identifying the color</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "default",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the label.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the label</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "boolean",
- "name": "locked",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintainer_can_modify",
- "description": "<p>Indicates whether maintainers can modify the pull request.</p>"
- },
- {
- "type": "string or null",
- "name": "merge_commit_sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "mergeable",
- "description": ""
- },
- {
- "type": "string",
- "name": "mergeable_state",
- "description": ""
- },
- {
- "type": "boolean or null",
- "name": "merged",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "merged_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "merged_by",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object or null",
- "name": "milestone",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "due_on",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>The number of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>The state of the milestone.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>Number uniquely identifying the pull request within its repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "patch_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "rebaseable",
- "description": ""
- },
- {
- "type": "array",
- "name": "requested_reviewers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "requested_teams",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>"
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "parent",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "isRequired": true,
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "slug",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>"
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "slug",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "review_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "review_comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "review_comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>State of this Pull Request. Either <code>open</code> or <code>closed</code>.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the pull request.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "app"
- ],
- "action": "default",
- "category": "merge_queue_entry"
- }
- },
- "meta": {
- "deleted": {
- "descriptionHtml": "<p>The webhook was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "deleted"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "hook",
- "in": "body",
- "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "active",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "config",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "content_type",
- "description": "",
- "isRequired": true,
- "enum": [
- "json",
- "form"
- ]
- },
- {
- "type": "string",
- "name": "insecure_ssl",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "secret",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "events",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "integer",
- "name": "hook_id",
- "in": "body",
- "description": "<p>The id of the modified webhook.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "organization",
- "in": "body",
- "description": "<p>A GitHub organization.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "marketplace",
- "business",
- "repository",
- "organization",
- "app"
- ],
- "action": "deleted",
- "category": "meta"
- }
- },
- "milestone": {
- "closed": {
- "descriptionHtml": "<p>A milestone was closed.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "closed"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "milestone",
- "in": "body",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
+ "name": "creator",
"description": "",
"isRequired": true,
"childParamsGroups": [
@@ -79963,7 +76801,7 @@
"type": "object",
"name": "build",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -119234,7 +116072,7 @@
},
"reopened": {
"descriptionHtml": "<p>A previously closed pull request was reopened.</p>",
- "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -139354,7 +136192,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -142796,7 +139634,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -146259,7 +143097,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -159386,7 +156224,7 @@
"pull_request_review_thread": {
"resolved": {
"descriptionHtml": "<p>A comment thread on a pull request was marked as resolved.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request review comment threads, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews\">Pull request reviews</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request reviews, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments\">Pull request review comments</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -166124,7 +162962,7 @@
"push": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when a commit or tag is pushed.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
+ "summaryHtml": "<p>This event occurs when a commit or tag is pushed, or when a repository is cloned.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
"bodyParameters": [
{
"type": "string",
@@ -166151,7 +162989,7 @@
"type": "array of objects",
"name": "commits",
"in": "body",
- "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
+ "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -167550,9 +164388,9 @@
"action": "published",
"category": "registry_package"
},
- "default": {
+ "updated": {
"descriptionHtml": "<p>A package that was previously published to a registry was updated.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead.</p>",
"bodyParameters": [
{
"type": "string",
@@ -167560,6 +164398,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "updated"
+ ],
"childParamsGroups": []
},
{
@@ -168338,7 +165179,7 @@
"organization",
"app"
],
- "action": "default",
+ "action": "updated",
"category": "registry_package"
}
},
@@ -168383,7 +165224,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -168905,7 +165746,7 @@
},
"deleted": {
"descriptionHtml": "<p>A release, pre-release, or draft release was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -168943,7 +165784,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -169465,7 +166306,7 @@
},
"edited": {
"descriptionHtml": "<p>The details of a release, pre-release, or draft release were edited. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release\">Managing releases in a repository</a>.\"</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -169551,7 +166392,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -170072,7 +166913,7 @@
},
"prereleased": {
"descriptionHtml": "<p>A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -170139,7 +166980,7 @@
},
"published": {
"descriptionHtml": "<p>A release, pre-release, or draft of a release was published.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -170206,7 +167047,7 @@
},
"released": {
"descriptionHtml": "<p>A release was published, or a pre-release was changed to a release.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -170244,7 +167085,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -170765,7 +167606,7 @@
},
"unpublished": {
"descriptionHtml": "<p>A release or pre-release was unpublished.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -173415,7 +170256,7 @@
}
},
"repository_dispatch": {
- "default": {
+ "sample.collected": {
"descriptionHtml": "<p>The <code>event_type</code> that was specified in the <code>POST /repos/{owner}/{repo}/dispatches</code> request body.</p>",
"summaryHtml": "<p>This event occurs when a GitHub App sends a <code>POST</code> request to <code>/repos/{owner}/{repo}/dispatches</code>. For more information, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event\">the REST API documentation for creating a repository dispatch event</a>.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
@@ -173425,6 +170266,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "sample.collected"
+ ],
"childParamsGroups": []
},
{
@@ -173483,7 +170327,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "sample.collected",
"category": "repository_dispatch"
}
},
@@ -184094,7 +180938,7 @@
"status": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/commits#commit-statuses\">Statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses\">Commit statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
"bodyParameters": [
{
"type": "string or null",
@@ -188163,7 +185007,7 @@
},
"waiting": {
"descriptionHtml": "<p>A job in a workflow run was created and is waiting for approvals.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a job in a GitHub Actions workflow.</p>\n<p>For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow\">Using jobs in a workflow</a>.\" For information about the API to manage workflow jobs, see <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs\">the REST API documentation</a>.</p>\n<p>For activity relating to a workflow run instead of a job in a workflow run, see the <code>workflow_run</code> event.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//actions/using-jobs/using-jobs-in-a-workflow\">Using jobs in a workflow</a>.\" For information about the API to manage workflow jobs, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-jobs\">Workflow jobs</a>\" in the REST API documentation.</p>\n<p>For activity relating to a workflow run instead of a job in a workflow run, use the <code>workflow_run</code> event.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
diff --git a/src/webhooks/data/ghes-3.10/schema.json b/src/webhooks/data/ghes-3.10/schema.json
index 821abdaaf1c7..2a6249c4f429 100644
--- a/src/webhooks/data/ghes-3.10/schema.json
+++ b/src/webhooks/data/ghes-3.10/schema.json
@@ -2,7 +2,7 @@
"branch_protection_rule": {
"created": {
"descriptionHtml": "<p>A branch protection rule was created.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -9515,7 +9515,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -10413,7 +10413,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -11309,7 +11309,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -14418,7 +14418,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#get-a-commit-comment\">commit comment</a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment\">commit comment</a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -17853,7 +17853,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -17975,7 +17975,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -18085,7 +18085,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -28920,7 +28920,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -29650,7 +29650,7 @@
"type": "object",
"name": "deployment_status",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/deployments#list-deployment-statuses\">deployment status</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/deployments/statuses#list-deployment-statuses\">deployment status</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -45451,7 +45451,7 @@
"installation": {
"created": {
"descriptionHtml": "<p>Someone installed a GitHub App on a user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -45668,7 +45668,7 @@
},
"deleted": {
"descriptionHtml": "<p>Someone uninstalled a GitHub App from their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -45771,7 +45771,7 @@
},
"new_permissions_accepted": {
"descriptionHtml": "<p>Someone granted new permissions to a GitHub App.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -45874,7 +45874,7 @@
},
"suspend": {
"descriptionHtml": "<p>Someone blocked access by a GitHub App to their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -45977,7 +45977,7 @@
},
"unsuspend": {
"descriptionHtml": "<p>A GitHub App that was blocked from accessing a user or organization account was given access the account again.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -46082,7 +46082,7 @@
"installation_repositories": {
"added": {
"descriptionHtml": "<p>A GitHub App installation was granted access to one or more repositories.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -46346,7 +46346,7 @@
},
"removed": {
"descriptionHtml": "<p>Access to one or more repositories was revoked for a GitHub App installation.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -46615,9 +46615,9 @@
}
},
"installation_target": {
- "default": {
+ "renamed": {
"descriptionHtml": "<p>Somebody renamed the user or organization account that a GitHub App is installed on.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "object",
@@ -46813,6 +46813,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "renamed"
+ ],
"childParamsGroups": []
},
{
@@ -46897,7 +46900,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "renamed",
"category": "installation_target"
}
},
@@ -46921,7 +46924,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -47452,7 +47455,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -47506,7 +47509,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -48038,7 +48041,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -48114,7 +48117,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -48646,7 +48649,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -48836,7 +48839,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -50181,7 +50184,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true
},
{
@@ -50249,7 +50252,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -51916,7 +51919,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -53311,7 +53314,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -55057,7 +55060,7 @@
{
"type": "object or null",
"name": "old_issue",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -57071,7 +57074,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -58414,7 +58417,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -59815,7 +59818,7 @@
{
"type": "object",
"name": "new_issue",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -61841,7 +61844,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -63303,7 +63306,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -64648,7 +64651,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -66111,7 +66114,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -68788,7 +68791,7 @@
},
"removed": {
"descriptionHtml": "<p>An organization member was removed from a team.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the API to manage team memberships, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the APIs to manage team memberships, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -69153,10 +69156,10 @@
"category": "membership"
}
},
- "merge_queue_entry": {
- "default": {
- "descriptionHtml": "<p>A pull request was removed from a merge queue.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request\">Automatically merging a pull request</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in limited private beta and subject to change.</p>",
+ "meta": {
+ "deleted": {
+ "descriptionHtml": "<p>The webhook was deleted.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -69164,6 +69167,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "deleted"
+ ],
"childParamsGroups": []
},
{
@@ -69175,39 +69181,64 @@
},
{
"type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "merge_queue",
+ "name": "hook",
"in": "body",
- "description": "",
+ "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
"isRequired": true,
"childParamsGroups": [
{
- "type": "integer",
- "name": "id",
+ "type": "boolean",
+ "name": "active",
"description": "",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "config",
+ "description": "",
+ "isRequired": true,
+ "childParamsGroups": [
+ {
+ "type": "string",
+ "name": "content_type",
+ "description": "",
+ "isRequired": true,
+ "enum": [
+ "json",
+ "form"
+ ]
+ },
+ {
+ "type": "string",
+ "name": "insecure_ssl",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "secret",
+ "description": ""
+ },
+ {
+ "type": "string",
+ "name": "url",
+ "description": "",
+ "isRequired": true
+ }
+ ]
+ },
{
"type": "string",
- "name": "node_id",
+ "name": "created_at",
"description": "",
"isRequired": true
- }
- ]
- },
- {
- "type": "object or null",
- "name": "merge_queue_entry",
- "in": "body",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
+ },
+ {
+ "type": "array of strings",
+ "name": "events",
+ "description": "",
+ "isRequired": true
+ },
{
"type": "integer",
"name": "id",
@@ -69215,26 +69246,39 @@
"isRequired": true
},
{
- "type": "boolean",
- "name": "is_solo",
+ "type": "string",
+ "name": "name",
"description": "",
"isRequired": true
},
{
"type": "string",
- "name": "node_id",
+ "name": "type",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "updated_at",
"description": "",
"isRequired": true
}
]
},
{
- "type": "string or null",
- "name": "message",
+ "type": "integer",
+ "name": "hook_id",
"in": "body",
- "description": "",
+ "description": "<p>The id of the modified webhook.</p>",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
{
"type": "object",
"name": "organization",
@@ -69244,3294 +69288,88 @@
},
{
"type": "object",
- "name": "pull_request",
+ "name": "repository",
+ "in": "body",
+ "description": "<p>A repository on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "sender",
+ "in": "body",
+ "description": "<p>A GitHub user.</p>",
+ "childParamsGroups": []
+ }
+ ],
+ "availability": [
+ "marketplace",
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ],
+ "action": "deleted",
+ "category": "meta"
+ }
+ },
+ "milestone": {
+ "closed": {
+ "descriptionHtml": "<p>A milestone was closed.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "name": "action",
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "closed"
+ ],
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "enterprise",
+ "in": "body",
+ "description": "<p>An enterprise on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "milestone",
+ "in": "body",
+ "description": "<p>A collection of related issues and pull requests.</p>",
+ "isRequired": true,
"childParamsGroups": [
{
- "type": "object",
- "name": "_links",
+ "type": "string or null",
+ "name": "closed_at",
"description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "object",
- "name": "comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "commits",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "html",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "issue",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comment",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "self",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "statuses",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- }
- ]
+ "isRequired": true
},
{
- "type": "string or null",
- "name": "active_lock_reason",
+ "type": "integer",
+ "name": "closed_issues",
"description": "",
- "isRequired": true,
- "enum": [
- "resolved",
- "off-topic",
- "too heated",
- "spam",
- null
- ]
+ "isRequired": true
},
{
- "type": "integer",
- "name": "additions",
- "description": ""
+ "type": "string",
+ "name": "created_at",
+ "description": "",
+ "isRequired": true
},
{
"type": "object or null",
- "name": "assignee",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "array of object,nulls",
- "name": "assignees",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "author_association",
- "description": "<p>How the author is associated with the repository.</p>",
- "isRequired": true,
- "enum": [
- "COLLABORATOR",
- "CONTRIBUTOR",
- "FIRST_TIMER",
- "FIRST_TIME_CONTRIBUTOR",
- "MANNEQUIN",
- "MEMBER",
- "NONE",
- "OWNER"
- ]
- },
- {
- "type": "object or null",
- "name": "auto_merge",
- "description": "<p>The status of auto merging a pull request.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "commit_message",
- "description": "<p>Commit message for the merge commit.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commit_title",
- "description": "<p>Title for the merge commit message.</p>",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "enabled_by",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string",
- "name": "merge_method",
- "description": "<p>The merge method to use.</p>",
- "isRequired": true,
- "enum": [
- "merge",
- "squash",
- "rebase"
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "base",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string or null",
- "name": "body",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "changed_files",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "commits",
- "description": ""
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "deletions",
- "description": ""
- },
- {
- "type": "string",
- "name": "diff_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "draft",
- "description": "<p>Indicates whether or not the pull request is a draft.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "head",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "labels",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "color",
- "description": "<p>6-character hex code, without the leading #, identifying the color</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "default",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the label.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the label</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "boolean",
- "name": "locked",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintainer_can_modify",
- "description": "<p>Indicates whether maintainers can modify the pull request.</p>"
- },
- {
- "type": "string or null",
- "name": "merge_commit_sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "mergeable",
- "description": ""
- },
- {
- "type": "string",
- "name": "mergeable_state",
- "description": ""
- },
- {
- "type": "boolean or null",
- "name": "merged",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "merged_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "merged_by",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object or null",
- "name": "milestone",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "due_on",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>The number of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>The state of the milestone.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>Number uniquely identifying the pull request within its repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "patch_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "rebaseable",
- "description": ""
- },
- {
- "type": "array",
- "name": "requested_reviewers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "requested_teams",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>"
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "parent",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "isRequired": true,
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "slug",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>"
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "slug",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "review_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "review_comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "review_comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>State of this Pull Request. Either <code>open</code> or <code>closed</code>.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the pull request.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "app"
- ],
- "action": "default",
- "category": "merge_queue_entry"
- }
- },
- "meta": {
- "deleted": {
- "descriptionHtml": "<p>The webhook was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "deleted"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "hook",
- "in": "body",
- "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "active",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "config",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "content_type",
- "description": "",
- "isRequired": true,
- "enum": [
- "json",
- "form"
- ]
- },
- {
- "type": "string",
- "name": "insecure_ssl",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "secret",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "events",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "integer",
- "name": "hook_id",
- "in": "body",
- "description": "<p>The id of the modified webhook.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "organization",
- "in": "body",
- "description": "<p>A GitHub organization.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "marketplace",
- "business",
- "repository",
- "organization",
- "app"
- ],
- "action": "deleted",
- "category": "meta"
- }
- },
- "milestone": {
- "closed": {
- "descriptionHtml": "<p>A milestone was closed.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "closed"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "milestone",
- "in": "body",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
+ "name": "creator",
"description": "",
"isRequired": true,
"childParamsGroups": [
@@ -77171,7 +74009,7 @@
"type": "object",
"name": "build",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/pages/pages#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -110011,7 +106849,7 @@
},
"reopened": {
"descriptionHtml": "<p>A previously closed pull request was reopened.</p>",
- "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -130131,7 +126969,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -133573,7 +130411,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -137036,7 +133874,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -150163,7 +147001,7 @@
"pull_request_review_thread": {
"resolved": {
"descriptionHtml": "<p>A comment thread on a pull request was marked as resolved.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request review comment threads, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews\">Pull request reviews</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request reviews, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/pulls/comments\">Pull request review comments</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -156901,7 +153739,7 @@
"push": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when a commit or tag is pushed.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
+ "summaryHtml": "<p>This event occurs when a commit or tag is pushed, or when a repository is cloned.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
"bodyParameters": [
{
"type": "string",
@@ -156928,7 +153766,7 @@
"type": "array of objects",
"name": "commits",
"in": "body",
- "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos#commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
+ "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/enterprise-server@3.10/rest/commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -158327,9 +155165,9 @@
"action": "published",
"category": "registry_package"
},
- "default": {
+ "updated": {
"descriptionHtml": "<p>A package that was previously published to a registry was updated.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead.</p>",
"bodyParameters": [
{
"type": "string",
@@ -158337,6 +155175,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "updated"
+ ],
"childParamsGroups": []
},
{
@@ -159115,7 +155956,7 @@
"organization",
"app"
],
- "action": "default",
+ "action": "updated",
"category": "registry_package"
}
},
@@ -159160,7 +156001,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -159682,7 +156523,7 @@
},
"deleted": {
"descriptionHtml": "<p>A release, pre-release, or draft release was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -159720,7 +156561,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -160242,7 +157083,7 @@
},
"edited": {
"descriptionHtml": "<p>The details of a release, pre-release, or draft release were edited. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release\">Managing releases in a repository</a>.\"</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -160328,7 +157169,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -160849,7 +157690,7 @@
},
"prereleased": {
"descriptionHtml": "<p>A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -160916,7 +157757,7 @@
},
"published": {
"descriptionHtml": "<p>A release, pre-release, or draft of a release was published.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -160983,7 +157824,7 @@
},
"released": {
"descriptionHtml": "<p>A release was published, or a pre-release was changed to a release.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -161021,7 +157862,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -161542,7 +158383,7 @@
},
"unpublished": {
"descriptionHtml": "<p>A release or pre-release was unpublished.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -162608,7 +159449,7 @@
}
},
"repository_dispatch": {
- "default": {
+ "sample.collected": {
"descriptionHtml": "<p>The <code>event_type</code> that was specified in the <code>POST /repos/{owner}/{repo}/dispatches</code> request body.</p>",
"summaryHtml": "<p>This event occurs when a GitHub App sends a <code>POST</code> request to <code>/repos/{owner}/{repo}/dispatches</code>. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-dispatch-event\">the REST API documentation for creating a repository dispatch event</a>.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
@@ -162618,6 +159459,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "sample.collected"
+ ],
"childParamsGroups": []
},
{
@@ -162676,7 +159520,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "sample.collected",
"category": "repository_dispatch"
}
},
@@ -169035,7 +165879,7 @@
"status": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/reference/commits#commit-statuses\">Statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/enterprise-server@3.10/graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/commits/statuses\">Commit statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
"bodyParameters": [
{
"type": "string or null",
@@ -173460,7 +170304,7 @@
},
"waiting": {
"descriptionHtml": "<p>A job in a workflow run was created and is waiting for approvals.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a job in a GitHub Actions workflow.</p>\n<p>For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/actions/using-jobs/using-jobs-in-a-workflow\">Using jobs in a workflow</a>.\" For information about the API to manage workflow jobs, see <a href=\"https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-jobs\">the REST API documentation</a>.</p>\n<p>For activity relating to a workflow run instead of a job in a workflow run, see the <code>workflow_run</code> event.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/actions/using-jobs/using-jobs-in-a-workflow\">Using jobs in a workflow</a>.\" For information about the API to manage workflow jobs, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-jobs\">Workflow jobs</a>\" in the REST API documentation.</p>\n<p>For activity relating to a workflow run instead of a job in a workflow run, use the <code>workflow_run</code> event.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
diff --git a/src/webhooks/data/ghes-3.7/schema.json b/src/webhooks/data/ghes-3.7/schema.json
index f32124f200a5..2cdc80db1b57 100644
--- a/src/webhooks/data/ghes-3.7/schema.json
+++ b/src/webhooks/data/ghes-3.7/schema.json
@@ -2,7 +2,7 @@
"branch_protection_rule": {
"created": {
"descriptionHtml": "<p>A branch protection rule was created.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -9216,7 +9216,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -10114,7 +10114,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -11010,7 +11010,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -14119,7 +14119,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#get-a-commit-comment\">commit comment</a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/commits/comments#get-a-commit-comment\">commit comment</a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -17554,7 +17554,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -17676,7 +17676,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -17786,7 +17786,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -24882,7 +24882,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -25612,7 +25612,7 @@
"type": "object",
"name": "deployment_status",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/deployments#list-deployment-statuses\">deployment status</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/deployments/statuses#list-deployment-statuses\">deployment status</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -40263,7 +40263,7 @@
"installation": {
"created": {
"descriptionHtml": "<p>Someone installed a GitHub App on a user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -40480,7 +40480,7 @@
},
"deleted": {
"descriptionHtml": "<p>Someone uninstalled a GitHub App from their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -40583,7 +40583,7 @@
},
"new_permissions_accepted": {
"descriptionHtml": "<p>Someone granted new permissions to a GitHub App.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -40686,7 +40686,7 @@
},
"suspend": {
"descriptionHtml": "<p>Someone blocked access by a GitHub App to their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -40789,7 +40789,7 @@
},
"unsuspend": {
"descriptionHtml": "<p>A GitHub App that was blocked from accessing a user or organization account was given access the account again.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -40894,7 +40894,7 @@
"installation_repositories": {
"added": {
"descriptionHtml": "<p>A GitHub App installation was granted access to one or more repositories.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -41158,7 +41158,7 @@
},
"removed": {
"descriptionHtml": "<p>Access to one or more repositories was revoked for a GitHub App installation.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -41427,9 +41427,9 @@
}
},
"installation_target": {
- "default": {
+ "renamed": {
"descriptionHtml": "<p>Somebody renamed the user or organization account that a GitHub App is installed on.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "object",
@@ -41625,6 +41625,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "renamed"
+ ],
"childParamsGroups": []
},
{
@@ -41709,7 +41712,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "renamed",
"category": "installation_target"
}
},
@@ -41733,7 +41736,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -42264,7 +42267,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -42318,7 +42321,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -42850,7 +42853,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -42926,7 +42929,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -43458,7 +43461,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -43648,7 +43651,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -44993,7 +44996,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true
},
{
@@ -45061,7 +45064,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -46728,7 +46731,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -48123,7 +48126,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -49869,7 +49872,7 @@
{
"type": "object or null",
"name": "old_issue",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -51883,7 +51886,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -53226,7 +53229,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -54627,7 +54630,7 @@
{
"type": "object",
"name": "new_issue",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -56653,7 +56656,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -58115,7 +58118,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -59460,7 +59463,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -60923,7 +60926,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -63581,7 +63584,7 @@
},
"removed": {
"descriptionHtml": "<p>An organization member was removed from a team.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the API to manage team memberships, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the APIs to manage team memberships, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -63927,10 +63930,10 @@
"category": "membership"
}
},
- "merge_queue_entry": {
- "default": {
- "descriptionHtml": "<p>A pull request was removed from a merge queue.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request\">Automatically merging a pull request</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in limited private beta and subject to change.</p>",
+ "meta": {
+ "deleted": {
+ "descriptionHtml": "<p>The webhook was deleted.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -63938,6 +63941,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "deleted"
+ ],
"childParamsGroups": []
},
{
@@ -63949,39 +63955,64 @@
},
{
"type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "merge_queue",
+ "name": "hook",
"in": "body",
- "description": "",
+ "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
"isRequired": true,
"childParamsGroups": [
{
- "type": "integer",
- "name": "id",
+ "type": "boolean",
+ "name": "active",
"description": "",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "config",
+ "description": "",
+ "isRequired": true,
+ "childParamsGroups": [
+ {
+ "type": "string",
+ "name": "content_type",
+ "description": "",
+ "isRequired": true,
+ "enum": [
+ "json",
+ "form"
+ ]
+ },
+ {
+ "type": "string",
+ "name": "insecure_ssl",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "secret",
+ "description": ""
+ },
+ {
+ "type": "string",
+ "name": "url",
+ "description": "",
+ "isRequired": true
+ }
+ ]
+ },
{
"type": "string",
- "name": "node_id",
+ "name": "created_at",
"description": "",
"isRequired": true
- }
- ]
- },
- {
- "type": "object or null",
- "name": "merge_queue_entry",
- "in": "body",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
+ },
+ {
+ "type": "array of strings",
+ "name": "events",
+ "description": "",
+ "isRequired": true
+ },
{
"type": "integer",
"name": "id",
@@ -63989,26 +64020,39 @@
"isRequired": true
},
{
- "type": "boolean",
- "name": "is_solo",
+ "type": "string",
+ "name": "name",
"description": "",
"isRequired": true
},
{
"type": "string",
- "name": "node_id",
+ "name": "type",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "updated_at",
"description": "",
"isRequired": true
}
]
},
{
- "type": "string or null",
- "name": "message",
+ "type": "integer",
+ "name": "hook_id",
"in": "body",
- "description": "",
+ "description": "<p>The id of the modified webhook.</p>",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
{
"type": "object",
"name": "organization",
@@ -64018,3294 +64062,88 @@
},
{
"type": "object",
- "name": "pull_request",
+ "name": "repository",
+ "in": "body",
+ "description": "<p>A repository on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "sender",
+ "in": "body",
+ "description": "<p>A GitHub user.</p>",
+ "childParamsGroups": []
+ }
+ ],
+ "availability": [
+ "marketplace",
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ],
+ "action": "deleted",
+ "category": "meta"
+ }
+ },
+ "milestone": {
+ "closed": {
+ "descriptionHtml": "<p>A milestone was closed.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "name": "action",
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "closed"
+ ],
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "enterprise",
+ "in": "body",
+ "description": "<p>An enterprise on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "milestone",
+ "in": "body",
+ "description": "<p>A collection of related issues and pull requests.</p>",
+ "isRequired": true,
"childParamsGroups": [
{
- "type": "object",
- "name": "_links",
+ "type": "string or null",
+ "name": "closed_at",
"description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "object",
- "name": "comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "commits",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "html",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "issue",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comment",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "self",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "statuses",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- }
- ]
+ "isRequired": true
},
{
- "type": "string or null",
- "name": "active_lock_reason",
+ "type": "integer",
+ "name": "closed_issues",
"description": "",
- "isRequired": true,
- "enum": [
- "resolved",
- "off-topic",
- "too heated",
- "spam",
- null
- ]
+ "isRequired": true
},
{
- "type": "integer",
- "name": "additions",
- "description": ""
+ "type": "string",
+ "name": "created_at",
+ "description": "",
+ "isRequired": true
},
{
"type": "object or null",
- "name": "assignee",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "array of object,nulls",
- "name": "assignees",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "author_association",
- "description": "<p>How the author is associated with the repository.</p>",
- "isRequired": true,
- "enum": [
- "COLLABORATOR",
- "CONTRIBUTOR",
- "FIRST_TIMER",
- "FIRST_TIME_CONTRIBUTOR",
- "MANNEQUIN",
- "MEMBER",
- "NONE",
- "OWNER"
- ]
- },
- {
- "type": "object or null",
- "name": "auto_merge",
- "description": "<p>The status of auto merging a pull request.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "commit_message",
- "description": "<p>Commit message for the merge commit.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commit_title",
- "description": "<p>Title for the merge commit message.</p>",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "enabled_by",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string",
- "name": "merge_method",
- "description": "<p>The merge method to use.</p>",
- "isRequired": true,
- "enum": [
- "merge",
- "squash",
- "rebase"
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "base",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string or null",
- "name": "body",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "changed_files",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "commits",
- "description": ""
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "deletions",
- "description": ""
- },
- {
- "type": "string",
- "name": "diff_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "draft",
- "description": "<p>Indicates whether or not the pull request is a draft.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "head",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "labels",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "color",
- "description": "<p>6-character hex code, without the leading #, identifying the color</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "default",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the label.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the label</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "boolean",
- "name": "locked",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintainer_can_modify",
- "description": "<p>Indicates whether maintainers can modify the pull request.</p>"
- },
- {
- "type": "string or null",
- "name": "merge_commit_sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "mergeable",
- "description": ""
- },
- {
- "type": "string",
- "name": "mergeable_state",
- "description": ""
- },
- {
- "type": "boolean or null",
- "name": "merged",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "merged_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "merged_by",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object or null",
- "name": "milestone",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "due_on",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>The number of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>The state of the milestone.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>Number uniquely identifying the pull request within its repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "patch_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "rebaseable",
- "description": ""
- },
- {
- "type": "array",
- "name": "requested_reviewers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "requested_teams",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>"
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "parent",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "isRequired": true,
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "slug",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>"
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "slug",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "review_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "review_comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "review_comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>State of this Pull Request. Either <code>open</code> or <code>closed</code>.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the pull request.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "app"
- ],
- "action": "default",
- "category": "merge_queue_entry"
- }
- },
- "meta": {
- "deleted": {
- "descriptionHtml": "<p>The webhook was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "deleted"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "hook",
- "in": "body",
- "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "active",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "config",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "content_type",
- "description": "",
- "isRequired": true,
- "enum": [
- "json",
- "form"
- ]
- },
- {
- "type": "string",
- "name": "insecure_ssl",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "secret",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "events",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "integer",
- "name": "hook_id",
- "in": "body",
- "description": "<p>The id of the modified webhook.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "organization",
- "in": "body",
- "description": "<p>A GitHub organization.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "marketplace",
- "business",
- "repository",
- "organization",
- "app"
- ],
- "action": "deleted",
- "category": "meta"
- }
- },
- "milestone": {
- "closed": {
- "descriptionHtml": "<p>A milestone was closed.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "closed"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "milestone",
- "in": "body",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
+ "name": "creator",
"description": "",
"isRequired": true,
"childParamsGroups": [
@@ -71945,7 +68783,7 @@
"type": "object",
"name": "build",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/pages/pages#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -100779,7 +97617,7 @@
},
"reopened": {
"descriptionHtml": "<p>A previously closed pull request was reopened.</p>",
- "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -120899,7 +117737,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -124341,7 +121179,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -127804,7 +124642,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -140931,7 +137769,7 @@
"pull_request_review_thread": {
"resolved": {
"descriptionHtml": "<p>A comment thread on a pull request was marked as resolved.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request review comment threads, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/reviews\">Pull request reviews</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request reviews, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/pulls/comments\">Pull request review comments</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -147669,7 +144507,7 @@
"push": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when a commit or tag is pushed.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
+ "summaryHtml": "<p>This event occurs when a commit or tag is pushed, or when a repository is cloned.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
"bodyParameters": [
{
"type": "string",
@@ -147696,7 +144534,7 @@
"type": "array of objects",
"name": "commits",
"in": "body",
- "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
+ "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -149095,9 +145933,9 @@
"action": "published",
"category": "registry_package"
},
- "default": {
+ "updated": {
"descriptionHtml": "<p>A package that was previously published to a registry was updated.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead.</p>",
"bodyParameters": [
{
"type": "string",
@@ -149105,6 +145943,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "updated"
+ ],
"childParamsGroups": []
},
{
@@ -149883,7 +146724,7 @@
"organization",
"app"
],
- "action": "default",
+ "action": "updated",
"category": "registry_package"
}
},
@@ -149928,7 +146769,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -150450,7 +147291,7 @@
},
"deleted": {
"descriptionHtml": "<p>A release, pre-release, or draft release was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -150488,7 +147329,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -151010,7 +147851,7 @@
},
"edited": {
"descriptionHtml": "<p>The details of a release, pre-release, or draft release were edited. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release\">Managing releases in a repository</a>.\"</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -151083,7 +147924,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -151604,7 +148445,7 @@
},
"prereleased": {
"descriptionHtml": "<p>A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -151671,7 +148512,7 @@
},
"published": {
"descriptionHtml": "<p>A release, pre-release, or draft of a release was published.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -151738,7 +148579,7 @@
},
"released": {
"descriptionHtml": "<p>A release was published, or a pre-release was changed to a release.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -151776,7 +148617,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -152297,7 +149138,7 @@
},
"unpublished": {
"descriptionHtml": "<p>A release or pre-release was unpublished.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -153363,7 +150204,7 @@
}
},
"repository_dispatch": {
- "default": {
+ "sample.collected": {
"descriptionHtml": "<p>The <code>event_type</code> that was specified in the <code>POST /repos/{owner}/{repo}/dispatches</code> request body.</p>",
"summaryHtml": "<p>This event occurs when a GitHub App sends a <code>POST</code> request to <code>/repos/{owner}/{repo}/dispatches</code>. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.7/rest/repos/repos#create-a-repository-dispatch-event\">the REST API documentation for creating a repository dispatch event</a>.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
@@ -153373,6 +150214,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "sample.collected"
+ ],
"childParamsGroups": []
},
{
@@ -153431,7 +150275,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "sample.collected",
"category": "repository_dispatch"
}
},
@@ -159746,7 +156590,7 @@
"status": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/commits#commit-statuses\">Statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/enterprise-server@3.7/graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/commits/statuses\">Commit statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
"bodyParameters": [
{
"type": "string or null",
diff --git a/src/webhooks/data/ghes-3.8/schema.json b/src/webhooks/data/ghes-3.8/schema.json
index c894cdf7561e..7672909fcfd5 100644
--- a/src/webhooks/data/ghes-3.8/schema.json
+++ b/src/webhooks/data/ghes-3.8/schema.json
@@ -2,7 +2,7 @@
"branch_protection_rule": {
"created": {
"descriptionHtml": "<p>A branch protection rule was created.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -9216,7 +9216,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -10114,7 +10114,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -11010,7 +11010,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -14119,7 +14119,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#get-a-commit-comment\">commit comment</a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/commits/comments#get-a-commit-comment\">commit comment</a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -17554,7 +17554,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -17676,7 +17676,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -17786,7 +17786,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -24882,7 +24882,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -25612,7 +25612,7 @@
"type": "object",
"name": "deployment_status",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/deployments#list-deployment-statuses\">deployment status</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/deployments/statuses#list-deployment-statuses\">deployment status</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -40263,7 +40263,7 @@
"installation": {
"created": {
"descriptionHtml": "<p>Someone installed a GitHub App on a user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -40480,7 +40480,7 @@
},
"deleted": {
"descriptionHtml": "<p>Someone uninstalled a GitHub App from their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -40583,7 +40583,7 @@
},
"new_permissions_accepted": {
"descriptionHtml": "<p>Someone granted new permissions to a GitHub App.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -40686,7 +40686,7 @@
},
"suspend": {
"descriptionHtml": "<p>Someone blocked access by a GitHub App to their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -40789,7 +40789,7 @@
},
"unsuspend": {
"descriptionHtml": "<p>A GitHub App that was blocked from accessing a user or organization account was given access the account again.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -40894,7 +40894,7 @@
"installation_repositories": {
"added": {
"descriptionHtml": "<p>A GitHub App installation was granted access to one or more repositories.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -41158,7 +41158,7 @@
},
"removed": {
"descriptionHtml": "<p>Access to one or more repositories was revoked for a GitHub App installation.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -41427,9 +41427,9 @@
}
},
"installation_target": {
- "default": {
+ "renamed": {
"descriptionHtml": "<p>Somebody renamed the user or organization account that a GitHub App is installed on.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "object",
@@ -41625,6 +41625,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "renamed"
+ ],
"childParamsGroups": []
},
{
@@ -41709,7 +41712,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "renamed",
"category": "installation_target"
}
},
@@ -41733,7 +41736,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -42264,7 +42267,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -42318,7 +42321,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -42850,7 +42853,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -42926,7 +42929,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -43458,7 +43461,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -43648,7 +43651,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -44993,7 +44996,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true
},
{
@@ -45061,7 +45064,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -46728,7 +46731,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -48123,7 +48126,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -49869,7 +49872,7 @@
{
"type": "object or null",
"name": "old_issue",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -51883,7 +51886,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -53226,7 +53229,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -54627,7 +54630,7 @@
{
"type": "object",
"name": "new_issue",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -56653,7 +56656,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -58115,7 +58118,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -59460,7 +59463,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -60923,7 +60926,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -63581,7 +63584,7 @@
},
"removed": {
"descriptionHtml": "<p>An organization member was removed from a team.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the API to manage team memberships, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the APIs to manage team memberships, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -63927,10 +63930,10 @@
"category": "membership"
}
},
- "merge_queue_entry": {
- "default": {
- "descriptionHtml": "<p>A pull request was removed from a merge queue.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request\">Automatically merging a pull request</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in limited private beta and subject to change.</p>",
+ "meta": {
+ "deleted": {
+ "descriptionHtml": "<p>The webhook was deleted.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -63938,6 +63941,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "deleted"
+ ],
"childParamsGroups": []
},
{
@@ -63949,39 +63955,64 @@
},
{
"type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "merge_queue",
+ "name": "hook",
"in": "body",
- "description": "",
+ "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
"isRequired": true,
"childParamsGroups": [
{
- "type": "integer",
- "name": "id",
+ "type": "boolean",
+ "name": "active",
"description": "",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "config",
+ "description": "",
+ "isRequired": true,
+ "childParamsGroups": [
+ {
+ "type": "string",
+ "name": "content_type",
+ "description": "",
+ "isRequired": true,
+ "enum": [
+ "json",
+ "form"
+ ]
+ },
+ {
+ "type": "string",
+ "name": "insecure_ssl",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "secret",
+ "description": ""
+ },
+ {
+ "type": "string",
+ "name": "url",
+ "description": "",
+ "isRequired": true
+ }
+ ]
+ },
{
"type": "string",
- "name": "node_id",
+ "name": "created_at",
"description": "",
"isRequired": true
- }
- ]
- },
- {
- "type": "object or null",
- "name": "merge_queue_entry",
- "in": "body",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
+ },
+ {
+ "type": "array of strings",
+ "name": "events",
+ "description": "",
+ "isRequired": true
+ },
{
"type": "integer",
"name": "id",
@@ -63989,26 +64020,39 @@
"isRequired": true
},
{
- "type": "boolean",
- "name": "is_solo",
+ "type": "string",
+ "name": "name",
"description": "",
"isRequired": true
},
{
"type": "string",
- "name": "node_id",
+ "name": "type",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "updated_at",
"description": "",
"isRequired": true
}
]
},
{
- "type": "string or null",
- "name": "message",
+ "type": "integer",
+ "name": "hook_id",
"in": "body",
- "description": "",
+ "description": "<p>The id of the modified webhook.</p>",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
{
"type": "object",
"name": "organization",
@@ -64018,3294 +64062,88 @@
},
{
"type": "object",
- "name": "pull_request",
+ "name": "repository",
+ "in": "body",
+ "description": "<p>A repository on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "sender",
+ "in": "body",
+ "description": "<p>A GitHub user.</p>",
+ "childParamsGroups": []
+ }
+ ],
+ "availability": [
+ "marketplace",
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ],
+ "action": "deleted",
+ "category": "meta"
+ }
+ },
+ "milestone": {
+ "closed": {
+ "descriptionHtml": "<p>A milestone was closed.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "name": "action",
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "closed"
+ ],
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "enterprise",
+ "in": "body",
+ "description": "<p>An enterprise on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "milestone",
+ "in": "body",
+ "description": "<p>A collection of related issues and pull requests.</p>",
+ "isRequired": true,
"childParamsGroups": [
{
- "type": "object",
- "name": "_links",
+ "type": "string or null",
+ "name": "closed_at",
"description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "object",
- "name": "comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "commits",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "html",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "issue",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comment",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "self",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "statuses",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- }
- ]
+ "isRequired": true
},
{
- "type": "string or null",
- "name": "active_lock_reason",
+ "type": "integer",
+ "name": "closed_issues",
"description": "",
- "isRequired": true,
- "enum": [
- "resolved",
- "off-topic",
- "too heated",
- "spam",
- null
- ]
+ "isRequired": true
},
{
- "type": "integer",
- "name": "additions",
- "description": ""
+ "type": "string",
+ "name": "created_at",
+ "description": "",
+ "isRequired": true
},
{
"type": "object or null",
- "name": "assignee",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "array of object,nulls",
- "name": "assignees",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "author_association",
- "description": "<p>How the author is associated with the repository.</p>",
- "isRequired": true,
- "enum": [
- "COLLABORATOR",
- "CONTRIBUTOR",
- "FIRST_TIMER",
- "FIRST_TIME_CONTRIBUTOR",
- "MANNEQUIN",
- "MEMBER",
- "NONE",
- "OWNER"
- ]
- },
- {
- "type": "object or null",
- "name": "auto_merge",
- "description": "<p>The status of auto merging a pull request.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "commit_message",
- "description": "<p>Commit message for the merge commit.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commit_title",
- "description": "<p>Title for the merge commit message.</p>",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "enabled_by",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string",
- "name": "merge_method",
- "description": "<p>The merge method to use.</p>",
- "isRequired": true,
- "enum": [
- "merge",
- "squash",
- "rebase"
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "base",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string or null",
- "name": "body",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "changed_files",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "commits",
- "description": ""
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "deletions",
- "description": ""
- },
- {
- "type": "string",
- "name": "diff_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "draft",
- "description": "<p>Indicates whether or not the pull request is a draft.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "head",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "labels",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "color",
- "description": "<p>6-character hex code, without the leading #, identifying the color</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "default",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the label.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the label</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "boolean",
- "name": "locked",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintainer_can_modify",
- "description": "<p>Indicates whether maintainers can modify the pull request.</p>"
- },
- {
- "type": "string or null",
- "name": "merge_commit_sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "mergeable",
- "description": ""
- },
- {
- "type": "string",
- "name": "mergeable_state",
- "description": ""
- },
- {
- "type": "boolean or null",
- "name": "merged",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "merged_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "merged_by",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object or null",
- "name": "milestone",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "due_on",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>The number of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>The state of the milestone.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>Number uniquely identifying the pull request within its repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "patch_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "rebaseable",
- "description": ""
- },
- {
- "type": "array",
- "name": "requested_reviewers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "requested_teams",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>"
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "parent",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "isRequired": true,
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "slug",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>"
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "slug",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "review_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "review_comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "review_comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>State of this Pull Request. Either <code>open</code> or <code>closed</code>.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the pull request.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "app"
- ],
- "action": "default",
- "category": "merge_queue_entry"
- }
- },
- "meta": {
- "deleted": {
- "descriptionHtml": "<p>The webhook was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "deleted"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "hook",
- "in": "body",
- "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "active",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "config",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "content_type",
- "description": "",
- "isRequired": true,
- "enum": [
- "json",
- "form"
- ]
- },
- {
- "type": "string",
- "name": "insecure_ssl",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "secret",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "events",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "integer",
- "name": "hook_id",
- "in": "body",
- "description": "<p>The id of the modified webhook.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "organization",
- "in": "body",
- "description": "<p>A GitHub organization.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "marketplace",
- "business",
- "repository",
- "organization",
- "app"
- ],
- "action": "deleted",
- "category": "meta"
- }
- },
- "milestone": {
- "closed": {
- "descriptionHtml": "<p>A milestone was closed.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "closed"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "milestone",
- "in": "body",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
+ "name": "creator",
"description": "",
"isRequired": true,
"childParamsGroups": [
@@ -71945,7 +68783,7 @@
"type": "object",
"name": "build",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/pages/pages#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -100779,7 +97617,7 @@
},
"reopened": {
"descriptionHtml": "<p>A previously closed pull request was reopened.</p>",
- "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -120899,7 +117737,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -124341,7 +121179,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -127804,7 +124642,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -140931,7 +137769,7 @@
"pull_request_review_thread": {
"resolved": {
"descriptionHtml": "<p>A comment thread on a pull request was marked as resolved.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request review comment threads, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/reviews\">Pull request reviews</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request reviews, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/pulls/comments\">Pull request review comments</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -147669,7 +144507,7 @@
"push": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when a commit or tag is pushed.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
+ "summaryHtml": "<p>This event occurs when a commit or tag is pushed, or when a repository is cloned.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
"bodyParameters": [
{
"type": "string",
@@ -147696,7 +144534,7 @@
"type": "array of objects",
"name": "commits",
"in": "body",
- "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
+ "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -149095,9 +145933,9 @@
"action": "published",
"category": "registry_package"
},
- "default": {
+ "updated": {
"descriptionHtml": "<p>A package that was previously published to a registry was updated.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead.</p>",
"bodyParameters": [
{
"type": "string",
@@ -149105,6 +145943,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "updated"
+ ],
"childParamsGroups": []
},
{
@@ -149883,7 +146724,7 @@
"organization",
"app"
],
- "action": "default",
+ "action": "updated",
"category": "registry_package"
}
},
@@ -149928,7 +146769,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -150450,7 +147291,7 @@
},
"deleted": {
"descriptionHtml": "<p>A release, pre-release, or draft release was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -150488,7 +147329,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -151010,7 +147851,7 @@
},
"edited": {
"descriptionHtml": "<p>The details of a release, pre-release, or draft release were edited. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release\">Managing releases in a repository</a>.\"</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -151083,7 +147924,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -151604,7 +148445,7 @@
},
"prereleased": {
"descriptionHtml": "<p>A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -151671,7 +148512,7 @@
},
"published": {
"descriptionHtml": "<p>A release, pre-release, or draft of a release was published.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -151738,7 +148579,7 @@
},
"released": {
"descriptionHtml": "<p>A release was published, or a pre-release was changed to a release.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -151776,7 +148617,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -152297,7 +149138,7 @@
},
"unpublished": {
"descriptionHtml": "<p>A release or pre-release was unpublished.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -153363,7 +150204,7 @@
}
},
"repository_dispatch": {
- "default": {
+ "sample.collected": {
"descriptionHtml": "<p>The <code>event_type</code> that was specified in the <code>POST /repos/{owner}/{repo}/dispatches</code> request body.</p>",
"summaryHtml": "<p>This event occurs when a GitHub App sends a <code>POST</code> request to <code>/repos/{owner}/{repo}/dispatches</code>. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/repos/repos#create-a-repository-dispatch-event\">the REST API documentation for creating a repository dispatch event</a>.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
@@ -153373,6 +150214,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "sample.collected"
+ ],
"childParamsGroups": []
},
{
@@ -153431,7 +150275,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "sample.collected",
"category": "repository_dispatch"
}
},
@@ -159774,7 +156618,7 @@
"status": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/commits#commit-statuses\">Statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/commits/statuses\">Commit statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
"bodyParameters": [
{
"type": "string or null",
@@ -164072,7 +160916,7 @@
},
"waiting": {
"descriptionHtml": "<p>A job in a workflow run was created and is waiting for approvals.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a job in a GitHub Actions workflow.</p>\n<p>For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/actions/using-jobs/using-jobs-in-a-workflow\">Using jobs in a workflow</a>.\" For information about the API to manage workflow jobs, see <a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/workflow-jobs\">the REST API documentation</a>.</p>\n<p>For activity relating to a workflow run instead of a job in a workflow run, see the <code>workflow_run</code> event.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/actions/using-jobs/using-jobs-in-a-workflow\">Using jobs in a workflow</a>.\" For information about the API to manage workflow jobs, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/workflow-jobs\">Workflow jobs</a>\" in the REST API documentation.</p>\n<p>For activity relating to a workflow run instead of a job in a workflow run, use the <code>workflow_run</code> event.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
diff --git a/src/webhooks/data/ghes-3.9/schema.json b/src/webhooks/data/ghes-3.9/schema.json
index e82106fc8fab..7df02682bf12 100644
--- a/src/webhooks/data/ghes-3.9/schema.json
+++ b/src/webhooks/data/ghes-3.9/schema.json
@@ -2,7 +2,7 @@
"branch_protection_rule": {
"created": {
"descriptionHtml": "<p>A branch protection rule was created.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to branch protection rules. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches\">About protected branches</a>.\" For information about the APIs to manage branch protection rules, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#branchprotectionrule\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection\">Branch protection</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -9436,7 +9436,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -10334,7 +10334,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -11230,7 +11230,7 @@
"type": "object",
"name": "check_suite",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/checks#suites\">check_suite</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/checks/suites#get-a-check-suite\">check_suite</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -14339,7 +14339,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#get-a-commit-comment\">commit comment</a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment\">commit comment</a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -17774,7 +17774,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -17896,7 +17896,7 @@
"type": "object",
"name": "key",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/deployments#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/deploy-keys/deploy-keys#get-a-deploy-key\"><code>deploy key</code></a> resource.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -18006,7 +18006,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -25102,7 +25102,7 @@
"type": "object",
"name": "deployment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/deployments#list-deployments\">deployment</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments#list-deployments\">deployment</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -25832,7 +25832,7 @@
"type": "object",
"name": "deployment_status",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/deployments#list-deployment-statuses\">deployment status</a>.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/deployments/statuses#list-deployment-statuses\">deployment status</a>.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -41633,7 +41633,7 @@
"installation": {
"created": {
"descriptionHtml": "<p>Someone installed a GitHub App on a user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -41850,7 +41850,7 @@
},
"deleted": {
"descriptionHtml": "<p>Someone uninstalled a GitHub App from their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -41953,7 +41953,7 @@
},
"new_permissions_accepted": {
"descriptionHtml": "<p>Someone granted new permissions to a GitHub App.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -42056,7 +42056,7 @@
},
"suspend": {
"descriptionHtml": "<p>Someone blocked access by a GitHub App to their user or organization account.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -42159,7 +42159,7 @@
},
"unsuspend": {
"descriptionHtml": "<p>A GitHub App that was blocked from accessing a user or organization account was given access the account again.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -42264,7 +42264,7 @@
"installation_repositories": {
"added": {
"descriptionHtml": "<p>A GitHub App installation was granted access to one or more repositories.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -42528,7 +42528,7 @@
},
"removed": {
"descriptionHtml": "<p>Access to one or more repositories was revoked for a GitHub App installation.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.</p>\n<p>For more information about GitHub Apps, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "string",
@@ -42797,9 +42797,9 @@
}
},
"installation_target": {
- "default": {
+ "renamed": {
"descriptionHtml": "<p>Somebody renamed the user or organization account that a GitHub App is installed on.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/apps\">Apps</a>\" in the REST API documentation.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps\">About apps</a>.\" For information about the APIs to manage GitHub Apps, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/apps\">Apps</a>\" in the REST API documentation.</p>",
"bodyParameters": [
{
"type": "object",
@@ -42995,6 +42995,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "renamed"
+ ],
"childParamsGroups": []
},
{
@@ -43079,7 +43082,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "renamed",
"category": "installation_target"
}
},
@@ -43103,7 +43106,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -43634,7 +43637,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -43688,7 +43691,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -44220,7 +44223,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -44296,7 +44299,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -44828,7 +44831,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> the comment belongs to.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> the comment belongs to.</p>",
"isRequired": true
},
{
@@ -45018,7 +45021,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -46363,7 +46366,7 @@
"type": "",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true
},
{
@@ -46431,7 +46434,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -48098,7 +48101,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -49493,7 +49496,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -51239,7 +51242,7 @@
{
"type": "object or null",
"name": "old_issue",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -53253,7 +53256,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -54596,7 +54599,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -55997,7 +56000,7 @@
{
"type": "object",
"name": "new_issue",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -58023,7 +58026,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -59485,7 +59488,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -60830,7 +60833,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -62293,7 +62296,7 @@
"type": "object",
"name": "issue",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/issues\">issue</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue\">issue</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -64951,7 +64954,7 @@
},
"removed": {
"descriptionHtml": "<p>An organization member was removed from a team.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the API to manage team memberships, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to team membership. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams\">About teams</a>.\" For more information about the APIs to manage team memberships, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#team\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/teams/members\">Team members</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -65297,10 +65300,10 @@
"category": "membership"
}
},
- "merge_queue_entry": {
- "default": {
- "descriptionHtml": "<p>A pull request was removed from a merge queue.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a pull requests in a merge queue. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request\">Automatically merging a pull request</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in limited private beta and subject to change.</p>",
+ "meta": {
+ "deleted": {
+ "descriptionHtml": "<p>The webhook was deleted.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -65308,6 +65311,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "deleted"
+ ],
"childParamsGroups": []
},
{
@@ -65319,39 +65325,64 @@
},
{
"type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "merge_queue",
+ "name": "hook",
"in": "body",
- "description": "",
+ "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
"isRequired": true,
"childParamsGroups": [
{
- "type": "integer",
- "name": "id",
+ "type": "boolean",
+ "name": "active",
"description": "",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "config",
+ "description": "",
+ "isRequired": true,
+ "childParamsGroups": [
+ {
+ "type": "string",
+ "name": "content_type",
+ "description": "",
+ "isRequired": true,
+ "enum": [
+ "json",
+ "form"
+ ]
+ },
+ {
+ "type": "string",
+ "name": "insecure_ssl",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "secret",
+ "description": ""
+ },
+ {
+ "type": "string",
+ "name": "url",
+ "description": "",
+ "isRequired": true
+ }
+ ]
+ },
{
"type": "string",
- "name": "node_id",
+ "name": "created_at",
"description": "",
"isRequired": true
- }
- ]
- },
- {
- "type": "object or null",
- "name": "merge_queue_entry",
- "in": "body",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
+ },
+ {
+ "type": "array of strings",
+ "name": "events",
+ "description": "",
+ "isRequired": true
+ },
{
"type": "integer",
"name": "id",
@@ -65359,26 +65390,39 @@
"isRequired": true
},
{
- "type": "boolean",
- "name": "is_solo",
+ "type": "string",
+ "name": "name",
"description": "",
"isRequired": true
},
{
"type": "string",
- "name": "node_id",
+ "name": "type",
+ "description": "",
+ "isRequired": true
+ },
+ {
+ "type": "string",
+ "name": "updated_at",
"description": "",
"isRequired": true
}
]
},
{
- "type": "string or null",
- "name": "message",
+ "type": "integer",
+ "name": "hook_id",
"in": "body",
- "description": "",
+ "description": "<p>The id of the modified webhook.</p>",
"isRequired": true
},
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
{
"type": "object",
"name": "organization",
@@ -65388,3294 +65432,88 @@
},
{
"type": "object",
- "name": "pull_request",
+ "name": "repository",
+ "in": "body",
+ "description": "<p>A repository on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "sender",
+ "in": "body",
+ "description": "<p>A GitHub user.</p>",
+ "childParamsGroups": []
+ }
+ ],
+ "availability": [
+ "marketplace",
+ "business",
+ "repository",
+ "organization",
+ "app"
+ ],
+ "action": "deleted",
+ "category": "meta"
+ }
+ },
+ "milestone": {
+ "closed": {
+ "descriptionHtml": "<p>A milestone was closed.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
+ "bodyParameters": [
+ {
+ "type": "string",
+ "name": "action",
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "closed"
+ ],
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "enterprise",
+ "in": "body",
+ "description": "<p>An enterprise on GitHub.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "installation",
+ "in": "body",
+ "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
+ "childParamsGroups": []
+ },
+ {
+ "type": "object",
+ "name": "milestone",
+ "in": "body",
+ "description": "<p>A collection of related issues and pull requests.</p>",
+ "isRequired": true,
"childParamsGroups": [
{
- "type": "object",
- "name": "_links",
+ "type": "string or null",
+ "name": "closed_at",
"description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "object",
- "name": "comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "commits",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "html",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "issue",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comment",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "review_comments",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "self",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "object",
- "name": "statuses",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "href",
- "description": "",
- "isRequired": true
- }
- ]
- }
- ]
+ "isRequired": true
},
{
- "type": "string or null",
- "name": "active_lock_reason",
+ "type": "integer",
+ "name": "closed_issues",
"description": "",
- "isRequired": true,
- "enum": [
- "resolved",
- "off-topic",
- "too heated",
- "spam",
- null
- ]
+ "isRequired": true
},
{
- "type": "integer",
- "name": "additions",
- "description": ""
+ "type": "string",
+ "name": "created_at",
+ "description": "",
+ "isRequired": true
},
{
"type": "object or null",
- "name": "assignee",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "array of object,nulls",
- "name": "assignees",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "author_association",
- "description": "<p>How the author is associated with the repository.</p>",
- "isRequired": true,
- "enum": [
- "COLLABORATOR",
- "CONTRIBUTOR",
- "FIRST_TIMER",
- "FIRST_TIME_CONTRIBUTOR",
- "MANNEQUIN",
- "MEMBER",
- "NONE",
- "OWNER"
- ]
- },
- {
- "type": "object or null",
- "name": "auto_merge",
- "description": "<p>The status of auto merging a pull request.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "commit_message",
- "description": "<p>Commit message for the merge commit.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commit_title",
- "description": "<p>Title for the merge commit message.</p>",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "enabled_by",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string",
- "name": "merge_method",
- "description": "<p>The merge method to use.</p>",
- "isRequired": true,
- "enum": [
- "merge",
- "squash",
- "rebase"
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "base",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string or null",
- "name": "body",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "changed_files",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "commits",
- "description": ""
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "deletions",
- "description": ""
- },
- {
- "type": "string",
- "name": "diff_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "draft",
- "description": "<p>Indicates whether or not the pull request is a draft.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "head",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "label",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ref",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "repo",
- "description": "<p>A git repository</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "allow_auto_merge",
- "description": "<p>Whether to allow auto-merge for pull requests.</p>",
- "default": false
- },
- {
- "type": "boolean",
- "name": "allow_forking",
- "description": "<p>Whether to allow private forks</p>"
- },
- {
- "type": "boolean",
- "name": "allow_merge_commit",
- "description": "<p>Whether to allow merge commits for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_rebase_merge",
- "description": "<p>Whether to allow rebase merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_squash_merge",
- "description": "<p>Whether to allow squash merges for pull requests.</p>",
- "default": true
- },
- {
- "type": "boolean",
- "name": "allow_update_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "archive_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "archived",
- "description": "<p>Whether the repository is archived.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string",
- "name": "assignees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "blobs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "branches_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "clone_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "collaborators_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "compare_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contents_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "contributors_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer or string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "default_branch",
- "description": "<p>The default branch of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "delete_branch_on_merge",
- "description": "<p>Whether to delete head branches when pull requests are merged</p>",
- "default": false
- },
- {
- "type": "string",
- "name": "deployments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "disabled",
- "description": "<p>Returns whether or not this repository is disabled.</p>"
- },
- {
- "type": "string",
- "name": "downloads_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "fork",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "forks_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "forks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "full_name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_commits_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_refs_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "git_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_downloads",
- "description": "<p>Whether downloads are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_issues",
- "description": "<p>Whether issues are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_pages",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "has_projects",
- "description": "<p>Whether projects are enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_wiki",
- "description": "<p>Whether the wiki is enabled.</p>",
- "isRequired": true,
- "default": true
- },
- {
- "type": "boolean",
- "name": "has_discussions",
- "description": "<p>Whether discussions are enabled.</p>",
- "isRequired": true,
- "default": false
- },
- {
- "type": "string or null",
- "name": "homepage",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "hooks_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the repository</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "is_template",
- "description": ""
- },
- {
- "type": "string",
- "name": "issue_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_events_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issues_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "keys_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "language",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "languages_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "license",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "key",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "spdx_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "master_branch",
- "description": ""
- },
- {
- "type": "string",
- "name": "merges_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "milestones_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "mirror_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "notifications_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "organization",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "owner",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object",
- "name": "permissions",
- "description": "",
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "admin",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintain",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "pull",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "push",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "triage",
- "description": ""
- }
- ]
- },
- {
- "type": "boolean",
- "name": "private",
- "description": "<p>Whether the repository is private or public.</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "public",
- "description": ""
- },
- {
- "type": "string",
- "name": "pulls_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "null or integer or string",
- "name": "pushed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "releases_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "role_name",
- "description": ""
- },
- {
- "type": "integer",
- "name": "size",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "ssh_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "stargazers",
- "description": ""
- },
- {
- "type": "integer",
- "name": "stargazers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "stargazers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscribers_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "subscription_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "svn_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "tags_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "teams_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "topics",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "trees_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "visibility",
- "description": "",
- "isRequired": true,
- "enum": [
- "public",
- "private",
- "internal"
- ]
- },
- {
- "type": "integer",
- "name": "watchers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "watchers_count",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "web_commit_signoff_required",
- "description": "<p>Whether to require contributors to sign off on web-based commits</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "issue_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "labels",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "color",
- "description": "<p>6-character hex code, without the leading #, identifying the color</p>",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "default",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>The name of the label.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the label</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "boolean",
- "name": "locked",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean",
- "name": "maintainer_can_modify",
- "description": "<p>Indicates whether maintainers can modify the pull request.</p>"
- },
- {
- "type": "string or null",
- "name": "merge_commit_sha",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "mergeable",
- "description": ""
- },
- {
- "type": "string",
- "name": "mergeable_state",
- "description": ""
- },
- {
- "type": "boolean or null",
- "name": "merged",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "merged_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "merged_by",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "object or null",
- "name": "milestone",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string or null",
- "name": "due_on",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "labels_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>The number of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "open_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>The state of the milestone.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the milestone.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "number",
- "description": "<p>Number uniquely identifying the pull request within its repository.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "patch_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "boolean or null",
- "name": "rebaseable",
- "description": ""
- },
- {
- "type": "array",
- "name": "requested_reviewers",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of objects",
- "name": "requested_teams",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>"
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "object or null",
- "name": "parent",
- "description": "",
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "description",
- "description": "<p>Description of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "html_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "<p>Unique identifier of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "members_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "<p>Name of the team</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "node_id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "isRequired": true,
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "slug",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "permission",
- "description": "<p>Permission that the team will have for its repositories</p>"
- },
- {
- "type": "string",
- "name": "privacy",
- "description": "",
- "enum": [
- "open",
- "closed",
- "secret"
- ]
- },
- {
- "type": "string",
- "name": "repositories_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "slug",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "<p>URL for the team</p>"
- }
- ]
- },
- {
- "type": "string",
- "name": "review_comment_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "review_comments",
- "description": ""
- },
- {
- "type": "string",
- "name": "review_comments_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "state",
- "description": "<p>State of this Pull Request. Either <code>open</code> or <code>closed</code>.</p>",
- "isRequired": true,
- "enum": [
- "open",
- "closed"
- ]
- },
- {
- "type": "string",
- "name": "statuses_url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "title",
- "description": "<p>The title of the pull request.</p>",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "user",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "avatar_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "deleted",
- "description": ""
- },
- {
- "type": "string or null",
- "name": "email",
- "description": ""
- },
- {
- "type": "string",
- "name": "events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "followers_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "following_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gists_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "gravatar_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "html_url",
- "description": ""
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "login",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": ""
- },
- {
- "type": "string",
- "name": "node_id",
- "description": ""
- },
- {
- "type": "string",
- "name": "organizations_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "received_events_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "repos_url",
- "description": ""
- },
- {
- "type": "boolean",
- "name": "site_admin",
- "description": ""
- },
- {
- "type": "string",
- "name": "starred_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "subscriptions_url",
- "description": ""
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "enum": [
- "Bot",
- "User",
- "Organization"
- ]
- },
- {
- "type": "string",
- "name": "url",
- "description": ""
- }
- ]
- }
- ]
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "app"
- ],
- "action": "default",
- "category": "merge_queue_entry"
- }
- },
- "meta": {
- "deleted": {
- "descriptionHtml": "<p>The webhook was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a webhook itself.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Meta\" app permission.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "deleted"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "hook",
- "in": "body",
- "description": "<p>The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "boolean",
- "name": "active",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "config",
- "description": "",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string",
- "name": "content_type",
- "description": "",
- "isRequired": true,
- "enum": [
- "json",
- "form"
- ]
- },
- {
- "type": "string",
- "name": "insecure_ssl",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "secret",
- "description": ""
- },
- {
- "type": "string",
- "name": "url",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "array of strings",
- "name": "events",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "id",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "name",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "type",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "updated_at",
- "description": "",
- "isRequired": true
- }
- ]
- },
- {
- "type": "integer",
- "name": "hook_id",
- "in": "body",
- "description": "<p>The id of the modified webhook.</p>",
- "isRequired": true
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "organization",
- "in": "body",
- "description": "<p>A GitHub organization.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "repository",
- "in": "body",
- "description": "<p>A repository on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "sender",
- "in": "body",
- "description": "<p>A GitHub user.</p>",
- "childParamsGroups": []
- }
- ],
- "availability": [
- "marketplace",
- "business",
- "repository",
- "organization",
- "app"
- ],
- "action": "deleted",
- "category": "meta"
- }
- },
- "milestone": {
- "closed": {
- "descriptionHtml": "<p>A milestone was closed.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to milestones. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones\">About milestones</a>.\" For information about the APIs to manage milestones, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/issues/milestones\">Milestones</a>\" in the REST API documentation.</p>\n<p>If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the <code>milestoned</code> or <code>demilestoned</code> action type for the <code>issues</code> or <code>pull_request</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.</p>",
- "bodyParameters": [
- {
- "type": "string",
- "name": "action",
- "in": "body",
- "description": "",
- "isRequired": true,
- "enum": [
- "closed"
- ],
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "enterprise",
- "in": "body",
- "description": "<p>An enterprise on GitHub.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "installation",
- "in": "body",
- "description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
- "childParamsGroups": []
- },
- {
- "type": "object",
- "name": "milestone",
- "in": "body",
- "description": "<p>A collection of related issues and pull requests.</p>",
- "isRequired": true,
- "childParamsGroups": [
- {
- "type": "string or null",
- "name": "closed_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "integer",
- "name": "closed_issues",
- "description": "",
- "isRequired": true
- },
- {
- "type": "string",
- "name": "created_at",
- "description": "",
- "isRequired": true
- },
- {
- "type": "object or null",
- "name": "creator",
+ "name": "creator",
"description": "",
"isRequired": true,
"childParamsGroups": [
@@ -73315,7 +70153,7 @@
"type": "object",
"name": "build",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/pages/pages#list-github-pages-builds\">List GitHub Pages builds</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -104793,7 +101631,7 @@
},
"reopened": {
"descriptionHtml": "<p>A previously closed pull request was reopened.</p>",
- "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments,or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests\">About pull requests</a>.\" For information about the APIs to manage pull requests, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls\">Pulls</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the <code>pull_request_review</code>, <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review_thread</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -124913,7 +121751,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -128355,7 +125193,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -131818,7 +128656,7 @@
"type": "object",
"name": "comment",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/pulls#comments\">comment</a> itself.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">comment</a> itself.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -144945,7 +141783,7 @@
"pull_request_review_thread": {
"resolved": {
"descriptionHtml": "<p>A comment thread on a pull request was marked as resolved.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request review comment threads, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews\">Pull request reviews</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews\">About pull request reviews</a>.\" For information about the APIs to manage pull request reviews, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewthread\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/pulls/comments\">Pull request review comments</a>\" in the REST API documentation.</p>\n<p>For activity related to pull request review comments, pull request comments, or pull request reviews, use the <code>pull_request_review_comment</code>, <code>issue_comment</code>, or <code>pull_request_review</code> events instead.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -151683,7 +148521,7 @@
"push": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when a commit or tag is pushed.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
+ "summaryHtml": "<p>This event occurs when a commit or tag is pushed, or when a repository is cloned.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>\n<p><strong>Note</strong>: An event will not be created when more than three tags are pushed at once.</p>",
"bodyParameters": [
{
"type": "string",
@@ -151710,7 +148548,7 @@
"type": "array of objects",
"name": "commits",
"in": "body",
- "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
+ "description": "<p>An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the <code>compare</code> between the <code>before</code> commit and the <code>after</code> commit.) The array includes a maximum of 20 commits. If necessary, you can use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/commits\">Commits API</a> to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -153109,9 +149947,9 @@
"action": "published",
"category": "registry_package"
},
- "default": {
+ "updated": {
"descriptionHtml": "<p>A package that was previously published to a registry was updated.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to GitHub Packages. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages\">Introduction to GitHub Packages</a>.\" For information about the APIs to manage GitHub Packages, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/packages\">Packages</a>\" in the REST API documentation.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.</p>\n<p><strong>Note</strong>: GitHub recommends that you use the newer <code>package</code> event instead.</p>",
"bodyParameters": [
{
"type": "string",
@@ -153119,6 +149957,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "updated"
+ ],
"childParamsGroups": []
},
{
@@ -153897,7 +150738,7 @@
"organization",
"app"
],
- "action": "default",
+ "action": "updated",
"category": "registry_package"
}
},
@@ -153942,7 +150783,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -154464,7 +151305,7 @@
},
"deleted": {
"descriptionHtml": "<p>A release, pre-release, or draft release was deleted.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -154502,7 +151343,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -155024,7 +151865,7 @@
},
"edited": {
"descriptionHtml": "<p>The details of a release, pre-release, or draft release were edited. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release\">Managing releases in a repository</a>.\"</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -155110,7 +151951,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -155631,7 +152472,7 @@
},
"prereleased": {
"descriptionHtml": "<p>A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -155698,7 +152539,7 @@
},
"published": {
"descriptionHtml": "<p>A release, pre-release, or draft of a release was published.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -155765,7 +152606,7 @@
},
"released": {
"descriptionHtml": "<p>A release was published, or a pre-release was changed to a release.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -155803,7 +152644,7 @@
"type": "object",
"name": "release",
"in": "body",
- "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos/#get-a-release\">release</a> object.</p>",
+ "description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release\">release</a> object.</p>",
"isRequired": true,
"childParamsGroups": [
{
@@ -156324,7 +153165,7 @@
},
"unpublished": {
"descriptionHtml": "<p>A release or pre-release was unpublished.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/packages\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to releases. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases\">About releases</a>.\" For information about the APIs to manage releases, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release\">the GraphQL API documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/releases\">Releases</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
@@ -157390,7 +154231,7 @@
}
},
"repository_dispatch": {
- "default": {
+ "sample.collected": {
"descriptionHtml": "<p>The <code>event_type</code> that was specified in the <code>POST /repos/{owner}/{repo}/dispatches</code> request body.</p>",
"summaryHtml": "<p>This event occurs when a GitHub App sends a <code>POST</code> request to <code>/repos/{owner}/{repo}/dispatches</code>. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-dispatch-event\">the REST API documentation for creating a repository dispatch event</a>.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.</p>",
"bodyParameters": [
@@ -157400,6 +154241,9 @@
"in": "body",
"description": "",
"isRequired": true,
+ "enum": [
+ "sample.collected"
+ ],
"childParamsGroups": []
},
{
@@ -157458,7 +154302,7 @@
"availability": [
"app"
],
- "action": "default",
+ "action": "sample.collected",
"category": "repository_dispatch"
}
},
@@ -163801,7 +160645,7 @@
"status": {
"default": {
"descriptionHtml": "",
- "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/commits#commit-statuses\">Statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
+ "summaryHtml": "<p>This event occurs when the status of a Git commit changes. For example, commits can be marked as <code>error</code>, <code>failure</code>, <code>pending</code>, or <code>success</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks\">About status checks</a>.\" For information about the APIs to manage commit statuses, see <a href=\"https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#status\">the GraphQL documentation</a> or \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/commits/statuses\">Commit statuses</a>\" in the REST API documentation.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.</p>",
"bodyParameters": [
{
"type": "string or null",
@@ -168099,7 +164943,7 @@
},
"waiting": {
"descriptionHtml": "<p>A job in a workflow run was created and is waiting for approvals.</p>",
- "summaryHtml": "<p>This event occurs when there is activity relating to a job in a GitHub Actions workflow.</p>\n<p>For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow\">Using jobs in a workflow</a>.\" For information about the API to manage workflow jobs, see <a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs\">the REST API documentation</a>.</p>\n<p>For activity relating to a workflow run instead of a job in a workflow run, see the <code>workflow_run</code> event.</p>\n<p>To install this event on a GitHub App, the app must have at least read-level access for the Actions metadata permission.</p>",
+ "summaryHtml": "<p>This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow\">Using jobs in a workflow</a>.\" For information about the API to manage workflow jobs, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs\">Workflow jobs</a>\" in the REST API documentation.</p>\n<p>For activity relating to a workflow run instead of a job in a workflow run, use the <code>workflow_run</code> event.</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.</p>",
"bodyParameters": [
{
"type": "string",
diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json
index acefeb2865d0..6151ea40ffc2 100644
--- a/src/webhooks/lib/config.json
+++ b/src/webhooks/lib/config.json
@@ -1,3 +1,3 @@
{
- "sha": "45ba714d4fde4f522d5cad95427eea033423da8f"
+ "sha": "da33840287fe37f6173edf958b888e02ca2b4110"
}
\ No newline at end of file
diff --git a/tests/fixtures/article-with-redirect-from-string.md b/tests/fixtures/article-with-redirect-from-string.md
index b131c1284df8..79a3c7d9e3c3 100644
--- a/tests/fixtures/article-with-redirect-from-string.md
+++ b/tests/fixtures/article-with-redirect-from-string.md
@@ -1,5 +1,9 @@
---
title: Article with redirect_from string
-versions: '*'
+versions:
+ fpt: '*'
+ ghes: '*'
+ ghae: '*'
+ ghec: '*'
redirect_from: /redirect-string
---
diff --git a/tests/fixtures/content/early-access/index.md b/tests/fixtures/content/early-access/index.md
index 21a549b103c0..9279a1d6a7a7 100644
--- a/tests/fixtures/content/early-access/index.md
+++ b/tests/fixtures/content/early-access/index.md
@@ -1,7 +1,11 @@
---
title: Early Access documentation
hidden: true
-versions: '*'
+versions:
+ fpt: '*'
+ ghes: '*'
+ ghae: '*'
+ ghec: '*'
children:
- /secrets
---
diff --git a/tests/fixtures/content/early-access/secrets/deeper/index.md b/tests/fixtures/content/early-access/secrets/deeper/index.md
index 767020a471bb..9f804e9159ac 100644
--- a/tests/fixtures/content/early-access/secrets/deeper/index.md
+++ b/tests/fixtures/content/early-access/secrets/deeper/index.md
@@ -1,6 +1,10 @@
---
title: Deeper secrets
-versions: '*'
+versions:
+ fpt: '*'
+ ghes: '*'
+ ghae: '*'
+ ghec: '*'
hidden: true
children:
- /mariana-trench
diff --git a/tests/fixtures/content/early-access/secrets/deeper/mariana-trench.md b/tests/fixtures/content/early-access/secrets/deeper/mariana-trench.md
index 0f8ff8c531f1..9d07fc1aff83 100644
--- a/tests/fixtures/content/early-access/secrets/deeper/mariana-trench.md
+++ b/tests/fixtures/content/early-access/secrets/deeper/mariana-trench.md
@@ -1,6 +1,10 @@
---
title: Mariana Trench
-versions: '*'
+versions:
+ fpt: '*'
+ ghes: '*'
+ ghae: '*'
+ ghec: '*'
hidden: true
---
diff --git a/tests/fixtures/content/early-access/secrets/index.md b/tests/fixtures/content/early-access/secrets/index.md
index f0b3eb3dda8b..c95a719683a6 100644
--- a/tests/fixtures/content/early-access/secrets/index.md
+++ b/tests/fixtures/content/early-access/secrets/index.md
@@ -1,6 +1,10 @@
---
title: GitHub Secrets
-versions: '*'
+versions:
+ fpt: '*'
+ ghes: '*'
+ ghae: '*'
+ ghec: '*'
hidden: true
children:
- /early-days
diff --git a/tests/fixtures/content/index.md b/tests/fixtures/content/index.md
index 5821abe8f9a4..a8c0aecc86cf 100644
--- a/tests/fixtures/content/index.md
+++ b/tests/fixtures/content/index.md
@@ -12,7 +12,11 @@ featuredLinks:
- /actions/category/map-topic
redirect_from:
- /olden-days
-versions: '*'
+versions:
+ fpt: '*'
+ ghes: '*'
+ ghae: '*'
+ ghec: '*'
children:
# The list of childen in the fixtures has to be the same names
# as we use in the real content. It can have fewer but can't include
diff --git a/tests/fixtures/liquid-tags/bad-data-variable.md b/tests/fixtures/liquid-tags/bad-data-variable.md
index e2d66f64bde3..669c888d0c89 100644
--- a/tests/fixtures/liquid-tags/bad-data-variable.md
+++ b/tests/fixtures/liquid-tags/bad-data-variable.md
@@ -1,6 +1,10 @@
---
title: Sample page
-versions: '*'
+versions:
+ fpt: '*'
+ ghes: '*'
+ ghae: '*'
+ ghec: '*'
---
{% data foo.bar.tipu %}
diff --git a/tests/fixtures/liquid-tags/good-data-variable.md b/tests/fixtures/liquid-tags/good-data-variable.md
index 8b838798f10e..bdce079cf982 100644
--- a/tests/fixtures/liquid-tags/good-data-variable.md
+++ b/tests/fixtures/liquid-tags/good-data-variable.md
@@ -1,6 +1,10 @@
---
title: Good sample page
-versions: '*'
+versions:
+ fpt: '*'
+ ghes: '*'
+ ghae: '*'
+ ghec: '*'
---
{% data variables.stuff.foo %}
diff --git a/tests/rendering-fixtures/playwright-rendering.spec.ts b/tests/rendering-fixtures/playwright-rendering.spec.ts
index d3802bdacdda..3794a84f7db7 100644
--- a/tests/rendering-fixtures/playwright-rendering.spec.ts
+++ b/tests/rendering-fixtures/playwright-rendering.spec.ts
@@ -155,34 +155,6 @@ test.describe('tool picker', () => {
})
})
-test('filter article cards', async ({ page }) => {
- await page.goto('/code-security/guides')
- const articleCards = page.getByTestId('article-cards')
- await expect(articleCards.getByText('Secure quickstart')).toBeVisible()
- await expect(articleCards.getByText('Securing your organization')).toBeVisible()
-
- // For both the type and topic dropdowns, with the Primer component we use it
- // ends creating a button to open the dropdowns so that's why we're clicking
- // a button here to expand the option items.
-
- // all the articles are displayed, filter by topic
- await page.getByTestId('card-filter-topics').getByRole('button', { name: 'All' }).click()
- await page.getByTestId('topics-dropdown').getByText('Organizations').click()
- await expect(articleCards.getByText('Secure quickstart')).not.toBeVisible()
- await expect(articleCards.getByText('Securing your organization')).toBeVisible()
-
- // now show all the articles again and then filter by type
- await page
- .getByTestId('card-filter-topics')
- .getByRole('button', { name: 'Organizations' })
- .click()
- await page.getByTestId('topics-dropdown').getByText('All').click()
- await page.getByTestId('card-filter-types').getByRole('button', { name: 'All' }).click()
- await page.getByTestId('types-dropdown').getByText('Quickstart').click()
- await expect(articleCards.getByText('Secure quickstart')).toBeVisible()
- await expect(articleCards.getByText('Securing your organization')).not.toBeVisible()
-})
-
test('navigate with side bar into article inside a map-topic inside a category', async ({
page,
}) => {
@@ -449,9 +421,9 @@ test.describe('test nav at different viewports', () => {
test.describe('survey', () => {
test('happy path, thumbs up and enter email', async ({ page }) => {
- await page.goto('/get-started/foo/for-playwright')
-
let fulfilled = 0
+ // Important to set this up *before* interacting with the page
+ // in case of possible race conditions.
await page.route('**/api/events', (route, request) => {
route.fulfill({})
expect(request.method()).toBe('POST')
@@ -462,21 +434,24 @@ test.describe('survey', () => {
// See https://github.com/microsoft/playwright/issues/12231
})
+ await page.goto('/get-started/foo/for-playwright')
+
// The label is visually an SVG. Finding it by its `for` value feels easier.
await page.locator('[for=survey-yes]').click()
await page.getByPlaceholder('email@example.com').click()
await page.getByPlaceholder('email@example.com').fill('test@example.com')
await page.getByRole('button', { name: 'Send' }).click()
- // Because it sent one about the thumbs and then another with the email.
- expect(fulfilled).toBe(2)
+ // One for the page view event, one for the thumbs up click, one for
+ // the submission.
+ expect(fulfilled).toBe(1 + 2)
await expect(page.getByTestId('survey-end')).toBeVisible()
})
test('thumbs down without filling in the form sends an API POST', async ({ page }) => {
- await page.goto('/get-started/foo/for-playwright')
-
let fulfilled = 0
+ // Important to set this up *before* interacting with the page
+ // in case of possible race conditions.
await page.route('**/api/events', (route, request) => {
route.fulfill({})
expect(request.method()).toBe('POST')
@@ -487,8 +462,11 @@ test.describe('survey', () => {
// See https://github.com/microsoft/playwright/issues/12231
})
+ await page.goto('/get-started/foo/for-playwright')
+
await page.locator('[for=survey-yes]').click()
- expect(fulfilled).toBe(1)
+ // One for the page view event and one for the thumbs up click
+ expect(fulfilled).toBe(1 + 1)
await expect(page.getByRole('button', { name: 'Send' })).toBeVisible()
await page.getByRole('button', { name: 'Cancel' }).click()
diff --git a/tests/unit/get-applicable-versions.js b/tests/unit/get-applicable-versions.js
index 89eb18c7a51e..2bd251697a2f 100644
--- a/tests/unit/get-applicable-versions.js
+++ b/tests/unit/get-applicable-versions.js
@@ -35,10 +35,18 @@ describe('Versions frontmatter', () => {
})
describe('general cases', () => {
- test('simply a wildcard', () => {
- const applicableVersions = getApplicableVersions('*')
- expect(applicableVersions.length).toBe(Object.keys(allVersions).length)
- expect(Object.keys(allVersions).every((v) => applicableVersions.includes(v)))
+ test('wildcard * is no longer used', () => {
+ // docs engineering 3110
+ expect.assertions(2)
+ try {
+ getApplicableVersions('*')
+ } catch (e) {
+ expect(e).toBeInstanceOf(Error)
+ expect(e).toHaveProperty(
+ 'message',
+ 'undefined contains the invalid versions frontmatter: *. Please explicitly list out all the versions that apply to this article.',
+ )
+ }
})
test("using 'features'", () => {
const possibleFeatures = fs
diff --git a/tests/unit/page.js b/tests/unit/page.js
index 0f8ac750da81..5e72428e03df 100644
--- a/tests/unit/page.js
+++ b/tests/unit/page.js
@@ -341,7 +341,7 @@ describe('Page class', () => {
basePath: path.join(__dirname, '../../content'),
languageCode: 'en',
})
- expect(page.versions).toBe('*')
+ expect(page.versions).toEqual({ fpt: '*', ghae: '*', ghec: '*', ghes: '*' })
})
test('enterprise admin index page', async () => {