Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Oreoxmt authored Jul 27, 2022
1 parent 49c774a commit 9292396
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
# openapi-scripts
Scripts used in postprocessing OpenAPI document for ReDoc.

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

### dereference

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

### Generate code sample
ToDo

Use [openapi-snippet](https://github.com/ErikWittern/openapi-snippet) to generate code samples automatically.

### Convert string to int for int32 type in `.proto`

ToDo

### Import markown 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
### Add `x-logo`

[`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 comments on commit 9292396

Please sign in to comment.