Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
8c48883
updates openapi-to-postmanv2 to 5.6.0
JaredCE Nov 28, 2025
7afd42f
0.0.119
JaredCE Nov 28, 2025
9c592fb
test on node 24.x
JaredCE Nov 28, 2025
90220a1
Merge pull request #263 from JaredCE/openapi-to-postmanv2@5.6.0
JaredCE Nov 28, 2025
38baa70
Add a spec for Bruno generation
JaredCE Dec 15, 2025
49e88e1
add a spec for Postman generation
JaredCE Dec 15, 2025
2549132
add a spec for a collection factory
JaredCE Dec 15, 2025
4cef49e
stop these tests
JaredCE Dec 15, 2025
3712a15
update generation commands for postman and bruno
JaredCE Dec 15, 2025
3318e83
add a 400 error for redocly validation
JaredCE Dec 15, 2025
f70040d
update README to include Bruno generation notes
JaredCE Dec 15, 2025
7923ae0
install the Bruno convertor
JaredCE Dec 15, 2025
f0c8d30
create a Postman collection creator
JaredCE Dec 15, 2025
06e3526
create a Bruno collection creator
JaredCE Dec 15, 2025
89f3641
build a collection factory
JaredCE Dec 15, 2025
3360f08
allow generation of Bruno colections
JaredCE Dec 15, 2025
afc986c
0.0.120
JaredCE Dec 15, 2025
8a7857e
Merge pull request #265 from JaredCE/bruno-conversion
JaredCE Dec 15, 2025
94fcf2b
update for secure publishing
JaredCE Dec 15, 2025
880bc47
Merge pull request #266 from JaredCE/secure-publishing
JaredCE Dec 15, 2025
47c7d1d
0.0.121
JaredCE Dec 15, 2025
a910ba5
slim down the published package
JaredCE Dec 15, 2025
310c7a1
Merge pull request #267 from JaredCE/0.0.121
JaredCE Dec 15, 2025
4358241
all fields in contact obj are optional
JaredCE Jan 4, 2026
103d930
only add ehaders if there are any
JaredCE Jan 4, 2026
86efbed
check the length
JaredCE Jan 4, 2026
ccf8c71
improved handling of multiple contentTypes
JaredCE Jan 4, 2026
5c46818
correctly handle multiple media types
JaredCE Jan 4, 2026
aff03aa
improve tests
JaredCE Jan 29, 2026
63e2254
improve tests
JaredCE Jan 29, 2026
9b81702
improve checks
JaredCE Jan 29, 2026
018c678
0.0.122
JaredCE Jan 29, 2026
a77de03
Merge pull request #268 from JaredCE/minor-documentation-fixes
JaredCE Jan 29, 2026
3d33d95
updates the libraries
JaredCE Jan 29, 2026
7affecf
0.0.123
JaredCE Jan 29, 2026
288d74c
Merge pull request #269 from JaredCE/update-collections-libraries
JaredCE Jan 29, 2026
a22b42d
add a beta workflow
JaredCE Jul 13, 2025
b50f7b7
don't use version
JaredCE Jul 13, 2025
c054513
We shouldn't need to convert schemas for 3.1.x
JaredCE Jul 13, 2025
5829aa8
add to README
JaredCE Jul 13, 2025
acb223c
adds tests and fixes case
JaredCE Jul 13, 2025
5ccbe0a
fixes casing of OpenAPI
JaredCE Jan 29, 2026
0c18f91
check whether we should try and convert an OpenAPI schema
JaredCE Jul 13, 2025
2cd0577
update README with warning
JaredCE Jul 13, 2025
b4fb2be
improve README
JaredCE Jan 29, 2026
27112ab
updates redocly-core to latest version 1
JaredCE Jan 29, 2026
8231e09
should run tests on beta too
JaredCE Jul 28, 2025
9d5b20a
add a beta workflow
JaredCE Jul 13, 2025
9e0f8d5
don't use version
JaredCE Jul 13, 2025
2de9491
We shouldn't need to convert schemas for 3.1.x
JaredCE Jul 13, 2025
fdfe3c9
add to README
JaredCE Jul 13, 2025
47df351
check whether we should try and convert an OpenAPI schema
JaredCE Jul 13, 2025
3aca723
update README with warning
JaredCE Jul 13, 2025
f1aedf7
improve README
JaredCE Jul 13, 2025
1492d2e
updates redocly-core to latest version 1
JaredCE Jan 29, 2026
79c382f
0.0.115-beta.1
JaredCE Jan 29, 2026
d6b8b98
We shouldn't need to convert schemas for 3.1.x
JaredCE Jan 29, 2026
0327828
add to README
JaredCE Jul 13, 2025
283efce
check whether we should try and convert an OpenAPI schema
JaredCE Jul 13, 2025
3f01856
update README with warning
JaredCE Jul 13, 2025
e00d8d6
improve README
JaredCE Jan 29, 2026
16340b6
0.0.115-beta.2
JaredCE Jul 28, 2025
473fbbc
0.0.117-beta.1
JaredCE Sep 24, 2025
5adf95b
We shouldn't need to convert schemas for 3.1.x
JaredCE Jan 29, 2026
703eaab
add to README
JaredCE Jul 13, 2025
8670a9b
check whether we should try and convert an OpenAPI schema
JaredCE Jul 13, 2025
219719a
update README with warning
JaredCE Jul 13, 2025
d0a3219
improve README
JaredCE Jan 29, 2026
cc89f7e
0.0.118-beta.1
JaredCE Jan 29, 2026
236204e
add some extra debugging
JaredCE Jan 29, 2026
c8e0059
0.0.120-beta.1
JaredCE Jan 29, 2026
bb4b780
update README
JaredCE Jan 29, 2026
e4eb8b3
Merge branch 'beta' into beta-rebase
JaredCE Jan 29, 2026
4f10e67
0.0.124-beta.1
JaredCE Jan 29, 2026
f8b89a9
remove deprecated tests
JaredCE Jan 29, 2026
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
4 changes: 2 additions & 2 deletions .github/workflows/node.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ jobs:
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: "npm"
Expand Down
18 changes: 11 additions & 7 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages

