Removed API endpoint and specs

gitlabhq · May 30, 2018 · 4d3f7ae · 4d3f7ae
1 parent 439adb9
commit 4d3f7ae
Show file tree

Hide file tree

Showing 97 changed files with 356 additions and 16,029 deletions.
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -8,8 +8,6 @@ engines:
       languages:
       - ruby
       - javascript
-    exclude_paths:
-      - "lib/api/v3/*"
 ratings:
   paths:
   - Gemfile.lock

diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -173,7 +173,6 @@ Lint/UriEscapeUnescape:
     - 'spec/requests/api/files_spec.rb'
     - 'spec/requests/api/internal_spec.rb'
     - 'spec/requests/api/issues_spec.rb'
-    - 'spec/requests/api/v3/issues_spec.rb'
 
 # Offense count: 1
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
@@ -333,8 +332,6 @@ RSpec/ScatteredSetup:
     - 'spec/lib/gitlab/bitbucket_import/importer_spec.rb'
     - 'spec/lib/gitlab/git/env_spec.rb'
     - 'spec/requests/api/jobs_spec.rb'
-    - 'spec/requests/api/v3/builds_spec.rb'
-    - 'spec/requests/api/v3/projects_spec.rb'
     - 'spec/services/projects/create_service_spec.rb'
 
 # Offense count: 1
@@ -618,7 +615,6 @@ Style/OrAssignment:
   Exclude:
     - 'app/models/concerns/token_authenticatable.rb'
     - 'lib/api/commit_statuses.rb'
-    - 'lib/api/v3/members.rb'
     - 'lib/gitlab/project_transfer.rb'
 
 # Offense count: 50
@@ -781,7 +777,6 @@ Style/TernaryParentheses:
     - 'app/finders/projects_finder.rb'
     - 'app/helpers/namespaces_helper.rb'
     - 'features/support/capybara.rb'
-    - 'lib/api/v3/projects.rb'
     - 'lib/gitlab/ci/build/artifacts/metadata/entry.rb'
     - 'spec/requests/api/pipeline_schedules_spec.rb'
     - 'spec/support/capybara.rb'

diff --git a/app/models/application_setting.rb b/app/models/application_setting.rb
@@ -360,17 +360,6 @@ def repository_storages
     Array(read_attribute(:repository_storages))
   end
 
-  # DEPRECATED
-  # repository_storage is still required in the API. Remove in 9.0
-  # Still used in API v3
-  def repository_storage
-    repository_storages.first
-  end
-
-  def repository_storage=(value)
-    self.repository_storages = [value]
-  end
-
   def default_project_visibility=(level)
     super(Gitlab::VisibilityLevel.level_value(level))
   end

diff --git a/app/models/concerns/project_features_compatibility.rb b/app/models/concerns/project_features_compatibility.rb
@@ -1,4 +1,4 @@
-# Makes api V3 compatible with old project features permissions methods
+# Makes api V4 compatible with old project features permissions methods
 #
 # After migrating issues_enabled merge_requests_enabled builds_enabled snippets_enabled and wiki_enabled
 # fields to a new table "project_features", support for the old fields is still needed in the API.

diff --git a/changelogs/unreleased/fj-36819-remove-v3-api.yml b/changelogs/unreleased/fj-36819-remove-v3-api.yml
@@ -0,0 +1,5 @@
+---
+title: Removed API v3 from the codebase
+merge_request: 18970
+author:
+type: removed
diff --git a/doc/api/README.md b/doc/api/README.md
@@ -90,24 +90,23 @@ specification.
 ## Compatibility Guidelines
 
 The HTTP API is versioned using a single number, the current one being 4. This
