Skip to content

Commit 52c7821

Browse files
committed
update readme
1 parent d9cbcb5 commit 52c7821

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# openapi-scripts
2+
23
Scripts used in postprocessing OpenAPI document for ReDoc.
34

45
## Postprocess the JSON file generated by `bufbuild/buf`
56

6-
### dereference
7+
### Dereference
78

89
Use [@apidevtools/json-schema-ref-parser](https://github.com/APIDevTools/json-schema-ref-parser) to dereference the auto-generated JSON file.
910

@@ -44,13 +45,13 @@ The default JSON generated by `bufbuild/buf` is:
4445
}
4546
```
4647

47-
### Import markdown files
48+
### Import Markdown files
4849

4950
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.
5051

51-
### Add `x-logo`
52+
### Apply JSON patch
5253

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.
5455

5556
### Add tag group
5657

0 commit comments

Comments
 (0)