[GH-ISSUE #378] Make "private" methods in `BaseClient` public #119

New issue

Closed

opened 2026-02-27 20:23:14 +03:00 by kerem · 1 comment

kerem commented

2026-02-27 20:23:14 +03:00

Owner

Originally created by @marioortizmanero on GitHub (Dec 29, 2022).
Original GitHub issue: https://github.com/ramsayleung/rspotify/issues/378

Is your feature request related to a problem? Please describe.

We currently have advanced methods in BaseClient like api_get, api_post, etc (see #356 to learn more about the new naming). However, they aren't properly documented, and making them public would make it possible to implement custom endpoints. For example, users would be able to implement #104 themselves, which we currently don't support.

Describe the solution you'd like

Make all the #[doc(hidden)] methods in BaseClient and OAuthClient public and document them appropriately. Indicate that they aren't meant to be used directly, but include an example of how users could implement their own custom endpoints. We could have a file in the examples directory for that.

Describe alternatives you've considered

We currently have them as private, but it's just a hack. Users can still access them, we just hide the methods from the docs, which might be confusing. Besides, having them public can be useful.

Originally created by @marioortizmanero on GitHub (Dec 29, 2022). Original GitHub issue: https://github.com/ramsayleung/rspotify/issues/378 **Is your feature request related to a problem? Please describe.** We currently have advanced methods in `BaseClient` like `api_get`, `api_post`, etc (see #356 to learn more about the new naming). However, they aren't properly documented, and making them public would make it possible to implement custom endpoints. For example, users would be able to implement #104 themselves, which we currently don't support. **Describe the solution you'd like** Make all the `#[doc(hidden)]` methods in `BaseClient` and `OAuthClient` public and document them appropriately. Indicate that they aren't meant to be used directly, but include an example of how users could implement their own custom endpoints. We could have a file in the `examples` directory for that. **Describe alternatives you've considered** We currently have them as private, but it's just a hack. Users can still access them, we just hide the methods from the docs, which might be confusing. Besides, having them public can be useful.

kerem

2026-02-27 20:23:14 +03:00

closed this issue
added the
enhancement

Stale
labels

kerem commented

2026-02-27 20:23:14 +03:00

Author

Owner

@github-actions[bot] commented on GitHub (Jun 24, 2023):

Message to comment on stale issues. If none provided, will not mark issues stale

@github-actions[bot] commented on GitHub (Jun 24, 2023): Message to comment on stale issues. If none provided, will not mark issues stale

kerem referenced this issue

2026-02-27 20:23:59 +03:00

[PR #119] [MERGED] Rename environmental variables with prefix RSPOTIFY_ #255