1 files changed, 10 insertions, 8 deletions
diff --git a/lib/api/entities/bulk_imports/entity_failure.rb b/lib/api/entities/bulk_imports/entity_failure.rb
index 56312745868..3e69e7fa2aa 100644
--- a/lib/api/entities/bulk_imports/entity_failure.rb
+++ b/lib/api/entities/bulk_imports/entity_failure.rb
@@ -4,16 +4,18 @@ module API
   module Entities
     module BulkImports
       class EntityFailure < Grape::Entity
-        expose :relation
-        expose :pipeline_step, as: :step
-        expose :exception_message do |failure|
+        expose :relation, documentation: { type: 'string', example: 'group' }
+        expose :pipeline_step, as: :step, documentation: { type: 'string', example: 'extractor' }
+        expose :exception_message, documentation: { type: 'string', example: 'error message' } do |failure|
           ::Projects::ImportErrorFilter.filter_message(failure.exception_message.truncate(72))
         end
-        expose :exception_class
-        expose :correlation_id_value
-        expose :created_at
-        expose :pipeline_class
-        expose :pipeline_step
+        expose :exception_class, documentation: { type: 'string', example: 'Exception' }
+        expose :correlation_id_value, documentation: { type: 'string', example: 'dfcf583058ed4508e4c7c617bd7f0edd' }
+        expose :created_at, documentation: { type: 'dateTime', example: '2012-05-28T04:42:42-07:00' }
+        expose :pipeline_class, documentation: {
+          type: 'string', example: 'BulkImports::Groups::Pipelines::GroupPipeline'
+        }
+        expose :pipeline_step, documentation: { type: 'string', example: 'extractor' }
       end
     end
   end