Add JSON data covering all the rate limit tiers of Web APIs (#815)

Author: seratch

metadata/web-api/rate_limit_tiers.json

@@ -0,0 +1,249 @@
+{
+  "admin.analytics.getFile": "Tier2",
+  "admin.apps.approve": "Tier2",
+  "admin.apps.approved.list": "Tier2",
+  "admin.apps.clearResolution": "Tier2",
+  "admin.apps.requests.list": "Tier2",
+  "admin.apps.restrict": "Tier2",
+  "admin.apps.restricted.list": "Tier2",
+  "admin.apps.uninstall": "Tier1",
+  "admin.auth.policy.assignEntities": "Tier4",
+  "admin.auth.policy.getEntities": "Tier4",
+  "admin.auth.policy.removeEntities": "Tier4",
+  "admin.barriers.create": "Tier2",
+  "admin.barriers.delete": "Tier2",
+  "admin.barriers.list": "Tier2",
+  "admin.barriers.update": "Tier2",
+  "admin.conversations.archive": "Tier2",
+  "admin.conversations.convertToPrivate": "Tier2",
+  "admin.conversations.create": "Tier2",
+  "admin.conversations.delete": "Tier2",
+  "admin.conversations.disconnectShared": "Tier2",
+  "admin.conversations.ekm.listOriginalConnectedChannelInfo": "Tier2",
+  "admin.conversations.getConversationPrefs": "Tier2",
+  "admin.conversations.getTeams": "Tier2",
+  "admin.conversations.invite": "Tier2",
+  "admin.conversations.rename": "Tier2",
+  "admin.conversations.restrictAccess.addGroup": "Tier2",
+  "admin.conversations.restrictAccess.listGroups": "Tier2",
+  "admin.conversations.restrictAccess.removeGroup": "Tier1",
+  "admin.conversations.search": "Tier2",
+  "admin.conversations.setConversationPrefs": "Tier2",
+  "admin.conversations.setTeams": "Tier2",
+  "admin.conversations.unarchive": "Tier2",
+  "admin.conversations.whitelist.add": "Tier2",
+  "admin.conversations.whitelist.listGroupsLinkedToChannel": "Tier2",
+  "admin.conversations.whitelist.remove": "Tier1",
+  "admin.emoji.add": "Tier2",
+  "admin.emoji.addAlias": "Tier2",
+  "admin.emoji.list": "Tier2",
+  "admin.emoji.remove": "Tier2",
+  "admin.emoji.rename": "Tier2",
+  "admin.inviteRequests.approve": "Tier2",
+  "admin.inviteRequests.approved.list": "Tier2",
+  "admin.inviteRequests.denied.list": "Tier2",
+  "admin.inviteRequests.deny": "Tier2",
+  "admin.inviteRequests.list": "Tier2",
+  "admin.teams.admins.list": "Tier3",
+  "admin.teams.create": "Tier1",
+  "admin.teams.list": "Tier3",
+  "admin.teams.owners.list": "Tier3",
+  "admin.teams.settings.info": "Tier3",
+  "admin.teams.settings.setDefaultChannels": "Tier2",
+  "admin.teams.settings.setDescription": "Tier2",
+  "admin.teams.settings.setDiscoverability": "Tier2",
+  "admin.teams.settings.setIcon": "Tier2",
+  "admin.teams.settings.setName": "Tier3",
+  "admin.usergroups.addChannels": "Tier1",
+  "admin.usergroups.addTeams": "Tier2",
+  "admin.usergroups.listChannels": "Tier2",
+  "admin.usergroups.removeChannels": "Tier2",
+  "admin.users.assign": "Tier2",
+  "admin.users.invite": "Tier2",
+  "admin.users.list": "Tier3",
+  "admin.users.remove": "Tier2",
+  "admin.users.session.clearSettings": "Tier4",
+  "admin.users.session.getSettings": "Tier4",
+  "admin.users.session.invalidate": "Tier2",
+  "admin.users.session.list": "Tier2",
+  "admin.users.session.reset": "Tier2",
+  "admin.users.session.setSettings": "Tier4",
+  "admin.users.setAdmin": "Tier2",
+  "admin.users.setExpiration": "Tier2",
+  "admin.users.setOwner": "Tier2",
+  "admin.users.setRegular": "Tier2",
+  "api.test": "Tier4",
+  "apps.connections.open": "Tier1",
+  "apps.event.authorizations.list": "Tier4",
+  "apps.permissions.info": "Tier2",
+  "apps.permissions.request": "Tier2",
+  "apps.permissions.resources.list": "Tier2",
+  "apps.permissions.scopes.list": "Tier2",
+  "apps.permissions.users.list": "Tier2",
+  "apps.permissions.users.request": "Tier2",
+  "apps.uninstall": "Tier1",
+  "auth.revoke": "Tier3",
+  "auth.teams.list": "Tier2",
+  "auth.test": "SpecialTier_auth_test",
+  "bots.info": "Tier3",
+  "calls.add": "Tier2",
+  "calls.end": "Tier2",
+  "calls.info": "Tier2",
+  "calls.participants.add": "Tier2",
+  "calls.participants.remove": "Tier2",
+  "calls.update": "Tier2",
+  "channels.archive": "Tier2",
+  "channels.create": "Tier2",
+  "channels.history": "Tier2",
+  "channels.info": "Tier3",
+  "channels.invite": "Tier3",
+  "channels.join": "Tier3",
+  "channels.kick": "Tier3",
+  "channels.leave": "Tier3",
+  "channels.list": "Tier3",
+  "channels.mark": "Tier3",
+  "channels.rename": "Tier2",
+  "channels.replies": "Tier3",
+  "channels.setPurpose": "Tier2",
+  "channels.setTopic": "Tier2",
+  "channels.unarchive": "Tier2",
+  "chat.delete": "Tier3",
+  "chat.deleteScheduledMessage": "Tier3",
+  "chat.getPermalink": "SpecialTier_chat_getPermalink",
+  "chat.meMessage": "Tier3",
+  "chat.postEphemeral": "Tier4",
+  "chat.postMessage": "SpecialTier_chat_postMessage",
+  "chat.scheduleMessage": "Tier3",
+  "chat.scheduledMessages.list": "Tier3",
+  "chat.unfurl": "Tier3",
+  "chat.update": "Tier3",
+  "conversations.acceptSharedInvite": "Tier1",
+  "conversations.approveSharedInvite": "Tier1",
+  "conversations.archive": "Tier2",
+  "conversations.close": "Tier2",
+  "conversations.create": "Tier2",
+  "conversations.declineSharedInvite": "Tier1",
+  "conversations.history": "Tier3",
+  "conversations.info": "Tier3",
+  "conversations.invite": "Tier3",
+  "conversations.inviteShared": "Tier2",
+  "conversations.join": "Tier3",
+  "conversations.kick": "Tier3",
+  "conversations.leave": "Tier3",
+  "conversations.list": "Tier2",
+  "conversations.listConnectInvites": "Tier1",
+  "conversations.mark": "Tier3",
+  "conversations.members": "Tier4",
+  "conversations.open": "Tier3",
+  "conversations.rename": "Tier2",
+  "conversations.replies": "Tier3",
+  "conversations.setPurpose": "Tier2",
+  "conversations.setTopic": "Tier2",
+  "conversations.unarchive": "Tier2",
+  "dialog.open": "Tier4",
+  "dnd.endDnd": "Tier2",
+  "dnd.endSnooze": "Tier2",
+  "dnd.info": "Tier3",
+  "dnd.setSnooze": "Tier2",
+  "dnd.teamInfo": "Tier2",
+  "emoji.list": "Tier2",
+  "files.comments.delete": "Tier2",
+  "files.delete": "Tier3",
+  "files.info": "Tier4",
+  "files.list": "Tier3",
+  "files.remote.add": "Tier2",
+  "files.remote.info": "Tier2",
+  "files.remote.list": "Tier2",
+  "files.remote.remove": "Tier2",
+  "files.remote.share": "Tier2",
+  "files.remote.update": "Tier2",
+  "files.revokePublicURL": "Tier3",
+  "files.sharedPublicURL": "Tier3",
+  "files.upload": "Tier2",
+  "groups.archive": "Tier2",
+  "groups.create": "Tier2",
+  "groups.createChild": "Tier2",
+  "groups.history": "Tier2",
+  "groups.info": "Tier3",
+  "groups.invite": "Tier3",
+  "groups.kick": "Tier3",
+  "groups.leave": "Tier3",
+  "groups.list": "Tier3",
+  "groups.mark": "Tier3",
+  "groups.open": "Tier3",
+  "groups.rename": "Tier2",
+  "groups.replies": "Tier2",
+  "groups.setPurpose": "Tier2",
+  "groups.setTopic": "Tier2",
+  "groups.unarchive": "Tier2",
+  "im.close": "Tier2",
+  "im.history": "Tier4",
+  "im.list": "Tier2",
+  "im.mark": "Tier3",
+  "im.open": "Tier4",
+  "im.replies": "Tier2",
+  "migration.exchange": "Tier2",
+  "mpim.close": "Tier2",
+  "mpim.history": "Tier3",
+  "mpim.list": "Tier2",
+  "mpim.mark": "Tier3",
+  "mpim.open": "Tier3",
+  "mpim.replies": "Tier2",
+  "oauth.access": "Tier4",
+  "oauth.token": "Tier4",
+  "oauth.v2.access": "Tier4",
+  "oauth.v2.exchange": "Tier3",
+  "openid.connect.token": "Tier4",
+  "openid.connect.userInfo": "Tier3",
+  "pins.add": "Tier2",
+  "pins.list": "Tier2",
+  "pins.remove": "Tier2",
+  "reactions.add": "Tier3",
+  "reactions.get": "Tier3",
+  "reactions.list": "Tier2",
+  "reactions.remove": "Tier2",
+  "reminders.add": "Tier2",
+  "reminders.complete": "Tier2",
+  "reminders.delete": "Tier2",
+  "reminders.info": "Tier2",
+  "reminders.list": "Tier2",
+  "rtm.connect": "Tier1",
+  "rtm.start": "Tier1",
+  "search.all": "Tier2",
+  "search.files": "Tier2",
+  "search.messages": "Tier2",
+  "stars.add": "Tier2",
+  "stars.list": "Tier3",
+  "stars.remove": "Tier2",
+  "team.accessLogs": "Tier2",
+  "team.billableInfo": "Tier2",
+  "team.info": "Tier3",
+  "team.integrationLogs": "Tier2",
+  "team.profile.get": "Tier3",
+  "usergroups.create": "Tier2",
+  "usergroups.disable": "Tier2",
+  "usergroups.enable": "Tier2",
+  "usergroups.list": "Tier2",
+  "usergroups.update": "Tier2",
+  "usergroups.users.list": "Tier2",
+  "usergroups.users.update": "Tier2",
+  "users.conversations": "Tier2",
+  "users.deletePhoto": "Tier2",
+  "users.getPresence": "Tier3",
+  "users.identity": "Tier3",
+  "users.info": "Tier4",
+  "users.list": "Tier2",
+  "users.lookupByEmail": "Tier3",
+  "users.profile.get": "Tier4",
+  "users.profile.set": "Tier4",
+  "users.setActive": "Tier2",
+  "users.setPhoto": "Tier2",
+  "users.setPresence": "Tier2",
+  "views.open": "Tier4",
+  "views.publish": "Tier4",
+  "views.push": "Tier4",
+  "views.update": "Tier4",
+  "workflows.stepCompleted": "Tier2",
+  "workflows.stepFailed": "Tier2",
+  "workflows.updateStep": "Tier2"
+}

slack-api-client/src/main/java/com/slack/api/methods/MethodsRateLimits.java

@@ -2,8 +2,7 @@
 
 import lombok.extern.slf4j.Slf4j;
 
-import java.util.Arrays;
-import java.util.List;
+import java.util.*;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 
@@ -23,6 +22,14 @@ public static MethodsRateLimitTier lookupRateLimitTier(String methodName) {
         }
     }
 
