loopbackio / loopbackio/loopback-next

Introduce getModelSchema and soft-deprecate getModelSchemaRef

Offen
#5,791 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

tech-debt
Vorherrschende Sprache
TypeScript
Sterne
5.1k
Forks
1.1k
Ø Merge
2 T. 21 Std.
Gemergte PRs (30 T.)
27

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit src/controller-spec.ts und dem verlinkten Kontext zur schema-consolidation, um die angeforderte Änderung an getModelSchema zu verstehen. Untersuche anschließend die Controller-Vorlagen, die /examples-Controller, die /docs-Dateien und den tsdoc-Kommentar; abgeschlossen ist die Aufgabe, wenn diese Verwendungen und die Dokumentation getModelSchema verwenden und auch das externe Shopping-Beispiel aktualisiert ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
openapi, typescript
Bereich
api, cli, documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.