Add latest changes from gitlab-org/gitlab@15-7-stable-eev15.7.0-rc42

12 files changed, 57 insertions, 48 deletions

diff --git a/lib/api/entities/nuget/dependency.rb b/lib/api/entities/nuget/dependency.rb
index b61c37f5882..adb11376cfa 100644
--- a/lib/api/entities/nuget/dependency.rb
+++ b/lib/api/entities/nuget/dependency.rb
@@ -4,10 +4,10 @@ module API
   module Entities
     module Nuget
       class Dependency < Grape::Entity
-        expose :id, as: :@id
-        expose :type, as: :@type
-        expose :name, as: :id
-        expose :range
+        expose :id, as: :@id, documentation: { type: 'string', example: 'http://gitlab.com/Sandbox.App/1.0.0.json#dependency' }
+        expose :type, as: :@type, documentation: { type: 'string', example: 'PackageDependency' }
+        expose :name, as: :id, documentation: { type: 'string', example: 'Dependency' }
+        expose :range, documentation: { type: 'string', example: '2.0.0' }
       end
     end
   end
diff --git a/lib/api/entities/nuget/dependency_group.rb b/lib/api/entities/nuget/dependency_group.rb
index dcab9359fcf..8d943050cd8 100644
--- a/lib/api/entities/nuget/dependency_group.rb
+++ b/lib/api/entities/nuget/dependency_group.rb
@@ -4,10 +4,12 @@ module API
   module Entities
     module Nuget
       class DependencyGroup < Grape::Entity
-        expose :id, as: :@id
-        expose :type, as: :@type
-        expose :target_framework, as: :targetFramework, expose_nil: false
-        expose :dependencies, using: ::API::Entities::Nuget::Dependency
+        expose :id, as: :@id, documentation: { type: 'string', example: 'http://gitlab.com/Sandbox.App/1.0.0.json#dependencygroup' }
+        expose :type, as: :@type, documentation: { type: 'string', example: 'PackageDependencyGroup' }
+        expose :target_framework, as: :targetFramework, expose_nil: false,
+                                  documentation: { type: 'string', example: 'fwk test' }
+        expose :dependencies, using: ::API::Entities::Nuget::Dependency,
+                              documentation: { is_array: true, type: 'API::Entities::Nuget::Dependency' }
       end
     end
   end
diff --git a/lib/api/entities/nuget/metadatum.rb b/lib/api/entities/nuget/metadatum.rb
index 87caef41a85..256b916cb64 100644
--- a/lib/api/entities/nuget/metadatum.rb
+++ b/lib/api/entities/nuget/metadatum.rb
@@ -4,9 +4,9 @@ module API
   module Entities
     module Nuget
       class Metadatum < Grape::Entity
-        expose :project_url, as: :projectUrl, expose_nil: false
-        expose :license_url, as: :licenseUrl, expose_nil: false
-        expose :icon_url, as: :iconUrl, expose_nil: false
+        expose :project_url, as: :projectUrl, expose_nil: false, documentation: { type: 'string', example: 'http://sandbox.com/project' }
+        expose :license_url, as: :licenseUrl, expose_nil: false, documentation: { type: 'string', example: 'http://sandbox.com/license' }
+        expose :icon_url, as: :iconUrl, expose_nil: false, documentation: { type: 'string', example: 'http://sandbox.com/icon' }
       end
     end
   end
diff --git a/lib/api/entities/nuget/package_metadata.rb b/lib/api/entities/nuget/package_metadata.rb
index e1c2a1ae161..1c94426bdd6 100644
--- a/lib/api/entities/nuget/package_metadata.rb
+++ b/lib/api/entities/nuget/package_metadata.rb
@@ -4,9 +4,10 @@ module API
   module Entities
     module Nuget
       class PackageMetadata < Grape::Entity
-        expose :json_url, as: :@id
-        expose :archive_url, as: :packageContent
-        expose :catalog_entry, as: :catalogEntry, using: ::API::Entities::Nuget::PackageMetadataCatalogEntry
+        expose :json_url, as: :@id, documentation: { type: 'string', example: 'https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json' }
+        expose :archive_url, as: :packageContent, documentation: { type: 'string', example: 'https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/MyNuGetPkg/1.3.0.17/helloworld.1.3.0.17.nupkg' }
+        expose :catalog_entry, as: :catalogEntry, using: ::API::Entities::Nuget::PackageMetadataCatalogEntry,
+                               documentation: { type: 'API::Entities::Nuget::PackageMetadataCatalogEntry' }
       end
     end
   end
