From 2c48bd3c3a4d8d17462ea66e79e28c9ae4977476 Mon Sep 17 00:00:00 2001 From: Justin Sanford Date: Thu, 14 Nov 2024 11:18:52 -0800 Subject: [PATCH 1/2] add note to README around usage with webhooks --- README.md | 4 ++++ gen/templates/README.mustache | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/README.md b/README.md index 7a6716f..04a1632 100644 --- a/README.md +++ b/README.md @@ -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 verifying 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) diff --git a/gen/templates/README.mustache b/gen/templates/README.mustache index ca1ee37..a313b18 100644 --- a/gen/templates/README.mustache +++ b/gen/templates/README.mustache @@ -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 verifying 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) From f6d25a03f7cf6210241e3bcfd856cb741775ae2f Mon Sep 17 00:00:00 2001 From: Justin Sanford Date: Fri, 15 Nov 2024 10:55:56 -0800 Subject: [PATCH 2/2] wording update --- README.md | 2 +- gen/templates/README.mustache | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 04a1632..480c903 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ Mux Ruby is a code generated lightweight wrapper around the Mux REST API and ref ### Usage With Webhooks -At this moment, this SDK is not suitable for verifying 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. +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) diff --git a/gen/templates/README.mustache b/gen/templates/README.mustache index a313b18..c59a851 100644 --- a/gen/templates/README.mustache +++ b/gen/templates/README.mustache @@ -82,7 +82,7 @@ Mux Ruby is a code generated lightweight wrapper around the Mux REST API and ref ### Usage With Webhooks -At this moment, this SDK is not suitable for verifying 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. +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)