jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-06 06:02:35 -05:00
Code Issues Projects Releases Wiki Activity
29,406 Commits 28 Branches 1 Tag
562fd458b087aea74a2d3bdf8a9f99cfb18924d8
Commit Graph

138 Commits

Author SHA1 Message Date
Courtney Wilson
8ae669cfe7 Merge branch 'main' into patch-3 2022-08-04 13:21:07 -05:00
Sarah Edwards
f6d51bcf57 Delete OAuth Authorizations API for free/pro/team and GHEC (#29335) 
Co-authored-by: Vanessa <vgrl@github.com>
Co-authored-by: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com>
Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
 2022-08-02 08:21:43 +10:00
Ryan Hanson
49a74065ce Add case-sensitivity note to HTTP verbs 
This change adds a note that HTTP verbs/methods are case-sensitive. This may cut down on confusion from users that submit an otherwise accurate API request but receive a 403 Forbidden response from GitHub.
 2022-07-30 12:22:19 -05:00
Mingzi
f4ca2a5537 Add pages permission document (#21141) 
Co-authored-by: Amy Burns <timeyoutakeit@github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Octomerger Bot <63058869+Octomerger@users.noreply.github.com>
Co-authored-by: Yoann Chaudet <yoannchaudet@github.com>
 2022-07-29 11:31:34 +10:00
Rachael Sewell
e8acff555c refactor the enabled for apps page component (#29253) 2022-07-26 18:14:50 +00:00
Tim Rogers
d1ea358256 Add information about timeouts to the "Resources in the REST API" page (#29241) 2022-07-26 17:35:32 +00:00
Tim Rogers
3da9a4b822 Document the x-ratelimit-used response header on the "Resources in the REST API" page (#29242) 2022-07-22 22:44:48 +00:00
Sarah Schneider
4cbbf22fbd Merge branch 'main' of github.com:github/docs-internal into versioned-redirects 2022-07-21 09:04:04 -04:00
Sarah Edwards
28deb383b4 Remove hardcoded links from GHEC docs to FPT GraphQL docs (#28973) 2022-07-12 16:54:51 +00:00
Hector Alfaro
95e6f3d3ab Deprecate GHES 3.1 (#28798) 
* add 3.1 to deprecated versions

* rewrite img src to use azure blob storage in archive script

Co-authored-by: rachmari <rachmari@users.noreply.github.com>

* remove static files for ghes 3.1

* remove liquid conditionals and content for ghes 3.1

* remove outdated hardware reqs reusable

* Fix liquid conditional uncaught by script

* Close liquid conditionals missed by script

* Apply @mattpollard's suggestions

Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>

Co-authored-by: rachmari <rachmari@users.noreply.github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
 2022-07-11 21:17:09 +00:00
Sarah Edwards
8733e39428 Remove remaining mentions of v3 in the accept header (#28825) 
remove remaining mentions of v3 in the accept header for REST requests
 2022-06-30 15:49:39 +00:00
Tim Rogers
10a901eaa9 Remove references on the "Media Types" page to setting the version in the Accept header (#28478) 2022-06-28 21:16:02 +00:00
Sarah Schneider
10b7d41e36 fix conflicts 2022-06-24 09:21:18 -04:00
Tim Rogers
5b5606cae4 Drop references to the REST API as V3 and the GraphQL API as V4 (#28445) 2022-06-15 20:48:40 +00:00
Sarah Edwards
33c1fd7f6c Remove octokit maintenance warning (#28496) 
remove warning about octokit not being maintained
 2022-06-15 15:56:34 +00:00
Fredrick Kofi Tam
10db1a7ea2 Switch access permissions from write to read on vulnerability alerts GET endpoint (#28409) 2022-06-15 15:24:24 +00:00
Michael Cantú
b581ada1b8 Fixing typo 
Fixing 'offical' to 'official' typo
 2022-06-14 09:25:22 -05:00
Rachael Sewell
856982c188 add intro content (#25800) 2022-06-13 22:25:39 +00:00
Sarah Schneider
f44578572c Ran script/content-migrations/convert-if-to-ifversion.js 2022-06-06 18:13:12 -04:00
Matt Pollard
94486e851b Remove GitHub AE versioning from "API previews" article (#27938) 2022-05-31 17:38:55 +00:00
Sophie
cc7d8b8f20 Deleted content versioned as else according to review 2022-05-25 14:10:04 +02:00
Sarah Schneider
25522dc1b5 Merge branch 'main' of github.com:github/docs-internal into versioned-redirects 2022-05-20 12:39:50 -04:00
Sophie
efc0c9fbfb Added versioning for ghec 2022-05-20 13:57:24 +02:00
Janice
ccd8d228b0 Merge branch 'main' into patch-2 2022-05-19 04:08:40 -07:00
Sarah Schneider
a1e04edc96 Merge branch 'main' of github.com:github/docs-internal into versioned-redirects 2022-05-17 10:13:07 -04:00
Kaitlin Newson
215bf22ccf Fix anchor link 2022-05-14 15:47:22 -04:00
Logan Gorence
5845adee71 Update github.dart link to new organization. 
It's been quite a while, but the github.dart repo was moved to a different organization.
 2022-05-10 10:20:50 -07:00
Sarah Schneider
2636bcc0dc add redirects to content files that were previously only in redirect exceptions file 2022-04-27 17:59:29 -04:00
Grace Park
b98c83e924 REST operations sidebar (#26225) 
* testing out a rest operations sidebar

* cleanup

* renamed 5 files

* renamed 5 files

* set redirect_from on 5 files

* renamed 1 files

* renamed 1 files

* renamed 3 files

* renamed 1 files

* renamed 1 files

* renamed 3 files

* renamed 1 files

* renamed 2 files

* renamed 1 files

* renamed 4 files

* renamed 15 files

* renamed 2 files

* renamed 6 files

* renamed 1 files

* renamed 4 files

* renamed 7 files

* renamed 1 files

* renamed 3 files

* renamed 3 files

* renamed 1 files

* renamed 5 files

* renamed 1 files

* renamed 1 files

* renamed 3 files

* renamed 4 files

* renamed 1 files

* renamed 1 files

* renamed 2 files

* renamed 4 files

* renamed 1 files

* renamed 1 files

* renamed 1 files

* renamed 6 files

* renamed 6 files

* renamed 4 files

* move files

* adding more

* updating to add restcontext and start of removing data/reusables/rest-reference

* removed data/reusables

* add a RestMiniTocItem and updating the filtering to add a subcategory so all manually added H3s are in mini tocs in addition to operations

* remove console log

* [WIP]: REST New Proposal Sidebar (#26471)

* saving

* update sidebar

* remove console log

* update guides and overview

* import Category for category level rest pages

* update undefined restOperations

* update restOperationData category and subcategory levels"

* minor updates

* update get mini toc items function

* updating REST context for sidebar

* updating rest data

* remove console logs

* WIP: mini-toc-ing the sidebar

Co-authored-by: Robert Sese <rsese@github.com>

* A little cleanup

* Fix first subcategory link and add some comments

* updating anchor links in sidebar

* adding updates

* remove standalone

* update product and maptopic pages using article context

* add conditional link wrapper

* fix sidebar toggle and versions for enterprise admin

* update versions per subcategory

* Highlight sidebar link for current page

* Update miniToc hash links and hash change tracking

* fix unique key in CollapsibleSection

* Fix list markup

* remove title

* update permissions

* Hide minitocs on landing (#26594)

* hide minitocs on landing page

* simplify page components and remove minitoc from sidebar for guides/overview

* fix carats and category fix

* remove id

Co-authored-by: Grace Park <gracepark@github.com>

* updating content based on versions script check with the OpenAPI

* update script and content files

* update script and content/rest files

* update to add TocLanding

* update script

* update index files

* add codespaces repository-secrets

* remove openapi schema check script

* remove minitocs at the top

* add h2 about the {title} api

* fix tests/unit/openapi-schema.js

* Fix linting tests

* fix search/topics test

* fix tests/unit/pages test

* update rest/reference links in components

* run prettier

* Update components/rest/RestReferencePage.tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update components/rest/RestReferencePage.tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update pages/[versionId]/rest/[category]/[subcategory].tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update pages/[versionId]/rest/[category]/[subcategory].tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update pages/[versionId]/rest/[category]/[subcategory].tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update pages/[versionId]/rest/[category]/[subcategory].tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Update tests/unit/openapi-schema.js

Co-authored-by: Rachael Sewell <rachmari@github.com>

* updating comment location

* remove dependabot override

* remove path-utils current product update for rest

* run linter

* remove dependabot.md and remove h2 heading on restreference

* update the correct product to rest for rest pages

* adding comments for updates to path-utils

* remove console log

* REST sidebar: handle legacy v3 redirects (#26686)

* Add script to handle legacy v3 REST redirects

* Run the script

* Handle a redirect to a redirect

* Update REST test URLs

* 'await' and test runs subcategory of checks

* Update REST URLs for routing/developer-site-redirects tests

* Update developer-redirects fixture with new REST URLs

* Resolve merge conflicts

* Update rest-redirects fixture with new REST URLs

* Fix broken links with REST pages re-org

* redirectTo could be undefined

* Fix script for posterity, can't redirect paths with hashes

* Remove invalid hash redirects

* Typically don't need to save one-off scripts

* Undo redirect changes (not necessary for handling v3 redirects)

* Remove script-added redirects

* Update old v3 redirects with new REST URLs

* No more GHES search indexing page

* 'org' not 'organization'

* Update fixture data for new REST URLs

* revert any content directory changes

Co-authored-by: Grace Park <gracepark@github.com>
Co-authored-by: Rachael Sewell <rachmari@github.com>

* Adding test rest (#26750)

* add test to check openapi schema versions and content rest frontmatter versions

* update lib/redirects

* fix test and add error messages

* adding repository secrets

* adding repository-secrets.md

* Revert "update lib/redirects"

This reverts commit 3aafe28265764d5bc09c0c478c8e0ca099c8fbcf.

* remove lib/redirects changes and console logs

* Update lib/rest/index.js

Co-authored-by: Rachael Sewell <rachmari@github.com>

* update unique key

* Rest client side redirects (#26754)

* adding tags subcategory for the rest content repos category

* run prettier

* bug fix for anchor scrolls" (#26892)

* updating width size for rest reference page

* Rest sidebar consolidation (#26862)

* refactor sidebar

* fix articlecontext provider issue on rest product landing page for all versions

* fix a bug, create new component

* revert change to create new component and fix bug

Co-authored-by: Rachael Sewell <rachmari@github.com>

* Set currentAnchor with a hashchange handler (#26923)

* Rest sidebar design tweaks (#26807)

* Rest sidebar design tweaks

* tweak color to subtle

* use muted color and margin for line

* update to design feedback

Co-authored-by: Grace Park <gracepark@github.com>

* Remove cheerio from rest-collapsible (#26948)

* remove cheerio from rest-collapsible

* update type

* adding endswith instead

* use productId instead

* one off edge case for secret-scanning

* Reorganize subcategory and category, Update pre -> div, Add RestContext (#26950)

* reorganize subcategory and category

* add RestContext

* update comment

* update for endpoints page

* add comment

* move object to restcontext

* remove effectiveDate in restcontext

* remove width calculation for rest reference page

* fix adding manual writer's minitocs to sidebar

* update with feedback

* update comment

* update isRestReferencePage

* remove page component and fix bug

* adding back rest/index.tsx

Co-authored-by: Rachael Sewell <rachmari@github.com>

* update content/rest"

* add back design tweak

* update to div

* update margins on rest api reference

* remove page component

* adding tests

* separate product from rest sidebar (#27065)

* separate product from rest sidebar

* Use ProductCollapsibleSections for product pages

* fix tests

Co-authored-by: Robert Sese <rsese@github.com>
Co-authored-by: Grace Park <gracepark@github.com>

* Rest sidebar translations (#27052)

* update translations

* remove general test

Co-authored-by: Robert Sese <rsese@github.com>
Co-authored-by: Rachael Sewell <rachmari@github.com>
 2022-04-20 10:19:48 -07:00
Sarah Edwards
345a950ad5 API preview follow up (#26914) 2022-04-19 20:06:18 +00:00
Matt Pollard
c999ebfe11 Remove fpt versioning for secret scanning REST API reference article (#26869) 2022-04-19 08:34:06 +00:00
Joshua Miller
0e30279443 📝 add note about future SDK team (#17072) 2022-04-18 16:09:47 +00:00
Sophie
ac4c64b683 Merge branch 'main' into sophie-6156-content 2022-04-13 09:14:13 +02:00
Debbie Milburn
d0efbf239d Update permissions-required-for-github-apps.md (#26537) 2022-04-12 17:58:14 +00:00
Josh Soref
158111374f Warn re:status for official octokit libraries (#16718) 2022-04-06 18:17:47 +00:00
Matt Pollard
30f2b92798 Merge branch 'main' into sophie-6156-content 2022-04-06 13:53:40 +02:00
Sarah Edwards
3dcef750f0 version previews (#26571) 2022-03-31 16:42:04 +00:00
Gijs van Dam
6947c0964c Add -I parameter to curl command 
When checking the rate limit while using your app's client ID and secret, you need to supply the `-I` argument to show the header of the response, containing `x-ratelimit-limit` and `x-ratelimit-remaining`
 2022-03-25 11:35:59 +08:00
proudmuslim-dev
29282ff72e Add octocat-rs to Rust libraries 2022-03-18 09:12:03 -07:00
Sophie
18edb677c9 Merge branch 'main' into sophie-6156-content 2022-03-17 09:25:19 +01:00
Sophie
74ba23bec7 Change instances of user account to personal account in content 2022-03-16 15:18:37 +01:00
Lucas Costi
cfba19d927 Add cache section for Actions REST API (#24924) 
* Add cache section for Actions REST API

* Add permissions entries, cache section

* Add new cache directory after REST reactify changes

* Update content/actions/using-workflows/caching-dependencies-to-speed-up-workflows.md

Co-authored-by: Martin Lopes <martin389@github.com>

* Add versioning for GHES/AE

Co-authored-by: Martin Lopes <martin389@github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
 2022-03-16 10:37:19 +00:00
Robert Sese
79c48070c4 Deprecate 3.0 (#25646) 
* Deprecate 3.0

* 3.0 deprecation: remove 3.0 markup (#25647)

* Remove liquid conditionals and content for 3.0 deprecation

* Remove manually, no longer versioned in a supported version

* Remove translations manually, no longer versioned in a supported version

* Remove 'if', now in all supported versions

* Remove dangling 'elseif', now in all supported versions

* Remove dangling 'elseif' and 3.0 screenshot reference, now in all supported versions

* Nudge to latest supported GHES version

* Nudge to latest supported release GHES version

* Bump all the version for the liquid tests

* Bump first deprecated version for linting tests

* Prefer double quotes

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Prefer double quotes

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Prefer double quotes

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Prefer double quotes

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Prefer double quotes

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Prefer double quotes

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Prefer double quotes

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Prefer double quotes

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Prefer double quotes

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Remove extra newline

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Remove extra newline

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Remove extra newline

Co-authored-by: Laura Coursen <lecoursen@github.com>

* One reusable per line

Co-authored-by: Laura Coursen <lecoursen@github.com>

* One reusable per line

Co-authored-by: Laura Coursen <lecoursen@github.com>

* One reusable per line

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Version check not needed anymore

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Version check not needed anymore

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Version check not needed anymore

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Version check not needed anymore

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Version check not needed anymore

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Version check not needed anymore

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Version check not needed anymore

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Stray whitespace ✂️

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Stray whitespace ✂️

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Stray whitespace ✂️

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Stray whitespace ✂️

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Stray whitespace ✂️

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Stray whitespace ✂️

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Stray whitespace ✂️

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Stray whitespace ✂️

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Version check not needed anymore

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Version check not needed anymore

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Just 'ghes' since we're deprecating 3.0

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Just 'ghes' since we're deprecating 3.0

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Just 'ghes' since we're deprecating 3.0

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Just 'ghes' since we're deprecating 3.0

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Just 'ghes' since we're deprecating 3.0

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Just 'ghes' since we're deprecating 3.0

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Just 'ghes' since we're deprecating 3.0

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Just 'ghes' since we're deprecating 3.0

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Don't depend on hardcoded versions

Co-authored-by: Laura Coursen <lecoursen@github.com>

* Remove static files for 3.0 deprecation (#25649)

Co-authored-by: Laura Coursen <lecoursen@github.com>
 2022-03-03 13:08:24 -06:00
Peter Bengtsson
693fb35bc6 links on /rest/overview/endpoints (#25771) 
* links on /rest/overview/endpoints-available-for-github-apps

* tests

* remove unused code
 2022-03-03 17:45:37 +00:00
Rachael Sewell
2ade7d8489 reactify rest pages (#25005) 2022-02-28 18:30:54 +00:00
alpn
74e6dc4514 Set all x-ratelimit-* header names to loweracse 
Currently x-ratelimit-* headers are in CamelCase (in the docs), but in practice the API returns them in lower case.
Although HTTP header names are (not case sensitive)[https://www.w3.org/Protocols/rfc2616/rfc2616.html],  this could still be confusing for some, therefor I propose to change it.
 2022-02-01 08:32:02 -06:00
Matt Pollard
5af07647ef Centralize, update, and restructure some information about rate limits for REST API requests (#23685) 2022-01-25 15:04:24 +00:00
Peter Bengtsson
825e41ac61 cleaning up trailing slash redirects (part 10 (last one)) (#23818) 2021-12-17 13:48:46 +01:00
Rachael Sewell
daafb8cb9d break up large rest pages (#23652) 2021-12-14 20:39:25 +00:00
Sarah Edwards
52893a6bce Sunset content attachments (#23285) 2021-12-03 00:28:55 +00:00