Skip to content
This repository has been archived by the owner on Dec 27, 2024. It is now read-only.

Commit

Permalink
docs: document new option
Browse files Browse the repository at this point in the history
  • Loading branch information
joolfe committed Aug 29, 2022
1 parent c16a09f commit c0a37ae
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ The third parameter used in the library method is an `options` object containing
| [responseHeaders](#responseheaders-boolean) | Indicate if should parse the response headers from the collection examples. |
| [replaceVars](#replacevars-boolean) | Boolean value to indicate if postman variables should be replaced.|
| [additionalVars](#additionalvars-object) | Object to provide additional values for variables replacement.|
| [outputFormat](#outputformat-string) | Indicate the format of the output document. |

### info (Object)

Expand Down Expand Up @@ -346,6 +347,12 @@ This parameter is a json Object that contain as key the variable name and as val

Take into account that variable values provided in the `additionalVars` Object supersede those defined at Postman collection level.

### outputFormat (string)

Indicates the resulting format of the OpenAPI document between `json` and `yaml`, the resulting file will be writte using this format and also the result value fo the method `postmanToOpenApi(...)` will use this format.

Default value is `yaml`, if you use a unknown value `yaml` will be used.

# Features

## Basic conversion
Expand Down

0 comments on commit c0a37ae

Please sign in to comment.