openapi-to-postmanv2/SYNC_OPTIONS.md

Convert a given OpenAPI specification to Postman Collection v2.0

# Sync Options

This document describes the available options for syncing OpenAPI specifications with existing Postman collections using the `syncCollection` functionality.

## Available Sync Options

| id | type | default | description | version |
|---|---|---|---|---|
| syncExamples | boolean | false | Whether to sync response examples from the OpenAPI specification to the collection. When enabled, response examples in the spec will be synced with existing collection responses. | v2 |
| deleteOrphanedRequests | boolean | false | Whether to delete requests and folders that exist in the collection but no longer exist in the OpenAPI specification. When disabled (default), such orphans are preserved to avoid unintentional data loss. | v2 |

## Usage

### CLI Usage

#### Using inline sync options:
```bash
openapi2postmanv2 -s spec.yaml --sync collection.json --sync-options syncExamples=true -o synced.json
```

#### Using sync options config file:
```bash
openapi2postmanv2 -s spec.yaml --sync collection.json --sync-options-config sync-options.json -o synced.json
```

**sync-options.json:**
```json
{
  "syncExamples": true
}
```