From badc31c4ad4964885e25d20723e677351c260138 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 9 Jun 2025 12:26:35 -0700 Subject: [PATCH] [DOCS] Change source for overlay-docs --- .gitignore | 8 ++++---- Makefile | 22 +++++++++++----------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.gitignore b/.gitignore index 68826241d8..37aa8d7301 100644 --- a/.gitignore +++ b/.gitignore @@ -66,7 +66,7 @@ output/schema/schema 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 \ No newline at end of file +output/openapi/elasticsearch-serverless-openapi-docs.tmp*.json +output/openapi/elasticsearch-serverless-openapi-docs-final.json +output/openapi/elasticsearch-openapi-docs.tmp*.json +output/openapi/elasticsearch-openapi-docs-final.json \ No newline at end of file diff --git a/Makefile b/Makefile index f33e06f3e3..38fa6c0367 100644 --- a/Makefile +++ b/Makefile @@ -65,23 +65,23 @@ 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 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