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

Rename Public API endpoints #8391

Merged
merged 3 commits into from
Oct 31, 2024
Merged

Rename Public API endpoints #8391

merged 3 commits into from
Oct 31, 2024

Conversation

flvndvd
Copy link
Contributor

@flvndvd flvndvd commented Oct 31, 2024

Description

This PR resolves #8266.

Vaults endpoints introduced recently are already being used (see here) so we need to support them. I'll reach out to the few workspaces.

It renames all the public API endpoints from /vaults to /spaces by using a NextJS rewrites instructions. This let's remove all occurrences of vaults except for an instruction in our next.config.js.

The only hack is to adapt the key in the /api/v1/w/[wId]/vaults to change the key based on the original url (successfully tested locally).

A follow up PR (the last one) will change all logic that calls those endpoints.

Risk

Tested on front-edge.

Deploy Plan

Copy link

github-actions bot commented Oct 31, 2024

Warnings
⚠️

Files in **/api/v1/ have been modified and the PR has the documentation-ack label.
Don't forget to run npm run docs and use the Deploy OpenAPI Docs Github action to update https://docs.dust.tt/reference.

Generated by 🚫 dangerJS against 1f874e2

@flvndvd flvndvd marked this pull request as ready for review October 31, 2024 15:55
@flvndvd flvndvd self-assigned this Oct 31, 2024
@flvndvd flvndvd added the documentation-ack Used to acknowledge that documentation is up-to-date with this PR label Oct 31, 2024
Copy link
Contributor

@fontanierh fontanierh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

neat ✨

@flvndvd flvndvd merged commit fb40ff5 into main Oct 31, 2024
7 checks passed
@flvndvd flvndvd deleted the flav/vaults-to-space-step-7 branch October 31, 2024 16:40
Copy link
Contributor

@spolu spolu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation-ack Used to acknowledge that documentation is up-to-date with this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename endpoints
3 participants