lib/yammer/api/topic.rb in yammer-client-0.1.4 vs lib/yammer/api/topic.rb in yammer-client-0.1.5
- old
+ new
@@ -1,17 +1,19 @@
module Yammer
module Api
module Topic
- # @see https://developer.yammer.com/restapi/#rest-users
+ # @see https://developer.yammer.com/restapi/#rest-topics
# @api_path /api/v1/topics
# @rate_limited Yes
# @authentication Requires user context
- # @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+ # @raise [Yammer::Error::Unauthorized] Error raised when supplied
+ # user credentials are not valid.
# @return [Yammer::ApiResponse]
# @param id [Integer]
# @param [Hash] opts the options to fetch a thread with
- # @option opts [Integer] :is_followed_by
+ # @option opts [Integer] :is_followed_by include if specified user
+ # is following topic that is being fetched
# @example Fetch data for the thread
# Yammer.get_topic(42, :is_followed_by => 2)
def get_topic(id, opts={})
get("/api/v1/topics/#{id}", opts)
end
\ No newline at end of file