chore: deprecate /v2 public api (#373)

Co-authored-by: Jackie Potts <[email protected]>

Author: mc-jones

README.md

@@ -1,13 +1,26 @@
 ## Doppler
-
 [![CircleCI](https://circleci.com/gh/artsy/doppler.svg?style=svg)](https://circleci.com/gh/artsy/doppler)
 [![Code Climate](https://codeclimate.com/github/artsy/doppler.svg)](https://codeclimate.com/github/artsy/doppler)
 
-I am Doppler, the Artsy developer website. 
+I am Doppler, the Artsy developer website.
 
 - **Production:** [developers.artsy.net](https://developers.artsy.net)
 - **Staging:** [developers-staging.artsy.net/](https://developers-staging.artsy.net/)
 
+---
+
+### 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 **July 28th, 2025.**
+
+This change will not affect partners currently using our [partner api.](developers.artsy.net/v1).
+
+If you're interested in integrating your service with Artsy's partner api, please reach out to ....
+
+---
+
 ### Setup
 
 Clone the project:

app/controllers/client_applications_controller.rb

@@ -3,25 +3,11 @@ class ClientApplicationsController < ApplicationController
 
   before_action :fetch_client_application, only: %i[show edit destroy update]
   before_action :no_cache!, except: [:index]
-  before_action :parse_redirect_uris, only: %i[update create]
-
-  def new
-    @client_application = ClientApplication.new
-  end
+  before_action :parse_redirect_uris, only: %i[update]
 
   def show
   end
 
-  def create
-    redirect_uri = safe_redirect_uri(client_application_params.delete(:redirect_uri))
-    @client_application = artsy_client.applications._post(client_application_params.to_h)
-    flash.now[:error] = nil
-    flash.now[:notice] = "Application created!"
-    redirect_uri += "?id=#{@client_application.id}" if @client_application && !redirect_uri.blank?
-    redirect_uri = client_applications_path if redirect_uri.blank?
-    redirect_to redirect_uri
-  end
-
   def update
     @client_application._put(**client_application_params.to_h)
     fetch_client_application

app/controllers/v2/start_controller.rb

@@ -6,7 +6,6 @@
     There was an error retrieving applications: #{@error}.
 
 - elsif @client_applications.any?
-  = link_to "Create a New App", new_client_application_path, class: 'btn'
 
   %table.table.table-bordered.table-striped
     %thead
@@ -35,7 +34,5 @@
             = link_to 'destroy', client_application_path(client_application.id), disabled: client_application.api_version == 1, method: :delete, data: { confirm: "Are you sure?" }, class: 'btn btn-danger'
 - else
 
-  .alert.alert-success
-    In order to get started with the Artsy API, you must create a new app. Each app has a unique client ID and secret.
-
-  = link_to "Create a New App", new_client_application_path, class: 'btn btn-primary btn-lg'
+  .alert.alert-info
+    No apps found

app/views/client_applications/index.html.haml

@@ -2,7 +2,6 @@
 
 ### General
 
-* [Getting Started](/v2/start)
 * [Authentication](/v2/docs/authentication)
 * [Requests & Responses](/v2/docs/http)
 * [Pagination And Sets](/v2/docs/pagination)

app/views/client_applications/new.html.haml

@@ -1,13 +1,5 @@
 %h1 Help
 
-.p
-  Please post all API-related questions on our
-  = succeed '.' do
-    =link_to 'Developer Mailing List', 'http://groups.google.com/group/artsy-api-developers', target: '_blank'
-  Join the mailing list
-  = succeed '.' do
-    =link_to 'here', 'http://groups.google.com/group/artsy-api-developers/subscribe', target: '_blank'
-
 .p
   For reporting security issues, please see instructions at
   = succeed '.' do

app/views/content/v2/index.md

@@ -12,3 +12,16 @@
     -else
       = menu_item "Sign In", '/auth/artsy/new'
 = bootstrap_flash
+
+- unless request.path.include?('/v1')
+  .alert.alert-warning
+    %p
+      Please note, we are in the process of retiring the
+      = link_to 'public api.', '/v2'
+      The public api, as well as its documentation and playground, will remain available until
+      %strong July 28th, 2025.
+      This change will not affect integration partners using our
+      = link_to 'partner api.', '/v1'
+    %br/
+    %p
+      If you're an Artsy partner gallery, reach out to your Artsy Liaison or contact our Support team for assistance.

app/views/help/show.html.haml

@@ -9,17 +9,3 @@
   .p
     The Artsy <a href='/v1'>Partner API</a> enables select partners to upload artworks, manage partner artists and more.
     Please <a href='mailto:[email protected]'>contact us</a> for access to this API and all other inquiries.
-  .p
-    = link_to "Ready? Start Here", v2_start_path, class: 'btn btn-primary btn-lg'
-    = link_to 'Subscribe to the Dev Mailing List', 'http://groups.google.com/group/artsy-api-developers/subscribe', target: '_blank', class: 'btn btn-default btn-lg', id: 'subscribe_link'
-    - if @artworks_count.to_i > 0
-      %span.btn
-        = "#{pluralize(@artworks_count, 'artwork')} available"
-  .p.ideas
-    Have an app idea or looking for one? Check <a href='https://github.com/artsy/doppler/labels/app%20idea' target='_blank'>these</a> out.
-
-.alert.alert-success
-  Please
-  =link_to 'join the mailing list', 'http://groups.google.com/group/artsy-api-developers'
-  for questions and feedback.
-

app/views/shared/_nav.html.haml

@@ -1,7 +1,7 @@
 Rails.application.routes.draw do
   root "welcome#index"
 
-  resources :client_applications do
+  resources :client_applications, except: [:new] do
     resources :client_application_partners, only: [:index]
     resources :webhook_deliveries, only: [:index, :show] do
       member do
@@ -57,7 +57,6 @@
   ].each do |page|
     get "/v2/docs/#{page}", to: "pages#show", id: "v2/docs/#{page}"
   end
-  get "/v2/start", to: "v2/start#show"
   get "/v2/playground", to: "playground#index"
   get "/v2/terms", to: "pages#show", id: "v2/terms"