From f9f397930b04e7b2397e0244a1c1675481dfeecb Mon Sep 17 00:00:00 2001 From: Jorge Date: Sat, 15 Jan 2022 20:48:41 +0100 Subject: [PATCH] docs: updates docs --- docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 08ff2f7..fb9530f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -60,11 +60,11 @@ npm i postman-to-openapi -g ## As library -Use the library is as easy as use a single method `async postmanToOpenApi(inputPath, outputPath, options)`, the parameters are: +Use the library is as easy as use a single method `async postmanToOpenApi(input, outputPath, options)`, the parameters are: | Param | Description | |--------------|---------------------------------------------------------------------------------------------| -| `inputPath` | String. Path of the Postman collection file. | +| `input` | String. Path of the Postman collection file or value of the postman collection as String. | | `outputPath` | String. Path of the output file where the OpenAPi will be stored. This param is optional if not provided (`undefined` or `null`) no file will be saved. | | `options` | Object. Optional configuration, see [options](#options) section for a detailed description. |