Skip to content

Commit

Permalink
docs: add better docs for the webhook attribute
Browse files Browse the repository at this point in the history
  • Loading branch information
Lulalaby committed Dec 19, 2024
1 parent 1bc109b commit 36cc1c3
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions AITSYS.Vimeo.Ott/Attributes/VimeoOttWebhookAttribute.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
using AITSYS.Vimeo.Ott.Entities;

namespace AITSYS.Vimeo.Ott.Attributes;

/// <summary>
/// Marks a method to handle one or more topics for incoming OTT webhooks.
/// <para>You can create a method like this:</para>
/// <code>
/// [VimeoOttWebhook("customer.product.created", "customer.product.deleted")]
/// async Task&lt;ActionResult&gt; HandleVimeoOttWebhookAsync(OttWebhook webhook)
/// {
/// // do stuff
/// return new OkResult();
/// }
/// </code>
/// <para>Important is that you define the parameter <c><see cref="OttWebhook">OttWebhook</see> webhook</c>, since we populate to this parameter.</para>
/// </summary>
/// <param name="topics">The topics to handle.</param>
[AttributeUsage(AttributeTargets.Method)]
Expand Down

0 comments on commit 36cc1c3

Please sign in to comment.