starred/rspotify

Fork 0

mirror of https://github.com/ramsayleung/rspotify.git synced 2026-04-26 07:55:55 +03:00

[GH-ISSUE #281] Doc links are broken again #86

New issue

Closed

opened 2026-02-27 20:23:02 +03:00 by kerem · 6 comments

kerem commented

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

Owner

Originally created by @marioortizmanero on GitHub (Nov 19, 2021).
Original GitHub issue: https://github.com/ramsayleung/rspotify/issues/281

Describe the bug
Looks like the spotify team revamped their reference page: https://developer.spotify.com/documentation/web-api/reference/#/

Which means that their reference links are completely broken now.

To Reproduce
Steps to reproduce the behavior:

Go to https://docs.rs/rspotify/0.11.2/rspotify/clients/base/trait.BaseClient.html#method.artist
Click on reference
See that it's broken

Originally created by @marioortizmanero on GitHub (Nov 19, 2021). Original GitHub issue: https://github.com/ramsayleung/rspotify/issues/281 **Describe the bug** Looks like the spotify team revamped their reference page: https://developer.spotify.com/documentation/web-api/reference/#/ Which means that their reference links are completely broken now. **To Reproduce** Steps to reproduce the behavior: 1. Go to https://docs.rs/rspotify/0.11.2/rspotify/clients/base/trait.BaseClient.html#method.artist 2. Click on `reference` 3. See that it's broken

kerem

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

closed this issue
added the
help wanted

bug
labels

kerem commented

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

Author

Owner

@marioortizmanero commented on GitHub (Nov 19, 2021):

Not sure how to tackle this for rspotify-model, it seems that said section has been removed...

@marioortizmanero commented on GitHub (Nov 19, 2021): Not sure how to tackle this for `rspotify-model`, it seems that said section has been removed...

kerem commented

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

Author

Owner

@ramsayleung commented on GitHub (Nov 20, 2021):

To be honest, I think the upstream(Spotify API) is pretty unstable, perhaps we should figure out a better way to maintain the field information of the structure

@ramsayleung commented on GitHub (Nov 20, 2021): To be honest, I think the upstream(Spotify API) is pretty unstable, perhaps we should figure out a better way to maintain the `field` information of the structure

kerem commented

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

Author

Owner

@marioortizmanero commented on GitHub (Nov 20, 2021):

That sounds complicated though... I don't think they'll change it for a long time now, it's pretty much got everything already. I hope...

@marioortizmanero commented on GitHub (Nov 20, 2021): That sounds complicated though... I don't think they'll change it for a long time now, it's pretty much got everything already. I hope...

kerem commented

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

Author

Owner

@marioortizmanero commented on GitHub (Nov 29, 2021):

I guess we could just remove the reference links in the rspotify-model crate? The endpoints already have links with their models anyway.

The other option would be to add links to whichever endpoint uses that specific model. For example, for SimplifiedAlbum it could point to https://developer.spotify.com/documentation/web-api/reference/#/operations/get-an-artists-albums. But I don't really have time right now to do that for every model, and it might be an unnecessary maintainaince cost, since other spotify libraries don't even have links to the reference.

@marioortizmanero commented on GitHub (Nov 29, 2021): I guess we could just remove the reference links in the `rspotify-model` crate? The endpoints already have links with their models anyway. The other option would be to add links to whichever endpoint uses that specific model. For example, for `SimplifiedAlbum` it could point to https://developer.spotify.com/documentation/web-api/reference/#/operations/get-an-artists-albums. But I don't really have time right now to do that for every model, and it might be an unnecessary maintainaince cost, since other spotify libraries don't even have [links to the reference](https://tekore.readthedocs.io/en/stable/reference/models.html#tekore.model.FullArtist).

kerem commented

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

Author

Owner

@ramsayleung commented on GitHub (Nov 29, 2021):

I guess we could just remove the reference links in the rspotify-model crate? The endpoints already have links with their models anyway.

I agree with this solution, the other solution is expensive.

@ramsayleung commented on GitHub (Nov 29, 2021): > I guess we could just remove the reference links in the rspotify-model crate? The endpoints already have links with their models anyway. I agree with this solution, the other solution is expensive.

kerem commented

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

Author

Owner

@marioortizmanero commented on GitHub (Nov 29, 2021):

Alright! I'll write a PR for that and then we can release a new version.

@marioortizmanero commented on GitHub (Nov 29, 2021): Alright! I'll write a PR for that and then we can release a new version.