Add changes for api version 2024-10-01

[Nikpolik]

Important

🔎 Previews:

• https://clerk.com/docs/pr/1717/backend-requests/versioning/available-versions

This PR:

• Adds the changes for our new api version 2024-10-01 in the appropriate list

Checklist

• I have clicked on "Files changed" and performed a thorough self-review
• I have added the "deploy-preview" label and added the preview link(s) to this PR description
• All existing checks pass

[github-actions]

Hey, here’s your docs preview: https://clerk.com/docs/pr/1717

[gkats]

Looks good to me, thanks @Nikpolik!

[victoriaxyz]

Looks good! Only minor nits.

didn't mean to approve - meant to comment

[alexisintech]

This file says its for API versions with their respective breaking changes - are these breaking changes?

Also, I'm not quite sure what versions we're documenting here. It goes from 2021-02-05 all the way to 2024-10-01. Did someone advise you to add this to this document, or what was the reasoning leading up to this PR?

[Nikpolik]

@alexisintech In this file we document the Client and Backend API versions and their changes. It was initially added as part of the API versioning project (by me 🙃).

This is actually the first api version (2024-10-01) we will ever release, but we needed to label how the API worked up to now, 2021-02-05 was chosen, it's the date that clerk was publicly released for the first time. That's why there is such a big jump in the versions. From now on I imagine there will be a smaller gap.

Regarding if the changes are breaking, the response change definitely is as we changed how the API behaves for the same input.

The new clients feature it's not exactly breaking but it will only work from this version and onward so it felt appropriate to mention it here.

For some additional context there is a ClerkJS pr that starts utilising this new version (and will link to this doc)

• Version bump
• Response changes

[alexisintech]

amazing, thank you providing more explanation and context!

[Nikpolik]

Should have put some of this information in the PR description 😅 Sorry for that!