1
0
mirror of synced 2025-12-30 12:02:01 -05:00
Commit Graph

226 Commits

Author SHA1 Message Date
Rachael Sewell
434f49afe0 remove prerendered request description (#27185) 2022-04-25 16:09:48 +00:00
Robert Sese
78ebd2e483 openapi: render example request and response descriptions (#27057)
* Render code example response descriptions

* Add updated decorated files

* Pluralize

* Also render example request descriptions

* Add updated decorated files
2022-04-20 17:51:13 -05:00
github-openapi-bot
12163066f7 Update OpenAPI Descriptions (#27095)
* Update OpenAPI  Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
2022-04-21 08:29:37 +10: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
github-openapi-bot
68e1c0f319 Update OpenAPI Descriptions (#27040)
* Update OpenAPI  Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
Co-authored-by: Vanessa <vgrl@github.com>
2022-04-20 09:01:59 +10:00
github-openapi-bot
eddda040c5 Update OpenAPI Descriptions (#27024)
Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
2022-04-19 08:51:52 +10:00
Robert Sese
0056a2d648 openapi: fix array of objects params (#26978)
* Make a copy of the type array, splice() will modify it

* Also check for 'array' in array of types

* Add updated decorated files

* Make copying clearer

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

Co-authored-by: Rachael Sewell <rachmari@github.com>
2022-04-15 22:50:27 +00:00
github-openapi-bot
8aa591e0c8 Update OpenAPI Descriptions 2022-04-14 12:28:29 +00:00
Robert Sese
aff739a381 openapi: fix param description rendering (#26913)
* Should be 'param.descriptionHTML'

* Add updated decorated files
2022-04-13 20:22:08 +00:00
github-openapi-bot
e1701e0b69 Update OpenAPI Descriptions 2022-04-13 12:35:54 +01:00
Robert Sese
cb355c6da3 openapi: fix nested params (#26894)
* Check for 'object' in ['object', 'null']

* Add updated decorated files

* arrays can also be null with this format

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

* arrays can also be null with this format

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

Co-authored-by: Rachael Sewell <rachmari@github.com>
2022-04-12 18:15:22 -05:00
github-openapi-bot
5d9b2b4602 Update OpenAPI Descriptions 2022-04-12 08:58:16 +00:00
Rachael Sewell
e86dc05ecc add openapi example tests (#26860) 2022-04-11 16:08:15 -07:00
Rachael Sewell
02dbebbef3 render existing openapi examples (#26405) 2022-04-11 16:09:03 +00:00
github-openapi-bot
77f4d3fed9 Update OpenAPI Descriptions (#26779) 2022-04-08 10:53:54 +10:00
github-openapi-bot
593327a548 Update OpenAPI Descriptions (#26752) 2022-04-07 14:05:09 +10:00
github-openapi-bot
a8a346ada0 Add decorated OpenAPI schema files 2022-04-05 16:19:16 +00:00
github-openapi-bot
45101b47d0 Update OpenAPI Descriptions (#26580) 2022-03-31 14:26:49 +00:00
github-openapi-bot
2b873fd328 Update OpenAPI Descriptions (#26544) 2022-03-30 07:47:18 -05:00
github-openapi-bot
e8e4b1e077 Update OpenAPI Descriptions (#26460) 2022-03-23 17:18:16 +00:00
github-openapi-bot
1bb3737305 Update OpenAPI Descriptions (#26442) 2022-03-22 20:32:09 +00:00
github-openapi-bot
98daee0533 Update OpenAPI Descriptions 2022-03-22 12:23:02 +00:00
Rachael Sewell
e591ffec57 Openapi update api.github.com (#26398) 2022-03-22 00:47:06 +00:00
Grace Park
2c8713037d Move deploy keys from deployments to keys in rest pages (#26166)
* move deploy keys from deployments to keys in rest pages

* move minitocs above intro

* Update content/rest/reference/keys.md

Co-authored-by: Sarah Edwards <skedwards88@github.com>

* add to banner, add redirects from deployments

* remove deploy keys from deployments intro

* update data/reusables name

* update - to _

* update script and add redirects for subcategories turned categories

Co-authored-by: Sarah Edwards <skedwards88@github.com>
2022-03-17 17:25:12 +00:00
github-openapi-bot
43d39a8b3c Update OpenAPI Descriptions (#26288)
* Update OpenAPI  Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
2022-03-17 18:12:28 +10:00
github-openapi-bot
8a0bb5c37c Update OpenAPI Descriptions (#26275) 2022-03-17 14:07:38 +10:00
github-openapi-bot
f31f297591 Update OpenAPI Descriptions (#26227) 2022-03-16 10:16:08 +10:00
github-openapi-bot
74e691d88c Update OpenAPI Descriptions (#26178)
Co-authored-by: Robert Sese <rsese@github.com>
2022-03-15 15:04:12 +10:00
github-openapi-bot
856c2d73ea Update OpenAPI Descriptions (#26117)
Co-authored-by: Robert Sese <rsese@github.com>
2022-03-14 11:14:01 +10:00
github-openapi-bot
910b382a1d Update OpenAPI Descriptions (#25877)
Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
Co-authored-by: Vanessa <vgrl@github.com>
2022-03-06 23:03:15 +00:00
Rachael Sewell
9fd4fe0a6c remove prerendered response rest docs (#25652) 2022-03-04 21:24:46 +00:00
github-openapi-bot
287b79cc4c Update OpenAPI Descriptions (#25855)
* Update OpenAPI  Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2022-03-04 19:18:29 +00:00
github-openapi-bot
862aca9368 Update OpenAPI Descriptions (#25816) 2022-03-04 00:55:16 +00:00
Rachael Sewell
0fcf31cdc3 Support OpenAPI 3.1 (#25710) 2022-03-03 05:51:25 +00:00
github-openapi-bot
2003a4a175 Update OpenAPI Descriptions (#25770)
* Update OpenAPI  Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2022-03-02 14:59:07 -08:00
github-openapi-bot
271e7c301a Update OpenAPI Descriptions (#25706)
* Update OpenAPI  Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
Co-authored-by: Ethan P <56270045+ethanpalm@users.noreply.github.com>
2022-03-01 12:03:42 -08:00
Rachael Sewell
2ade7d8489 reactify rest pages (#25005) 2022-02-28 18:30:54 +00:00
github-openapi-bot
dac8f44fa2 Update OpenAPI Descriptions (#25681)
* Update OpenAPI  Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
2022-02-26 17:21:02 +00:00
github-openapi-bot
f0bcb98c75 Update OpenAPI Descriptions (#25446) 2022-02-17 15:09:40 +10:00
github-openapi-bot
0240435995 Update OpenAPI Descriptions (#25416) 2022-02-16 13:33:13 +00:00
github-openapi-bot
9dddf18eae Update OpenAPI Descriptions (#25288) 2022-02-11 18:15:59 +00:00
github-openapi-bot
d02feb0ab5 Update OpenAPI Descriptions (#25228) 2022-02-10 18:43:30 +00:00
github-openapi-bot
84603d3a29 Update OpenAPI Descriptions (#25217) 2022-02-10 10:47:48 +00:00
github-openapi-bot
e650b121a2 Update OpenAPI Descriptions (#25138) 2022-02-08 21:56:44 +00:00
github-openapi-bot
7b35a0a024 Update OpenAPI Descriptions (#25076)
* Update OpenAPI  Descriptions

* Add decorated OpenAPI schema files

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
2022-02-07 17:06:24 +00:00
github-openapi-bot
a47141dd2c Update OpenAPI Descriptions (#25071) 2022-02-07 10:15:24 -06:00
github-openapi-bot
433932e25c Update OpenAPI Descriptions (#25047) 2022-02-07 10:25:40 +00:00
github-openapi-bot
bcba10e241 Update OpenAPI Descriptions (#24981) 2022-02-03 15:47:10 +00:00
github-openapi-bot
5476d79fa6 Update OpenAPI Descriptions (#24700) 2022-02-01 10:01:31 +00:00
github-openapi-bot
d75b5f7751 Update OpenAPI Descriptions (#24642) 2022-01-26 13:50:20 +00:00