[PR #284] [MERGED] Fix docs links for `rspotify` #371

New issue

Closed

opened 2026-02-27 20:24:27 +03:00 by kerem · 0 comments

kerem commented

2026-02-27 20:24:27 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/ramsayleung/rspotify/pull/284
Author: @marioortizmanero
Created: 11/19/2021
Status: ✅ Merged
Merged: 11/29/2021
Merged by: @ramsayleung

Base: master ← Head: fix-docs

📝 Commits (2)

726b685 Fix docs links
706ea12 Fix redirection

📊 Changes

10 files changed (+98 additions, -96 deletions)

View changed files

📝 .github/workflows/ci.yml (+3 -1)
📝 CHANGELOG.md (+4 -4)
📝 README.md (+1 -1)
📝 rspotify-model/src/auth.rs (+2 -2)
📝 src/auth_code.rs (+1 -1)
📝 src/auth_code_pkce.rs (+2 -2)
📝 src/client_creds.rs (+1 -1)
📝 src/clients/base.rs (+29 -29)
📝 src/clients/oauth.rs (+49 -49)
📝 src/lib.rs (+6 -6)

📄 Description

Description

This updates the client's documentation to the latest version of the Spotify reference for the rspotify crate (not rspotify-model).

Motivation and Context

Works towards #281

Dependencies

None

Type of change

Please delete options that are not relevant.

This change requires a documentation update

How Has This Been Tested?

Unfortunately, cargo-deadlinks doesn't pick up the new endpoint links. It will print out this:

Fragment #/operations/remove-tracks-playlist at https://developer.spotify.com/documentation/web-api/reference/#/operations/remove-tracks-playlist does not exist!

But that link does, in fact, work.

As far as I know the changes in the URLs were relatively trivial, and running a substitution s/endpoint-/\/operations\// was enough for the endpoints. The rest of the links were checked manually and should work just fine.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/ramsayleung/rspotify/pull/284 **Author:** [@marioortizmanero](https://github.com/marioortizmanero) **Created:** 11/19/2021 **Status:** ✅ Merged **Merged:** 11/29/2021 **Merged by:** [@ramsayleung](https://github.com/ramsayleung) **Base:** `master` ← **Head:** `fix-docs` --- ### 📝 Commits (2) - [`726b685`](https://github.com/ramsayleung/rspotify/commit/726b685bef91ae97883561abead73b181db6162c) Fix docs links - [`706ea12`](https://github.com/ramsayleung/rspotify/commit/706ea124e16c65e9e39fd13d78dcef37989115b6) Fix redirection ### 📊 Changes **10 files changed** (+98 additions, -96 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/ci.yml` (+3 -1) 📝 `CHANGELOG.md` (+4 -4) 📝 `README.md` (+1 -1) 📝 `rspotify-model/src/auth.rs` (+2 -2) 📝 `src/auth_code.rs` (+1 -1) 📝 `src/auth_code_pkce.rs` (+2 -2) 📝 `src/client_creds.rs` (+1 -1) 📝 `src/clients/base.rs` (+29 -29) 📝 `src/clients/oauth.rs` (+49 -49) 📝 `src/lib.rs` (+6 -6) </details> ### 📄 Description ## Description This updates the client's documentation to the latest version of the Spotify reference for the `rspotify` crate (not `rspotify-model`). ## Motivation and Context Works towards #281 ## Dependencies None ## Type of change Please delete options that are not relevant. - [x] This change requires a documentation update ## How Has This Been Tested? Unfortunately, `cargo-deadlinks` doesn't pick up the new endpoint links. It will print out this: > Fragment #/operations/remove-tracks-playlist at https://developer.spotify.com/documentation/web-api/reference/#/operations/remove-tracks-playlist does not exist! But that link does, in fact, work. As far as I know the changes in the URLs were relatively trivial, and running a substitution `s/endpoint-/\/operations\//` was enough for the endpoints. The rest of the links were checked manually and should work just fine. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>