Skip to content

Commit 4e1170c

Browse files
committed
[DOCS] Change source for overlay-docs (#4504)
(cherry picked from commit 26ed911)
1 parent 4558150 commit 4e1170c

File tree

2 files changed

+9
-13
lines changed

2 files changed

+9
-13
lines changed

.gitignore

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,6 @@ output/schema/schema
6565
# Test suite outputs
6666
compiler/test/**/output/
6767

68-
# Temporary openAPI files
69-
output/openapi/elasticsearch-serverless-openapi.tmp*.json
70-
output/openapi/elasticsearch-serverless-openapi.examples.json
71-
output/openapi/elasticsearch-openapi.tmp*.json
72-
output/openapi/elasticsearch-openapi.examples.json
73-
output/openapi/elasticsearch-serverless-openapi-docs.json
74-
output/openapi/elasticsearch-openapi-docs.json
68+
# Temporary openAPI documentation files
69+
output/openapi/elasticsearch-openapi-docs*.json
70+
output/openapi/elasticsearch*.redirects.csv

Makefile

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@ dump-routes: ## Create a new schema with all generics expanded
6565
@npm run dump-routes --prefix compiler
6666

6767
overlay-docs: ## Apply overlays to OpenAPI documents
68-
@npx bump overlay "output/openapi/elasticsearch-openapi.json" "docs/overlays/elasticsearch-openapi-overlays.yaml" > "output/openapi/elasticsearch-openapi.tmp1.json"
69-
@npx bump overlay "output/openapi/elasticsearch-openapi.tmp1.json" "docs/overlays/elasticsearch-shared-overlays.yaml" > "output/openapi/elasticsearch-openapi.tmp2.json"
70-
@npx @redocly/cli bundle output/openapi/elasticsearch-openapi.tmp2.json --ext json -o output/openapi/elasticsearch-openapi.examples.json
71-
rm output/openapi/elasticsearch-openapi.tmp*.json
68+
@npx bump overlay "output/openapi/elasticsearch-openapi-docs.json" "docs/overlays/elasticsearch-openapi-overlays.yaml" > "output/openapi/elasticsearch-openapi-docs.tmp1.json"
69+
@npx bump overlay "output/openapi/elasticsearch-openapi-docs.tmp1.json" "docs/overlays/elasticsearch-shared-overlays.yaml" > "output/openapi/elasticsearch-openapi-docs.tmp2.json"
70+
@npx @redocly/cli bundle output/openapi/elasticsearch-openapi-docs.tmp2.json --ext json -o output/openapi/elasticsearch-openapi-docs-final.json
71+
rm output/openapi/elasticsearch-openapi-docs.tmp*.json
7272

7373
generate-language-examples:
7474
@node docs/examples/generate-language-examples.js
@@ -81,8 +81,8 @@ generate-language-examples-with-java:
8181
lint-docs: ## Lint the OpenAPI documents after overlays
8282
@npx @redocly/cli lint "output/openapi/elasticsearch-*.json" --config "docs/linters/redocly.yaml" --format stylish --max-problems 500
8383

84-
lint-docs-stateful: ## Lint only the elasticsearch-openapi.examples.json file
85-
@npx @redocly/cli lint "output/openapi/elasticsearch-openapi.examples.json" --config "docs/linters/redocly.yaml" --format stylish --max-problems 500
84+
lint-docs-stateful: ## Lint only the elasticsearch-openapi-docs-final.json file
85+
@npx @redocly/cli lint "output/openapi/elasticsearch-openapi-docs-final.json" --config "docs/linters/redocly.yaml" --format stylish --max-problems 500
8686

8787
contrib: | generate license-check spec-format-fix transform-to-openapi filter-for-serverless lint-docs ## Pre contribution target
8888

0 commit comments

Comments
 (0)