Skip to content

Commit 93d3504

Browse files
Add OpenAPI steps to Readme.md (#3873) (#3875)
(cherry picked from commit b65dd3f) Co-authored-by: Lisa Cawley <[email protected]>
1 parent 518eda3 commit 93d3504

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,20 @@ $ make generate
5353
$ cat output/schema/schema.json
5454
```
5555

56+
## How to generate the OpenAPI representation
57+
58+
Follow the steps to generate the JSON representation, then:
59+
60+
```
61+
# Generate the OpenAPI representation
62+
$ make transform-to-openapi
63+
64+
# Apply fixes
65+
$ make overlay-docs
66+
67+
# The generated output can be found in ./output/openapi/
68+
```
69+
5670
## Make Targets
5771

5872
```

0 commit comments

Comments
 (0)