Skip to content

[Backport 8.x] Add OpenAPI steps to Readme.md #3874

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 1 commit into from
Mar 7, 2025
Merged

[Backport 8.x] Add OpenAPI steps to Readme.md #3874

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,20 @@ $ make generate
$ cat output/schema/schema.json
```

## How to generate the OpenAPI representation

Follow the steps to generate the JSON representation, then:

```
# Generate the OpenAPI representation
$ make transform-to-openapi

# Apply fixes
$ make overlay-docs

# The generated output can be found in ./output/openapi/
```

## Make Targets

```
Expand Down