name: Node.js Package
name: Publish npm Package

on:
release:
types: [created]

permissions:
id-token: write # Required for OIDC
contents: read

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
- run: npm ci
Expand All @@ -22,12 +26,12 @@ jobs:
needs: build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 20
registry-url: https://registry.npmjs.org/
- name: Update npm
run: npm install -g npm@latest
- run: npm ci
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{secrets.npm_token}}
3 changes: 2 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/test/serverless-tests/*
/test/*
.github/*
.gitignore
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
</a>
</p>

This will generate an [OpenAPI V3](https://spec.openapis.org/oas/v3.0.0.html) (up to v3.0.4) specification file for you from your serverless file. It can optionally generate a [Postman Collection V2](https://github.com/postmanlabs/openapi-to-postman) from the OpenAPI file for you too. This currently works for `http` and `httpApi` configurations.
This will generate an OpenAPI V3 (up to v3.0.4) Document file for you from your serverless file. It can optionally generate a [Postman Collection V2](https://github.com/postmanlabs/openapi-to-postman) or (as of 0.0.120) [Bruno Collection](https://docs.usebruno.com/) from the OpenAPI file. This currently works for `http` and `httpApi` configurations.

If you are using the beta of 0.0.115, it will now try and create [OpenAPI V3.1 (3.1.x)](https://spec.openapis.org/oas/v3.1.0.html) specification file for you, should you run the command `serverless openapi generate -o openapi.json -f json -a 3.1.1 -p postman.json`. Please see this [guide on migrating to V3.1](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0). Whilst I perosnally use this plugin all the time, please do open and report bugs, and I will do my best to fix them.
If you are using the beta of 0.0.115, it will now try and create [OpenAPI V3.1 (3.1.x)](https://spec.openapis.org/oas/v3.1.0.html) Document for you, should you run the command `serverless openapi generate -o openapi.json -f json -a 3.1.1 -p postman.json`. Please see this [guide on migrating to V3.1](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0). Whilst I perosnally use this plugin all the time, please do open and report bugs, and I will do my best to fix them.

Originally based off of: https://github.com/temando/serverless-openapi-documentation

Expand Down Expand Up @@ -51,6 +51,7 @@ Options:
--indent -i File indentation in spaces. Default: 2
--openApiVersion -a OpenAPI version to generate for. Default: 3.0.0
--postmanCollection -p Will generate a postman collection (from the generated OpenAPI Description), in json only, if passed in. Default: postman.json
--brunoCollection -b Will generate a Bruno collection (from the generated OpenAPI Description), in json only, if passed in. Default: bruno.json
--validationWarn -w Warn about validation errors only. Will write the OpenAPI file if generation is successful. Default: false
```

Expand Down Expand Up @@ -1110,7 +1111,7 @@ module.exports = {
dereference: {
circular: false, // Don't allow circular $refs
excludedPathMatcher: (
path // Skip dereferencing content under any 'example' key
path, // Skip dereferencing content under any 'example' key
) => path.includes("/example/"),
},
};
Expand Down
Loading