Skip to content

[8.18] Update readme, gitignore (#4503) #4573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 17, 2025
Merged

[8.18] Update readme, gitignore (#4503) #4573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
455c65e
Add elasticsearch-serverless-openapi-docs.json (#4503)
lcawl Jun 12, 2025
855283b
Merge branch '8.18' into backport/8.18/pr-4503
lcawl Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,6 @@ compiler/test/**/output/
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-openapi.examples.json
output/openapi/elasticsearch-serverless-openapi-docs.json
output/openapi/elasticsearch-openapi-docs.json
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,13 @@ Follow the steps to generate the JSON representation, then:
```
# Generate the OpenAPI representation
$ make transform-to-openapi
```

To generate the JSON representation that is used for documentation purposes, the commands are different:

```
# Generate the OpenAPI files
$ make transform-to-openapi-for-docs

# Apply fixes
$ make overlay-docs
Expand Down