From 494d9618d34bab57654b3cf804495401a43fd177 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 9 Jun 2025 12:14:40 -0700 Subject: [PATCH 1/3] Add elasticsearch-serverless-openapi-docs.json --- .gitignore | 4 +++- Makefile | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 68826241d8..1861b77072 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 \ No newline at end of file diff --git a/Makefile b/Makefile index f33e06f3e3..88ed7cbee3 100644 --- a/Makefile +++ b/Makefile @@ -57,6 +57,7 @@ transform-to-openapi: ## Generate the OpenAPI definition from the compiled schem transform-to-openapi-for-docs: ## Generate the OpenAPI definition tailored for API docs generation @npm run transform-to-openapi -- --schema output/schema/schema.json --flavor stack --lift-enum-descriptions --merge-multipath-endpoints --output output/openapi/elasticsearch-openapi-docs.json + @npm run transform-to-openapi -- --schema output/schema/schema.json --flavor serverless --lift-enum-descriptions --merge-multipath-endpoints --output output/openapi/elasticsearch-serverless-openapi-docs.json filter-for-serverless: ## Generate the serverless version from the compiled schema @npm run --prefix compiler filter-by-availability -- --serverless --visibility=public --input ../output/schema/schema.json --output ../output/output/openapi/elasticsearch-serverless-openapi.json From f86c7953226560e825bcd9257d98f3b7f5b55477 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 9 Jun 2025 12:27:13 -0700 Subject: [PATCH 2/3] Update commands in readme --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 9d883fa3b4..5c7aa9856b 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 From dbe967baa45044f712c3a9baa38415ba12048504 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 12 Jun 2025 09:46:16 -0700 Subject: [PATCH 3/3] Fix formatting --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 8c90476558..fe2852a137 100644 --- a/Makefile +++ b/Makefile @@ -57,7 +57,7 @@ transform-to-openapi: ## Generate the OpenAPI definition from the compiled schem transform-to-openapi-for-docs: ## Generate the OpenAPI definition tailored for API docs generation @npm run transform-to-openapi -- --schema output/schema/schema.json --flavor stack --lift-enum-descriptions --merge-multipath-endpoints --multipath-redirects --output output/openapi/elasticsearch-openapi-docs.json - @npm run transform-to-openapi -- --schema output/schema/schema.json --flavor serverless --lift-enum-descriptions --merge-multipath-endpoints --multipath-redirects --output output/openapi/elasticsearch-serverless-openapi-docs.json + @npm run transform-to-openapi -- --schema output/schema/schema.json --flavor serverless --lift-enum-descriptions --merge-multipath-endpoints --multipath-redirects --output output/openapi/elasticsearch-serverless-openapi-docs.json filter-for-serverless: ## Generate the serverless version from the compiled schema @npm run --prefix compiler filter-by-availability -- --serverless --visibility=public --input ../output/schema/schema.json --output ../output/output/openapi/elasticsearch-serverless-openapi.json