Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs are out of date #451

Open
jhwheeler opened this issue Jul 15, 2024 · 0 comments
Open

Docs are out of date #451

jhwheeler opened this issue Jul 15, 2024 · 0 comments

Comments

@jhwheeler
Copy link

jhwheeler commented 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.

Screenshot 2024-07-15 at 17 45 07

Another example is that the docs explain how to get a video asset with a method called get; however, this does not work:

Screenshot 2024-07-15 at 17 45 52

The actual method found in src/resources/video/assets.ts is called retrieve:

  /**
   * 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.

@jhwheeler jhwheeler changed the title Docs are quite out of date Docs are out of date Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant