Module: ActivityNotification::Swagger::NotificationsParameters::FilterByParameters

Defined in:
lib/activity_notification/controllers/concerns/swagger/notifications_parameters.rb

Overview

:nodoc:

Class Method Summary collapse

Class Method Details

.extended(base) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/activity_notification/controllers/concerns/swagger/notifications_parameters.rb', line 38

def self.extended(base)
  base.parameter do
    key :name, :filtered_by_type
    key :in, :query
    key :description, "Notifiable type to filter notification index: e.g. 'Comment'"
    key :required, false
    key :type, :string
    key :example, "Comment"
  end
  base.parameter do
    key :name, :filtered_by_group_type
    key :in, :query
    key :description, "Group type to filter notification index, valid with 'filtered_by_group_id': e.g. 'Article'"
    key :required, false
    key :type, :string
    key :example, "Article"
  end
  base.parameter do
    key :name, :filtered_by_group_id
    key :in, :query
    key :description, "Group instance ID to filter notification index, valid with 'filtered_by_group_type'"
    key :required, false
    key :type, :string
    key :example, 2
  end
  base.parameter do
    key :name, :filtered_by_key
    key :in, :query
    key :description, "Key of notifications to filter notification index: e.g. 'comment.default'"
    key :required, false
    key :type, :string
    key :example, "comment.default"
  end
  base.parameter do
    key :name, :later_than
    key :in, :query
    key :description, "ISO 8601 format time to filter notification index later than specified time"
    key :required, false
    key :type, :string
    key :format, :'date-time'
    key :example, Time.current.ago(10.years).iso8601(3)
  end
  base.parameter do
    key :name, :earlier_than
    key :in, :query
    key :description, "ISO 8601 format time to filter notification index earlier than specified time"
    key :required, false
    key :type, :string
    key :format, :'date-time'
    key :example, Time.current.since(10.years).iso8601(3)
  end
end