microsoft / microsoft/OpenAPI.NET.OData

add support for emitting webhooks

Offen
#508 6 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

priority:p2 type:enhancement
Vorherrschende Sprache
C#
Sterne
240
Forks
70
Ø Merge
7 Std. 59 Min.
Gemergte PRs (30 T.)
13

Beschreibung

Microsoft Graph has types that are only used when the service calls to the client's APIs: change notifications.
In the Microsoft Graph pipeline, those types are being trimmed by kiota because they are not used anywhere (any inbound endpoint).
We should:

  1. come up with an annotation that means "used for a webhook"
  2. add this annotation to the metadata via XOD
  3. leverage that annotation here so a webhook definition can be added to the description
  4. have kiota project the types from webhooks components, and not trim them.

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, die Microsoft Graph pipeline, den XOD metadata flow und das Trimming von nicht von eingehenden Endpunkten verwendeten Typen durch Kiota nachzuverfolgen. Definiere, wie Webhook-Annotationen in der generierten Beschreibung dargestellt und verwendet werden sollen. Die Aufgabe ist abgeschlossen, wenn Webhook-Definitionen die erforderlichen Typen beibehalten und Kiota sie projiziert, statt sie zu entfernen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp, openapi
Bereich
api, backend-api-design
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.