diff --git a/lib/api/entities/nuget/package_metadata_catalog_entry.rb b/lib/api/entities/nuget/package_metadata_catalog_entry.rb
index 5533f857596..ce328c5a5ca 100644
--- a/lib/api/entities/nuget/package_metadata_catalog_entry.rb
+++ b/lib/api/entities/nuget/package_metadata_catalog_entry.rb
@@ -4,15 +4,17 @@ module API
   module Entities
     module Nuget
       class PackageMetadataCatalogEntry < Grape::Entity
-        expose :json_url, as: :@id
-        expose :authors
-        expose :dependency_groups, as: :dependencyGroups, using: ::API::Entities::Nuget::DependencyGroup
-        expose :package_name, as: :id
-        expose :package_version, as: :version
-        expose :tags
-        expose :archive_url, as: :packageContent
-        expose :summary
-        expose :metadatum, using: ::API::Entities::Nuget::Metadatum, merge: true
+        expose :json_url, as: :@id, documentation: { type: 'string', example: 'https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json' }
+        expose :authors, documentation: { type: 'string', example: 'Author' }
+        expose :dependency_groups, as: :dependencyGroups, using: ::API::Entities::Nuget::DependencyGroup,
+                                   documentation: { is_array: true, type: 'API::Entities::Nuget::DependencyGroup' }
+        expose :package_name, as: :id, documentation: { type: 'string', example: 'MyNuGetPkg' }
+        expose :package_version, as: :version, documentation: { type: 'string', example: '1.3.0.17' }
+        expose :tags, documentation: { type: 'string', example: 'tag#1 tag#2' }
+        expose :archive_url, as: :packageContent, documentation: { type: 'string', example: 'https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/MyNuGetPkg/1.3.0.17/helloworld.1.3.0.17.nupkg' }
+        expose :summary, documentation: { type: 'string', example: 'Summary' }
+        expose :metadatum, using: ::API::Entities::Nuget::Metadatum, merge: true,
+                           documentation: { type: 'API::Entities::Nuget::Metadatum' }
       end
     end
   end
diff --git a/lib/api/entities/nuget/packages_metadata.rb b/lib/api/entities/nuget/packages_metadata.rb
index 1cdf2491725..e556df0ce1f 100644
--- a/lib/api/entities/nuget/packages_metadata.rb
+++ b/lib/api/entities/nuget/packages_metadata.rb
@@ -4,8 +4,9 @@ module API
   module Entities
     module Nuget
       class PackagesMetadata < Grape::Entity
-        expose :count
-        expose :items, using: ::API::Entities::Nuget::PackagesMetadataItem
+        expose :count, documentation: { type: 'integer', example: 1 }
+        expose :items, using: ::API::Entities::Nuget::PackagesMetadataItem,
+                       documentation: { is_array: true, type: 'API::Entities::Nuget::PackagesMetadataItem' }
       end
     end
   end
diff --git a/lib/api/entities/nuget/packages_metadata_item.rb b/lib/api/entities/nuget/packages_metadata_item.rb
index 84cc79166f3..420a4c3941c 100644
--- a/lib/api/entities/nuget/packages_metadata_item.rb
+++ b/lib/api/entities/nuget/packages_metadata_item.rb
@@ -4,11 +4,12 @@ module API
   module Entities
     module Nuget
       class PackagesMetadataItem < Grape::Entity
-        expose :json_url, as: :@id
-        expose :lower_version, as: :lower
-        expose :upper_version, as: :upper
-        expose :packages_count, as: :count
-        expose :packages, as: :items, using: ::API::Entities::Nuget::PackageMetadata
+        expose :json_url, as: :@id, documentation: { type: 'string', example: 'https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json' }
+        expose :lower_version, as: :lower, documentation: { type: 'string', example: '1.3.0.17' }
+        expose :upper_version, as: :upper, documentation: { type: 'string', example: '1.3.0.17' }
+        expose :packages_count, as: :count, documentation: { type: 'integer', example: 1 }
+        expose :packages, as: :items, using: ::API::Entities::Nuget::PackageMetadata,
+                          documentation: { is_array: true, type: 'API::Entities::Nuget::PackageMetadata' }
       end
     end
   end
diff --git a/lib/api/entities/nuget/packages_versions.rb b/lib/api/entities/nuget/packages_versions.rb
index 498c6970d5c..e0330300ca7 100644
--- a/lib/api/entities/nuget/packages_versions.rb
+++ b/lib/api/entities/nuget/packages_versions.rb
@@ -4,7 +4,7 @@ module API
   module Entities
     module Nuget
       class PackagesVersions < Grape::Entity
