Skip to content

Commit

Permalink
add note to README around usage with webhooks (#64)
Browse files Browse the repository at this point in the history
* add note to README around usage with webhooks

* wording update
  • Loading branch information
jsanford8 authored Nov 15, 2024
1 parent e0b5013 commit b50165c
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 5 deletions.
10 changes: 5 additions & 5 deletions Mux.Csharp.Sdk.sln
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 14
VisualStudioVersion = 14.0.25420.1
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Mux.Csharp.Sdk", "src\Mux.Csharp.Sdk\Mux.Csharp.Sdk.csproj", "{445DE6AE-2A5E-4F29-AA4E-4EFDDD0DA229}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Mux.Csharp.Sdk", "src\Mux.Csharp.Sdk\Mux.Csharp.Sdk.csproj", "{34EE238D-C4B0-4067-8947-2553C44DBA1F}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Mux.Csharp.Sdk.Test", "src\Mux.Csharp.Sdk.Test\Mux.Csharp.Sdk.Test.csproj", "{19F1DEBC-DE5E-4517-8062-F000CD499087}"
EndProject
Expand All @@ -12,10 +12,10 @@ Global
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{445DE6AE-2A5E-4F29-AA4E-4EFDDD0DA229}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{445DE6AE-2A5E-4F29-AA4E-4EFDDD0DA229}.Debug|Any CPU.Build.0 = Debug|Any CPU
{445DE6AE-2A5E-4F29-AA4E-4EFDDD0DA229}.Release|Any CPU.ActiveCfg = Release|Any CPU
{445DE6AE-2A5E-4F29-AA4E-4EFDDD0DA229}.Release|Any CPU.Build.0 = Release|Any CPU
{34EE238D-C4B0-4067-8947-2553C44DBA1F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{34EE238D-C4B0-4067-8947-2553C44DBA1F}.Debug|Any CPU.Build.0 = Debug|Any CPU
{34EE238D-C4B0-4067-8947-2553C44DBA1F}.Release|Any CPU.ActiveCfg = Release|Any CPU
{34EE238D-C4B0-4067-8947-2553C44DBA1F}.Release|Any CPU.Build.0 = Release|Any CPU
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.Build.0 = Debug|Any CPU
{19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.ActiveCfg = Release|Any CPU
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ Mux is how developers build online video. This API encompasses both Mux Video an

**PLEASE NOTE:** This is an early build of the Mux C# SDK, as evidenced by its pre-1.0 status, but we're reasonably certain of its stability and usability against the Mux API.. Documentation is currently best-effort, but it'll improve over time! Instead of contacting Mux Support, please file an issue on this repository or email [Mux DevEx]([email protected]) for assistance.

## Usage With Webhooks

At this moment, this SDK is not suitable for parsing or modeling webhook payloads, due to some incompatibilities in our API spec and our SDK generation tooling. We are working on resolving these issues, but for now you should only use this SDK for Mux's REST APIs.

- API version: v1
- SDK version: 0.15.0
[https://docs.mux.com](https://docs.mux.com)
Expand Down
4 changes: 4 additions & 0 deletions gen/templates/README.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@

**PLEASE NOTE:** This is an early build of the Mux C# SDK, as evidenced by its pre-1.0 status, but we're reasonably certain of its stability and usability against the Mux API.. Documentation is currently best-effort, but it'll improve over time! Instead of contacting Mux Support, please file an issue on this repository or email [Mux DevEx]([email protected]) for assistance.

## Usage With Webhooks

At this moment, this SDK is not suitable for parsing or modeling webhook payloads, due to some incompatibilities in our API spec and our SDK generation tooling. We are working on resolving these issues, but for now you should only use this SDK for Mux's REST APIs.

- API version: {{appVersion}}
- SDK version: {{packageVersion}}
{{^hideGenerationTimestamp}}
Expand Down

0 comments on commit b50165c

Please sign in to comment.