chore: deprecate /v2 public api #373
Conversation
mc-jones
changed the title
mc-jones
force-pushed
the
mc-jones/deprecate-public-v2
branch
from
2b3d95a to
e334976
Compare
mc-jones
force-pushed
the
mc-jones/deprecate-public-v2
branch
from
e334976 to
e4bc389
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR deprecates public access to the /v2 API endpoint by removing /v2-specific pages and controllers, updating navigation alerts, and revising documentation to provide a clear retirement notice.
- Removed the /v2 start view and its controller
- Updated the navigation bar to display a deprecation warning for the public API
- Revised documentation and client application views to reflect the impending retirement of the /v2 endpoint
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| app/views/welcome/index.html.haml | Removed /v2 call-to-action and mailing list sign-up related to the deprecated API |
| app/views/v2/start/show.html.haml | Completely removed the /v2 start view |
| app/views/shared/_nav.html.haml | Removed the "My Apps" menu item and added an alert indicating public API deprecation |
| app/views/help/show.html.haml | Removed outdated mailing list references |
| app/views/content/v2/index.md | Removed the link to the deprecated /v2 start page |
| app/views/client_applications/index.html.haml | Replaced the app creation prompt with a "No apps found" alert |
| app/controllers/v2/start_controller.rb | Removed the deprecated V2 start controller |
| README.md | Added a section announcing the Public API Retirement Notice |
Comments suppressed due to low confidence (1)
app/controllers/v2/start_controller.rb:1
- Since the entire V2 start controller has been removed, please ensure that any routing configuration (typically defined in config/routes.rb) is updated accordingly to prevent requests from reaching non-existent endpoints.
module V2
| If you're interested in integrating your service with Artsy's partner api, please reach out to .... | ||
| %br/ | ||
| %p | ||
| If you're an Artsy partner gallery, reach out to your Artsy Liaison or contact our Support team for assistance. |
There was a problem hiding this comment.
To avoid situations like what was brought to us from B2B.
| @@ -12,3 +12,19 @@ | |||
| -else | |||
| = menu_item "Sign In", '/auth/artsy/new' | |||
| = bootstrap_flash | |||
|
|
|||
| - unless request.path.include?('/v1') | |||
There was a problem hiding this comment.
Don't alert if we're looking at a /v1 path.
|
Might be worth writing a very quick blog post about why we're doing this, which can be included in the email blast to the group list. |
README.md
Outdated
| ### Public API Retirement Notice | ||
| Please note, we are in the process of retiring the [public api.](developers.artsy.net/v2). | ||
|
|
||
| The public api, as well as its documentation and playground, will remain available until **June 30th, 2025.** |
There was a problem hiding this comment.
Somewhat arbitrary date, but arguably gives enough time to us and those who will receive a notice about its retirement.
Co-authored-by: Copilot <[email protected]>
|
I believe we can remove Line 60 in 93466a2 |
|
|
||
| - **Production:** [developers.artsy.net](https://developers.artsy.net) | ||
| - **Staging:** [developers-staging.artsy.net/](https://developers-staging.artsy.net/) | ||
|
|
||
| --- |
There was a problem hiding this comment.
Nice! all looks fine, I think there is one more entry point to create apps from the client application index page:
Screen.Recording.2025-05-28.at.1.49.58.PM.mov
Let me try and find the files!! I'll push up a commit, please hold
There was a problem hiding this comment.
Ok addressed the above in this commit here
This will:
- Remove this button from client app index page
- Removes the create/new forms
- Removes create/new controller actions
- Removes
:newfor client_applications namespace from routes.rb so people cant just writedevelopers.artsy.net/newin the URL directly
… new app button from Client App flow, removes support for :new action in routes
This PR officially announces the deprecation of public access to our
/v2endpoint as well as our plans for eventual retirement.TODO:
Thanks to everyone who participated in the mob session to get this done. I don't want to flood everyones inbox with co-authored @ mentions 😂
Demo
Updated copy banner:
Screen.Recording.2025-05-15.at.2.36.46.PM.mov