From 137611f6c2ff6bf5b4a2d385b6bde8b5f9fb329d Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 9 Jun 2025 12:26:35 -0700 Subject: [PATCH 1/2] [DOCS] Change source for overlay-docs --- .gitignore | 10 +++------- Makefile | 22 +++++++++++----------- 2 files changed, 14 insertions(+), 18 deletions(-) diff --git a/.gitignore b/.gitignore index 1861b77072..30de0cc875 100644 --- a/.gitignore +++ b/.gitignore @@ -65,10 +65,6 @@ output/schema/schema # Test suite outputs compiler/test/**/output/ -# Temporary openAPI files -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 -output/openapi/elasticsearch-serverless-openapi-docs.json -output/openapi/elasticsearch-openapi-docs.json \ No newline at end of file +# Temporary openAPI documentation files +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 468fc02464..eae04f3ac9 100644 --- a/Makefile +++ b/Makefile @@ -69,14 +69,14 @@ dump-routes: ## Create a new schema with all generics expanded @npm run dump-routes --prefix compiler overlay-docs: ## Apply overlays to OpenAPI documents - @npx bump overlay "output/openapi/elasticsearch-serverless-openapi.json" "docs/overlays/elasticsearch-serverless-openapi-overlays.yaml" > "output/openapi/elasticsearch-serverless-openapi.tmp1.json" - @npx bump overlay "output/openapi/elasticsearch-serverless-openapi.tmp1.json" "docs/overlays/elasticsearch-shared-overlays.yaml" > "output/openapi/elasticsearch-serverless-openapi.tmp2.json" - @npx @redocly/cli bundle output/openapi/elasticsearch-serverless-openapi.tmp2.json --ext json -o output/openapi/elasticsearch-serverless-openapi.examples.json - @npx bump overlay "output/openapi/elasticsearch-openapi.json" "docs/overlays/elasticsearch-openapi-overlays.yaml" > "output/openapi/elasticsearch-openapi.tmp1.json" - @npx bump overlay "output/openapi/elasticsearch-openapi.tmp1.json" "docs/overlays/elasticsearch-shared-overlays.yaml" > "output/openapi/elasticsearch-openapi.tmp2.json" - @npx @redocly/cli bundle output/openapi/elasticsearch-openapi.tmp2.json --ext json -o output/openapi/elasticsearch-openapi.examples.json - rm output/openapi/elasticsearch-serverless-openapi.tmp*.json - rm output/openapi/elasticsearch-openapi.tmp*.json + @npx bump overlay "output/openapi/elasticsearch-serverless-openapi-docs.json" "docs/overlays/elasticsearch-serverless-openapi-overlays.yaml" > "output/openapi/elasticsearch-serverless-openapi-docs.tmp1.json" + @npx bump overlay "output/openapi/elasticsearch-serverless-openapi-docs.tmp1.json" "docs/overlays/elasticsearch-shared-overlays.yaml" > "output/openapi/elasticsearch-serverless-openapi-docs.tmp2.json" + @npx @redocly/cli bundle output/openapi/elasticsearch-serverless-openapi-docs.tmp2.json --ext json -o output/openapi/elasticsearch-serverless-openapi-docs-final.json + @npx bump overlay "output/openapi/elasticsearch-openapi-docs.json" "docs/overlays/elasticsearch-openapi-overlays.yaml" > "output/openapi/elasticsearch-openapi-docs.tmp1.json" + @npx bump overlay "output/openapi/elasticsearch-openapi-docs.tmp1.json" "docs/overlays/elasticsearch-shared-overlays.yaml" > "output/openapi/elasticsearch-openapi-docs.tmp2.json" + @npx @redocly/cli bundle output/openapi/elasticsearch-openapi-docs.tmp2.json --ext json -o output/openapi/elasticsearch-openapi-docs-final.json + rm output/openapi/elasticsearch-serverless-openapi-docs.tmp*.json + rm output/openapi/elasticsearch-openapi-docs.tmp*.json generate-language-examples: @node docs/examples/generate-language-examples.js @@ -89,11 +89,11 @@ generate-language-examples-with-java: lint-docs: ## Lint the OpenAPI documents after overlays @npx @redocly/cli lint "output/openapi/elasticsearch-*.json" --config "docs/linters/redocly.yaml" --format stylish --max-problems 500 -lint-docs-stateful: ## Lint only the elasticsearch-openapi.examples.json file - @npx @redocly/cli lint "output/openapi/elasticsearch-openapi.examples.json" --config "docs/linters/redocly.yaml" --format stylish --max-problems 500 +lint-docs-stateful: ## Lint only the elasticsearch-openapi-docs-final.json file + @npx @redocly/cli lint "output/openapi/elasticsearch-openapi-docs-final.json" --config "docs/linters/redocly.yaml" --format stylish --max-problems 500 lint-docs-serverless: ## Lint only the serverless OpenAPI document after overlays - @npx @redocly/cli lint "output/openapi/elasticsearch-serverless-openapi.examples.json" --config "docs/linters/redocly.yaml" --format stylish --max-problems 500 + @npx @redocly/cli lint "output/openapi/elasticsearch-serverless-openapi-docs-final.json" --config "docs/linters/redocly.yaml" --format stylish --max-problems 500 contrib: | generate license-check spec-format-fix transform-to-openapi filter-for-serverless lint-docs ## Pre contribution target From a1fe0c8f8c591f07074d00812832f6b511086b20 Mon Sep 17 00:00:00 2001 From: lcawl Date: Fri, 20 Jun 2025 09:16:52 -0700 Subject: [PATCH 2/2] Add redirect files to gitignore --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 30de0cc875..de557a2e20 100644 --- a/.gitignore +++ b/.gitignore @@ -67,4 +67,5 @@ compiler/test/**/output/ # Temporary openAPI documentation files output/openapi/elasticsearch-serverless-openapi-docs*.json -output/openapi/elasticsearch-openapi-docs*.json \ No newline at end of file +output/openapi/elasticsearch-openapi-docs*.json +output/openapi/elasticsearch*.redirects.csv \ No newline at end of file