Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] develop from postmanlabs:develop #88

Merged
merged 2 commits into from
Jan 8, 2025
Merged

[pull] develop from postmanlabs:develop #88

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
758ebfa
Fix Table of Contents links and validate preview
Yashkrit-Singh Dec 5, 2024
d092f0f
Merge pull request #837 from Yashkrit-Singh/831-pointing-links
barshan23 Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
---
---

## 💭 Getting Started
<h2 id="getting-started">💭 Getting Started</h2>

To use the converter as a Node module, you need to have a copy of the NodeJS runtime. The easiest way to do this is through npm. If you have NodeJS installed you have npm installed as well.

Expand All @@ -48,7 +48,7 @@ $ npm i -g openapi-to-postmanv2
```


## 📖 Command Line Interface
<h2 id="command-line-interface">📖 Command Line Interface</h2>

The converter can be used as a CLI tool as well. The following [command line options](#options) are available.

Expand Down Expand Up @@ -107,7 +107,7 @@ $ openapi2postmanv2 --test
```


## 🛠 Using the converter as a NodeJS module
<h2 id="using-the-converter-as-a-nodejs-module">🛠 Using the converter as a NodeJS module</h2>

In order to use the convert in your node application, you need to import the package using `require`.

Expand Down Expand Up @@ -219,7 +219,7 @@ The validate function is synchronous and returns a status object which conforms

- `reason` - Provides a reason for an unsuccessful validation of the specification

## 🧭 Conversion Schema
<h2 id="conversion-schema">🧭 Conversion Schema</h2>

| *postman* | *openapi* | *related options* |
| --- | --- | :---: |
Expand Down
Loading