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
Copy file name to clipboardExpand all lines: README.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,10 @@
1
1
# openapi-scripts
2
+
2
3
Scripts used in postprocessing OpenAPI document for ReDoc.
3
4
4
5
## Postprocess the JSON file generated by `bufbuild/buf`
5
6
6
-
### dereference
7
+
### Dereference
7
8
8
9
Use [@apidevtools/json-schema-ref-parser](https://github.com/APIDevTools/json-schema-ref-parser) to dereference the auto-generated JSON file.
9
10
@@ -44,13 +45,13 @@ The default JSON generated by `bufbuild/buf` is:
44
45
}
45
46
```
46
47
47
-
### Import markdown files
48
+
### Import Markdown files
48
49
49
50
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.
50
51
51
-
### Add `x-logo`
52
+
### Apply JSON patch
52
53
53
-
[`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.
54
+
Apply JSON patch to the auto-generated JSON file. See [RFC 6902](https://tools.ietf.org/html/rfc6902) for more information.
0 commit comments