jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-21 02:46:50 -05:00
Code Issues Projects Releases Wiki Activity
26,723 Commits 28 Branches 1 Tag
ad044d04b51e30bc5386f95644571118d1435b1a
Commit Graph

50 Commits

Author SHA1 Message Date
Mike Surowiec
b4608a86d8 fix: remove usage of readFileAsync (#28053) 
* fix: remove usage of readFileAsync

* fix: use same import style

* fix: update tests

Co-authored-by: Peter Bengtsson <mail@peterbe.com>
 2022-06-01 14:49:30 +00:00
Grace Park
2e821f52ff REST subcategory/category rendering test and refactor test-open-api-schema (#27138) 
* first stage of test

* update test

* add rest test for categories and subcategories rendering

* update timeout back to original

* remove export

* remove testing

* refactor test-open-api-schema

* remove function

* remove check

* remove slash

* remove comment

* rearrange

* update getting the categories and maptopic levels

* update tests

* update copy

* add error message task
 2022-05-10 17:09:47 +00:00
Rachael Sewell
14111129e2 display dictionary type body parameters (#27483) 2022-05-04 21:50:49 +00:00
Grace Park
f2c6004aaa REST API Pages: fix links of endpoints-available-for-github-apps page (#27425) 2022-05-04 00:56:04 +00:00
Rachael Sewell
5f4f858b94 REST two-pane layout (#26954) 2022-05-02 10:10:33 -07:00
Rachael Sewell
749efd7b99 Rest redirect endpoint (#27027) 2022-04-25 16:14:04 +00:00
Rachael Sewell
434f49afe0 remove prerendered request description (#27185) 2022-04-25 16:09:48 +00:00
Grace Park
bb2e234238 update openapi test (#27127) 2022-04-21 19:56:30 +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
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
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
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
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
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
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
Rachael Sewell
9fd4fe0a6c remove prerendered response rest docs (#25652) 2022-03-04 21:24:46 +00:00
Rachael Sewell
0fcf31cdc3 Support OpenAPI 3.1 (#25710) 2022-03-03 05:51:25 +00:00
Rachael Sewell
2ade7d8489 reactify rest pages (#25005) 2022-02-28 18:30:54 +00:00
Robert Sese
f48d536bbf Fix management console API URLs (#25562) 
* No /api/v3 for mgmt console operations

* Add updated decorated files
 2022-02-24 22:51:01 +00:00
Lucas Costi
e6af9ae1e6 Remove Actions REST enterprise subcategory (moved to Actions page) (#25065) 
Co-authored-by: Rachael Sewell <rachmari@github.com>
 2022-02-17 15:18:07 +10:00
dependabot[bot]
a02a4355e3 Bump url-template from 2.0.8 to 3.0.0 (#24889) 
* Bump url-template from 2.0.8 to 3.0.0

Bumps [url-template](https://github.com/bramstein/url-template) from 2.0.8 to 3.0.0.
- [Release notes](https://github.com/bramstein/url-template/releases)
- [Commits](https://github.com/bramstein/url-template/compare/v2.0.8...v3.0.0)

---
updated-dependencies:
- dependency-name: url-template
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

* No more default export

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
Co-authored-by: Robert Sese <rsese@github.com>
Co-authored-by: Robert Sese <robert.sese@gmail.com>
 2022-02-02 22:27:30 +00:00
Rachael Sewell
ef4dee2e7d Revert "Revert "rest/reference/repos#statuses redirect"" (#24559) 2022-01-27 22:09:20 +00:00
Robert Sese
c02a5ec9b3 Render the operation response description Markdown (#24466) 
* Render the operation description Markdown

* Add updated decorated files
 2022-01-24 20:11:40 +00:00
Rachael Sewell
a340162d84 reorganize repository apis (#23728) 
Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
Co-authored-by: Peter Bengtsson <peterbe@github.com>
 2022-01-11 11:53:12 +10:00
Robert Sese
9234921dca Fix server URL for repos/upload-release-asset (#23838) 
* Fix server URL for repos/upload-release-asset

* Add updated decorated file
 2022-01-05 14:58:00 -06:00
Kevin Heis
5b1ac53379 A few things that Prettier seemed to miss (#23005) 2021-11-19 18:32:20 +00:00
Rachael Sewell
bbc5778e4a add new options to rest schema script (#21571) 2021-09-23 19:34:56 +00:00
Marc-Andre Giroux
264a4f2fbc Fix example generation for "any" schema types (#21290) 2021-09-09 18:02:53 +00:00
Kevin Heis
b29e37318a Remove import x statements (#20594) 
* Clear out most import x

* Update rimraf use

* Move up readme blocks in scripts
 2021-07-29 20:28:30 +00:00
Kevin Heis
8a56437c93 Pretty format (#20352) 
* Update prettier flow to include JS

* Run prettier

* ...run prettier
 2021-07-14 14:35:01 -07:00
Kevin Heis
42e785b0a8 Migrate CommonJS to ESM (#20301) 
* First run of script

* Get the app running --- ish

* Get NextJS working

* Remove `node:`

* Get more tests passing in unit directory

* Update FailBot test to use nock

* Update test.yml

* Update Dockerfile

* tests/content fixes

* Update page.js

* Update build-changelog.js

* updating tests/routing

* Update orphan-tests.js

* updating tests/rendering

* Update .eslintrc.js

* Update .eslintrc.js

* Install jest/globals

* "linting" tests

* staging update to server.mjs

* Change '.github/allowed-actions.js' to a ESM export

* Lint

* Fixes for the main package.json

* Move Jest to be last in the npm test command so we can pass args

* Just use 'npm run lint' in the npm test command

* update algolia label script

* update openapi script

* update require on openapi

* Update enterprise-algolia-label.js

* forgot JSON.parse

* Update lunr-search-index.js

* Always explicitly include process.cwd() for JSON file reads pathed from project root

* update graphql/update-files.js script

* Update other npm scripts using jest to pass ESM NODE_OPTIONS

* Update check-for-enterprise-issues-by-label.js for ESM

* Update create-enterprise-issue.js for ESM

* Import jest global for browser tests

* Convert 'script/deploy' to ESM

Co-authored-by: Grace Park <gracepark@github.com>
Co-authored-by: James M. Greene <jamesmgreene@github.com>
 2021-07-14 13:49:18 -07:00
Rachael Sewell
87690bf634 revert to using static content type (#20319) 2021-07-13 09:54:09 -07:00
Rachael Sewell
4f3761004b OpenAPI form data curl examples (#19507) 2021-06-30 17:33:20 -07:00
Grace Park
d3d1902414 Merge pull request #20017 from github/upgrade-esm 
Enforce and Move to Top Level require
 2021-06-22 11:27:48 -07:00
Rachael Sewell
0ae4979f41 clean up openapi build errors (#19963) 2021-06-16 20:08:24 +00:00
Kevin Heis
f6acb1f08a Update dependencies (#19408) 
* Update dependencies 2

* Lint fixes

* Update graphql packages

* Update changelog-entry.json

* Update @octokit/rest

* Update commander with help from @rachmari

@rachmari

* Upgrade helmet

* Upgrade js-yaml

* Update server.js

* Update cheerio

* Revert "Update cheerio"

This reverts commit 8aa17c39fbf564ee554037d89e7a473027d16984.
 2021-05-19 17:32:47 +00:00
Marc-Andre Giroux
2deb8275da Accept glob patterns for source files in openapi-check script (#18965) 
Co-authored-by: James M. Greene <JamesMGreene@github.com>
 2021-04-26 21:56:12 +00:00
Rachael Sewell
ae4cddcf13 OpenAPI bug fixes (#18625) 2021-04-21 15:09:36 -07:00
Marc-Andre Giroux
1635048d0f Add an openapi-check ci check and dockerize it (#18652) 2021-04-09 11:02:53 -07:00
Sarah Edwards
c66b44fcf8 pass include_unpublished when generating the root api files (#18532) 2021-04-05 16:46:19 +00:00
github-openapi-bot
10fef4dfad Update OpenAPI Descriptions (#18553) 
Co-authored-by: Rachael Sewell <rachmari@github.com>
 2021-04-02 15:45:24 -07:00
Rachael Sewell
a9bee89188 Remove sentence case from openapi response (#17872) 2021-03-25 13:47:55 -07:00
Rachael Sewell
28ff566293 rest api enterprise hostname fix (#18095) 2021-03-18 22:16:14 -07:00
Rachael Sewell
fc38a404d9 check for openapi type property (#18257) 2021-03-16 08:59:14 -07:00
Rachael Sewell
c535420c77 decorate script fix (#18201) 2021-03-15 18:40:00 -07:00
Sarah Edwards
46d8de0040 add output arg (#17992) 2021-02-25 16:49:27 +00:00
Rachael Sewell
58aae970cf add troubleshooting message to openapi script (#17253) 
* add troubleshooting message to openapi script

* i always forget to lint
 2021-01-17 00:35:10 +00:00
Sarah Schneider
cf78a71df1 recreate rest-api-operations PR #111 2020-11-25 09:21:24 -05:00
Sarah Schneider
8f0093c63a OpenAPI tooling updates (#16320) 2020-11-24 12:20:10 -08:00