diff --git a/src/rest/scripts/README.md b/src/rest/scripts/README.md index 377cb092b6..bed3aa0c84 100644 --- a/src/rest/scripts/README.md +++ b/src/rest/scripts/README.md @@ -8,6 +8,16 @@ These scripts update the dereferenced OpenAPI files to create [the decorated fil render REST docs. See the [`src/rest/README`](../../src/rest/README.md) for more info. +Writers and developers depend on this script to preview OpenAPI changes in the docs. When you update this script please [follow the preview steps here](https://thehub.github.com/epd/engineering/products-and-services/public-apis/rest/openapi/openapi-in-the-docs/#previewing-changes-in-the-docs) to verify that: + +- The script runs without errors +- You can preview REST API changes +- You can preview webhook changes +- You can generate a preview for an individual version (e.g. GHEC only) +- You can generate a preview when a new category is added +- You can generate a preview when a new subcategory is added +- You can generate a preview when a new category and subcategory are added together + ## Production `--decorate-only` option When changes to the OpenAPI are merged to the default branch of the `github/github` repository, a pull request is automatically opened with the updated dereferenced OpenAPI files. When pull requests are authored by `github-openapi-bot`, a CI test runs the `src/rest/scripts/update-files.js` script with the `--decorate-only` option. The `--decorate-only` option only decorates the dereferenced OpenAPI files, using the existing dereferenced OpenAPI schema files, and checks those changes in to the existing branch. The `--decorate-only` option is only used by a 🤖 and is only used on production dereferenced OpenAPI schema files.