mirror of synced 2025-12-25 11:03:37 -05:00

Files

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

static

Deprecate GHES 3.1 (#28798 )

2022-07-11 21:17:09 +00:00

index.js

make miniToc pure data and no html strings (#28517 )

2022-06-15 18:31:36 +00:00

README.md

OpenAPI tooling updates (#16320 )

2020-11-24 12:20:10 -08:00

README.md

REST

About this directory

lib/rest/index.js is human-editable.
lib/rest/static/*.json are generated by scripts.

Editable files

lib/rest/index.js consumes the static decorated schema files and exports categories, operations, and operationsEnabledForGitHubApps used by the REST middleware contextualizer.

Static files

Generated by script/rest/update-files.js:

lib/rest/static/dereferenced - dereferenced OpenAPI schema file for each version of GitHub
lib/rest/static/decorated - files generated from the dereferenced OpenAPI schema with the Markdown descriptions rendered in HTML

Rendering docs

When the server starts, middleware/contextualizers/rest.js accesses the data exported from the static decorated JSON files, fetches the data for the current version and requested path, and adds it to the context object. The added property is:

req.context.currentRestOperations - all operations with a category matching the current path

Markdown files in content/rest/reference use Liquid to loop over these context properties. The Liquid calls HTML files in the includes directory to do most of the rendering. Writers can add content to the Markdown files alongside the Liquid.