summaryrefslogtreecommitdiff
path: root/lib/api/entities/bulk_imports/entity.rb
blob: 176d10b2580931d5b78d82469ee46f7f2ad94373 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# frozen_string_literal: true

module API
  module Entities
    module BulkImports
      class Entity < Grape::Entity
        expose :id, documentation: { type: 'integer', example: 1 }
        expose :bulk_import_id, documentation: { type: 'integer', example: 1 }
        expose :status_name, as: :status, documentation: {
          type: 'string', example: 'created', values: %w[created started finished timeout failed]
        }
        expose :entity_type, documentation: { type: 'string', values: %w[group project] }
        expose :source_full_path, documentation: { type: 'string', example: 'source_group' }
        expose :full_path, as: :destination_full_path, documentation: {
          type: 'string', example: 'some_group/source_project'
        }
        expose :destination_name, documentation: { type: 'string', example: 'destination_slug' } # deprecated
        expose :destination_slug, documentation: { type: 'string', example: 'destination_slug' }
        expose :destination_namespace, documentation: { type: 'string', example: 'destination_path' }
        expose :parent_id, documentation: { type: 'integer', example: 1 }
        expose :namespace_id, documentation: { type: 'integer', example: 1 }
        expose :project_id, documentation: { type: 'integer', example: 1 }
        expose :created_at, documentation: { type: 'dateTime', example: '2012-05-28T04:42:42-07:00' }
        expose :updated_at, documentation: { type: 'dateTime', example: '2012-05-28T04:42:42-07:00' }
        expose :failures, using: EntityFailure, documentation: { is_array: true }
        expose :migrate_projects, documentation: { type: 'boolean', example: true }
      end
    end
  end
end