You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Scripts used in postprocessing OpenAPI document for ReDoc.
3
+
3
4
## Postprocess the JSON file generated by `bufbuild/buf`
4
5
5
6
### dereference
7
+
6
8
Use [@apidevtools/json-schema-ref-parser](https://github.com/APIDevTools/json-schema-ref-parser) to dereference the auto-generated JSON file.
9
+
7
10
### Generate code sample
8
-
ToDo
11
+
12
+
Use [openapi-snippet](https://github.com/ErikWittern/openapi-snippet) to generate code samples automatically.
13
+
9
14
### Convert string to int for int32 type in `.proto`
15
+
10
16
ToDo
11
17
12
18
### Import markown files
13
19
14
20
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.
15
21
16
-
### Add x-logo
22
+
### Add `x-logo`
17
23
18
24
[`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