mirror of synced 2026-01-14 21:01:32 -05:00

Files

hubwriter c9b4766254 Update docs for the code scanning API (#17653 )

* Add custom media type info and update subsection cross-refs

* Update the permissions for GH Apps page

* Add temporary JSON files

Replace these with the autogenerated ones from
github/github, when the associated PR over there
is merged.

* Change json+sarif to sarif+json

* Condition media types section

This new section will only become accurate in
GHES 3.1

* Add temporary copies of decorated & dereferenced files

* Add new endpoints to the permissions page

/rest/reference/permissions-required-for-github-apps

* Update temp JSON files

* Update JSON files

* Add  github-ae: '*'

* Add  github-ae: '*'

* Add  github-ae: '*'

* Update content/rest/reference/code-scanning.md

* Update JSON files

* Update content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md

Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>

* Update content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md

Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>

* Update content/rest/reference/code-scanning.md

Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>

* Update content/rest/reference/code-scanning.md

Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>

* Update content/rest/reference/permissions-required-for-github-apps.md

Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>

* Make review comment changes

* Remove development mode JSON files

* Update OpenAPI Descriptions (#17857)

* Update OpenAPI Descriptions

* Add decorated OpenAPI schema files

* Remove development mode JSON files

* Update OpenAPI JSON files (#17869)

* Update OpenAPI Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <security+github-openapi-bot@github.com>

* Remove development mode JSON files

* Update OpenAPI Descriptions (#17863)

* Update OpenAPI Descriptions

* Add decorated OpenAPI schema files

* Update content/rest/reference/permissions-required-for-github-apps.md

Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>

* Update content/rest/reference/permissions-required-for-github-apps.md

* Update content/rest/reference/permissions-required-for-github-apps.md

* Update content/rest/reference/permissions-required-for-github-apps.md

* Update content/rest/reference/permissions-required-for-github-apps.md

* Update content/rest/reference/code-scanning.md

Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com>
Co-authored-by: github-openapi-bot <security+github-openapi-bot@github.com>

2021-02-16 22:07:48 +00:00

guides

fix: update broken link

2021-02-07 14:10:42 -07:00

overview

Merge branch 'main' into capital-h

2021-02-08 15:21:49 +01:00

reference

Update docs for the code scanning API (#17653 )

2021-02-16 22:07:48 +00:00

index.md

GitHub AE (GHAE) (#16090 )

2020-11-02 15:12:44 -06:00

README.md

Add READMEs for API content directories (#1895 )

2020-12-10 13:31:10 +10:00

README.md

REST

The /content/rest directory is where the GitHub REST API docs live!

The /content/rest/guides and /content/rest/overview directories contain regular articles. These are human-editable.
The /content/rest/reference directory contains an article for each group of endpoints in the GitHub REST API. Most of the content in this directory is rendered using include tags.

The content rendered by include tags is sourced from the /lib/rest/static directory, which is automatically generated from the API source code internally in GitHub, and should not be edited by a human. For more information, see the /lib/rest/README.md.

As a result, we cannot accept contributions to REST API reference content in this repository.