Skip to content

Commit 9292396

Browse files
authored
Update README.md
1 parent 49c774a commit 9292396

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
11
# openapi-scripts
22
Scripts used in postprocessing OpenAPI document for ReDoc.
3+
34
## Postprocess the JSON file generated by `bufbuild/buf`
45

56
### dereference
7+
68
Use [@apidevtools/json-schema-ref-parser](https://github.com/APIDevTools/json-schema-ref-parser) to dereference the auto-generated JSON file.
9+
710
### Generate code sample
8-
ToDo
11+
12+
Use [openapi-snippet](https://github.com/ErikWittern/openapi-snippet) to generate code samples automatically.
13+
914
### Convert string to int for int32 type in `.proto`
15+
1016
ToDo
1117

1218
### Import markown files
1319

1420
Embed external Markdown file contents to the `info.description` auto-generated JSON file. See [Redoc documentation](https://redocly.com/docs/api-reference-docs/guides/embedded-markdown/) for more information.
1521

16-
### Add x-logo
22+
### Add `x-logo`
1723

1824
[`x-logo`](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md#x-logo) is a [vendor extension](https://swagger.io/specification/#specificationExtensions) from Redoc. It allows you to show a custom logo on the left upper corner of your redoc output.

0 commit comments

Comments
 (0)