BlakeWilliams / Elixir-Slack

Slack real time messaging and web API client in Elixir
MIT License
675 stars 182 forks source link

breaking: Update latest api docs #255

Open inooid opened 2 years ago

inooid commented 2 years ago

⚠️ This PR contains breaking changes based on deprecated methods by Slack (which presumably are already not working) and changes to which arguments are considered required and optional. The breaking changes are listed in the PR description.

Descriptions

For review:

I've converted all existing JSON files into the current format for an easier time reviewing. Think of it as:

Enum.map(files, fn file ->
  contents = file
  |> File.read!()
  |> Jason.decode!()
  |> Jason.encode!(pretty: true)

  File.write!(file, contents)
end)

It's probably easiest to review this commit: https://github.com/BlakeWilliams/Elixir-Slack/commit/952114d2990665453fd02054bffc2e597c1ea4f2 (as it contains the pre-formatting to make it easier to review).

Breaking changes

Non breaking changes

inooid commented 2 years ago

I suspect in order to move this PR forward, we'll probably want to release the previous changes first. Let those soak in and then see if we can update all of these. In order to move this forward after the current release cut, we'll have to have an opinion on: https://github.com/BlakeWilliams/Elixir-Slack/pull/255#discussion_r941429465.