Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Oreoxmt committed Sep 22, 2022
1 parent d9cbcb5 commit 52c7821
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# openapi-scripts

Scripts used in postprocessing OpenAPI document for ReDoc.

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

### dereference
### Dereference

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

Expand Down Expand Up @@ -44,13 +45,13 @@ The default JSON generated by `bufbuild/buf` is:
}
```

### Import markdown files
### Import Markdown files

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.

### Add `x-logo`
### Apply JSON patch

[`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.
Apply JSON patch to the auto-generated JSON file. See [RFC 6902](https://tools.ietf.org/html/rfc6902) for more information.

### Add tag group

Expand Down

0 comments on commit 52c7821

Please sign in to comment.