Skip to content

Updated method template to include a warning for undocumented endpoints #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
aviflombaum wants to merge 2 commits into from
Closed

Updated method template to include a warning for undocumented endpoints #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c130e9
Updated method template to include a warning for undocumented endpoints
aviflombaum Nov 25, 2017
9e261cc
Update CHANGELOG.md
aviflombaum Nov 26, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### 0.11.1 (Next)

* Your contribution here.
Copy link
Copy Markdown
Collaborator

@dblock dblock Nov 26, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Put this back please.

* [#185](https://github.com/slack-ruby/slack-ruby-client/pull/185): Updated method template to include a warning for undocumented endpoints - [@aviflombaum](https://github.com/aviflombaum).

### 0.11.0 (11/25/2017)

Expand Down
3 changes: 3 additions & 0 deletions lib/slack/web/api/templates/method.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ module Slack
<% if data['args']['user'] %>
options = options.merge(user: users_id(options)['user']['id']) if options[:user]
<% end %>
<% if data['undocumented'] %>
logger.warn('<%= group %>.<%= name %> is an undocumented API endpoint.')
Copy link
Copy Markdown
Collaborator

@dblock dblock Nov 26, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe "The <%= group %>.<%= name %> method is undocumented."

Copy link
Copy Markdown
Contributor Author

@aviflombaum aviflombaum Nov 26, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

<% end %>
<% if data['args'].keys.include?('cursor') %>
if block_given?
Pagination::Cursor.new(self, :<%= group.gsub(".", "_") %>_<%= name %>, options).each do |page|
Expand Down