add support for emitting webhooks

Open
#508 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp, openapi
Domain
api, backend-api-design

Research direction

Start by tracing the Microsoft Graph pipeline, XOD metadata flow, and Kiota's trimming of types that are not used by inbound endpoints. Define how webhook annotations should be represented and consumed in the generated description. Done means webhook definitions preserve the required types and Kiota projects them instead of trimming them.

Written by the indexing model from the issue text.

Description

priority:p2 type:enhancement

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.
Dominant language
C#
Stars
240
Forks
70
Avg merge
7h 59m
Merged PRs (30d)
13

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/OpenAPI.NET.OData

All issues in microsoft/OpenAPI.NET.OData

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.