Merge branch 'dz-api-public-project-schema' into 'master'

Add spec public api project schema

See merge request gitlab-org/gitlab!60493

spec/fixtures/api/schemas/public_api/v4/project.json

+{
+  "type": "object",
+  "properties" : {
+    "id": { "type": "integer" },
+    "name": { "type": "string" },
+    "name_with_namespace": { "type": "string" },
+    "description": { "type": ["string", "null"] },
+    "path": { "type": "string" },
+    "path_with_namespace": { "type": "string" },
+    "created_at": { "type": "string", "format": "date-time" },
+    "default_branch": { "type": ["string", "null"] },
+    "tag_list": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "ssh_url_to_repo": { "type": "string" },
+    "http_url_to_repo": { "type": "string" },
+    "web_url": { "type": "string" },
+    "readme_url": { "type": ["string", "null"] },
+    "avatar_url": { "type": ["string", "null"] },
+    "star_count": { "type": "integer" },
+    "forks_count": { "type": "integer" },
+    "last_activity_at": { "type": "string", "format": "date-time" },
+    "namespace": {
+      "type": "object",
+      "properties" : {
+        "id": { "type": "integer" },
+        "name": { "type": "string" },
+        "path": { "type": "string" },
+        "kind": { "type": "string" },
+        "full_path": { "type": "string" },
+        "parent_id": { "type": ["integer", "null"] }
+      }
+    }
+  },
+  "required": [
+    "id", "name", "name_with_namespace", "description", "path",
+    "path_with_namespace", "created_at", "default_branch", "tag_list",
+    "ssh_url_to_repo", "http_url_to_repo", "web_url", "readme_url", "avatar_url",
+    "star_count", "forks_count", "last_activity_at", "namespace"
+  ],
+  "additionalProperties": false
+}

spec/fixtures/api/schemas/public_api/v4/projects.json

 {
   "type": "array",
-  "items": {
-    "type": "object",
-    "properties" : {
-      "id": { "type": "integer" },
-      "name": { "type": "string" },
-      "name_with_namespace": { "type": "string" },
-      "description": { "type": ["string", "null"] },
-      "path": { "type": "string" },
-      "path_with_namespace": { "type": "string" },
-      "created_at": { "type": "string", "format": "date-time" },
-      "default_branch": { "type": ["string", "null"] },
-      "tag_list": {
-        "type": "array",
-        "items": {
-          "type": "string"
-        }
-      },
-      "ssh_url_to_repo": { "type": "string" },
-      "http_url_to_repo": { "type": "string" },
-      "web_url": { "type": "string" },
-      "readme_url": { "type": ["string", "null"] },
-      "avatar_url": { "type": ["string", "null"] },
-      "star_count": { "type": "integer" },
-      "forks_count": { "type": "integer" },
-      "last_activity_at": { "type": "string", "format": "date-time" },
-      "namespace": {
-        "type": "object",
-        "properties" : {
-          "id": { "type": "integer" },
-          "name": { "type": "string" },
-          "path": { "type": "string" },
-          "kind": { "type": "string" },
-          "full_path": { "type": "string" },
-          "parent_id": { "type": ["integer", "null"] }
-        }
-      }
-    },
-    "required": [
-      "id", "name", "name_with_namespace", "description", "path",
-      "path_with_namespace", "created_at", "default_branch", "tag_list",
-      "ssh_url_to_repo", "http_url_to_repo", "web_url", "avatar_url",
-      "star_count", "last_activity_at", "namespace"
-    ],
-    "additionalProperties": false
-  }
+  "items": { "$ref": "project.json" }
 }

spec/requests/api/environments_spec.rb

@@ -15,16 +15,6 @@ RSpec.describe API::Environments do
   describe 'GET /projects/:id/environments' do
     context 'as member of the project' do
       it 'returns project environments' do
-        project_data_keys = %w(
-          id description default_branch tag_list
-          ssh_url_to_repo http_url_to_repo web_url readme_url
-          name name_with_namespace
-          path path_with_namespace
-          star_count forks_count
-          created_at last_activity_at
-          avatar_url namespace
-        )
-
         get api("/projects/#{project.id}/environments", user)
 
         expect(response).to have_gitlab_http_status(:ok)
@@ -33,7 +23,7 @@ RSpec.describe API::Environments do
         expect(json_response.size).to eq(1)
         expect(json_response.first['name']).to eq(environment.name)
         expect(json_response.first['external_url']).to eq(environment.external_url)
-        expect(json_response.first['project'].keys).to contain_exactly(*project_data_keys)
+        expect(json_response.first['project']).to match_schema('public_api/v4/project')
         expect(json_response.first['enable_advanced_logs_querying']).to eq(false)
         expect(json_response.first).not_to have_key('last_deployment')
       end

spec/requests/api/projects_spec.rb

@@ -348,22 +348,11 @@ RSpec.describe API::Projects do
 
       context 'and with simple=true' do
         it 'returns a simplified version of all the projects' do
-          expected_keys = %w(
-            id description default_branch tag_list
-            ssh_url_to_repo http_url_to_repo web_url readme_url
-            name name_with_namespace
-            path path_with_namespace
-            star_count forks_count
-            created_at last_activity_at
-            avatar_url namespace
-          )
-
           get api('/projects?simple=true', user)
 
           expect(response).to have_gitlab_http_status(:ok)
           expect(response).to include_pagination_headers
-          expect(json_response).to be_an Array
-          expect(json_response.first.keys).to match_array expected_keys
+          expect(response).to match_response_schema('public_api/v4/projects')
         end
       end