loopbackio / loopbackio/loopback-next

Introduce getModelSchema and soft-deprecate getModelSchemaRef

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

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

tech-debt
主要言語
TypeScript
スター
5.1k
フォーク
1.1k
平均マージ
2日 21時間
マージ済み PR(30日)
27

説明

Opening a follow up issue according to: https://github.com/strongloop/loopback-next/issues/4328#issuecomment-571638433

Cross posting @bajtos' comment from the above link:


After we land feat(rest): add openapi schema consolidation #4365, I'd like to start the process of deprecating getModelSchemaRef and reworking both our existing code and CLI templates to leverage the new schema consolidation:

  • Introduce getModelSchema similar to getModelSchemaRef (see src/controller-spec.ts)
  • Rework our controller templates to use getModelSchema instead of getModelSchemaRef
  • Rework controllers inside /examples to use getModelSchema
  • Soft-deprecate getModelSchemaRef in our documentation (both /docs files and the tsdoc comment)
  • Update https://github.com/strongloop/loopback4-example-shopping to use getModelSchema

cc @bajtos @jannyHou

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

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

はじめの一歩

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

調査の方向性

src/controller-spec.ts と、リンクされている schema-consolidation のコンテキストから始めて、要求されている getModelSchema の変更を理解します。次に、controller のテンプレート、/examples の controller、/docs ファイル、tsdoc コメントを確認します。これらの使用箇所とドキュメントで getModelSchema が使われ、外部の shopping の例も更新されていれば完了です。

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

評価

技術スタック
openapi, typescript
領域
api, cli, documentation
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

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