Skip to content

Commit

Permalink
add note to README around usage with webhooks (#19)
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 bfa35a4 commit 2ee4c97
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@

**PLEASE NOTE:** This is an early build of the Mux Java 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.

Mux is how developers build online video. This API encompasses both Mux Video and Mux Data functionality to help you build your video-related projects better and faster than ever before.

For more information, please visit [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 @@ -12,6 +12,10 @@

**PLEASE NOTE:** This is an early build of the Mux Java 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.

{{#appDescriptionWithNewLines}}{{{appDescriptionWithNewLines}}}{{/appDescriptionWithNewLines}}

{{#infoUrl}}
Expand Down
4 changes: 4 additions & 0 deletions gen/templates/libraries/okhttp-gson/README.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@

**PLEASE NOTE:** This is an early build of the Mux Java 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.

{{#appDescriptionWithNewLines}}{{{appDescriptionWithNewLines}}}{{/appDescriptionWithNewLines}}

{{#infoUrl}}
Expand Down

0 comments on commit 2ee4c97

Please sign in to comment.