Sha256: 8779d8890ec6c454cbf764efbc6b231ae613d7209328e2076021c8fbd47d8a92
Contents?: true
Size: 1.54 KB
Versions: 14
Compression:
Stored size: 1.54 KB
Contents
module ActivityNotification
module Swagger::SubscriptionsParameters #:nodoc:
module TargetParameters #:nodoc:
def self.extended(base)
base.parameter do
key :name, :target_type
key :in, :path
key :description, "Target type of subscriptions: e.g. 'users'"
key :required, true
key :type, :string
key :example, "users"
end
base.parameter do
key :name, :target_id
key :in, :path
key :description, "Target ID of subscriptions. This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs."
key :required, true
key :type, :string
key :example, 1
end
end
end
module IdParameter #:nodoc:
def self.extended(base)
base.parameter do
key :name, :id
key :in, :path
key :description, 'ID of subscription record. This parameter type is integer with ActiveRecord, but will be string with Mongoid or Dynamoid ORMs.'
key :required, true
key :type, :string
key :example, 123
end
end
end
module FilterByParameters #:nodoc:
def self.extended(base)
base.parameter do
key :name, :filtered_by_key
key :in, :query
key :description, "Key of subscriptions to filter subscription index: e.g. 'comment.default'"
key :required, false
key :type, :string
key :example, "comment.default"
end
end
end
end
end
Version data entries
14 entries across 14 versions & 1 rubygems