-        expose :versions
+        expose :versions, documentation: { type: 'string', is_array: true, example: '1.3.0.17' }
       end
     end
   end
diff --git a/lib/api/entities/nuget/search_result.rb b/lib/api/entities/nuget/search_result.rb
index 8e028cbad95..bb3698de30b 100644
--- a/lib/api/entities/nuget/search_result.rb
+++ b/lib/api/entities/nuget/search_result.rb
@@ -4,17 +4,18 @@ module API
   module Entities
     module Nuget
       class SearchResult < Grape::Entity
-        expose :type, as: :@type
-        expose :authors
-        expose :name, as: :id
-        expose :name, as: :title
-        expose :summary
-        expose :total_downloads, as: :totalDownloads
-        expose :verified
-        expose :version
+        expose :type, as: :@type, documentation: { type: 'string', example: 'Package' }
+        expose :authors, documentation: { type: 'string', example: 'Author' }
+        expose :name, as: :id, documentation: { type: 'string', example: 'MyNuGetPkg' }
+        expose :name, as: :title, documentation: { type: 'string', example: 'MyNuGetPkg' }
+        expose :summary, documentation: { type: 'string', example: 'Summary' }
+        expose :total_downloads, as: :totalDownloads, documentation: { type: 'integer', example: 1 }
+        expose :verified, documentation: { type: 'boolean' }
+        expose :version, documentation: { type: 'string', example: '1.3.0.17' }
         expose :versions, using: ::API::Entities::Nuget::SearchResultVersion
-        expose :tags
-        expose :metadatum, using: ::API::Entities::Nuget::Metadatum, merge: true
+        expose :tags, documentation: { type: 'string', example: 'tag#1 tag#2' }
+        expose :metadatum, using: ::API::Entities::Nuget::Metadatum, merge: true,
+                           documentation: { is_array: true, type: 'API::Entities::Nuget::Metadatum' }
       end
     end
   end
diff --git a/lib/api/entities/nuget/search_result_version.rb b/lib/api/entities/nuget/search_result_version.rb
index 9032c964c44..fb8d8b75f83 100644
--- a/lib/api/entities/nuget/search_result_version.rb
+++ b/lib/api/entities/nuget/search_result_version.rb
@@ -4,9 +4,9 @@ module API
   module Entities
     module Nuget
       class SearchResultVersion < Grape::Entity
-        expose :json_url, as: :@id
-        expose :version
-        expose :downloads
+        expose :json_url, as: :@id, documentation: { type: 'string', example: 'https://gitlab.example.com/api/v4/projects/1/packages/nuget/metadata/MyNuGetPkg/1.3.0.17.json' }
+        expose :version, documentation: { type: 'string', example: '1.3.0.17' }
+        expose :downloads, documentation: { type: 'integer', example: 1 }
       end
     end
   end
diff --git a/lib/api/entities/nuget/search_results.rb b/lib/api/entities/nuget/search_results.rb
index 22a77dc7b6c..117904a1aff 100644
--- a/lib/api/entities/nuget/search_results.rb
+++ b/lib/api/entities/nuget/search_results.rb
@@ -4,8 +4,9 @@ module API
   module Entities
     module Nuget
       class SearchResults < Grape::Entity
-        expose :total_count, as: :totalHits
-        expose :data, using: ::API::Entities::Nuget::SearchResult
+        expose :total_count, as: :totalHits, documentation: { type: 'integer', example: 1 }
+        expose :data, using: ::API::Entities::Nuget::SearchResult,
+                      documentation: { is_array: true, type: 'API::Entities::Nuget::SearchResult' }
       end
     end
   end
diff --git a/lib/api/entities/nuget/service_index.rb b/lib/api/entities/nuget/service_index.rb
index e57bd04adb9..4ab6c5ddc8b 100644
--- a/lib/api/entities/nuget/service_index.rb
+++ b/lib/api/entities/nuget/service_index.rb
@@ -4,8 +4,8 @@ module API
   module Entities
     module Nuget
       class ServiceIndex < Grape::Entity
-        expose :version
-        expose :resources
+        expose :version, documentation: { type: 'string', example: '1.3.0.17' }
+        expose :resources, documentation: { type: 'object', is_array: true, example: '{ "@id": "https://gitlab.com/api/v4/projects/1/packages/nuget/query", "@type": "SearchQueryService", "comment": "Filter and search for packages by keyword."}' }
       end
     end
   end