From b137531eb37178aa29d0d8755bdefb5c9f1a9fc7 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 12 Jun 2025 09:49:10 -0700 Subject: [PATCH] Add elasticsearch-serverless-openapi-docs.json (#4503) (cherry picked from commit e02c7772c899c3e01bca8a8fa2dbccecc0be818f) --- .gitignore | 4 +++- README.md | 7 +++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 68826241d8..ef46cc40cd 100644 --- a/.gitignore +++ b/.gitignore @@ -69,4 +69,6 @@ compiler/test/**/output/ output/openapi/elasticsearch-serverless-openapi.tmp*.json output/openapi/elasticsearch-serverless-openapi.examples.json output/openapi/elasticsearch-openapi.tmp*.json -output/openapi/elasticsearch-openapi.examples.json \ No newline at end of file +output/openapi/elasticsearch-openapi.examples.json +output/openapi/elasticsearch-serverless-openapi-docs.json +output/openapi/elasticsearch-openapi-docs.json diff --git a/README.md b/README.md index 6e8c85f275..b098e14f87 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,13 @@ Follow the steps to generate the JSON representation, then: ``` # Generate the OpenAPI representation $ make transform-to-openapi +``` + +To generate the JSON representation that is used for documentation purposes, the commands are different: + +``` +# Generate the OpenAPI files +$ make transform-to-openapi-for-docs # Apply fixes $ make overlay-docs