Skip to content

Commit 26fc84d

Browse files
authored
Update README.md
1 parent 545c979 commit 26fc84d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ This is a [Serverless](http://www.serverless.com) v1 plugin that adds support fo
66
documentation and models (e.g. to export a Swagger JSON file with input/output definitions and full text
77
documentation for API documentation).
88

9+
## Important notice
10+
This plugin is no longer maintained and therefore archived.
11+
If you want to continue this project feel free to fork it and publish it under a new name.
12+
Unfortunately we can't transfer ownership of this project.
13+
914
## What is AWS API Gateway documentation?
1015

1116
Amazon introduced a new documentation feature for it's API Gateway on AWS at the end of 2016. With this you can add manually written documentation to all parts of API Gateway such as resources, requests, responses or single path or query parameters. When exporting Swagger from API Gateway these documentation is added to the other information to create a more human understandable documentation.

0 commit comments

Comments
 (0)