Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
072239d
add a beta workflow
JaredCE Jul 13, 2025
352b5bc
don't use version
JaredCE Jul 13, 2025
18f8366
0.0.115-beta.1
JaredCE Jul 13, 2025
e5d7da3
We shouldn't need to convert schemas for 3.1.x
JaredCE Jul 13, 2025
beed295
add to README
JaredCE Jul 13, 2025
4ed4320
adds tests and fixes case
JaredCE Jul 13, 2025
7bcfa6e
fixes casing of OpenAPI
JaredCE Jul 13, 2025
1b9a104
check whether we should try and convert an OpenAPI schema
JaredCE Jul 13, 2025
e1c0f69
update README with warning
JaredCE Jul 13, 2025
b2474e2
improve README
JaredCE Jul 13, 2025
ef47e30
Merge pull request #251 from JaredCE/3.1.x-pre-release
JaredCE Jul 14, 2025
5255d1d
updates openapi-to-postmanv2 to 5.0.1
JaredCE Jul 28, 2025
6bc69e3
updates redocly-core to latest version 1
JaredCE Jul 28, 2025
cca128e
0.0.115-beta.2
JaredCE Jul 28, 2025
0247e5d
should run tests on beta too
JaredCE Jul 28, 2025
83b6965
Merge pull request #254 from JaredCE/3.1.x-dependency-updates
JaredCE Jul 28, 2025
6c53dfb
add a beta workflow
JaredCE Jul 13, 2025
60830e9
don't use version
JaredCE Jul 13, 2025
11c429d
0.0.115-beta.1
JaredCE Jul 13, 2025
9fc2784
We shouldn't need to convert schemas for 3.1.x
JaredCE Jul 13, 2025
ff09af9
add to README
JaredCE Jul 13, 2025
b1ea673
adds tests and fixes case
JaredCE Jul 13, 2025
cbbedce
fixes casing of OpenAPI
JaredCE Jul 13, 2025
b0dd69a
check whether we should try and convert an OpenAPI schema
JaredCE Jul 13, 2025
95bc6fe
update README with warning
JaredCE Jul 13, 2025
61afb97
improve README
JaredCE Jul 13, 2025
8c8e035
updates redocly-core to latest version 1
JaredCE Jul 28, 2025
b9a67df
0.0.115-beta.2
JaredCE Jul 28, 2025
57c9fab
should run tests on beta too
JaredCE Jul 28, 2025
d8edcd9
0.0.117-beta.1
JaredCE Sep 24, 2025
39b16d1
Merge branch 'beta' into beta-rebase
JaredCE Sep 24, 2025
6bdd84f
Merge pull request #259 from JaredCE/beta-rebase
JaredCE Sep 24, 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
2 changes: 1 addition & 1 deletion .github/workflows/node.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
push:
branches: ["main"]
pull_request:
branches: ["main"]
branches: ["main", "beta"]

jobs:
build:
Expand Down
35 changes: 35 additions & 0 deletions .github/workflows/npm-publish-beta.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# 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 Beta Package

on:
push:
branches:
- beta # Or your beta branch name

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 20
- run: npm ci
# - run: npm test

publish-beta-npm:
needs: build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 20
registry-url: https://registry.npmjs.org/
- run: npm ci
- name: Bump version and publish
run: npm publish --tag beta
env:
NODE_AUTH_TOKEN: ${{secrets.npm_token}}
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
</a>
</p>

This will generate an OpenAPI V3 (up to v3.0.4) 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](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.

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.

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

Expand Down
Loading