env0 / env0/serverless-openapi-typescript
Full sample?
- 主要言語
- TypeScript
- スター
- 14
- フォーク
- 7
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Do you happen to have a sample of a basic "Hello World" type serverless project with this in it? It's unclear where all the docs come from... I just made a project with `--template aws-nodejs-typescript` and added this to it, but can't get docs to generate:
```
[serverless-openapi-typescript] Scanning functions for documentation attribute
Environment: darwin, node 16.17.1, framework 3.30.0 (local), plugin 6.2.3, SDK 4.3.2
Docs: docs.serverless.com
Support: forum.serverless.com
Bugs: github.com/serverless/serverless/issues
Error:
Error: Some functions have http events which are not documented:
hello
Please add a documentation attribute.
If you wish to keep the function undocumented, please explicitly set
documentation: ~
```
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
調査の方向性
まず、aws-nodejs-typescript テンプレートを使って報告されたコマンドと、表示されたドキュメントエラーを再現します。次に、plugin がドキュメント属性をどのように検出するかを追跡し、その後、必要な設定を明確にし、ドキュメント生成が成功することを確認できる基本的な Hello World の例を追加します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- nodejs, typescript
- 領域
- api, documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100