You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/**
* Retrieves the details of an asset that has previously been created. Supply the
* unique asset ID that was returned from your previous request, and Mux will
* return the corresponding asset information. The same information is returned
* when creating an asset.
*/
retrieve(assetId: string, options?: Core.RequestOptions): Core.APIPromise<Asset> {
return (
this._client.get(`/video/v1/assets/${assetId}`, options) as Core.APIPromise<{ data: Asset }>
)._thenUnwrap((obj) => obj.data);
}
While the library is well-typed and it is thus possible to figure all this out by going through the source code, it definitely adds quite a bit of time to decipher how to use anything described in the docs.
Perhaps auto-generated docs based on source code would be useful.
The text was updated successfully, but these errors were encountered:
jhwheeler
changed the title
Docs are quite out of date
Docs are out of date
Jul 15, 2024
A variety of fields and methods have been updated, but this is not reflected in the docs.
For example, the APIs are lowercase (e.g.
video
,data
,system
, etc.), whereas in the docs they are uppercase.Another example is that the docs explain how to get a video asset with a method called
get
; however, this does not work:The actual method found in src/resources/video/assets.ts is called
retrieve
:While the library is well-typed and it is thus possible to figure all this out by going through the source code, it definitely adds quite a bit of time to decipher how to use anything described in the docs.
Perhaps auto-generated docs based on source code would be useful.
The text was updated successfully, but these errors were encountered: