From 58716f0e072464e8374b29860305082d224d4bfd Mon Sep 17 00:00:00 2001 From: Justin Smestad Date: Sun, 20 Dec 2020 12:16:42 -0700 Subject: [PATCH 1/5] Draft document for apps.events.authorizations.list endpoint --- .../docs/apps.event.authorizations.list.json | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 lib/slack/web/docs/apps.event.authorizations.list.json diff --git a/lib/slack/web/docs/apps.event.authorizations.list.json b/lib/slack/web/docs/apps.event.authorizations.list.json new file mode 100644 index 0000000..b8f91dd --- /dev/null +++ b/lib/slack/web/docs/apps.event.authorizations.list.json @@ -0,0 +1,36 @@ +{ + "desc": "Returns a list of authorizations for the given event", + "args": { + "token": { + "description": "App-Level Authentication token. Requires scope: `authorizations:read`", + "required": true, + "type": "string" + }, + "event_context": { + "required": true, + "type": "string" + }, + "cursor": { + "required": false, + "type": "string" + }, + "limit": { + "required": false, + "type": "integer" + } + }, + "response": { + "ok": true, + "authorizations": { + "enterprise_id": "string", + "is_bot": "string", + "team_id": "string", + "user_id": "string" + } + }, + "errors": { + "invalid_event_context": "The given `event_context` didn't match an event.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "invalid_cursor": "The `cursor` argument was invalid." + } +} From 8ff1190a8d5165dbdb6fe08d13b03fd7aac48ea8 Mon Sep 17 00:00:00 2001 From: Justin Smestad Date: Sun, 20 Dec 2020 12:19:45 -0700 Subject: [PATCH 2/5] Remove extra documentation line that ex_doc warns about --- lib/slack/lookups.ex | 3 --- 1 file changed, 3 deletions(-) diff --git a/lib/slack/lookups.ex b/lib/slack/lookups.ex index c568907..8961956 100644 --- a/lib/slack/lookups.ex +++ b/lib/slack/lookups.ex @@ -90,9 +90,6 @@ defmodule Slack.Lookups do "#" <> slack.channels[channel_id].name end - @doc ~S""" - Turns a Slack private channel ID (`"G…"`) into a string in the format "#CHANNEL_NAME". - """ def lookup_channel_name(channel_id = "G" <> _id, slack) do "#" <> slack.groups[channel_id].name end From 1cd0a4b960dea15b4e10deb87f2fb2d5602b7252 Mon Sep 17 00:00:00 2001 From: Justin Smestad Date: Sun, 20 Dec 2020 12:23:08 -0700 Subject: [PATCH 3/5] Add descriptions to params --- lib/slack/web/docs/apps.event.authorizations.list.json | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/lib/slack/web/docs/apps.event.authorizations.list.json b/lib/slack/web/docs/apps.event.authorizations.list.json index b8f91dd..a59f5e5 100644 --- a/lib/slack/web/docs/apps.event.authorizations.list.json +++ b/lib/slack/web/docs/apps.event.authorizations.list.json @@ -7,16 +7,19 @@ "type": "string" }, "event_context": { + "description": "The `event-context` which is extracted from an Event payload" "required": true, "type": "string" }, "cursor": { "required": false, - "type": "string" + "type": "string", + "desc": "Paginate through collections of data by setting the cursor parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail." }, "limit": { "required": false, - "type": "integer" + "type": "integer", + "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.", } }, "response": { From aa6afde144d83742f78a1f5d1d6eb018e02c0a90 Mon Sep 17 00:00:00 2001 From: Justin Smestad Date: Sun, 20 Dec 2020 12:30:14 -0700 Subject: [PATCH 4/5] Updates with more data on endpoint attrs --- .../web/docs/apps.event.authorizations.list.json | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/lib/slack/web/docs/apps.event.authorizations.list.json b/lib/slack/web/docs/apps.event.authorizations.list.json index a59f5e5..72f0d9f 100644 --- a/lib/slack/web/docs/apps.event.authorizations.list.json +++ b/lib/slack/web/docs/apps.event.authorizations.list.json @@ -1,15 +1,11 @@ { "desc": "Returns a list of authorizations for the given event", "args": { - "token": { - "description": "App-Level Authentication token. Requires scope: `authorizations:read`", - "required": true, - "type": "string" - }, "event_context": { - "description": "The `event-context` which is extracted from an Event payload" + "description": "The `event-context` which is extracted from an Event payload", "required": true, - "type": "string" + "type": "string", + "example": "1-message-THG2FF18C-D02CT1XJJJ" }, "cursor": { "required": false, @@ -19,7 +15,7 @@ "limit": { "required": false, "type": "integer", - "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000.", + "desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000." } }, "response": { From d35e27f9ddbd929a473a0b4b4cba740bd6fd8dfb Mon Sep 17 00:00:00 2001 From: Justin Smestad Date: Sun, 20 Dec 2020 12:30:39 -0700 Subject: [PATCH 5/5] Update exdoc to avoid mix docs failure --- mix.lock | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/mix.lock b/mix.lock index b121288..d908279 100644 --- a/mix.lock +++ b/mix.lock @@ -5,17 +5,18 @@ "cowlib": {:hex, :cowlib, "1.0.2", "9d769a1d062c9c3ac753096f868ca121e2730b9a377de23dec0f7e08b1df84ee", [:make], [], "hexpm", "db622da03aa039e6366ab953e31186cc8190d32905e33788a1acb22744e6abd2"}, "credo": {:hex, :credo, "0.10.0", "66234a95effaf9067edb19fc5d0cd5c6b461ad841baac42467afed96c78e5e9e", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "893f53d5a5cb0bb6f96bde8732c20376e24be208fa052bdefd49119f77b64df6"}, "earmark": {:hex, :earmark, "1.3.1", "73812f447f7a42358d3ba79283cfa3075a7580a3a2ed457616d6517ac3738cb9", [:mix], [], "hexpm", "000aaeff08919e95e7aea13e4af7b2b9734577b3e6a7c50ee31ee88cab6ec4fb"}, - "ex_doc": {:hex, :ex_doc, "0.19.3", "3c7b0f02851f5fc13b040e8e925051452e41248f685e40250d7e40b07b9f8c10", [:mix], [{:earmark, "~> 1.2", [hex: :earmark, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.10", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm", "0e11d67e662142fc3945b0ee410c73c8c956717fbeae4ad954b418747c734973"}, + "earmark_parser": {:hex, :earmark_parser, "1.4.12", "b245e875ec0a311a342320da0551da407d9d2b65d98f7a9597ae078615af3449", [:mix], [], "hexpm", "711e2cc4d64abb7d566d43f54b78f7dc129308a63bc103fbd88550d2174b3160"}, + "ex_doc": {:hex, :ex_doc, "0.23.0", "a069bc9b0bf8efe323ecde8c0d62afc13d308b1fa3d228b65bca5cf8703a529d", [:mix], [{:earmark_parser, "~> 1.4.0", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm", "f5e2c4702468b2fd11b10d39416ddadd2fcdd173ba2a0285ebd92c39827a5a16"}, "hackney": {:hex, :hackney, "1.13.0", "24edc8cd2b28e1c652593833862435c80661834f6c9344e84b6a2255e7aeef03", [:rebar3], [{:certifi, "2.3.1", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "5.1.2", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm", "4d605d33dd07ee1b82b105033cccb02379515105fceb1850746591814b00c205"}, "httpoison": {:hex, :httpoison, "1.2.0", "2702ed3da5fd7a8130fc34b11965c8cfa21ade2f232c00b42d96d4967c39a3a3", [:mix], [{:hackney, "~> 1.8", [hex: :hackney, repo: "hexpm", optional: false]}], "hexpm", "712d9b1dfde2470ed000dff4b2faddaf56d038e5ac1944abc0a81c901a368391"}, "idna": {:hex, :idna, "5.1.2", "e21cb58a09f0228a9e0b95eaa1217f1bcfc31a1aaa6e1fdf2f53a33f7dbd9494", [:rebar3], [{:unicode_util_compat, "0.3.1", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "8fddb3aec4692c71647d67de72536254bce9069851754e370a99f2aae69fbdf4"}, "jason": {:hex, :jason, "1.1.1", "d3ccb840dfb06f2f90a6d335b536dd074db748b3e7f5b11ab61d239506585eb2", [:mix], [{:decimal, "~> 1.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "639645cfac325e34938167b272bae0791fea3a34cf32c29525abf1d323ed4c18"}, - "makeup": {:hex, :makeup, "0.8.0", "9cf32aea71c7fe0a4b2e9246c2c4978f9070257e5c9ce6d4a28ec450a839b55f", [:mix], [{:nimble_parsec, "~> 0.5.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "5fbc8e549aa9afeea2847c0769e3970537ed302f93a23ac612602e805d9d1e7f"}, - "makeup_elixir": {:hex, :makeup_elixir, "0.13.0", "be7a477997dcac2e48a9d695ec730b2d22418292675c75aa2d34ba0909dcdeda", [:mix], [{:makeup, "~> 0.8", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "adf0218695e22caeda2820eaba703fa46c91820d53813a2223413da3ef4ba515"}, + "makeup": {:hex, :makeup, "1.0.5", "d5a830bc42c9800ce07dd97fa94669dfb93d3bf5fcf6ea7a0c67b2e0e4a7f26c", [:mix], [{:nimble_parsec, "~> 0.5 or ~> 1.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "cfa158c02d3f5c0c665d0af11512fed3fba0144cf1aadee0f2ce17747fba2ca9"}, + "makeup_elixir": {:hex, :makeup_elixir, "0.15.0", "98312c9f0d3730fde4049985a1105da5155bfe5c11e47bdc7406d88e01e4219b", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.1", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "75ffa34ab1056b7e24844c90bfc62aaf6f3a37a15faa76b07bc5eba27e4a8b4a"}, "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm", "69b09adddc4f74a40716ae54d140f93beb0fb8978d8636eaded0c31b6f099f16"}, "mime": {:hex, :mime, "1.3.0", "5e8d45a39e95c650900d03f897fbf99ae04f60ab1daa4a34c7a20a5151b7a5fe", [:mix], [], "hexpm", "5e839994289d60326aa86020c4fbd9c6938af188ecddab2579f07b66cd665328"}, "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [:rebar3], [], "hexpm", "7a4c8e1115a2732a67d7624e28cf6c9f30c66711a9e92928e745c255887ba465"}, - "nimble_parsec": {:hex, :nimble_parsec, "0.5.0", "90e2eca3d0266e5c53f8fbe0079694740b9c91b6747f2b7e3c5d21966bba8300", [:mix], [], "hexpm", "5c040b8469c1ff1b10093d3186e2e10dbe483cd73d79ec017993fb3985b8a9b3"}, + "nimble_parsec": {:hex, :nimble_parsec, "1.1.0", "3a6fca1550363552e54c216debb6a9e95bd8d32348938e13de5eda962c0d7f89", [:mix], [], "hexpm", "08eb32d66b706e913ff748f11694b17981c0b04a33ef470e33e11b3d3ac8f54b"}, "parse_trans": {:hex, :parse_trans, "3.2.0", "2adfa4daf80c14dc36f522cf190eb5c4ee3e28008fc6394397c16f62a26258c2", [:rebar3], [], "hexpm", "578b1d484720749499db5654091ddac818ea0b6d568f2c99c562d2a6dd4aa117"}, "plug": {:hex, :plug, "1.6.2", "e06a7bd2bb6de5145da0dd950070110dce88045351224bd98e84edfdaaf5ffee", [:mix], [{:cowboy, "~> 1.0.1 or ~> 1.1 or ~> 2.4", [hex: :cowboy, repo: "hexpm", optional: true]}, {:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}], "hexpm", "b2713c085797012661a6c10e1898a009f0cc2bae556cc00341b69600074c757b"}, "poison": {:hex, :poison, "4.0.1", "bcb755a16fac91cad79bfe9fc3585bb07b9331e50cfe3420a24bcc2d735709ae", [:mix], [], "hexpm", "ba8836feea4b394bb718a161fc59a288fe0109b5006d6bdf97b6badfcf6f0f25"},