loopbackio / loopbackio/loopback-next

Customize openapi.json at root level

オープン
#2,062 コメント 7 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Docs good first issue help wanted
主要言語
TypeScript
スター
5.1k
フォーク
1.1k
平均マージ
2日 21時間
マージ済み PR(30日)
27

説明

How can I customize the openapi.json file at the root level. I want to add the following config . . .

```yaml
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
```

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

この issue では、ルートレベルの openapi.json 出力と、目的の components.securitySchemes.basicAuth 設定だけが示されています。まず、リポジトリがどのように openapi.json を生成しているかを追跡し、次にこのカスタマイズがサポートされているか、またどこにドキュメント化すべきかを判断してください。設定を適用する明確で検証済みの方法が示されているか、制限事項を記載したドキュメントがあれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
openapi, typescript
領域
api
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。