diff --git a/.gitignore b/.gitignore index 1861b77072..de557a2e20 100644 --- a/.gitignore +++ b/.gitignore @@ -65,10 +65,7 @@ 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 +output/openapi/elasticsearch*.redirects.csv \ No newline at end of file diff --git a/Makefile b/Makefile index 6eb10a0f53..f3d8da09f0 100644 --- a/Makefile +++ b/Makefile @@ -65,10 +65,10 @@ 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-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-openapi.tmp*.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-openapi-docs.tmp*.json generate-language-examples: @node docs/examples/generate-language-examples.js @@ -81,8 +81,8 @@ 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 contrib: | generate license-check spec-format-fix transform-to-openapi filter-for-serverless lint-docs ## Pre contribution target