From 2a1d21cc60b595a298bbd42fec9bb31b2dd2eef2 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Tue, 4 Mar 2025 23:33:27 -0800 Subject: [PATCH] Add OpenAPI steps to Readme.md (#3873) (cherry picked from commit b65dd3f72a11f630263d097d9818b2ada772463e) --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 08e5e2a9dc..9cdbab23c9 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,20 @@ $ make generate $ cat output/schema/schema.json ``` +## How to generate the OpenAPI representation + +Follow the steps to generate the JSON representation, then: + +``` +# Generate the OpenAPI representation +$ make transform-to-openapi + +# Apply fixes +$ make overlay-docs + +# The generated output can be found in ./output/openapi/ +``` + ## Make Targets ```