-number symbolises the same as the major version number as described by 
+number symbolises the same as the major version number as described by
 [SemVer](https://semver.org/). This mean that backward incompatible changes
 will require this version number to change. However, the minor version is
-not explicit. This allows for a stable API endpoint, but also means new 
+not explicit. This allows for a stable API endpoint, but also means new
 features can be added to the API in the same version number.
 
 New features and bug fixes are released in tandem with a new GitLab, and apart
 from incidental patch and security releases, are released on the 22nd each
-month. Backward incompatible changes (e.g. endpoints removal, parameters 
-removal etc.), as well as removal of entire API versions are done in tandem 
-with a major point release of GitLab itself. All deprecations and changes 
-between two versions should be listed in the documentation. For the changes 
+month. Backward incompatible changes (e.g. endpoints removal, parameters
+removal etc.), as well as removal of entire API versions are done in tandem
+with a major point release of GitLab itself. All deprecations and changes
+between two versions should be listed in the documentation. For the changes
 between v3 and v4; please read the [v3 to v4 documentation](v3_to_v4.md)
 
 #### Current status
 
-Currently two API versions are available, v3 and v4. v3 is deprecated and 
-will soon be removed. Deletion is scheduled for 
+Currently only API version v4 is available. Version v3 was removed in
 [GitLab 11.0](https://gitlab.com/gitlab-org/gitlab-ce/issues/36819).
 
 ## Basic usage

diff --git a/doc/api/applications.md b/doc/api/applications.md
@@ -23,7 +23,7 @@ POST /applications
 | `scopes` | string | yes | The scopes of the application |
 
 ```bash
-curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --data "name=MyApplication&redirect_uri=http://redirect.uri&scopes=" https://gitlab.example.com/api/v3/applications
+curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --data "name=MyApplication&redirect_uri=http://redirect.uri&scopes=" https://gitlab.example.com/api/v4/applications
 ```
 
 Example response:

diff --git a/doc/api/environments.md b/doc/api/environments.md
@@ -123,7 +123,7 @@ POST /projects/:id/environments/:environment_id/stop
 | `environment_id` | integer | yes | The ID of the environment |
 
 ```bash
-curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/environments/1/stop"
+curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/environments/1/stop"
 ```
 
 Example response:

diff --git a/doc/api/projects.md b/doc/api/projects.md
@@ -1169,7 +1169,7 @@ The `file=` parameter must point to a file on your filesystem and be preceded
 by `@`. For example:
 
 ```bash
-curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --form "file=@dk.png" https://gitlab.example.com/api/v3/projects/5/uploads
+curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --form "file=@dk.png" https://gitlab.example.com/api/v4/projects/5/uploads
 ```
 
 Returned object:

diff --git a/doc/api/v3_to_v4.md b/doc/api/v3_to_v4.md
@@ -2,10 +2,9 @@
 
 Since GitLab 9.0, API V4 is the preferred version to be used.
 
-API V3 will be unsupported from GitLab 9.5, to be released on August
-22, 2017. It will be removed in GitLab 9.5 or later. In the meantime, we advise
-you to make any necessary changes to applications that use V3. The V3 API
-documentation is still
+API V3 was unsupported from GitLab 9.5, released on August
+22, 2017. API v3 was removed in [GitLab 11.0](https://gitlab.com/gitlab-org/gitlab-ce/issues/36819).
+The V3 API documentation is still
 [available](https://gitlab.com/gitlab-org/gitlab-ce/blob/8-16-stable/doc/api/README.md).
 
 Below are the changes made between V3 and V4.

diff --git a/doc/integration/shibboleth.md b/doc/integration/shibboleth.md
@@ -107,7 +107,7 @@ you will not get a shibboleth session!
   RewriteEngine on
 
   #Don't escape encoded characters in api requests
-  RewriteCond %{REQUEST_URI} ^/api/v3/.*
+  RewriteCond %{REQUEST_URI} ^/api/v4/.*
   RewriteCond %{REQUEST_URI} !/Shibboleth.sso
   RewriteCond %{REQUEST_URI} !/shibboleth-sp
   RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA,NE]

diff --git a/lib/api/api.rb b/lib/api/api.rb
@@ -22,48 +22,14 @@ class API < Grape::API
     allow_access_with_scope :api
     prefix :api
 
-    version %w(v3 v4), using: :path
-
     version 'v3', using: :path do
-      helpers ::API::V3::Helpers
-      helpers ::API::Helpers::CommonHelpers
-
-      mount ::API::V3::AwardEmoji
-      mount ::API::V3::Boards
-      mount ::API::V3::Branches
-      mount ::API::V3::BroadcastMessages
-      mount ::API::V3::Builds
-      mount ::API::V3::Commits
-      mount ::API::V3::DeployKeys
-      mount ::API::V3::Environments
-      mount ::API::V3::Files
-      mount ::API::V3::Groups
-      mount ::API::V3::Issues
-      mount ::API::V3::Labels
-      mount ::API::V3::Members
-      mount ::API::V3::MergeRequestDiffs
-      mount ::API::V3::MergeRequests
-      mount ::API::V3::Notes
-      mount ::API::V3::Pipelines
-      mount ::API::V3::ProjectHooks
-      mount ::API::V3::Milestones
-      mount ::API::V3::Projects
-      mount ::API::V3::ProjectSnippets
-      mount ::API::V3::Repositories
-      mount ::API::V3::Runners
-      mount ::API::V3::Services
-      mount ::API::V3::Settings
-      mount ::API::V3::Snippets
-      mount ::API::V3::Subscriptions
-      mount ::API::V3::SystemHooks
-      mount ::API::V3::Tags
-      mount ::API::V3::Templates
-      mount ::API::V3::Todos
-      mount ::API::V3::Triggers
-      mount ::API::V3::Users
-      mount ::API::V3::Variables
+      route :any, '*path' do
+        error!('API V3 is no longer supported. Use API V4 instead.', 410)
+      end
     end
 
+    version 'v4', using: :path
+
     before do
       header['X-Frame-Options'] = 'SAMEORIGIN'
       header['X-Content-Type-Options'] = 'nosniff'

diff --git a/lib/api/v3/award_emoji.rb b/lib/api/v3/award_emoji.rb