fix: remove trailing slash for invalid URL

[maemaemae3]

Resolves #395

---

Before the change?

• remove trailing slashes from URL except expanded endpoint is /

After the change?

• if you specify url like endpoint("https://github.acme-inc/api/v3/"), it will cause to trailing slash removed.

Pull request checklist

• Tests for the changes have been added (for bug fixes / features)
• Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

• if you specify url like endpoint("https://github.acme-inc/api/v3/"), it will cause to trailing slash removed.

Please see our docs on breaking changes to help!

• Yes
• No

---

[maemaemae3]

considering for effects about breaking changes.
It seems there's no issue with omitting the trailing slash, but I'm considering whether there could be any unexpected effects.

[gr2m]

I like the change, I've seen lots of people reporting issues that turned out to be a trailing slash. But we have to be careful to not accidentally break use cases. For example, can you please test with https://docs.github.com/en/free-pro-team@latest/rest/git/refs?apiVersion=2022-11-28#list-matching-references and https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#get-repository-content (loading a folder)

I think in either case the / should be URL encoded, but I'm not sure

[maemaemae3]

Thanks for the excellent advice!
I added tests for trailing slash in expressions, and checked its encoded properly.
However trailing slash in https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#get-repository-content (loading a folder) returns Bad request, which means you must omit trailing slash.
(I mean API like http://api.github.com/repos/my-org/my-repo/contents/mydir%2Fnested-dir%2F returns Bad request.)
Should we also consider cases like this?

[gr2m]

However trailing slash in https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#get-repository-content (loading a folder) returns Bad request, which means you must omit trailing slash

That is something we should fix on the API side, so folks not using Octokit will benefit as well. I'll raise that internally.

[gr2m]

I am a bit worried about unforeseen consequences. I'm sure there are users that use octokit to send requests to non-github endpoints and this change might break their code. But I would not take that into account as well, it will bloat @octokit/endpoint even more, which is our lowest-level @octokit library for JavaScript.

My vote is to merge, release, and see if problems pop up. It's easy enough to reverse

[kfcampbell]

👍 I'll merge this now and standby to rollback if necessary.

[github-actions]

🎉 This PR is included in version 9.0.2 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