1 files changed, 11 insertions, 9 deletions
diff --git a/lib/api/entities/package.rb b/lib/api/entities/package.rb
index 9b73a142fcd..c92a4677220 100644
--- a/lib/api/entities/package.rb
+++ b/lib/api/entities/package.rb
@@ -7,9 +7,9 @@ module API
       include ::Routing::PackagesHelper
       extend ::API::Entities::EntityHelpers
 
-      expose :id
+      expose :id, documentation: { type: 'integer', example: 1 }
 
-      expose :name do |package|
+      expose :name, documentation: { type: 'string', example: '@foo/bar' } do |package|
         if package.conan?
           package.conan_recipe
         else
@@ -21,9 +21,9 @@ module API
         package.name
       end
 
-      expose :version
-      expose :package_type
-      expose :status
+      expose :version, documentation: { type: 'string', example: '1.0.3' }
+      expose :package_type, documentation: { type: 'string', example: 'npm' }
+      expose :status, documentation: { type: 'string', example: 'default' }
 
       expose :_links do
         expose :web_path do |package|
@@ -35,10 +35,12 @@ module API
         end
       end
 
-      expose :created_at
-      expose :last_downloaded_at
-      expose :project_id, if: ->(_, opts) { opts[:group] }
-      expose :project_path, if: ->(obj, opts) { opts[:group] && Ability.allowed?(opts[:user], :read_project, obj.project) }
+      expose :created_at, documentation: { type: 'dateTime', example: '2022-09-16T12:47:31.949Z' }
+      expose :last_downloaded_at, documentation: { type: 'dateTime', example: '2022-09-19T11:32:35.169Z' }
+      expose :project_id, documentation: { type: 'integer', example: 2 }, if: ->(_, opts) { opts[:group] }
+      expose :project_path, documentation: { type: 'string', example: 'gitlab/foo/bar' }, if: ->(obj, opts) do
+        opts[:group] && Ability.allowed?(opts[:user], :read_project, obj.project)
+      end
       expose :tags
 
       expose :pipeline, if: ->(package) { package.original_build_info }, using: Package::Pipeline