microsoft / microsoft/OpenAPI.NET.OData
add support for emitting webhooks
Open
Nobody has claimed this yet.
priority:p2
type:enhancement
- Dominant language
- C#
- Stars
- 240
- Forks
- 70
- Avg merge
- 7h 59m
- Merged PRs (30d)
- 13
Description
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:
- come up with an annotation that means "used for a webhook"
- add this annotation to the metadata via XOD
- leverage that annotation here so a webhook definition can be added to the description
- have kiota project the types from webhooks components, and not trim them.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- csharp, openapi
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100