Skip to content

Commit 32b468c

Browse files
committed
Update readme, fix types
1 parent 5cc5086 commit 32b468c

File tree

2 files changed

+0
-21
lines changed

2 files changed

+0
-21
lines changed

README.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
- [x] **Custom Domain + SSL** - Auto-configure a custom domain w/ a free AWS ACM SSL certificate.
1515
- [x] **Team Collaboration** - Collaborate with your teamates with shared state and outputs.
1616
- [x] **Built-in Monitoring** - Monitor your express app right from the Serverless Dashboard.
17-
- [x] **(NEW) Auto-Generate An OpenAPI Spec On Each Deployment** - A new OpenAPI spec is generated after each deployment.
1817

1918
<br/>
2019

@@ -115,7 +114,6 @@ inputs:
115114
- arn:aws:second:layer
116115
domain: api.serverless.com # (optional) if the domain was registered via AWS Route53 on the account you are deploying to, it will automatically be set-up with your Express app's API Gateway, as well as a free AWS ACM SSL Cert.
117116
region: us-east-2 # (optional) aws region to deploy to. default is us-east-1.
118-
openApi: true # (optional) (experimental) Initialize the express app on each deployment, extract an OpenAPI V.3 specification, and add it to the outputs.
119117
```
120118
121119
Once you've chosen your configuration, run `serverless deploy` again (or simply just `serverless`) to deploy your changes.
@@ -221,21 +219,6 @@ If things aren't working, revert your code to the old code, remove the `traffic`
221219

222220
If things are working, keep the new code, remove the `traffic` configuration option, and deploy.
223221

224-
### Auto-Generate An OpenAPI V3 Specification From Your Express.js App
225-
226-
Version 1.5.0 introduced experimental support for auto-generating an OpenAPI specification from your Express app upon every deployment, then adding them to the `outputs` of your app.
227-
228-
This works by attempting to run your application on each deployment and extracting the routes you've defined in your Express app.
229-
230-
Currently, this feature is disabled by default, since it's experimental. To enable it, add `openApi: true` to your `serverless.yml` and ensure you are using the latest version of the Express coponent (>= 1.1.0).
231-
232-
Given a lot of things can happen in your application upon starting it up, this does not work consistently. For example, your environment variables will NOT be available during this process, which could cause your app not to initialize.
233-
234-
If it runs into an error trying to start your application, it will try its best to pass through useful errors to you so you can address what's blocking it from working. You can see these by running `serverless deploy --debug`
235-
236-
Overall, an OpenAPI specification generated by default is very powerful. This means you don't have to maintain that manually since it auto-updates on every deployment. (That's what serverless is all about!)
237-
238-
We will be adding many interesting features built on this. Extracting your endpoints and putting them into a common format was merely the first step...
239222

240223
### How To Debug CORS Errors
241224

serverless.component.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -109,10 +109,6 @@ actions:
109109
min: 0
110110
max: 1
111111

112-
openApi:
113-
type: boolean
114-
description: Automatically generate an OpenAPI specification on every deployment.
115-
116112
# remove
117113

118114
remove:

0 commit comments

Comments
 (0)