From efa9abe9c4108bae9bca558aed72eb7eaa0540da Mon Sep 17 00:00:00 2001 From: lukaw3d Date: Fri, 20 Sep 2024 21:05:23 +0200 Subject: [PATCH] Improve OasisScan's swagger README --- .changelog/2060.trivial.md | 1 + src/vendors/oasisscan/README.md | 40 +++++++++++++++++++++++++++++++-- 2 files changed, 39 insertions(+), 2 deletions(-) create mode 100644 .changelog/2060.trivial.md diff --git a/.changelog/2060.trivial.md b/.changelog/2060.trivial.md new file mode 100644 index 0000000000..a227fbef3f --- /dev/null +++ b/.changelog/2060.trivial.md @@ -0,0 +1 @@ +Improve OasisScan's swagger README diff --git a/src/vendors/oasisscan/README.md b/src/vendors/oasisscan/README.md index b9b047a386..4c11b78db8 100644 --- a/src/vendors/oasisscan/README.md +++ b/src/vendors/oasisscan/README.md @@ -1,3 +1,39 @@ -# Oasis Scan +# Typescript bindings for Oasis Scan -See [../explorer/README.md](../explorer/README.md) +This folder contains generated typescript bindings for OasisScan. + +To update the bindings: + +1. Update swagger.yml based on + - + - + - + +2. Generate the bindings: + + ```sh + npx @openapitools/openapi-generator-cli generate \ + -i swagger.yml \ + -g typescript-fetch \ + -o . \ + --additional-properties=modelPropertyNaming=original,typescriptThreePlus=true + ``` + + or + + ```sh + docker run --rm --user "${UID}:${GID}" \ + -v ${PWD}:/local \ + --workdir /local \ + openapitools/openapi-generator-cli:v5.1.0 generate \ + -i swagger.yml \ + -g typescript-fetch \ + -o . \ + --additional-properties=modelPropertyNaming=original,typescriptThreePlus=true + ``` + +3. Lint: + + ```sh + yarn lint:fix + ```