+    public TreeMap<String, String> toMap() {
+        TreeMap<String, String> result = new TreeMap<>(); // using TreeMap to sort the keys
+        for (Map.Entry<String, MethodsRateLimitTier> e : methodNameToTier.entrySet()) {
+            result.put(e.getKey(), e.getValue().name());
+        }
+        return result;
+    }
+
     public static void setRateLimitTier(String methodName, MethodsRateLimitTier tier) {
         MethodsRateLimitTier currentTier = lookupRateLimitTier(methodName);
         if (currentTier == null) {

slack-api-client/src/test/java/test_locally/sample_json_generation/RateLimitsDumpTest.java

@@ -0,0 +1,37 @@
+package test_locally.sample_json_generation;
+
+import com.slack.api.SlackConfig;
+import com.slack.api.methods.MethodsRateLimits;
+import com.slack.api.util.json.GsonFactory;
+import org.junit.Test;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+public class RateLimitsDumpTest {
+    // This test class generates JSON data covering the rate limits for all public endpoints.
+
+    static String outputDirectory = "../metadata";
+
+    public void dump(String path, Object obj) throws IOException {
+        SlackConfig config = new SlackConfig();
+        config.setPrettyResponseLoggingEnabled(true);
+        String json = GsonFactory.createSnakeCase(config).toJson(obj);
+        Path filePath = new File(toFilePath(path)).toPath();
+        Files.createDirectories(filePath.getParent());
+        Files.write(filePath, json.getBytes(StandardCharsets.UTF_8));
+    }
+
+    private String toFilePath(String path) {
+        return outputDirectory + "/" + path;
+    }
+
+    @Test
+    public void webApi() throws Exception {
+        dump("web-api/rate_limit_tiers.json", new MethodsRateLimits().toMap());
+    }
+
+}