Module: BWAPI::Client::Projects::Data::MentionedAuthors

Included in:: BWAPI::Client::Projects::Data

Defined in:: lib/bwapi/client/projects/data/mentioned_authors.rb

Overview

MentionedAuthors module for the /projects/project_id/data/mentionedauthors endpoint

Instance Method Summary collapse

#data_mentioned_authors(project_id, opts = {}) ⇒ array

Get top n mentioned authors.

Instance Method Details

#data_mentioned_authors(project_id, opts = {}) ⇒ `array`

Get top n mentioned authors

Parameters:

project_id (Integer) —

Id of project
opts (Hash) (defaults to: {}) —

options hash of parameters

Options Hash (opts):

filter (Hash) —

The filters to apply
limit (Integer) —

The limit to return
orderBy (String) —

Parameter to sort by
orderDirection (String) —

Direction of sort

Returns:

(array) —

top n mentioned_authors based on parameter passed



16
17
18

# File 'lib/bwapi/client/projects/data/mentioned_authors.rb', line 16

def data_mentioned_authors(project_id, opts = {})
  get "/projects/#{project_id}/data/mentionedauthors", opts
end