loopbackio / loopbackio/loopback-next

OpenAPI shema definition for models should exclude hidden properties by default

Ouverte
#4,495 4 commentaires 3 réactions 1 personne assignée Voir sur GitHub

@jannyHou y travaille déjà.

Depuis le 25/1/2020.

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

Description

Hidden properties are automatically removed from the response data (model's toJSON() excludes the hidden properties), so it seems that the schema definition should also exclude these fields by default. Currently, one has to manually add these fields to the "exclude" option in getModelSchemaRef()

Current behavior: hidden properties are removed from response data but openapi schema definition lists hidden properties in the schema.

Expected behavior: hidden properties are removed from response data and openapi schema definition does not list hidden properties.

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.

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

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