File tree Expand file tree Collapse file tree 3 files changed +10
-8
lines changed Expand file tree Collapse file tree 3 files changed +10
-8
lines changed Original file line number Diff line number Diff line change @@ -69,4 +69,6 @@ compiler/test/**/output/
69
69
output /openapi /elasticsearch-serverless-openapi.tmp * .json
70
70
output /openapi /elasticsearch-serverless-openapi.examples.json
71
71
output /openapi /elasticsearch-openapi.tmp * .json
72
- output /openapi /elasticsearch-openapi.examples.json
72
+ output /openapi /elasticsearch-openapi.examples.json
73
+ output /openapi /elasticsearch-serverless-openapi-docs.json
74
+ output /openapi /elasticsearch-openapi-docs.json
Original file line number Diff line number Diff line change @@ -62,13 +62,9 @@ dump-routes: ## Create a new schema with all generics expanded
62
62
@npm run dump-routes --prefix compiler
63
63
64
64
overlay-docs : # # Apply overlays to OpenAPI documents
65
- @npx bump overlay " output/openapi/elasticsearch-serverless-openapi.json" " docs/overlays/elasticsearch-serverless-openapi-overlays.yaml" > " output/openapi/elasticsearch-serverless-openapi.tmp1.json"
66
- @npx bump overlay " output/openapi/elasticsearch-serverless-openapi.tmp1.json" " docs/overlays/elasticsearch-shared-overlays.yaml" > " output/openapi/elasticsearch-serverless-openapi.tmp2.json"
67
- @npx @redocly/cli bundle output/openapi/elasticsearch-serverless-openapi.tmp2.json --ext json -o output/openapi/elasticsearch-serverless-openapi.examples.json
68
65
@npx bump overlay " output/openapi/elasticsearch-openapi.json" " docs/overlays/elasticsearch-openapi-overlays.yaml" > " output/openapi/elasticsearch-openapi.tmp1.json"
69
66
@npx bump overlay " output/openapi/elasticsearch-openapi.tmp1.json" " docs/overlays/elasticsearch-shared-overlays.yaml" > " output/openapi/elasticsearch-openapi.tmp2.json"
70
67
@npx @redocly/cli bundle output/openapi/elasticsearch-openapi.tmp2.json --ext json -o output/openapi/elasticsearch-openapi.examples.json
71
- rm output/openapi/elasticsearch-serverless-openapi.tmp* .json
72
68
rm output/openapi/elasticsearch-openapi.tmp* .json
73
69
74
70
lint-docs : # # Lint the OpenAPI documents after overlays
@@ -77,9 +73,6 @@ lint-docs: ## Lint the OpenAPI documents after overlays
77
73
lint-docs-stateful : # # Lint only the elasticsearch-openapi.examples.json file
78
74
@npx @redocly/cli lint " output/openapi/elasticsearch-openapi.examples.json" --config " docs/linters/redocly.yaml" --format stylish --max-problems 500
79
75
80
- lint-docs-serverless : # # Lint only the serverless OpenAPI document after overlays
81
- @npx @redocly/cli lint " output/openapi/elasticsearch-serverless-openapi.examples.json" --config " docs/linters/redocly.yaml" --format stylish --max-problems 500
82
-
83
76
contrib : | generate license-check spec-format-fix transform-to-openapi filter-for-serverless lint-docs # # Pre contribution target
84
77
85
78
help : # # Display help
Original file line number Diff line number Diff line change @@ -60,6 +60,13 @@ Follow the steps to generate the JSON representation, then:
60
60
```
61
61
# Generate the OpenAPI representation
62
62
$ make transform-to-openapi
63
+ ```
64
+
65
+ To generate the JSON representation that is used for documentation purposes, the commands are different:
66
+
67
+ ```
68
+ # Generate the OpenAPI files
69
+ $ make transform-to-openapi-for-docs
63
70
64
71
# Apply fixes
65
72
$ make overlay-docs
You can’t perform that action at this time.
0 commit comments