From 15076eaa420b96900e1bd6b9d6008b946a56e98f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=81=B5=E3=81=81?= Date: Tue, 13 Jun 2023 15:33:34 +0900 Subject: [PATCH] update README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: ふぁ --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5c76f32..5262ac3 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,12 @@ Twitter OpenAPI(Swagger) specification ## Usage ```shell -openapi-generator-cli generate -g -i https://raw.githubusercontent.com/fa0311/twitter-openapi/main/dist/typescript/openapi-3.0.yaml -o ./generated +openapi-generator-cli generate -g -i https://raw.githubusercontent.com/fa0311/twitter-openapi/main/dist/docs/openapi-3.0.yaml -o ./generated ``` -If the language supports variable-length arguments. - -```shell -openapi-generator-cli generate -g -i https://raw.githubusercontent.com/fa0311/twitter-openapi/main/dist/dart/openapi-3.0.yaml -o ./generated -``` +There are several outputs, but the one that best follows the OpenAPI specification is `dist/docs`. +However, some Generators may use a syntax that is not supported. +You can also modify the hook to make the generated results more user-friendly. [build_config.py](./tools/build_config.py) Note that the license also inherits to the output.