loopbackio / loopbackio/loopback-next

getModelSchemaRef doesn't get all extended model's properties.

Offen
#7,566 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

Steps to reproduce

I've got a controller with an endpoint which take a request body of the Foo model class.

@requestBody({
      content: {
        'application/json': {
          schema: getModelSchemaRef(Foo),
        },
      },
    })

The model classes:

@model()
export class BarBase {
  @property()
  name: string
}

@model()
export class BarEdit extends BarBase {
  @property()
  id: number
  @property()
  delete: boolean
}

@model()
export class Foo {
  @property()
  id: number
  @property().array(BarEdit)
  bars: BarEdit[]
}

@model()
export class BarResult extends BarEdit {
  @property()
  result: string
}

Current Behaviour

When looking at the generated swagger document or calling the controller endpoint, the schema body is the following:

{
  id: number,
  bars: [
    {
      name: string
    }
  ]
}

The id and delete properties are missing.

Expected Behaviour

I expected that the controller model schema of Foo would be:

{
  id: number,
  bars: [
    {
      id: number,
      delete: boolean,
      name: string
    }
  ]
}

In the current behaviour the BarEdit model class seems to extends from the BarBase class and it has got the name property, but the id and delete property in the BarEdit model class itself disappeared. I expected the id and delete properties to be there as well, but it's not.

Also when the model class BarResult (which extends from BarEdit) is used in a controller's getModelSchemaRef it has got all the properties from all 3 model classes:

{
  id: number,
  delete: boolean,
  name: string,
  result: string
}

Additional information

A work around to this problem I've found is to create a copy of the BarBase model class and call it something for example BarBaseT and have BarEdit extends from that one instead.

Operating System Information

darwin x64 14.15.4
├── @loopback/boot@3.4.0
├── @loopback/core@2.16.0
├── @loopback/repository@3.6.0
├── @loopback/rest-explorer@3.3.0
├── @loopback/rest@9.3.0
├── @loopback/service-proxy@3.2.0
├── loopback-connector-kv-redis@3.0.3
├── loopback-connector-postgresql@5.3.0
├── loopback-connector-rest@3.7.0
npm notice 
npm notice New minor version of npm available! 7.6.1 -> 7.16.0
npm notice Changelog: https://github.com/npm/cli/releases/tag/v7.16.0
npm notice Run npm install -g npm@7.16.0 to update!
npm notice

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 damit, das Problem mit den im Bericht gezeigten Modelldefinitionen für BarBase, BarEdit, BarResult und Foo sowie der Verwendung von getModelSchemaRef im Controller zu reproduzieren. Verfolge das generierte Schema für Foo und vergleiche es mit den erwarteten geerbten Eigenschaften; abgeschlossen ist die Aufgabe, wenn die id- und delete-Eigenschaften von BarEdit im verschachtelten Schema ohne den Workaround erscheinen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
openapi, typescript
Bereich
api, backend
Issue-Typ
Bug
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.