loopbackio / loopbackio/loopback-next

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

Ouverte
#7,566 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

bug OpenAPI
Langage dominant
TypeScript
Étoiles
5.1k
Forks
1.1k
Merge moyen
2 j 21 h
PR mergées (30 j)
27

Description

## Steps to reproduce

I've got a controller with an endpoint which take a request body of the `Foo` model class.
```ts
@requestBody({
content: {
'application/json': {
schema: getModelSchemaRef(Foo),
},
},
})
```

The model classes:
```ts
@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:
```ts
{
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:
```ts
{
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:
```ts
{
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

```sh
darwin x64 14.15.4
```

```sh
├── @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
```

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par reproduire le problème avec les définitions des modèles BarBase, BarEdit, BarResult et Foo ainsi que l’utilisation de getModelSchemaRef dans le contrôleur présentées dans le rapport. Suivez le schéma généré pour Foo et comparez-le aux propriétés héritées attendues ; le travail est terminé lorsque les propriétés id et delete de BarEdit apparaissent dans le schéma imbriqué sans la solution de contournement.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
openapi, typescript
Domaine
api, backend
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.