Skip to content

Commit

Permalink
add note to README around usage with webhooks (#85)
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 91f0e3b commit a5f72e0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,10 @@ Mux Ruby is a code generated lightweight wrapper around the Mux REST API and ref

2) We don't use a lot of object orientation. For example API calls that happen on a single asset don't exist in the asset class, but are API calls in the AssetsApi which require an asset ID.

### 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.

### Authentication
To use the Mux API, you'll need an access token and a secret. [Details on obtaining these can be found here in the Mux documentation.](https://docs.mux.com/docs#section-1-get-an-api-access-token)

Expand Down
4 changes: 4 additions & 0 deletions gen/templates/README.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ Mux Ruby is a code generated lightweight wrapper around the Mux REST API and ref

2) We don't use a lot of object orientation. For example API calls that happen on a single asset don't exist in the asset class, but are API calls in the AssetsApi which require an asset ID.

### 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.

### Authentication
To use the Mux API, you'll need an access token and a secret. [Details on obtaining these can be found here in the Mux documentation.](https://docs.mux.com/docs#section-1-get-an-api-access-token)

Expand Down

0 comments on commit a5f72e0

Please sign in to comment.