microsoft / microsoft/OpenAPI.NET.OData

Add support for IsDelta in return types

Ouverte
#592 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

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

Description

OASIS has added support for an IsDelta annotation that specifies that action or function parameters or return types may be represented as a delta (that is, they may contain deleted entities or nested changes). See https://github.com/oasis-tcs/odata-specs/blob/main/docs/odata-csdl-json/odata-csdl-json.md#annotation-coreisdelta) for a description of applying the annotation to a return type.

For example, the following "getChanges" function returns a collection of users, represented as a delta payload:

  <Function Name="getChanges" IsBound="true">
    <Parameter Name="bindingParameter" Type="microsoft.graph.savePoint" />
    <ReturnType Type="Collection(microsoft.graph.user)">
      <Annotation Term="Org.OData.Core.V1.IsDelta" Bool="true" />
    </ReturnType>
  </Function>

This Issue is to add support for this annotation to OpenAPI.NET.OData.

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

L’issue ne nomme aucun fichier d’implémentation ni aucun test. Commencez par déterminer comment OpenAPI.NET.OData traite les annotations OData et les types de retour, puis utilisez la fonction getChanges présentée comme cas d’entrée ; la tâche est terminée lorsque son annotation de type de retour IsDelta est représentée correctement dans le document OpenAPI généré.

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

Évaluation

Stack technique
csharp, openapi
Domaine
api
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

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