microsoft / microsoft/OpenAPI.NET.OData

add dynamicRef/generic support for collections when openapi 3.1 is supported

Ouverte
#461 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

blocked type:enhancement
Langage dominant
C#
Étoiles
240
Forks
70
Merge moyen
7 h 59 min
PR mergées (30 j)
13

Description

today we implement collections as:

  • BaseCollectionResponse (Odata next link field, etc...)
  • BaseCounCollectionResponse (inherits from the previous, add the count field)
  • A lot of Users/Groups/Sites/...Collection response (inherits from one of the previous, adds the value property)

With the advent of OpenAPI 3.1 support we could get rid of all the UsersCollectionResponse schemas (about 4k in v1) and make the base types generic.

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 examiner la génération du schéma de réponse de collection et la prise en charge d’OpenAPI 3.1 par le repository. Définissez les types de base génériques de collection et le comportement de dynamicRef, puis vérifiez que le document généré n’a plus besoin des nombreux schémas de collection spécifiques aux ressources.

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

Évaluation

Stack technique
csharp
Domaine
api
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

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