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

Support URLs without trailing slashes? #1254

Closed
mderriey opened this issue Mar 6, 2024 · 1 comment · Fixed by #1270
Closed

Support URLs without trailing slashes? #1254

mderriey opened this issue Mar 6, 2024 · 1 comment · Fixed by #1270
Assignees
Labels
server Issues regarding the server component

Comments

@mderriey
Copy link

mderriey commented Mar 6, 2024

Feature Request

Opening an issue as requested by @tasn in #1252.

Svix API endpoints all have a trailing slash, for example /api/v1/app/{app_id}/msg/.

Motivation

  • It's valid, but it's not common in my experience.
  • It also caught us twice while we were playing around with the API via Postman and hand-written code where we didn't include it out of habit and got 404s back.
  • Some tools don't support trailing slashes; we used Microsoft's Kiota to generate a .NET API client, and during generation it removed the trailing slashes (see Trailing slash in URL is dropped during generation microsoft/kiota#4291).

Proposal

The proposal is to:

  • Support URLs both with and without the trailing slashes so it's a backwards-compatible change.
  • Make URLs without the trailing slash "default", e.g. they should be the ones that appear in the OpenAPI document.

Alternatives

N/A

@tasn tasn added the server Issues regarding the server component label Mar 6, 2024
@tasn
Copy link
Member

tasn commented Mar 6, 2024

@svix/engineering, is where any reason why not just support both?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
server Issues regarding the server component
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants