loopbackio / loopbackio/loopback-next

Introduce getModelSchema and soft-deprecate getModelSchemaRef

Aperta
#5,791 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

tech-debt
Lingua principale
TypeScript
Stelle
5.1k
Fork
1.1k
Merge medio
2g 21h
PR unite (30g)
27

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia da src/controller-spec.ts e dal contesto collegato di schema-consolidation per comprendere la modifica richiesta a getModelSchema. Poi esamina i template dei controller, i controller di /examples, i file /docs e il commento tsdoc; il lavoro è completo quando questi utilizzi e la documentazione usano getModelSchema e anche l’esempio esterno di shopping è stato aggiornato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
openapi, typescript
Ambito
api, cli, documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.