Skip to content

Commit ec79b8e

Browse files
lcawlgithub-actions[bot]
authored andcommitted
Add elasticsearch-serverless-openapi-docs.json (#4503)
(cherry picked from commit e02c777)
1 parent 694a7cf commit ec79b8e

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,4 +69,6 @@ compiler/test/**/output/
6969
output/openapi/elasticsearch-serverless-openapi.tmp*.json
7070
output/openapi/elasticsearch-serverless-openapi.examples.json
7171
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

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ transform-to-openapi: ## Generate the OpenAPI definition from the compiled schem
5454

5555
transform-to-openapi-for-docs: ## Generate the OpenAPI definition tailored for API docs generation
5656
@npm run transform-to-openapi -- --schema output/schema/schema.json --flavor stack --lift-enum-descriptions --merge-multipath-endpoints --multipath-redirects --output output/openapi/elasticsearch-openapi-docs.json
57+
@npm run transform-to-openapi -- --schema output/schema/schema.json --flavor serverless --lift-enum-descriptions --merge-multipath-endpoints --multipath-redirects --output output/openapi/elasticsearch-serverless-openapi-docs.json
5758

5859
filter-for-serverless: ## Generate the serverless version from the compiled schema
5960
@npm run --prefix compiler filter-by-availability -- --serverless --visibility=public --input ../output/schema/schema.json --output ../output/output/openapi/elasticsearch-serverless-openapi.json

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,13 @@ Follow the steps to generate the JSON representation, then:
6060
```
6161
# Generate the OpenAPI representation
6262
$ 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
6370
6471
# Apply fixes
6572
$ make overlay-docs

0 commit comments

Comments
 (0)