From c51d57776806bf64e2d7634b5247a2cc85216b65 Mon Sep 17 00:00:00 2001 From: Matthias Gatto Date: Thu, 19 Dec 2024 14:39:38 +0100 Subject: [PATCH] improve readme Signed-off-by: Matthias Gatto --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8c48737..dedd926 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ For the Outscale API, the YAML source is converted to JSON using `yq`: (https:// When generating API calls, COGNAC by default assumes that the OpenAPI file contains components named CallRequest. For example, if the API has a call named `CreatePony`, the corresponding component should be located at `#/components/schemas/CreatePonyRequest`. -You can change the suffix of functions using `./configure --function-suffix FUNCTION_SUFFIX` +You can modify the suffix of functions by using `--function-suffix=FUNCTION_SUFFIX` option with `./configure` command. Or you can generate functions using what is inside `paths`, using `./configure --from-path` @@ -58,8 +58,8 @@ Run the following command: ```bash --function-suffix Input ``` -Look for Function named XInput instead of XRequest. +Search for functions named XInput instead of XRequest. ```bash --api-script='curl -s https://ponyapi.yolo | yq $(YQ_ARG) > osc-api.json' ```