From 42809c307847e4229f89e5b214d2406ee0c73341 Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Fri, 5 Jul 2024 11:51:51 +0530 Subject: [PATCH 01/12] [Automated] Update the toml files --- ballerina/Dependencies.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ballerina/Dependencies.toml b/ballerina/Dependencies.toml index cf56ab6..6b2ff12 100644 --- a/ballerina/Dependencies.toml +++ b/ballerina/Dependencies.toml @@ -5,7 +5,7 @@ [ballerina] dependencies-toml-version = "2" -distribution-version = "2201.9.1" +distribution-version = "2201.9.0" [[package]] org = "ballerina" From 94bb6aa156851f8fc52a270535280bce3ce3b7c9 Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Wed, 10 Jul 2024 14:42:04 +0530 Subject: [PATCH 02/12] Sanitize Default error template title in spec --- docs/spec/openapi.json | 146 ++++++++++++++++++++--------------------- 1 file changed, 73 insertions(+), 73 deletions(-) diff --git a/docs/spec/openapi.json b/docs/spec/openapi.json index 0dae400..95b494a 100644 --- a/docs/spec/openapi.json +++ b/docs/spec/openapi.json @@ -116,7 +116,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -273,7 +273,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -433,7 +433,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -535,7 +535,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -692,7 +692,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -1410,7 +1410,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -2044,7 +2044,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -2145,7 +2145,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -2259,7 +2259,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -2687,7 +2687,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -2909,7 +2909,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -3018,7 +3018,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -3148,7 +3148,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -3252,7 +3252,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -3361,7 +3361,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -3444,7 +3444,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -3550,7 +3550,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -3656,7 +3656,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -3739,7 +3739,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -3845,7 +3845,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -3954,7 +3954,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -4067,7 +4067,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -4177,7 +4177,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -4286,7 +4286,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -4386,7 +4386,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -4495,7 +4495,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -4599,7 +4599,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -4703,7 +4703,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -4812,7 +4812,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -4916,7 +4916,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -5024,7 +5024,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -5132,7 +5132,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -5264,7 +5264,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -5368,7 +5368,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -5484,7 +5484,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -5617,7 +5617,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -5736,7 +5736,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -5840,7 +5840,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -5943,7 +5943,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -6050,7 +6050,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -6154,7 +6154,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -6263,7 +6263,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -6378,7 +6378,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -6482,7 +6482,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -6692,7 +6692,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -7532,7 +7532,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -7641,7 +7641,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -8341,7 +8341,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -8443,7 +8443,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -8533,7 +8533,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -8636,7 +8636,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -8740,7 +8740,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -8851,7 +8851,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -14652,7 +14652,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -14731,7 +14731,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -15605,7 +15605,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -15703,7 +15703,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -15825,7 +15825,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -15928,7 +15928,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -16034,7 +16034,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -16157,7 +16157,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -16927,7 +16927,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -17067,7 +17067,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -17200,7 +17200,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -19553,7 +19553,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -20462,7 +20462,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -24451,7 +24451,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -24594,7 +24594,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -24745,7 +24745,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -24906,7 +24906,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -25004,7 +25004,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -25103,7 +25103,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } @@ -25225,7 +25225,7 @@ "required": [ "ok" ], - "title": "Default error template", + "title": "DefaultErrorTemplate", "type": "object" } } From 23b6ccc696794ba342d48859709dd44178c61819 Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Thu, 11 Jul 2024 20:37:40 +0530 Subject: [PATCH 03/12] Add inline response schema title sanitation --- docs/spec/openapi.json | 17133 ++++++++++++++++++------------------ docs/spec/sanitations.bal | 105 + docs/spec/sanitations.md | 3 +- 3 files changed, 8673 insertions(+), 8568 deletions(-) create mode 100644 docs/spec/sanitations.bal diff --git a/docs/spec/openapi.json b/docs/spec/openapi.json index 95b494a..0c819fb 100644 --- a/docs/spec/openapi.json +++ b/docs/spec/openapi.json @@ -1,48 +1,12 @@ { - "openapi": "3.0.0", - "servers": [ - { - "url": "https://slack.com/api" - } - ], - "info": { - "contact": { - "name": "Slack developer relations", - "url": "https://api.slack.com/support" - }, - "description": "One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens blessed with related OAuth scopes.", - "title": "Slack Web API", - "version": "1.7.0", - "x-apisguru-categories": [ - "collaboration", - "messaging" - ], - "x-logo": { - "url": "https://api.apis.guru/v2/cache/logo/http_static.tumblr.com_wvuzcz9_LlKncfhmp_slack_logo_240.png" - }, - "x-origin": [ - { - "format": "openapi", - "url": "https://raw.githubusercontent.com/slackapi/slack-api-specs/master/web-api/slack_web_openapi_v2.json", - "version": "3.0" - } - ], - "x-providerName": "slack.com" - }, - "externalDocs": { - "description": "Learn more about the Slack Web API", - "url": "https://api.slack.com/web" - }, - "tags": [], "paths": { "/admin.apps.approve": { "post": { "description": "Approve an app for installation on a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.apps.approve" - }, - "operationId": "admin_apps_approve", + "tags": [ + "admin.apps", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -67,18 +31,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -86,28 +46,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -115,13 +74,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -131,56 +95,39 @@ ] } ], - "tags": [ - "admin.apps", - "admin" - ] + "operationId": "admin_apps_approve", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.apps.approve" + } } }, "/admin.apps.approved.list": { "get": { "description": "List approved apps for an org or workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.apps.approved.list" - }, - "operationId": "admin_apps_approved_list", - "parameters": [ - { - "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "team_id", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "enterprise_id", - "schema": { - "type": "string" - } - } + "tags": [ + "admin.apps.approved", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -232,39 +179,19 @@ } } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -272,13 +199,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -288,20 +220,11 @@ ] } ], - "tags": [ - "admin.apps.approved", - "admin" - ] - } - }, - "/admin.apps.requests.list": { - "get": { - "description": "List app requests for a team/workspace.", + "operationId": "admin_apps_approved_list", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.apps.requests.list" + "url": "https://api.slack.com/methods/admin.apps.approved.list" }, - "operationId": "admin_apps_requests_list", "parameters": [ { "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", @@ -325,12 +248,43 @@ "schema": { "type": "string" } + }, + { + "in": "query", + "name": "enterprise_id", + "schema": { + "type": "string" + } } + ] + } + }, + "/admin.apps.requests.list": { + "get": { + "description": "List app requests for a team/workspace.", + "tags": [ + "admin.apps.requests", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -390,28 +344,28 @@ } } } - }, + } + } + } + }, + "default": { + "description": "Typical error response", + "content": { + "application/json": { "schema": { + "title": "DefaultErrorTemplate", + "type": "object", + "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/defs_ok_false" } }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" - } - } - }, - "description": "Typical success response" - }, - "default": { - "content": { - "application/json": { + ] + }, "examples": { "response": { "value": { @@ -421,24 +375,9 @@ "provided": "read,client,admin,identify,post,apps" } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -448,20 +387,45 @@ ] } ], - "tags": [ - "admin.apps.requests", - "admin" + "operationId": "admin_apps_requests_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.apps.requests.list" + }, + "parameters": [ + { + "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + }, + { + "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "team_id", + "schema": { + "type": "string" + } + } ] } }, "/admin.apps.restrict": { "post": { "description": "Restrict an app for installation on a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.apps.restrict" - }, - "operationId": "admin_apps_restrict", + "tags": [ + "admin.apps", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -486,18 +450,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -505,28 +465,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -534,13 +493,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -550,56 +514,39 @@ ] } ], - "tags": [ - "admin.apps", - "admin" - ] + "operationId": "admin_apps_restrict", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.apps.restrict" + } } }, "/admin.apps.restricted.list": { "get": { "description": "List restricted apps for an org or workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.apps.restricted.list" - }, - "operationId": "admin_apps_restricted_list", - "parameters": [ - { - "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "team_id", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "enterprise_id", - "schema": { - "type": "string" - } - } + "tags": [ + "admin.apps.restricted", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -651,39 +598,19 @@ ] } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -691,13 +618,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -707,20 +639,52 @@ ] } ], - "tags": [ - "admin.apps.restricted", - "admin" + "operationId": "admin_apps_restricted_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.apps.restricted.list" + }, + "parameters": [ + { + "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + }, + { + "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "team_id", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "enterprise_id", + "schema": { + "type": "string" + } + } ] } }, "/admin.conversations.archive": { "post": { "description": "Archive a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.archive" - }, - "operationId": "admin_conversations_archive", + "tags": [ + "admin.conversations", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -742,18 +706,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsArchiveSchema", + "type": "object", "description": "Schema for successful response of admin.conversations.archive", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -761,28 +721,27 @@ }, "required": [ "ok" - ], - "title": "admin.conversations.archive schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsArchiveErrorSchema", + "type": "object", "description": "Schema for error response from admin.conversations.archive", + "additionalProperties": false, "properties": { "error": { "enum": [ @@ -804,13 +763,18 @@ "required": [ "ok", "error" - ], - "title": "admin.conversations.archive error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -820,20 +784,20 @@ ] } ], - "tags": [ - "admin.conversations", - "admin" - ] + "operationId": "admin_conversations_archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.archive" + } } }, "/admin.conversations.convertToPrivate": { "post": { "description": "Convert a public channel to a private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.convertToPrivate" - }, - "operationId": "admin_conversations_convertToPrivate", + "tags": [ + "admin.conversations", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -855,18 +819,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsConvertToPrivateSchema", + "type": "object", "description": "Schema for successful response of admin.conversations.convertToPrivate", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -874,28 +834,27 @@ }, "required": [ "ok" - ], - "title": "admin.conversations.convertToPrivate schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsConvertToPrivateErrorSchema", + "type": "object", "description": "Schema for error response from admin.conversations.convertToPrivate", + "additionalProperties": false, "properties": { "error": { "enum": [ @@ -918,13 +877,18 @@ "required": [ "ok", "error" - ], - "title": "admin.conversations.convertToPrivate error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -934,20 +898,20 @@ ] } ], - "tags": [ - "admin.conversations", - "admin" - ] + "operationId": "admin_conversations_convertToPrivate", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.convertToPrivate" + } } }, "/admin.conversations.create": { "post": { "description": "Create a public or private channel-based conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.create" - }, - "operationId": "admin_conversations_create", + "tags": [ + "admin.conversations", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -986,19 +950,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "channel_id": "C12345", - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsCreateSchema", + "type": "object", "description": "Schema for successful response of admin.conversations.create", + "additionalProperties": false, "properties": { "channel_id": { "$ref": "#/components/schemas/defs_channel_id" @@ -1009,28 +968,28 @@ }, "required": [ "ok" - ], - "title": "admin.conversations.create schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "channel_id": "C12345", + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsCreateErrorSchema", + "type": "object", "description": "Schema for error response from admin.conversations.create", + "additionalProperties": false, "properties": { "error": { "enum": [ @@ -1052,13 +1011,18 @@ "required": [ "ok", "error" - ], - "title": "admin.conversations.create error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -1068,20 +1032,20 @@ ] } ], - "tags": [ - "admin.conversations", - "admin" - ] + "operationId": "admin_conversations_create", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.create" + } } }, "/admin.conversations.delete": { "post": { "description": "Delete a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.delete" - }, - "operationId": "admin_conversations_delete", + "tags": [ + "admin.conversations", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1103,18 +1067,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsDeleteSchema", + "type": "object", "description": "Schema for successful response of admin.conversations.delete", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -1122,28 +1082,27 @@ }, "required": [ "ok" - ], - "title": "admin.conversations.delete schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsDeleteErrorSchema", + "type": "object", "description": "Schema for error response from admin.conversations.delete", + "additionalProperties": false, "properties": { "error": { "enum": [ @@ -1165,13 +1124,18 @@ "required": [ "ok", "error" - ], - "title": "admin.conversations.delete error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -1181,20 +1145,20 @@ ] } ], - "tags": [ - "admin.conversations", - "admin" - ] + "operationId": "admin_conversations_delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.delete" + } } }, "/admin.conversations.disconnectShared": { "post": { "description": "Disconnect a connected channel from one or more workspaces.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.disconnectShared" - }, - "operationId": "admin_conversations_disconnectShared", + "tags": [ + "admin.conversations", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1220,18 +1184,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsRenameSchema", + "type": "object", "description": "Schema for successful response of admin.conversations.disconnectShared", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -1239,28 +1199,27 @@ }, "required": [ "ok" - ], - "title": "admin.conversations.rename schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsDisconnectSharedErrorSchema", + "type": "object", "description": "Schema for error response from admin.conversations.disconnectShared", + "additionalProperties": false, "properties": { "error": { "enum": [ @@ -1287,13 +1246,18 @@ "required": [ "ok", "error" - ], - "title": "admin.conversations.disconnectShared error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -1303,58 +1267,39 @@ ] } ], - "tags": [ - "admin.conversations", - "admin" - ] + "operationId": "admin_conversations_disconnectShared", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.disconnectShared" + } } }, "/admin.conversations.ekm.listOriginalConnectedChannelInfo": { "get": { "description": "List all disconnected channels—i.e., channels that were once connected to other workspaces and then disconnected—and the corresponding original channel IDs for key revocation with EKM.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo" - }, - "operationId": "admin_conversations_ekm_listOriginalConnectedChannelInfo", - "parameters": [ - { - "description": "A comma-separated list of channels to filter to.", - "in": "query", - "name": "channel_ids", - "schema": { - "type": "string" - } - }, - { - "description": "A comma-separated list of the workspaces to which the channels you would like returned belong.", - "in": "query", - "name": "team_ids", - "schema": { - "type": "string" - } - }, - { - "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - } + "tags": [ + "admin.conversations.ekm", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -1369,39 +1314,19 @@ "ok": true } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -1409,13 +1334,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -1425,45 +1355,64 @@ ] } ], - "tags": [ - "admin.conversations.ekm", - "admin" - ] - } - }, - "/admin.conversations.getConversationPrefs": { - "get": { - "description": "Get conversation preferences for a public or private channel.", + "operationId": "admin_conversations_ekm_listOriginalConnectedChannelInfo", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.getConversationPrefs" + "url": "https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo" }, - "operationId": "admin_conversations_getConversationPrefs", "parameters": [ { - "description": "The channel to get preferences for.", + "description": "A comma-separated list of channels to filter to.", "in": "query", - "name": "channel_id", - "required": true, + "name": "channel_ids", + "schema": { + "type": "string" + } + }, + { + "description": "A comma-separated list of the workspaces to which the channels you would like returned belong.", + "in": "query", + "name": "team_ids", + "schema": { + "type": "string" + } + }, + { + "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + }, + { + "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", + "in": "query", + "name": "cursor", "schema": { "type": "string" } } + ] + } + }, + "/admin.conversations.getConversationPrefs": { + "get": { + "description": "Get conversation preferences for a public or private channel.", + "tags": [ + "admin.conversations", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsGetConversationPrefsSchema", + "type": "object", "description": "Schema for successful response of admin.conversations.getConversationPrefs", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -1510,28 +1459,27 @@ }, "required": [ "ok" - ], - "title": "admin.conversations.getConversationPrefs schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsUnarchiveErrorSchema", + "type": "object", "description": "Schema for error response from admin.conversations.getConversationPrefs", + "additionalProperties": false, "properties": { "error": { "enum": [ @@ -1553,13 +1501,18 @@ "required": [ "ok", "error" - ], - "title": "admin.conversations.unarchive error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -1569,65 +1522,41 @@ ] } ], - "tags": [ - "admin.conversations", - "admin" - ] - } - }, - "/admin.conversations.getTeams": { - "get": { - "description": "Get all the workspaces a given public or private channel is connected to within this Enterprise org.", + "operationId": "admin_conversations_getConversationPrefs", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.getTeams" + "url": "https://api.slack.com/methods/admin.conversations.getConversationPrefs" }, - "operationId": "admin_conversations_getTeams", "parameters": [ { - "description": "The channel to determine connected workspaces within the organization for.", + "description": "The channel to get preferences for.", "in": "query", "name": "channel_id", "required": true, "schema": { "type": "string" } - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - }, - { - "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } } + ] + } + }, + "/admin.conversations.getTeams": { + "get": { + "description": "Get all the workspaces a given public or private channel is connected to within this Enterprise org.", + "tags": [ + "admin.conversations", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true, - "teams": [ - "T1234", - "T5678" - ] - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsGetTeamsSchema", + "type": "object", "description": "Schema for successful response of admin.conversations.getTeams", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -1654,28 +1583,31 @@ "required": [ "ok", "team_ids" - ], - "title": "admin.conversations.getTeams schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true, + "teams": [ + "T1234", + "T5678" + ] + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsGetTeamsErrorSchema", + "type": "object", "description": "Schema for error response from admin.conversations.getTeams", + "additionalProperties": false, "properties": { "error": { "enum": [ @@ -1697,13 +1629,18 @@ "required": [ "ok", "error" - ], - "title": "admin.conversations.getTeams error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -1713,20 +1650,47 @@ ] } ], - "tags": [ - "admin.conversations", - "admin" + "operationId": "admin_conversations_getTeams", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.getTeams" + }, + "parameters": [ + { + "description": "The channel to determine connected workspaces within the organization for.", + "in": "query", + "name": "channel_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + }, + { + "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + } ] } }, "/admin.conversations.invite": { "post": { "description": "Invite a user to a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.invite" - }, - "operationId": "admin_conversations_invite", + "tags": [ + "admin.conversations", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1753,18 +1717,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsInviteSchema", + "type": "object", "description": "Schema for successful response of admin.conversations.invite", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -1772,28 +1732,27 @@ }, "required": [ "ok" - ], - "title": "admin.conversations.invite schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "AdminConversationsInviteErrorSchema", + "type": "object", "description": "Schema for error response from admin.conversations.invite", + "additionalProperties": true, "properties": { "error": { "enum": [ @@ -1814,13 +1773,18 @@ "required": [ "ok", "error" - ], - "title": "admin.conversations.invite error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -1830,20 +1794,20 @@ ] } ], - "tags": [ - "admin.conversations", - "admin" - ] + "operationId": "admin_conversations_invite", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.invite" + } } }, "/admin.conversations.rename": { "post": { "description": "Rename a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.rename" - }, - "operationId": "admin_conversations_rename", + "tags": [ + "admin.conversations", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1869,18 +1833,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsRenameSchema", + "type": "object", "description": "Schema for successful response of admin.conversations.rename", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -1888,28 +1848,27 @@ }, "required": [ "ok" - ], - "title": "admin.conversations.rename schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsUnarchiveErrorSchema", + "type": "object", "description": "Schema for error response from admin.conversations.rename", + "additionalProperties": false, "properties": { "error": { "enum": [ @@ -1930,13 +1889,18 @@ "required": [ "ok", "error" - ], - "title": "admin.conversations.unarchive error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -1946,20 +1910,20 @@ ] } ], - "tags": [ - "admin.conversations", - "admin" - ] + "operationId": "admin_conversations_rename", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.rename" + } } }, "/admin.conversations.restrictAccess.addGroup": { "post": { "description": "Add an allowlist of IDP groups for accessing a channel", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup" - }, - "operationId": "admin_conversations_restrictAccess_addGroup", + "tags": [ + "admin.conversations.restrictAccess", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -1995,18 +1959,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -2014,28 +1974,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -2043,71 +2002,51 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" - } - } - }, - "description": "Typical error response" - } - }, - "security": [ - { + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } + } + } + } + } + }, + "security": [ + { "slackAuth": [ "admin.conversations:write" ] } ], - "tags": [ - "admin.conversations.restrictAccess", - "admin" - ] + "operationId": "admin_conversations_restrictAccess_addGroup", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup" + } } }, "/admin.conversations.restrictAccess.listGroups": { "get": { "description": "List all IDP Groups linked to a channel", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups" - }, - "operationId": "admin_conversations_restrictAccess_listGroups", - "parameters": [ - { - "in": "query", - "name": "channel_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.", - "in": "query", - "name": "team_id", - "schema": { - "type": "string" - } - } + "tags": [ + "admin.conversations.restrictAccess", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "group_ids": [ - "YOUR_GROUP_ID" - ], - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -2115,28 +2054,30 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "group_ids": [ + "YOUR_GROUP_ID" + ], + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -2144,13 +2085,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -2160,20 +2106,38 @@ ] } ], - "tags": [ - "admin.conversations.restrictAccess", - "admin" + "operationId": "admin_conversations_restrictAccess_listGroups", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups" + }, + "parameters": [ + { + "in": "query", + "name": "channel_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.", + "in": "query", + "name": "team_id", + "schema": { + "type": "string" + } + } ] } }, "/admin.conversations.restrictAccess.removeGroup": { "post": { "description": "Remove a linked IDP group linked from a private channel", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup" - }, - "operationId": "admin_conversations_restrictAccess_removeGroup", + "tags": [ + "admin.conversations.restrictAccess", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2210,18 +2174,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -2229,28 +2189,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -2258,13 +2217,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -2274,82 +2238,46 @@ ] } ], - "tags": [ - "admin.conversations.restrictAccess", - "admin" - ] + "operationId": "admin_conversations_restrictAccess_removeGroup", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup" + } } }, "/admin.conversations.search": { "get": { "description": "Search for public or private channels in an Enterprise organization.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.search" - }, - "operationId": "admin_conversations_search", - "parameters": [ - { - "description": "Comma separated string of team IDs, signifying the workspaces to search through.", - "in": "query", - "name": "team_ids", - "schema": { - "type": "string" - } - }, - { - "description": "Name of the the channel to query by.", - "in": "query", - "name": "query", - "schema": { - "type": "string" - } - }, - { - "description": "Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - }, - { - "description": "The type of channel to include or exclude in the search. For example `private` will search private channels, while `private_exclude` will exclude them. For a full list of types, check the [Types section](#types).", - "in": "query", - "name": "search_channel_types", - "schema": { - "type": "string" - } - }, - { - "description": "Possible values are `relevant` (search ranking based on what we think is closest), `name` (alphabetical), `member_count` (number of users in the channel), and `created` (date channel was created). You can optionally pair this with the `sort_dir` arg to change how it is sorted ", - "in": "query", - "name": "sort", - "schema": { - "type": "string" - } - }, - { - "description": "Sort direction. Possible values are `asc` for ascending order like (1, 2, 3) or (a, b, c), and `desc` for descending order like (3, 2, 1) or (c, b, a)", - "in": "query", - "name": "sort_dir", - "schema": { - "type": "string" - } - } + "tags": [ + "admin.conversations", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "AdminConversationsSearchSchema", + "type": "object", + "description": "Schema for successful response of admin.conversations.search", + "additionalProperties": false, + "properties": { + "channels": { + "items": { + "$ref": "#/components/schemas/objs_channel" + }, + "type": "array" + }, + "next_cursor": { + "type": "string" + } + }, + "required": [ + "channels", + "next_cursor" + ] + }, "examples": { "response": { "value": { @@ -2394,46 +2322,19 @@ } } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of admin.conversations.search", - "properties": { - "channels": { - "items": { - "$ref": "#/components/schemas/objs_channel" - }, - "type": "array" - }, - "next_cursor": { - "type": "string" - } - }, - "required": [ - "channels", - "next_cursor" - ], - "title": "admin.conversations.search schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "not_an_enterprise", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsSearchErrorSchema", + "type": "object", "description": "Schema for error response from admin.conversations.search", + "additionalProperties": false, "properties": { "error": { "enum": [ @@ -2457,13 +2358,18 @@ "required": [ "ok", "error" - ], - "title": "admin.conversations.search error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "not_an_enterprise", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -2473,20 +2379,78 @@ ] } ], - "tags": [ - "admin.conversations", - "admin" + "operationId": "admin_conversations_search", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.search" + }, + "parameters": [ + { + "description": "Comma separated string of team IDs, signifying the workspaces to search through.", + "in": "query", + "name": "team_ids", + "schema": { + "type": "string" + } + }, + { + "description": "Name of the the channel to query by.", + "in": "query", + "name": "query", + "schema": { + "type": "string" + } + }, + { + "description": "Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + }, + { + "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + }, + { + "description": "The type of channel to include or exclude in the search. For example `private` will search private channels, while `private_exclude` will exclude them. For a full list of types, check the [Types section](#types).", + "in": "query", + "name": "search_channel_types", + "schema": { + "type": "string" + } + }, + { + "description": "Possible values are `relevant` (search ranking based on what we think is closest), `name` (alphabetical), `member_count` (number of users in the channel), and `created` (date channel was created). You can optionally pair this with the `sort_dir` arg to change how it is sorted ", + "in": "query", + "name": "sort", + "schema": { + "type": "string" + } + }, + { + "description": "Sort direction. Possible values are `asc` for ascending order like (1, 2, 3) or (a, b, c), and `desc` for descending order like (3, 2, 1) or (c, b, a)", + "in": "query", + "name": "sort_dir", + "schema": { + "type": "string" + } + } ] } }, "/admin.conversations.setConversationPrefs": { "post": { "description": "Set the posting permissions for a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.setConversationPrefs" - }, - "operationId": "admin_conversations_setConversationPrefs", + "tags": [ + "admin.conversations", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2513,18 +2477,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsSetConversationPrefsSchema", + "type": "object", "description": "Schema for successful response of admin.conversations.setConversationPrefs", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -2532,28 +2492,27 @@ }, "required": [ "ok" - ], - "title": "admin.conversations.setConversationPrefs schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsSetConversationPrefsErrorSchema", + "type": "object", "description": "Schema for error response from admin.conversations.setConversationPrefs", + "additionalProperties": false, "properties": { "error": { "enum": [ @@ -2575,13 +2534,18 @@ "required": [ "ok", "error" - ], - "title": "admin.conversations.setConversationPrefs error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -2591,20 +2555,20 @@ ] } ], - "tags": [ - "admin.conversations", - "admin" - ] + "operationId": "admin_conversations_setConversationPrefs", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.setConversationPrefs" + } } }, "/admin.conversations.setTeams": { "post": { "description": "Set the workspaces in an Enterprise grid org that connect to a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.setTeams" - }, - "operationId": "admin_conversations_setTeams", + "tags": [ + "admin.conversations", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2638,18 +2602,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -2657,28 +2617,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -2686,13 +2645,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -2702,20 +2666,20 @@ ] } ], - "tags": [ - "admin.conversations", - "admin" - ] + "operationId": "admin_conversations_setTeams", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.setTeams" + } } }, "/admin.conversations.unarchive": { "post": { "description": "Unarchive a public or private channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.conversations.unarchive" - }, - "operationId": "admin_conversations_unarchive", + "tags": [ + "admin.conversations", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2737,18 +2701,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsUnarchiveSchema", + "type": "object", "description": "Schema for successful response of admin.conversations.unarchive", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -2756,28 +2716,27 @@ }, "required": [ "ok" - ], - "title": "admin.conversations.unarchive schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AdminConversationsUnarchiveErrorSchema", + "type": "object", "description": "Schema for error response from admin.conversations.unarchive", + "additionalProperties": false, "properties": { "error": { "enum": [ @@ -2799,13 +2758,18 @@ "required": [ "ok", "error" - ], - "title": "admin.conversations.unarchive error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -2815,20 +2779,20 @@ ] } ], - "tags": [ - "admin.conversations", - "admin" - ] + "operationId": "admin_conversations_unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.conversations.unarchive" + } } }, "/admin.emoji.add": { "post": { "description": "Add an emoji.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.emoji.add" - }, - "operationId": "admin_emoji_add", + "tags": [ + "admin.emoji", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2860,18 +2824,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -2879,28 +2839,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -2908,13 +2867,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -2924,20 +2888,20 @@ ] } ], - "tags": [ - "admin.emoji", - "admin" - ] + "operationId": "admin_emoji_add", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.emoji.add" + } } }, "/admin.emoji.addAlias": { "post": { "description": "Add an emoji alias.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.emoji.addAlias" - }, - "operationId": "admin_emoji_addAlias", + "tags": [ + "admin.emoji", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -2969,18 +2933,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -2988,28 +2948,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -3017,58 +2976,60 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:write" - ] + } } - ], - "tags": [ - "admin.emoji", - "admin" - ] - } - }, - "/admin.emoji.list": { - "get": { - "description": "List emoji for an Enterprise Grid organization.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.emoji.list" }, - "operationId": "admin_emoji_list", - "parameters": [ - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - }, - { - "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } + "security": [ + { + "slackAuth": [ + "admin.teams:write" + ] } ], + "operationId": "admin_emoji_addAlias", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.emoji.addAlias" + } + } + }, + "/admin.emoji.list": { + "get": { + "description": "List emoji for an Enterprise Grid organization.", + "tags": [ + "admin.emoji", + "admin" + ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -3107,39 +3068,19 @@ "ok": true } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -3147,13 +3088,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -3163,20 +3109,38 @@ ] } ], - "tags": [ - "admin.emoji", - "admin" + "operationId": "admin_emoji_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.emoji.list" + }, + "parameters": [ + { + "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + }, + { + "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + } ] } }, "/admin.emoji.remove": { "post": { "description": "Remove an emoji across an Enterprise Grid organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.emoji.remove" - }, - "operationId": "admin_emoji_remove", + "tags": [ + "admin.emoji", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3203,18 +3167,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -3222,28 +3182,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -3251,13 +3210,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -3267,20 +3231,20 @@ ] } ], - "tags": [ - "admin.emoji", - "admin" - ] + "operationId": "admin_emoji_remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.emoji.remove" + } } }, "/admin.emoji.rename": { "post": { "description": "Rename an emoji.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.emoji.rename" - }, - "operationId": "admin_emoji_rename", + "tags": [ + "admin.emoji", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -3312,18 +3276,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -3331,17 +3291,36 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { + "schema": { + "title": "DefaultErrorTemplate", + "type": "object", + "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_false" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -3349,10 +3328,73 @@ "ok": false } } + } + } + } + } + }, + "security": [ + { + "slackAuth": [ + "admin.teams:write" + ] + } + ], + "operationId": "admin_emoji_rename", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.emoji.rename" + } + } + }, + "/admin.inviteRequests.approve": { + "post": { + "description": "Approve a workspace invite request.", + "tags": [ + "admin.inviteRequests", + "admin" + ], + "requestBody": { + "$ref": "#/components/requestBodies/admin_inviteRequests_approve" + }, + "responses": { + "200": { + "description": "Typical success response", + "content": { + "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] }, + "examples": { + "response": { + "value": { + "ok": true + } + } + } + } + } + }, + "default": { + "description": "Typical error response", + "content": { + "application/json": { "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -3360,53 +3402,51 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ { "slackAuth": [ - "admin.teams:write" + "admin.invites:write" ] } ], - "tags": [ - "admin.emoji", - "admin" - ] - } - }, - "/admin.inviteRequests.approve": { - "post": { - "description": "Approve a workspace invite request.", + "operationId": "admin_inviteRequests_approve", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.inviteRequests.approve" - }, - "operationId": "admin_inviteRequests_approve", - "requestBody": { - "$ref": "#/components/requestBodies/admin_inviteRequests_approve" - }, + } + } + }, + "/admin.inviteRequests.approved.list": { + "get": { + "description": "List all approved workspace invite requests.", + "tags": [ + "admin.inviteRequests.approved", + "admin" + ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -3414,28 +3454,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -3443,36 +3482,32 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ { "slackAuth": [ - "admin.invites:write" + "admin.invites:read" ] } ], - "tags": [ - "admin.inviteRequests", - "admin" - ] - } - }, - "/admin.inviteRequests.approved.list": { - "get": { - "description": "List all approved workspace invite requests.", + "operationId": "admin_inviteRequests_approved_list", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.inviteRequests.approved.list" }, - "operationId": "admin_inviteRequests_approved_list", "parameters": [ { "description": "ID for the workspace where the invite requests were made.", @@ -3498,21 +3533,26 @@ "type": "integer" } } + ] + } + }, + "/admin.inviteRequests.denied.list": { + "get": { + "description": "List all denied workspace invite requests.", + "tags": [ + "admin.inviteRequests.denied", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -3520,28 +3560,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -3549,13 +3588,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -3565,20 +3609,11 @@ ] } ], - "tags": [ - "admin.inviteRequests.approved", - "admin" - ] - } - }, - "/admin.inviteRequests.denied.list": { - "get": { - "description": "List all denied workspace invite requests.", + "operationId": "admin_inviteRequests_denied_list", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.inviteRequests.denied.list" }, - "operationId": "admin_inviteRequests_denied_list", "parameters": [ { "description": "ID for the workspace where the invite requests were made.", @@ -3604,21 +3639,29 @@ "type": "integer" } } + ] + } + }, + "/admin.inviteRequests.deny": { + "post": { + "description": "Deny a workspace invite request.", + "tags": [ + "admin.inviteRequests", + "admin" ], + "requestBody": { + "$ref": "#/components/requestBodies/admin_inviteRequests_approve" + }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -3626,28 +3669,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -3655,53 +3697,51 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ { "slackAuth": [ - "admin.invites:read" + "admin.invites:write" ] } ], - "tags": [ - "admin.inviteRequests.denied", - "admin" - ] - } - }, - "/admin.inviteRequests.deny": { - "post": { - "description": "Deny a workspace invite request.", + "operationId": "admin_inviteRequests_deny", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.inviteRequests.deny" - }, - "operationId": "admin_inviteRequests_deny", - "requestBody": { - "$ref": "#/components/requestBodies/admin_inviteRequests_approve" - }, + } + } + }, + "/admin.inviteRequests.list": { + "get": { + "description": "List all pending workspace invite requests.", + "tags": [ + "admin.inviteRequests", + "admin" + ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -3709,28 +3749,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -3738,36 +3777,32 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ { "slackAuth": [ - "admin.invites:write" + "admin.invites:read" ] } ], - "tags": [ - "admin.inviteRequests", - "admin" - ] - } - }, - "/admin.inviteRequests.list": { - "get": { - "description": "List all pending workspace invite requests.", + "operationId": "admin_inviteRequests_list", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.inviteRequests.list" }, - "operationId": "admin_inviteRequests_list", "parameters": [ { "description": "ID for the workspace where the invite requests were made.", @@ -3793,21 +3828,26 @@ "type": "integer" } } + ] + } + }, + "/admin.teams.admins.list": { + "get": { + "description": "List all of the admins on a given workspace.", + "tags": [ + "admin.teams.admins", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -3815,28 +3855,30 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "admin_ids": [ + "U1234" + ], + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -3844,36 +3886,32 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ { "slackAuth": [ - "admin.invites:read" + "admin.teams:read" ] } ], - "tags": [ - "admin.inviteRequests", - "admin" - ] - } - }, - "/admin.teams.admins.list": { - "get": { - "description": "List all of the admins on a given workspace.", + "operationId": "admin_teams_admins_list", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/admin.teams.admins.list" }, - "operationId": "admin_teams_admins_list", "parameters": [ { "description": "The maximum number of items to return.", @@ -3899,90 +3937,16 @@ "type": "string" } } - ], - "responses": { - "200": { - "content": { - "application/json": { - "examples": { - "response": { - "value": { - "admin_ids": [ - "U1234" - ], - "ok": true - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" - } - } - }, - "description": "Typical success response" - }, - "default": { - "content": { - "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" - } - } - }, - "description": "Typical error response" - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:read" - ] - } - ], - "tags": [ - "admin.teams.admins", - "admin" ] } }, "/admin.teams.create": { "post": { "description": "Create an Enterprise team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.create" - }, - "operationId": "admin_teams_create", + "tags": [ + "admin.teams", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4017,19 +3981,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true, - "team": "T12345" - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -4037,28 +3996,28 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true, + "team": "T12345" + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -4066,13 +4025,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -4082,42 +4046,39 @@ ] } ], - "tags": [ - "admin.teams", - "admin" - ] + "operationId": "admin_teams_create", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.teams.create" + } } }, "/admin.teams.list": { "get": { "description": "List all teams on an Enterprise organization", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.list" - }, - "operationId": "admin_teams_list", - "parameters": [ - { - "description": "The maximum number of items to return. Must be between 1 - 100 both inclusive.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - } + "tags": [ + "admin.teams", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -4136,39 +4097,19 @@ ] } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -4176,13 +4117,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -4192,31 +4138,14 @@ ] } ], - "tags": [ - "admin.teams", - "admin" - ] - } - }, - "/admin.teams.owners.list": { - "get": { - "description": "List all of the owners on a given workspace.", + "operationId": "admin_teams_list", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.owners.list" + "url": "https://api.slack.com/methods/admin.teams.list" }, - "operationId": "admin_teams_owners_list", "parameters": [ { - "in": "query", - "name": "team_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "description": "The maximum number of items to return. Must be between 1 - 100 both inclusive.", "in": "query", "name": "limit", "schema": { @@ -4231,24 +4160,26 @@ "type": "string" } } + ] + } + }, + "/admin.teams.owners.list": { + "get": { + "description": "List all of the owners on a given workspace.", + "tags": [ + "admin.teams.owners", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true, - "owner_ids": [ - "U1234" - ] - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -4256,28 +4187,30 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true, + "owner_ids": [ + "U1234" + ] + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -4285,13 +4218,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -4301,20 +4239,11 @@ ] } ], - "tags": [ - "admin.teams.owners", - "admin" - ] - } - }, - "/admin.teams.settings.info": { - "get": { - "description": "Fetch information about settings in a workspace", + "operationId": "admin_teams_owners_list", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.settings.info" + "url": "https://api.slack.com/methods/admin.teams.owners.list" }, - "operationId": "admin_teams_settings_info", "parameters": [ { "in": "query", @@ -4323,12 +4252,52 @@ "schema": { "type": "string" } + }, + { + "description": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + }, + { + "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } } + ] + } + }, + "/admin.teams.settings.info": { + "get": { + "description": "Fetch information about settings in a workspace", + "tags": [ + "admin.teams.settings", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -4345,39 +4314,19 @@ } } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -4385,13 +4334,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -4401,20 +4355,30 @@ ] } ], - "tags": [ - "admin.teams.settings", - "admin" + "operationId": "admin_teams_settings_info", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.teams.settings.info" + }, + "parameters": [ + { + "in": "query", + "name": "team_id", + "required": true, + "schema": { + "type": "string" + } + } ] } }, "/admin.teams.settings.setDefaultChannels": { "post": { "description": "Set the default channels of a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.settings.setDefaultChannels" - }, - "operationId": "admin_teams_settings_setDefaultChannels", + "tags": [ + "admin.teams.settings", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4446,18 +4410,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -4465,28 +4425,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -4494,13 +4453,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -4510,20 +4474,20 @@ ] } ], - "tags": [ - "admin.teams.settings", - "admin" - ] + "operationId": "admin_teams_settings_setDefaultChannels", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.teams.settings.setDefaultChannels" + } } }, "/admin.teams.settings.setDescription": { "post": { "description": "Set the description of a given workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.settings.setDescription" - }, - "operationId": "admin_teams_settings_setDescription", + "tags": [ + "admin.teams.settings", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4550,18 +4514,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -4569,28 +4529,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -4598,13 +4557,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -4614,20 +4578,20 @@ ] } ], - "tags": [ - "admin.teams.settings", - "admin" - ] + "operationId": "admin_teams_settings_setDescription", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.teams.settings.setDescription" + } } }, "/admin.teams.settings.setDiscoverability": { "post": { "description": "An API method that allows admins to set the discoverability of a given workspace", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.settings.setDiscoverability" - }, - "operationId": "admin_teams_settings_setDiscoverability", + "tags": [ + "admin.teams.settings", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4654,18 +4618,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -4673,28 +4633,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -4702,13 +4661,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -4718,20 +4682,20 @@ ] } ], - "tags": [ - "admin.teams.settings", - "admin" - ] + "operationId": "admin_teams_settings_setDiscoverability", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.teams.settings.setDiscoverability" + } } }, "/admin.teams.settings.setIcon": { "post": { "description": "Sets the icon of a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.settings.setIcon" - }, - "operationId": "admin_teams_settings_setIcon", + "tags": [ + "admin.teams.settings", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4763,18 +4727,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -4782,28 +4742,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" - } - } - }, - "description": "Typical success response" - }, - "default": { - "content": { - "application/json": { + ] + }, "examples": { "response": { "value": { - "error": "invalid_auth", - "ok": false + "ok": true } } - }, + } + } + } + }, + "default": { + "description": "Typical error response", + "content": { + "application/json": { "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -4811,13 +4770,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -4827,20 +4791,20 @@ ] } ], - "tags": [ - "admin.teams.settings", - "admin" - ] + "operationId": "admin_teams_settings_setIcon", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.teams.settings.setIcon" + } } }, "/admin.teams.settings.setName": { "post": { "description": "Set the name of a given workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.teams.settings.setName" - }, - "operationId": "admin_teams_settings_setName", + "tags": [ + "admin.teams.settings", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4867,18 +4831,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -4886,28 +4846,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -4915,13 +4874,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -4931,20 +4895,20 @@ ] } ], - "tags": [ - "admin.teams.settings", - "admin" - ] + "operationId": "admin_teams_settings_setName", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.teams.settings.setName" + } } }, "/admin.usergroups.addChannels": { "post": { "description": "Add one or more default channels to an IDP group.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.usergroups.addChannels" - }, - "operationId": "admin_usergroups_addChannels", + "tags": [ + "admin.usergroups", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -4975,18 +4939,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -4994,28 +4954,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response if the token provided is not associated with an Org Admin or Owner", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "not_an_admin", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -5023,13 +4982,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "not_an_admin", + "ok": false + } + } } } - }, - "description": "Typical error response if the token provided is not associated with an Org Admin or Owner" + } } }, "security": [ @@ -5039,20 +5003,20 @@ ] } ], - "tags": [ - "admin.usergroups", - "admin" - ] + "operationId": "admin_usergroups_addChannels", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.usergroups.addChannels" + } } }, "/admin.usergroups.addTeams": { "post": { "description": "Associate one or more default workspaces with an organization-wide IDP group.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.usergroups.addTeams" - }, - "operationId": "admin_usergroups_addTeams", + "tags": [ + "admin.usergroups", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5083,18 +5047,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -5102,28 +5062,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -5131,67 +5090,60 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" - } - }, - "security": [ - { - "slackAuth": [ - "admin.teams:write" - ] - } - ], - "tags": [ - "admin.usergroups", - "admin" - ] - } - }, - "/admin.usergroups.listChannels": { - "get": { - "description": "List the channels linked to an org-level IDP group (user group).", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.usergroups.listChannels" - }, - "operationId": "admin_usergroups_listChannels", - "parameters": [ - { - "description": "ID of the IDP group to list default channels for.", - "in": "query", - "name": "usergroup_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "ID of the the workspace.", - "in": "query", - "name": "team_id", - "schema": { - "type": "string" - } - }, - { - "description": "Flag to include or exclude the count of members per channel.", - "in": "query", - "name": "include_num_members", - "schema": { - "type": "boolean" } } + }, + "security": [ + { + "slackAuth": [ + "admin.teams:write" + ] + } + ], + "operationId": "admin_usergroups_addTeams", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.usergroups.addTeams" + } + } + }, + "/admin.usergroups.listChannels": { + "get": { + "description": "List the channels linked to an org-level IDP group (user group).", + "tags": [ + "admin.usergroups", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -5223,39 +5175,19 @@ "ok": true } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response if the token provided is not associated with an Org Admin or Owner", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "not_an_admin", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -5263,13 +5195,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "not_an_admin", + "ok": false + } + } } } - }, - "description": "Typical error response if the token provided is not associated with an Org Admin or Owner" + } } }, "security": [ @@ -5279,20 +5216,47 @@ ] } ], - "tags": [ - "admin.usergroups", - "admin" + "operationId": "admin_usergroups_listChannels", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.usergroups.listChannels" + }, + "parameters": [ + { + "description": "ID of the IDP group to list default channels for.", + "in": "query", + "name": "usergroup_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "ID of the the workspace.", + "in": "query", + "name": "team_id", + "schema": { + "type": "string" + } + }, + { + "description": "Flag to include or exclude the count of members per channel.", + "in": "query", + "name": "include_num_members", + "schema": { + "type": "boolean" + } + } ] } }, "/admin.usergroups.removeChannels": { "post": { "description": "Remove one or more default channels from an org-level IDP group (user group).", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.usergroups.removeChannels" - }, - "operationId": "admin_usergroups_removeChannels", + "tags": [ + "admin.usergroups", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5319,18 +5283,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -5338,28 +5298,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response if the token provided is not associated with an Org Admin or Owner", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "not_an_admin", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -5367,13 +5326,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "not_an_admin", + "ok": false + } + } } } - }, - "description": "Typical error response if the token provided is not associated with an Org Admin or Owner" + } } }, "security": [ @@ -5383,20 +5347,20 @@ ] } ], - "tags": [ - "admin.usergroups", - "admin" - ] + "operationId": "admin_usergroups_removeChannels", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.usergroups.removeChannels" + } } }, "/admin.users.assign": { "post": { "description": "Add an Enterprise user to a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.assign" - }, - "operationId": "admin_users_assign", + "tags": [ + "admin.users", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5435,18 +5399,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -5454,28 +5414,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -5483,13 +5442,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -5499,20 +5463,20 @@ ] } ], - "tags": [ - "admin.users", - "admin" - ] + "operationId": "admin_users_assign", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.users.assign" + } } }, "/admin.users.invite": { "post": { "description": "Invite a user to a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.invite" - }, - "operationId": "admin_users_invite", + "tags": [ + "admin.users", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5564,22 +5528,18 @@ } } }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, + "required": true + }, + "responses": { + "200": { + "description": "Typical success response", + "content": { + "application/json": { "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -5587,28 +5547,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -5616,13 +5575,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -5632,51 +5596,39 @@ ] } ], - "tags": [ - "admin.users", - "admin" - ] + "operationId": "admin_users_invite", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.users.invite" + } } }, "/admin.users.list": { "get": { "description": "List users on a workspace", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.list" - }, - "operationId": "admin_users_list", - "parameters": [ - { - "description": "The ID (`T1234`) of the workspace.", - "in": "query", - "name": "team_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - }, - { - "description": "Limit for how many users to be retrieved per page", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } - } + "tags": [ + "admin.users", + "admin" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -5695,39 +5647,19 @@ ] } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -5735,13 +5667,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -5751,20 +5688,47 @@ ] } ], - "tags": [ - "admin.users", - "admin" + "operationId": "admin_users_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.users.list" + }, + "parameters": [ + { + "description": "The ID (`T1234`) of the workspace.", + "in": "query", + "name": "team_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + }, + { + "description": "Limit for how many users to be retrieved per page", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + } ] } }, "/admin.users.remove": { "post": { "description": "Remove a user from a workspace.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.remove" - }, - "operationId": "admin_users_remove", + "tags": [ + "admin.users", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5791,18 +5755,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -5810,28 +5770,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -5839,13 +5798,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -5855,20 +5819,20 @@ ] } ], - "tags": [ - "admin.users", - "admin" - ] + "operationId": "admin_users_remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.users.remove" + } } }, "/admin.users.session.invalidate": { "post": { "description": "Invalidate a single session for a user by session_id", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.session.invalidate" - }, - "operationId": "admin_users_session_invalidate", + "tags": [ + "admin.users.session", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -5894,18 +5858,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -5913,28 +5873,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -5942,13 +5901,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -5958,20 +5922,20 @@ ] } ], - "tags": [ - "admin.users.session", - "admin" - ] + "operationId": "admin_users_session_invalidate", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.users.session.invalidate" + } } }, "/admin.users.session.reset": { "post": { "description": "Wipes all valid sessions on all devices for a given user", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.session.reset" - }, - "operationId": "admin_users_session_reset", + "tags": [ + "admin.users.session", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6001,18 +5965,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -6020,28 +5980,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -6049,13 +6008,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -6065,20 +6029,20 @@ ] } ], - "tags": [ - "admin.users.session", - "admin" - ] + "operationId": "admin_users_session_reset", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.users.session.reset" + } } }, "/admin.users.setAdmin": { "post": { "description": "Set an existing guest, regular user, or owner to be an admin user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.setAdmin" - }, - "operationId": "admin_users_setAdmin", + "tags": [ + "admin.users", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6105,18 +6069,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -6124,28 +6084,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -6153,13 +6112,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -6169,20 +6133,20 @@ ] } ], - "tags": [ - "admin.users", - "admin" - ] + "operationId": "admin_users_setAdmin", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.users.setAdmin" + } } }, "/admin.users.setExpiration": { "post": { "description": "Set an expiration for a guest user", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.setExpiration" - }, - "operationId": "admin_users_setExpiration", + "tags": [ + "admin.users", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6214,18 +6178,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -6233,28 +6193,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -6262,13 +6221,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -6278,30 +6242,19 @@ ] } ], - "tags": [ - "admin.users", - "admin" - ] + "operationId": "admin_users_setExpiration", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.users.setExpiration" + } } }, "/admin.users.setOwner": { "post": { "description": "Set an existing guest, regular user, or admin user to be a workspace owner.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.setOwner" - }, - "operationId": "admin_users_setOwner", - "parameters": [ - { - "description": "Authentication token. Requires scope: `admin.users:write`", - "in": "header", - "name": "token", - "required": true, - "schema": { - "type": "string" - } - } + "tags": [ + "admin.users", + "admin" ], "requestBody": { "content": { @@ -6329,18 +6282,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -6348,28 +6297,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -6377,13 +6325,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -6393,20 +6346,31 @@ ] } ], - "tags": [ - "admin.users", - "admin" + "operationId": "admin_users_setOwner", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.users.setOwner" + }, + "parameters": [ + { + "description": "Authentication token. Requires scope: `admin.users:write`", + "in": "header", + "name": "token", + "required": true, + "schema": { + "type": "string" + } + } ] } }, "/admin.users.setRegular": { "post": { "description": "Set an existing guest user, admin user, or owner to be a regular user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/admin.users.setRegular" - }, - "operationId": "admin_users_setRegular", + "tags": [ + "admin.users", + "admin" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -6433,18 +6397,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -6452,28 +6412,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -6481,13 +6440,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -6497,46 +6461,31 @@ ] } ], - "tags": [ - "admin.users", - "admin" - ] + "operationId": "admin_users_setRegular", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/admin.users.setRegular" + } } }, "/api.test": { "get": { "description": "Checks API calling code.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/api.test" - }, - "operationId": "api_test", - "parameters": [ - { - "description": "example property to return", - "in": "query", - "name": "foo", - "schema": { - "type": "string" - } - } + "tags": [ + "api" ], "responses": { "200": { + "description": "Standard success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { + "title": "ApiTestSuccessSchema", + "type": "object", + "description": "Schema for successful response api.test method", "additionalProperties": { "type": "object" }, - "description": "Schema for successful response api.test method", "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -6544,33 +6493,29 @@ }, "required": [ "ok" - ], - "title": "api.test success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Standard success response" + } }, "default": { + "description": "Artificial error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "args": { - "error": "my_error" - }, - "error": "my_error", - "ok": false - } - } - }, "schema": { + "title": "ApiTestErrorSchema", + "type": "object", + "description": "Schema for error response api.test method", "additionalProperties": { "type": "object" }, - "description": "Schema for error response api.test method", "properties": { "error": { "type": "string" @@ -6582,13 +6527,21 @@ "required": [ "ok", "error" - ], - "title": "api.test error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "args": { + "error": "my_error" + }, + "error": "my_error", + "ok": false + } + } } } - }, - "description": "Artificial error response" + } } }, "security": [ @@ -6598,92 +6551,74 @@ ] } ], - "tags": [ - "api" - ] - } - }, - "/apps.event.authorizations.list": { - "get": { - "description": "Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.", + "operationId": "api_test", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.event.authorizations.list" + "url": "https://api.slack.com/methods/api.test" }, - "operationId": "apps_event_authorizations_list", "parameters": [ { + "description": "example property to return", "in": "query", - "name": "event_context", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "cursor", + "name": "foo", "schema": { "type": "string" } - }, - { - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } } + ] + } + }, + "/apps.event.authorizations.list": { + "get": { + "description": "Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.", + "tags": [ + "apps.event.authorizations", + "apps" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { "authorizations": { "enterprise_id": "string", "is_bot": "string", - "team_id": "string", - "user_id": "string" - }, - "ok": true - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "team_id": "string", + "user_id": "string" + }, + "ok": true } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -6691,13 +6626,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -6707,85 +6647,54 @@ ] } ], - "tags": [ - "apps.event.authorizations", - "apps" + "operationId": "apps_event_authorizations_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/apps.event.authorizations.list" + }, + "parameters": [ + { + "in": "query", + "name": "event_context", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + } ] } }, "/apps.permissions.info": { "get": { "description": "Returns list of permissions this app has on a team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.permissions.info" - }, - "operationId": "apps_permissions_info", + "tags": [ + "apps.permissions", + "apps" + ], "responses": { "200": { + "description": "Standard success response when used with a user token", "content": { "application/json": { - "examples": { - "response": { - "value": { - "info": { - "app_home": { - "resources": { - "ids": [ - "D0C0NU1Q8", - "D0BH95DLH" - ] - }, - "scopes": [ - "chat:write", - "im:history", - "im:read" - ] - }, - "channel": { - "resources": { - "excluded_ids": [], - "ids": [ - "C061FA5PB" - ], - "wildcard": false - }, - "scopes": [ - "channels:read" - ] - }, - "group": { - "resources": { - "ids": [] - }, - "scopes": [] - }, - "im": { - "resources": { - "ids": [] - }, - "scopes": [] - }, - "mpim": { - "resources": { - "ids": [] - }, - "scopes": [] - }, - "team": { - "resources": { - "ids": [] - }, - "scopes": [] - } - }, - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "AppsPermissionsInfoSchema", + "type": "object", "description": "Schema for successful response from apps.permissions.info method", + "additionalProperties": false, "properties": { "info": { "properties": { @@ -6877,28 +6786,78 @@ "required": [ "ok", "info" - ], - "title": "apps.permissions.info schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "info": { + "app_home": { + "resources": { + "ids": [ + "D0C0NU1Q8", + "D0BH95DLH" + ] + }, + "scopes": [ + "chat:write", + "im:history", + "im:read" + ] + }, + "channel": { + "resources": { + "excluded_ids": [], + "ids": [ + "C061FA5PB" + ], + "wildcard": false + }, + "scopes": [ + "channels:read" + ] + }, + "group": { + "resources": { + "ids": [] + }, + "scopes": [] + }, + "im": { + "resources": { + "ids": [] + }, + "scopes": [] + }, + "mpim": { + "resources": { + "ids": [] + }, + "scopes": [] + }, + "team": { + "resources": { + "ids": [] + }, + "scopes": [] + } + }, + "ok": true + } + } } } - }, - "description": "Standard success response when used with a user token" + } }, "default": { + "description": "Standard failure response when used with an invalid token", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AppsPermissionsInfoErrorSchema", + "type": "object", "description": "Schema for error response from apps.permissions.info method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -6935,13 +6894,18 @@ "required": [ "ok", "error" - ], - "title": "apps.permissions.info error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Standard failure response when used with an invalid token" + } } }, "security": [ @@ -6951,54 +6915,30 @@ ] } ], - "tags": [ - "apps.permissions", - "apps" - ] + "operationId": "apps_permissions_info", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/apps.permissions.info" + } } }, "/apps.permissions.request": { - "get": { - "description": "Allows an app to request additional scopes", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.permissions.request" - }, - "operationId": "apps_permissions_request", - "parameters": [ - { - "description": "A comma separated list of scopes to request for", - "in": "query", - "name": "scopes", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Token used to trigger the permissions API", - "in": "query", - "name": "trigger_id", - "required": true, - "schema": { - "type": "string" - } - } + "get": { + "description": "Allows an app to request additional scopes", + "tags": [ + "apps.permissions", + "apps" ], "responses": { "200": { + "description": "Standard success response when used with a user token", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "AppsPermissionsRequestSchema", + "type": "object", "description": "Schema for successful response from apps.permissions.request method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -7006,28 +6946,27 @@ }, "required": [ "ok" - ], - "title": "apps.permissions.request schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Standard success response when used with a user token" + } }, "default": { + "description": "Standard failure response when trigger_id is invalid", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_trigger_id", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AppsPermissionsRequestErrorSchema", + "type": "object", "description": "Schema for error response from apps.permissions.request method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -7068,13 +7007,18 @@ "required": [ "ok", "error" - ], - "title": "apps.permissions.request error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_trigger_id", + "ok": false + } + } } } - }, - "description": "Standard failure response when trigger_id is invalid" + } } }, "security": [ @@ -7084,69 +7028,50 @@ ] } ], - "tags": [ - "apps.permissions", - "apps" - ] - } - }, - "/apps.permissions.resources.list": { - "get": { - "description": "Returns list of resource grants this app has on a team.", + "operationId": "apps_permissions_request", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.permissions.resources.list" + "url": "https://api.slack.com/methods/apps.permissions.request" }, - "operationId": "apps_permissions_resources_list", "parameters": [ { - "description": "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](/docs/pagination) for more detail.", + "description": "A comma separated list of scopes to request for", "in": "query", - "name": "cursor", + "name": "scopes", + "required": true, "schema": { "type": "string" } }, { - "description": "The maximum number of items to return.", + "description": "Token used to trigger the permissions API", "in": "query", - "name": "limit", + "name": "trigger_id", + "required": true, "schema": { - "type": "integer" + "type": "string" } } + ] + } + }, + "/apps.permissions.resources.list": { + "get": { + "description": "Returns list of resource grants this app has on a team.", + "tags": [ + "apps.permissions.resources", + "apps" ], "responses": { "200": { + "description": "Typical successful paginated response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true, - "resources": [ - { - "id": "T0DES3UAN", - "type": "team" - }, - { - "id": "D024BFF1M", - "type": "app_home" - }, - { - "id": "C024BE91L", - "type": "channel" - } - ], - "response_metadata": { - "next_cursor": "dGVhbTpDMUg5UkVTR0w=" - } - } - } - }, "schema": { - "additionalProperties": true, + "title": "AppsPermissionsResourcesListSuccessSchema", + "type": "object", "description": "Schema for successful response apps.permissions.resources.list method", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -7195,28 +7120,44 @@ "required": [ "ok", "resources" - ], - "title": "apps.permissions.resources.list success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true, + "resources": [ + { + "id": "T0DES3UAN", + "type": "team" + }, + { + "id": "D024BFF1M", + "type": "app_home" + }, + { + "id": "C024BE91L", + "type": "channel" + } + ], + "response_metadata": { + "next_cursor": "dGVhbTpDMUg5UkVTR0w=" + } + } + } } } - }, - "description": "Typical successful paginated response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_cursor", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AppsPermissionsResourcesListErrorSchema", + "type": "object", "description": "Schema for error response from apps.permissions.resources.list method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -7254,13 +7195,18 @@ "required": [ "ok", "error" - ], - "title": "apps.permissions.resources.list error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_cursor", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -7270,58 +7216,48 @@ ] } ], - "tags": [ - "apps.permissions.resources", - "apps" + "operationId": "apps_permissions_resources_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/apps.permissions.resources.list" + }, + "parameters": [ + { + "description": "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](\/docs\/pagination) for more detail.", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + }, + { + "description": "The maximum number of items to return.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + } ] } }, "/apps.permissions.scopes.list": { "get": { "description": "Returns list of scopes this app has on a team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.permissions.scopes.list" - }, - "operationId": "apps_permissions_scopes_list", + "tags": [ + "apps.permissions.scopes", + "apps" + ], "responses": { "200": { + "description": "Typical successful paginated response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true, - "scopes": { - "app_home": [ - "chat:write", - "im:history", - "im:read" - ], - "channel": [ - "channels:history", - "chat:write" - ], - "group": [ - "chat:write" - ], - "im": [ - "chat:write" - ], - "mpim": [ - "chat:write" - ], - "team": [ - "users:read" - ], - "user": [] - } - } - } - }, "schema": { - "additionalProperties": true, + "title": "ApiPermissionsScopesListSuccessSchema", + "type": "object", "description": "Schema for successful response api.permissions.scopes.list method", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -7353,32 +7289,55 @@ }, "type": "object" } - }, - "required": [ - "ok", - "scopes" - ], - "title": "api.permissions.scopes.list success schema", - "type": "object" + }, + "required": [ + "ok", + "scopes" + ] + }, + "examples": { + "response": { + "value": { + "ok": true, + "scopes": { + "app_home": [ + "chat:write", + "im:history", + "im:read" + ], + "channel": [ + "channels:history", + "chat:write" + ], + "group": [ + "chat:write" + ], + "im": [ + "chat:write" + ], + "mpim": [ + "chat:write" + ], + "team": [ + "users:read" + ], + "user": [] + } + } + } } } - }, - "description": "Typical successful paginated response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AppsPermissionsScopesListErrorSchema", + "type": "object", "description": "Schema for error response from apps.permissions.scopes.list method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -7415,13 +7374,18 @@ "required": [ "ok", "error" - ], - "title": "apps.permissions.scopes.list error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -7431,42 +7395,39 @@ ] } ], - "tags": [ - "apps.permissions.scopes", - "apps" - ] + "operationId": "apps_permissions_scopes_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/apps.permissions.scopes.list" + } } }, "/apps.permissions.users.list": { "get": { "description": "Returns list of user grants and corresponding scopes this app has on a team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.permissions.users.list" - }, - "operationId": "apps_permissions_users_list", - "parameters": [ - { - "description": "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](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - }, - { - "description": "The maximum number of items to return.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } - } + "tags": [ + "apps.permissions.users", + "apps" ], "responses": { "200": { + "description": "Typical successful paginated response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -7491,39 +7452,19 @@ } } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Typical successful paginated response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_cursor", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -7531,13 +7472,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_cursor", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -7547,63 +7493,48 @@ ] } ], - "tags": [ - "apps.permissions.users", - "apps" - ] - } - }, - "/apps.permissions.users.request": { - "get": { - "description": "Enables an app to trigger a permissions modal to grant an app access to a user access scope.", + "operationId": "apps_permissions_users_list", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.permissions.users.request" + "url": "https://api.slack.com/methods/apps.permissions.users.list" }, - "operationId": "apps_permissions_users_request", "parameters": [ { - "description": "A comma separated list of user scopes to request for", - "in": "query", - "name": "scopes", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Token used to trigger the request", + "description": "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](\/docs\/pagination) for more detail.", "in": "query", - "name": "trigger_id", - "required": true, + "name": "cursor", "schema": { "type": "string" } }, { - "description": "The user this scope is being requested for", + "description": "The maximum number of items to return.", "in": "query", - "name": "user", - "required": true, + "name": "limit", "schema": { - "type": "string" + "type": "integer" } } + ] + } + }, + "/apps.permissions.users.request": { + "get": { + "description": "Enables an app to trigger a permissions modal to grant an app access to a user access scope.", + "tags": [ + "apps.permissions.users", + "apps" ], "responses": { "200": { + "description": "Standard success response when used with a user token", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -7611,28 +7542,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Standard success response when used with a user token" + } }, "default": { + "description": "Standard failure response when trigger_id is invalid", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_trigger_id", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -7640,13 +7570,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_trigger_id", + "ok": false + } + } } } - }, - "description": "Standard failure response when trigger_id is invalid" + } } }, "security": [ @@ -7656,52 +7591,58 @@ ] } ], - "tags": [ - "apps.permissions.users", - "apps" - ] - } - }, - "/apps.uninstall": { - "get": { - "description": "Uninstalls your app from a workspace.", + "operationId": "apps_permissions_users_request", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/apps.uninstall" + "url": "https://api.slack.com/methods/apps.permissions.users.request" }, - "operationId": "apps_uninstall", "parameters": [ { - "description": "Issued when you created your application.", + "description": "A comma separated list of user scopes to request for", "in": "query", - "name": "client_id", + "name": "scopes", + "required": true, "schema": { "type": "string" } }, { - "description": "Issued when you created your application.", + "description": "Token used to trigger the request", "in": "query", - "name": "client_secret", + "name": "trigger_id", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The user this scope is being requested for", + "in": "query", + "name": "user", + "required": true, "schema": { "type": "string" } } - ], - "responses": { - "200": { - "content": { - "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, + ] + } + }, + "/apps.uninstall": { + "get": { + "description": "Uninstalls your app from a workspace.", + "tags": [ + "apps" + ], + "responses": { + "200": { + "description": "Typical success response", + "content": { + "application/json": { "schema": { - "additionalProperties": false, + "title": "AppsUninstallSchema", + "type": "object", "description": "Schema for successful response from apps.uninstall method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -7709,28 +7650,27 @@ }, "required": [ "ok" - ], - "title": "apps.uninstall schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AppsUninstallErrorSchema", + "type": "object", "description": "Schema for error response from apps.uninstall method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -7770,13 +7710,18 @@ "required": [ "ok", "error" - ], - "title": "apps.uninstall error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -7786,44 +7731,47 @@ ] } ], - "tags": [ - "apps" - ] - } - }, - "/auth.revoke": { - "get": { - "description": "Revokes a token.", + "operationId": "apps_uninstall", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/auth.revoke" + "url": "https://api.slack.com/methods/apps.uninstall" }, - "operationId": "auth_revoke", "parameters": [ { - "description": "Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked.", + "description": "Issued when you created your application.", "in": "query", - "name": "test", + "name": "client_id", "schema": { - "type": "boolean" + "type": "string" + } + }, + { + "description": "Issued when you created your application.", + "in": "query", + "name": "client_secret", + "schema": { + "type": "string" } } + ] + } + }, + "/auth.revoke": { + "get": { + "description": "Revokes a token.", + "tags": [ + "auth" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true, - "revoked": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "AuthRevokeSchema", + "type": "object", "description": "Schema for successful response from auth.revoke method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -7835,28 +7783,28 @@ "required": [ "ok", "revoked" - ], - "title": "auth.revoke schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true, + "revoked": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AuthRevokeErrorSchema", + "type": "object", "description": "Schema for error response from auth.revoke method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -7892,13 +7840,18 @@ "required": [ "ok", "error" - ], - "title": "auth.revoke error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -7908,38 +7861,39 @@ ] } ], - "tags": [ - "auth" + "operationId": "auth_revoke", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/auth.revoke" + }, + "parameters": [ + { + "description": "Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked.", + "in": "query", + "name": "test", + "schema": { + "type": "boolean" + } + } ] } }, "/auth.test": { "get": { "description": "Checks authentication & identity.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/auth.test" - }, - "operationId": "auth_test", + "tags": [ + "auth" + ], "responses": { "200": { + "description": "Standard success response when used with a user token", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true, - "team": "Subarachnoid Workspace", - "team_id": "T12345678", - "url": "https://subarachnoid.slack.com/", - "user": "grace", - "user_id": "W12345678" - } - } - }, "schema": { - "additionalProperties": false, + "title": "AuthTestSuccessSchema", + "type": "object", "description": "Schema for successful response auth.test method", + "additionalProperties": false, "properties": { "bot_id": { "$ref": "#/components/schemas/defs_bot_id" @@ -7973,28 +7927,32 @@ "user", "team_id", "user_id" - ], - "title": "auth.test success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true, + "team": "Subarachnoid Workspace", + "team_id": "T12345678", + "url": "https://subarachnoid.slack.com/", + "user": "grace", + "user_id": "W12345678" + } + } } } - }, - "description": "Standard success response when used with a user token" + } }, "default": { + "description": "Standard failure response when used with an invalid token", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "AuthTestErrorSchema", + "type": "object", "description": "Schema for error response auth.test method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -8026,13 +7984,18 @@ "required": [ "ok", "error" - ], - "title": "auth.test error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Standard failure response when used with an invalid token" + } } }, "security": [ @@ -8042,56 +8005,29 @@ ] } ], - "tags": [ - "auth" - ] + "operationId": "auth_test", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/auth.test" + } } }, "/bots.info": { "get": { "description": "Gets information about a bot user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/bots.info" - }, - "operationId": "bots_info", - "parameters": [ - { - "description": "Bot user to get info on", - "in": "query", - "name": "bot", - "schema": { - "type": "string" - } - } + "tags": [ + "bots" ], "responses": { "200": { + "description": "When successful, returns bot info by bot ID.", "content": { "application/json": { - "examples": { - "response": { - "value": { - "bot": { - "app_id": "A161CLERW", - "deleted": false, - "icons": { - "image_36": "https://...", - "image_48": "https://...", - "image_72": "https://..." - }, - "id": "B061F7JD2", - "name": "beforebot", - "updated": 1449272004, - "user_id": "U012ABCDEF" - }, - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "BotsInfoSchema", + "type": "object", "description": "Schema for successful response from bots.info method", + "additionalProperties": false, "properties": { "bot": { "additionalProperties": false, @@ -8151,32 +8087,44 @@ "ok": { "$ref": "#/components/schemas/defs_ok_true" } - }, - "required": [ - "ok", - "bot" - ], - "title": "bots.info schema", - "type": "object" + }, + "required": [ + "ok", + "bot" + ] + }, + "examples": { + "response": { + "value": { + "bot": { + "app_id": "A161CLERW", + "deleted": false, + "icons": { + "image_36": "https://...", + "image_48": "https://...", + "image_72": "https://..." + }, + "id": "B061F7JD2", + "name": "beforebot", + "updated": 1449272004, + "user_id": "U012ABCDEF" + }, + "ok": true + } + } } } - }, - "description": "When successful, returns bot info by bot ID." + } }, "default": { + "description": "When no bot can be found, it returns an error.", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "bot_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "BotsInfoErrorSchema", + "type": "object", "description": "Schema for error response from bots.info method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -8213,13 +8161,18 @@ "required": [ "ok", "error" - ], - "title": "bots.info error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "bot_not_found", + "ok": false + } + } } } - }, - "description": "When no bot can be found, it returns an error." + } } }, "security": [ @@ -8229,19 +8182,29 @@ ] } ], - "tags": [ - "bots" + "operationId": "bots_info", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/bots.info" + }, + "parameters": [ + { + "description": "Bot user to get info on", + "in": "query", + "name": "bot", + "schema": { + "type": "string" + } + } ] } }, "/calls.add": { "post": { "description": "Registers a new Call.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/calls.add" - }, - "operationId": "calls_add", + "tags": [ + "calls" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8292,18 +8255,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -8311,28 +8270,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -8340,13 +8298,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -8356,19 +8319,19 @@ ] } ], - "tags": [ - "calls" - ] + "operationId": "calls_add", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/calls.add" + } } }, "/calls.end": { "post": { "description": "Ends a Call.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/calls.end" - }, - "operationId": "calls_end", + "tags": [ + "calls" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8394,18 +8357,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -8413,28 +8372,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -8442,13 +8400,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -8458,44 +8421,29 @@ ] } ], - "tags": [ - "calls" - ] + "operationId": "calls_end", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/calls.end" + } } }, "/calls.info": { "get": { "description": "Returns information about a Call.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/calls.info" - }, - "operationId": "calls_info", - "parameters": [ - { - "description": "`id` of the Call returned by the [`calls.add`](/methods/calls.add) method.", - "in": "query", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } + "tags": [ + "calls" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -8503,28 +8451,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -8532,13 +8479,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -8547,20 +8499,32 @@ "calls:read" ] } - ], - "tags": [ - "calls" + ], + "operationId": "calls_info", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/calls.info" + }, + "parameters": [ + { + "description": "`id` of the Call returned by the [`calls.add`](/methods/calls.add) method.", + "in": "query", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } ] } }, "/calls.participants.add": { "post": { "description": "Registers new participants added to a Call.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/calls.participants.add" - }, - "operationId": "calls_participants_add", + "tags": [ + "calls.participants", + "calls" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8587,18 +8551,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -8606,28 +8566,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -8635,13 +8594,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -8651,20 +8615,20 @@ ] } ], - "tags": [ - "calls.participants", - "calls" - ] + "operationId": "calls_participants_add", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/calls.participants.add" + } } }, "/calls.participants.remove": { "post": { "description": "Registers participants removed from a Call.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/calls.participants.remove" - }, - "operationId": "calls_participants_remove", + "tags": [ + "calls.participants", + "calls" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8691,18 +8655,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -8710,28 +8670,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -8739,13 +8698,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -8755,20 +8719,19 @@ ] } ], - "tags": [ - "calls.participants", - "calls" - ] + "operationId": "calls_participants_remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/calls.participants.remove" + } } }, "/calls.update": { "post": { "description": "Updates information about a Call.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/calls.update" - }, - "operationId": "calls_update", + "tags": [ + "calls" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8802,18 +8765,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -8821,28 +8780,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -8850,13 +8808,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -8866,19 +8829,19 @@ ] } ], - "tags": [ - "calls" - ] + "operationId": "calls_update", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/calls.update" + } } }, "/chat.delete": { "post": { "description": "Deletes a message.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.delete" - }, - "operationId": "chat_delete", + "tags": [ + "chat" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -8904,20 +8867,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "channel": "C024BE91L", - "ok": true, - "ts": "1401383885.000061" - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatDeleteSuccessSchema", + "type": "object", "description": "Schema for successful response of chat.delete method", + "additionalProperties": false, "properties": { "channel": { "$ref": "#/components/schemas/defs_channel" @@ -8933,28 +8890,29 @@ "ok", "channel", "ts" - ], - "title": "chat.delete success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "channel": "C024BE91L", + "ok": true, + "ts": "1401383885.000061" + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "message_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatDeleteErrorSchema", + "type": "object", "description": "Schema for error response from chat.delete method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -8993,13 +8951,18 @@ "required": [ "ok", "error" - ], - "title": "chat.delete error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "message_not_found", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -9010,19 +8973,19 @@ ] } ], - "tags": [ - "chat" - ] + "operationId": "chat_delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/chat.delete" + } } }, "/chat.deleteScheduledMessage": { "post": { "description": "Deletes a pending scheduled message from the queue.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.deleteScheduledMessage" - }, - "operationId": "chat_deleteScheduledMessage", + "tags": [ + "chat" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9052,18 +9015,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatDeleteScheduledMessageSchema", + "type": "object", "description": "Schema for successful response from chat.deleteScheduledMessage method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -9071,28 +9030,27 @@ }, "required": [ "ok" - ], - "title": "chat.deleteScheduledMessage schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response if no message is found", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_scheduled_message_id", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatDeleteScheduledMessageErrorSchema", + "type": "object", "description": "Schema for error response from chat.deleteScheduledMessage method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -9133,13 +9091,18 @@ "required": [ "ok", "error" - ], - "title": "chat.deleteScheduledMessage error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_scheduled_message_id", + "ok": false + } + } } } - }, - "description": "Typical error response if no message is found" + } } }, "security": [ @@ -9150,55 +9113,29 @@ ] } ], - "tags": [ - "chat" - ] + "operationId": "chat_deleteScheduledMessage", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/chat.deleteScheduledMessage" + } } }, "/chat.getPermalink": { "get": { "description": "Retrieve a permalink URL for a specific extant message", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.getPermalink" - }, - "operationId": "chat_getPermalink", - "parameters": [ - { - "description": "The ID of the conversation or channel containing the message", - "in": "query", - "name": "channel", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A message's `ts` value, uniquely identifying it within a channel", - "in": "query", - "name": "message_ts", - "required": true, - "schema": { - "type": "string" - } - } + "tags": [ + "chat" ], "responses": { "200": { + "description": "Standard success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "channel": "C1H9RESGA", - "ok": true, - "permalink": "https://ghostbusters.slack.com/archives/C1H9RESGA/p135854651500008" - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatGetPermalinkSuccessSchema", + "type": "object", "description": "Schema for successful response chat.getPermalink", + "additionalProperties": false, "properties": { "channel": { "$ref": "#/components/schemas/defs_channel" @@ -9215,28 +9152,29 @@ "ok", "channel", "permalink" - ], - "title": "chat.getPermalink success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "channel": "C1H9RESGA", + "ok": true, + "permalink": "https://ghostbusters.slack.com/archives/C1H9RESGA/p135854651500008" + } + } } } - }, - "description": "Standard success response" + } }, "default": { + "description": "Error response when channel cannot be found", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "channel_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatGetPermalinkErrorSchema", + "type": "object", "description": "Schema for error response from chat.getPermalink method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -9274,13 +9212,18 @@ "required": [ "ok", "error" - ], - "title": "chat.getPermalink error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "channel_not_found", + "ok": false + } + } } } - }, - "description": "Error response when channel cannot be found" + } } }, "security": [ @@ -9290,19 +9233,39 @@ ] } ], - "tags": [ - "chat" + "operationId": "chat_getPermalink", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/chat.getPermalink" + }, + "parameters": [ + { + "description": "The ID of the conversation or channel containing the message", + "in": "query", + "name": "channel", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "A message's `ts` value, uniquely identifying it within a channel", + "in": "query", + "name": "message_ts", + "required": true, + "schema": { + "type": "string" + } + } ] } }, "/chat.meMessage": { "post": { "description": "Share a me message into a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.meMessage" - }, - "operationId": "chat_meMessage", + "tags": [ + "chat" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9324,20 +9287,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "channel": "C024BE7LR", - "ok": true, - "ts": "1417671948.000006" - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatMeMessageSchema", + "type": "object", "description": "Schema for successful response from chat.meMessage method", + "additionalProperties": false, "properties": { "channel": { "$ref": "#/components/schemas/defs_channel" @@ -9351,28 +9308,29 @@ }, "required": [ "ok" - ], - "title": "chat.meMessage schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "channel": "C024BE7LR", + "ok": true, + "ts": "1417671948.000006" + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatMeMessageErrorSchema", + "type": "object", "description": "Schema for error response from chat.meMessage method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -9414,13 +9372,18 @@ "required": [ "ok", "error" - ], - "title": "chat.meMessage error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -9431,19 +9394,19 @@ ] } ], - "tags": [ - "chat" - ] + "operationId": "chat_meMessage", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/chat.meMessage" + } } }, "/chat.postEphemeral": { "post": { "description": "Sends an ephemeral message to a user in a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.postEphemeral" - }, - "operationId": "chat_postEphemeral", + "tags": [ + "chat" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9509,19 +9472,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "message_ts": "1502210682.580145", - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatPostEphemeralSuccessSchema", + "type": "object", "description": "Schema for successful response from chat.postEphemeral method", + "additionalProperties": false, "properties": { "message_ts": { "$ref": "#/components/schemas/defs_ts" @@ -9533,28 +9491,28 @@ "required": [ "ok", "message_ts" - ], - "title": "chat.postEphemeral success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "message_ts": "1502210682.580145", + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "user_not_in_channel", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatPostEphemeralErrorSchema", + "type": "object", "description": "Schema for error response from chat.postEphemeral method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -9597,13 +9555,18 @@ "required": [ "ok", "error" - ], - "title": "chat.postEphemeral error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "user_not_in_channel", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -9614,19 +9577,19 @@ ] } ], - "tags": [ - "chat" - ] + "operationId": "chat_postEphemeral", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/chat.postEphemeral" + } } }, "/chat.postMessage": { "post": { "description": "Sends a message to a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.postMessage" - }, - "operationId": "chat_postMessage", + "tags": [ + "chat" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9703,8 +9666,35 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "ChatPostMessageSuccessSchema", + "type": "object", + "description": "Schema for successful response of chat.postMessage method", + "additionalProperties": false, + "properties": { + "channel": { + "$ref": "#/components/schemas/defs_channel" + }, + "message": { + "$ref": "#/components/schemas/objs_message" + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "ts": { + "$ref": "#/components/schemas/defs_ts" + } + }, + "required": [ + "ok", + "channel", + "ts", + "message" + ] + }, "examples": { "response": { "value": { @@ -9728,51 +9718,19 @@ "ts": "1503435956.000247" } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response of chat.postMessage method", - "properties": { - "channel": { - "$ref": "#/components/schemas/defs_channel" - }, - "message": { - "$ref": "#/components/schemas/objs_message" - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "ts": { - "$ref": "#/components/schemas/defs_ts" - } - }, - "required": [ - "ok", - "channel", - "ts", - "message" - ], - "title": "chat.postMessage success schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response if too many attachments are included", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "too_many_attachments", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatPostMessageErrorSchema", + "type": "object", "description": "Schema for error response chat.postMessage method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -9806,13 +9764,18 @@ "required": [ "ok", "error" - ], - "title": "chat.postMessage error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "too_many_attachments", + "ok": false + } + } } } - }, - "description": "Typical error response if too many attachments are included" + } } }, "security": [ @@ -9823,19 +9786,19 @@ ] } ], - "tags": [ - "chat" - ] + "operationId": "chat_postMessage", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/chat.postMessage" + } } }, "/chat.scheduleMessage": { "post": { "description": "Schedules a message to be sent to a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.scheduleMessage" - }, - "operationId": "chat_scheduleMessage", + "tags": [ + "chat" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -9897,35 +9860,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "channel": "C1H9RESGL", - "message": { - "attachments": [ - { - "fallback": "This is an attachment's fallback", - "id": 1, - "text": "This is an attachment" - } - ], - "bot_id": "B19LU7CSY", - "subtype": "bot_message", - "text": "Here's a message for you in the future", - "type": "delayed_message", - "username": "ecto1" - }, - "ok": true, - "post_at": "1562180400", - "scheduled_message_id": "Q1298393284" - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatScheduleMessageSuccessSchema", + "type": "object", "description": "Schema for successful response of chat.scheduleMessage method", + "additionalProperties": false, "properties": { "channel": { "$ref": "#/components/schemas/defs_channel" @@ -9983,28 +9925,44 @@ "post_at", "scheduled_message_id", "message" - ], - "title": "chat.scheduleMessage success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "channel": "C1H9RESGL", + "message": { + "attachments": [ + { + "fallback": "This is an attachment's fallback", + "id": 1, + "text": "This is an attachment" + } + ], + "bot_id": "B19LU7CSY", + "subtype": "bot_message", + "text": "Here's a message for you in the future", + "type": "delayed_message", + "username": "ecto1" + }, + "ok": true, + "post_at": "1562180400", + "scheduled_message_id": "Q1298393284" + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response if the `post_at` is invalid (ex. in the past or too far into the future)", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "time_in_past", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatScheduleMessageErrorSchema", + "type": "object", "description": "Schema for error response chat.scheduleMessage method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -10056,104 +10014,52 @@ "required": [ "ok", "error" - ], - "title": "chat.scheduleMessage error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "time_in_past", + "ok": false + } + } } } - }, - "description": "Typical error response if the `post_at` is invalid (ex. in the past or too far into the future)" - } - }, - "security": [ - { - "slackAuth": [ - "chat:write:user", - "chat:write:bot" - ] - } - ], - "tags": [ - "chat" - ] - } - }, - "/chat.scheduledMessages.list": { - "get": { - "description": "Returns a list of scheduled messages.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.scheduledMessages.list" - }, - "operationId": "chat_scheduledMessages_list", - "parameters": [ - { - "description": "The channel of the scheduled messages", - "in": "query", - "name": "channel", - "schema": { - "type": "string" - } - }, - { - "description": "A UNIX timestamp of the latest value in the time range", - "in": "query", - "name": "latest", - "schema": { - "type": "number" - } - }, - { - "description": "A UNIX timestamp of the oldest value in the time range", - "in": "query", - "name": "oldest", - "schema": { - "type": "number" - } - }, - { - "description": "Maximum number of original entries to return.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } - }, - { - "description": "For pagination purposes, this is the `cursor` value returned from a previous call to `chat.scheduledmessages.list` indicating where you want to start this call from.", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" } } + }, + "security": [ + { + "slackAuth": [ + "chat:write:user", + "chat:write:bot" + ] + } + ], + "operationId": "chat_scheduleMessage", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/chat.scheduleMessage" + } + } + }, + "/chat.scheduledMessages.list": { + "get": { + "description": "Returns a list of scheduled messages.", + "tags": [ + "chat.scheduledMessages", + "chat" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true, - "response_metadata": { - "next_cursor": "" - }, - "scheduled_messages": [ - { - "channel_id": "C1H9RESGL", - "date_created": 1551891734, - "id": 1298393284, - "post_at": 1551991428, - "text": "Here's a message for you in the future" - } - ] - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatScheduledMessagesListSchema", + "type": "object", "description": "Schema for successful response from chat.scheduledMessages.list method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -10208,28 +10114,39 @@ "ok", "scheduled_messages", "response_metadata" - ], - "title": "chat.scheduledMessages.list schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true, + "response_metadata": { + "next_cursor": "" + }, + "scheduled_messages": [ + { + "channel_id": "C1H9RESGL", + "date_created": 1551891734, + "id": 1298393284, + "post_at": 1551991428, + "text": "Here's a message for you in the future" + } + ] + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response if the channel passed is invalid", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_channel", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatScheduledMessagesListErrorSchema", + "type": "object", "description": "Schema for error response from chat.scheduledMessages.list method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -10268,13 +10185,18 @@ "required": [ "ok", "error" - ], - "title": "chat.scheduledMessages.list error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_channel", + "ok": false + } + } } } - }, - "description": "Typical error response if the channel passed is invalid" + } } }, "security": [ @@ -10284,20 +10206,61 @@ ] } ], - "tags": [ - "chat.scheduledMessages", - "chat" + "operationId": "chat_scheduledMessages_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/chat.scheduledMessages.list" + }, + "parameters": [ + { + "description": "The channel of the scheduled messages", + "in": "query", + "name": "channel", + "schema": { + "type": "string" + } + }, + { + "description": "A UNIX timestamp of the latest value in the time range", + "in": "query", + "name": "latest", + "schema": { + "type": "number" + } + }, + { + "description": "A UNIX timestamp of the oldest value in the time range", + "in": "query", + "name": "oldest", + "schema": { + "type": "number" + } + }, + { + "description": "Maximum number of original entries to return.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + }, + { + "description": "For pagination purposes, this is the `cursor` value returned from a previous call to `chat.scheduledmessages.list` indicating where you want to start this call from.", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + } ] } }, "/chat.unfurl": { "post": { "description": "Provide custom unfurl behavior for user-posted URLs", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.unfurl" - }, - "operationId": "chat_unfurl", + "tags": [ + "chat" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10340,18 +10303,14 @@ }, "responses": { "200": { + "description": "Typical, minimal success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatUnfurlSuccessSchema", + "type": "object", "description": "Schema for successful response from chat.unfurl method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -10359,28 +10318,27 @@ }, "required": [ "ok" - ], - "title": "chat.unfurl success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical, minimal success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "cannot_unfurl_url", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatUnfurlErrorSchema", + "type": "object", "description": "Schema for error response from chat.unfurl method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -10421,13 +10379,18 @@ "required": [ "ok", "error" - ], - "title": "chat.unfurl error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "cannot_unfurl_url", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -10437,19 +10400,19 @@ ] } ], - "tags": [ - "chat" - ] + "operationId": "chat_unfurl", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/chat.unfurl" + } } }, "/chat.update": { "post": { "description": "Updates a message.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/chat.update" - }, - "operationId": "chat_update", + "tags": [ + "chat" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10499,25 +10462,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "channel": "C024BE91L", - "message": { - "text": "Updated text you carefully authored", - "user": "U34567890" - }, - "ok": true, - "text": "Updated text you carefully authored", - "ts": "1401383885.000061" - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatUpdateSuccessSchema", + "type": "object", "description": "Schema for successful response of chat.update method", + "additionalProperties": false, "properties": { "channel": { "type": "string" @@ -10559,28 +10511,34 @@ "ts", "text", "message" - ], - "title": "chat.update success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "channel": "C024BE91L", + "message": { + "text": "Updated text you carefully authored", + "user": "U34567890" + }, + "ok": true, + "text": "Updated text you carefully authored", + "ts": "1401383885.000061" + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "cant_update_message", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ChatUpdateErrorSchema", + "type": "object", "description": "Schema for error response chat.update method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -10619,17 +10577,22 @@ "ok": { "$ref": "#/components/schemas/defs_ok_false" } - }, - "required": [ - "ok", - "error" - ], - "title": "chat.update error schema", - "type": "object" + }, + "required": [ + "ok", + "error" + ] + }, + "examples": { + "response": { + "value": { + "error": "cant_update_message", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -10640,19 +10603,19 @@ ] } ], - "tags": [ - "chat" - ] + "operationId": "chat_update", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/chat.update" + } } }, "/conversations.archive": { "post": { "description": "Archives a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.archive" - }, - "operationId": "conversations_archive", + "tags": [ + "conversations" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10670,18 +10633,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsArchiveSuccessSchema", + "type": "object", "description": "Schema for successful response conversations.archive method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -10689,28 +10648,27 @@ }, "required": [ "ok" - ], - "title": "conversations.archive success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "channel_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsArchiveErrorSchema", + "type": "object", "description": "Schema for error response from conversations.archive method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -10760,13 +10718,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.archive error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "channel_not_found", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -10779,19 +10742,19 @@ ] } ], - "tags": [ - "conversations" - ] + "operationId": "conversations_archive", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.archive" + } } }, "/conversations.close": { "post": { "description": "Closes a direct message or multi-person direct message.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.close" - }, - "operationId": "conversations_close", + "tags": [ + "conversations" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10809,18 +10772,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsCloseSuccessSchema", + "type": "object", "description": "Schema for successful response conversations.close method", + "additionalProperties": false, "properties": { "already_closed": { "type": "boolean" @@ -10834,28 +10793,27 @@ }, "required": [ "ok" - ], - "title": "conversations.close success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "channel_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsCloseErrorSchema", + "type": "object", "description": "Schema for error response from conversations.close method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -10897,13 +10855,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.close error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "channel_not_found", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -10916,19 +10879,19 @@ ] } ], - "tags": [ - "conversations" - ] + "operationId": "conversations_close", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.close" + } } }, "/conversations.create": { "post": { "description": "Initiates a public or private channel-based conversation", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.create" - }, - "operationId": "conversations_create", + "tags": [ + "conversations" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -10950,8 +10913,27 @@ }, "responses": { "200": { + "description": "If successful, the command returns a rather stark [conversation object](/types/conversation)", "content": { "application/json": { + "schema": { + "title": "ConversationsCreateSuccessSchema", + "type": "object", + "description": "Schema for successful response conversations.create method", + "additionalProperties": false, + "properties": { + "channel": { + "$ref": "#/components/schemas/objs_conversation" + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok", + "channel" + ] + }, "examples": { "response": { "value": { @@ -10995,43 +10977,19 @@ "ok": true } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response conversations.create method", - "properties": { - "channel": { - "$ref": "#/components/schemas/objs_conversation" - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok", - "channel" - ], - "title": "conversations.create success schema", - "type": "object" } } - }, - "description": "If successful, the command returns a rather stark [conversation object](/types/conversation)" + } }, "default": { + "description": "Typical error response when name already in use", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "name_taken", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsCreateErrorSchema", + "type": "object", "description": "Schema for error response from conversations.create method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -11083,122 +11041,54 @@ }, "required": [ "ok", - "error" - ], - "title": "conversations.create error schema", - "type": "object" - } - } - }, - "description": "Typical error response when name already in use" - } - }, - "security": [ - { - "slackAuth": [ - "channels:write", - "groups:write", - "im:write", - "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.history": { - "get": { - "description": "Fetches a conversation's history of messages and events.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.history" - }, - "operationId": "conversations_history", - "parameters": [ - { - "description": "Conversation ID to fetch history for.", - "in": "query", - "name": "channel", - "schema": { - "type": "string" - } - }, - { - "description": "End of time range of messages to include in results.", - "in": "query", - "name": "latest", - "schema": { - "type": "number" - } - }, - { - "description": "Start of time range of messages to include in results.", - "in": "query", - "name": "oldest", - "schema": { - "type": "number" - } - }, - { - "description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", - "in": "query", - "name": "inclusive", - "schema": { - "type": "boolean" - } - }, - { - "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" + "error" + ] + }, + "examples": { + "response": { + "value": { + "error": "name_taken", + "ok": false + } + } + } + } } - }, + } + }, + "security": [ { - "description": "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](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } + "slackAuth": [ + "channels:write", + "groups:write", + "im:write", + "mpim:write" + ] } ], + "operationId": "conversations_create", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.create" + } + } + }, + "/conversations.history": { + "get": { + "description": "Fetches a conversation's history of messages and events.", + "tags": [ + "conversations" + ], "responses": { "200": { + "description": "Typical success response containing a channel's messages", "content": { "application/json": { - "examples": { - "response": { - "value": { - "has_more": true, - "messages": [ - { - "text": "I find you punny and would like to smell your nose letter", - "ts": "1512085950.000216", - "type": "message", - "user": "U012AB3CDE" - }, - { - "text": "What, you want to smell my shoes better?", - "ts": "1512104434.000490", - "type": "message", - "user": "U061F7AUR" - } - ], - "ok": true, - "pin_count": 0, - "response_metadata": { - "next_cursor": "bmV4dF90czoxNTEyMDg1ODYxMDAwNTQz" - } - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsHistorySuccessSchema", + "type": "object", "description": "Schema for successful response from conversations.history method", + "additionalProperties": false, "properties": { "channel_actions_count": { "type": "integer" @@ -11240,28 +11130,46 @@ "pin_count", "channel_actions_ts", "channel_actions_count" - ], - "title": "conversations.history success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "has_more": true, + "messages": [ + { + "text": "I find you punny and would like to smell your nose letter", + "ts": "1512085950.000216", + "type": "message", + "user": "U012AB3CDE" + }, + { + "text": "What, you want to smell my shoes better?", + "ts": "1512104434.000490", + "type": "message", + "user": "U061F7AUR" + } + ], + "ok": true, + "pin_count": 0, + "response_metadata": { + "next_cursor": "bmV4dF90czoxNTEyMDg1ODYxMDAwNTQz" + } + } + } } } - }, - "description": "Typical success response containing a channel's messages" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "channel_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsHistoryErrorSchema", + "type": "object", "description": "Schema for error response from conversations.history method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -11302,13 +11210,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.history error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "channel_not_found", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -11321,22 +11234,14 @@ ] } ], - "tags": [ - "conversations" - ] - } - }, - "/conversations.info": { - "get": { - "description": "Retrieve information about a conversation.", + "operationId": "conversations_history", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.info" + "url": "https://api.slack.com/methods/conversations.history" }, - "operationId": "conversations_info", "parameters": [ { - "description": "Conversation ID to learn more about", + "description": "Conversation ID to fetch history for.", "in": "query", "name": "channel", "schema": { @@ -11344,26 +11249,77 @@ } }, { - "description": "Set this to `true` to receive the locale for this conversation. Defaults to `false`", + "description": "End of time range of messages to include in results.", "in": "query", - "name": "include_locale", + "name": "latest", "schema": { - "type": "boolean" + "type": "number" } }, { - "description": "Set to `true` to include the member count for the specified conversation. Defaults to `false`", + "description": "Start of time range of messages to include in results.", "in": "query", - "name": "include_num_members", + "name": "oldest", + "schema": { + "type": "number" + } + }, + { + "description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", + "in": "query", + "name": "inclusive", "schema": { "type": "boolean" } + }, + { + "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + }, + { + "description": "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](\/docs\/pagination) for more detail.", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } } + ] + } + }, + "/conversations.info": { + "get": { + "description": "Retrieve information about a conversation.", + "tags": [ + "conversations" ], "responses": { "200": { + "description": "Typical success response for a public channel. (Also, a response from a private channel and a multi-party IM is very similar to this example.)", "content": { "application/json": { + "schema": { + "title": "ConversationsInfoSuccessSchema", + "type": "object", + "description": "Schema for successful response conversations.info", + "additionalProperties": false, + "properties": { + "channel": { + "$ref": "#/components/schemas/objs_conversation" + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok", + "channel" + ] + }, "examples": { "response": { "value": { @@ -11410,43 +11366,19 @@ "ok": true } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response conversations.info", - "properties": { - "channel": { - "$ref": "#/components/schemas/objs_conversation" - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok", - "channel" - ], - "title": "conversations.info success schema", - "type": "object" } } - }, - "description": "Typical success response for a public channel. (Also, a response from a private channel and a multi-party IM is very similar to this example.)" + } }, "default": { + "description": "Typical error response when a channel cannot be found", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "channel_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsInfoErrorSchema", + "type": "object", "description": "Schema for error response from conversations.info method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -11486,38 +11418,69 @@ "required": [ "ok", "error" - ], - "title": "conversations.info error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "channel_not_found", + "ok": false + } + } } } - }, - "description": "Typical error response when a channel cannot be found" + } } }, "security": [ { - "slackAuth": [ - "channels:read", - "groups:read", - "im:read", - "mpim:read" - ] + "slackAuth": [ + "channels:read", + "groups:read", + "im:read", + "mpim:read" + ] + } + ], + "operationId": "conversations_info", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.info" + }, + "parameters": [ + { + "description": "Conversation ID to learn more about", + "in": "query", + "name": "channel", + "schema": { + "type": "string" + } + }, + { + "description": "Set this to `true` to receive the locale for this conversation. Defaults to `false`", + "in": "query", + "name": "include_locale", + "schema": { + "type": "boolean" + } + }, + { + "description": "Set to `true` to include the member count for the specified conversation. Defaults to `false`", + "in": "query", + "name": "include_num_members", + "schema": { + "type": "boolean" + } } - ], - "tags": [ - "conversations" ] } }, "/conversations.invite": { "post": { "description": "Invites users to a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.invite" - }, - "operationId": "conversations_invite", + "tags": [ + "conversations" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -11539,8 +11502,27 @@ }, "responses": { "200": { + "description": "Typical success response when an invitation is extended", "content": { "application/json": { + "schema": { + "title": "ConversationsInviteErrorSchema", + "type": "object", + "description": "Schema for successful response from conversations.invite method", + "additionalProperties": false, + "properties": { + "channel": { + "$ref": "#/components/schemas/objs_conversation" + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok", + "channel" + ] + }, "examples": { "response": { "value": { @@ -11587,43 +11569,19 @@ "ok": true } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.invite method", - "properties": { - "channel": { - "$ref": "#/components/schemas/objs_conversation" - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok", - "channel" - ], - "title": "conversations.invite error schema", - "type": "object" } } - }, - "description": "Typical success response when an invitation is extended" + } }, "default": { + "description": "Typical error response when an invite is attempted on a conversation type that does not support it", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "method_not_supported_for_channel_type", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsInviteErrorSchema", + "type": "object", "description": "Schema for error response from conversations.invite method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -11735,13 +11693,18 @@ }, "required": [ "ok" - ], - "title": "conversations.invite error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "method_not_supported_for_channel_type", + "ok": false + } + } } } - }, - "description": "Typical error response when an invite is attempted on a conversation type that does not support it" + } } }, "security": [ @@ -11754,19 +11717,19 @@ ] } ], - "tags": [ - "conversations" - ] + "operationId": "conversations_invite", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.invite" + } } }, "/conversations.join": { "post": { "description": "Joins an existing conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.join" - }, - "operationId": "conversations_join", + "tags": [ + "conversations" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -11784,8 +11747,44 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "ConversationsJoinSuccessSchema", + "type": "object", + "description": "Schema for successful response from conversations.join method", + "additionalProperties": false, + "properties": { + "channel": { + "$ref": "#/components/schemas/objs_conversation" + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "response_metadata": { + "properties": { + "warnings": { + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "title": "Response metadata", + "type": "object" + }, + "warning": { + "type": "string" + } + }, + "required": [ + "ok", + "channel" + ] + }, "examples": { "response": { "value": { @@ -11830,60 +11829,19 @@ "warning": "already_in_channel" } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.join method", - "properties": { - "channel": { - "$ref": "#/components/schemas/objs_conversation" - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "response_metadata": { - "properties": { - "warnings": { - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - } - }, - "title": "Response metadata", - "type": "object" - }, - "warning": { - "type": "string" - } - }, - "required": [ - "ok", - "channel" - ], - "title": "conversations.join success schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response if the conversation is archived and cannot be joined", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "is_archived", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsJoinErrorSchema", + "type": "object", "description": "Schema for error response from conversations.join method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -11930,13 +11888,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.join error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "is_archived", + "ok": false + } + } } } - }, - "description": "Typical error response if the conversation is archived and cannot be joined" + } } }, "security": [ @@ -11946,19 +11909,19 @@ ] } ], - "tags": [ - "conversations" - ] + "operationId": "conversations_join", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.join" + } } }, "/conversations.kick": { "post": { "description": "Removes a user from a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.kick" - }, - "operationId": "conversations_kick", + "tags": [ + "conversations" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -11980,18 +11943,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsKickSuccessSchema", + "type": "object", "description": "Schema for successful response conversations.kick method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -11999,28 +11958,27 @@ }, "required": [ "ok" - ], - "title": "conversations.kick success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response when you attempt to kick yourself from a channel", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "cant_kick_self", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsKickErrorSchema", + "type": "object", "description": "Schema for error response conversations.kick method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -12067,13 +12025,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.kick error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "cant_kick_self", + "ok": false + } + } } } - }, - "description": "Typical error response when you attempt to kick yourself from a channel" + } } }, "security": [ @@ -12086,19 +12049,19 @@ ] } ], - "tags": [ - "conversations" - ] + "operationId": "conversations_kick", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.kick" + } } }, "/conversations.leave": { "post": { "description": "Leaves a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.leave" - }, - "operationId": "conversations_leave", + "tags": [ + "conversations" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -12116,18 +12079,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsLeaveSuccessSchema", + "type": "object", "description": "Schema for successful response from conversations.leave method", + "additionalProperties": false, "properties": { "not_in_channel": { "enum": [ @@ -12141,28 +12100,27 @@ }, "required": [ "ok" - ], - "title": "conversations.leave success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response when attempting to leave a workspace's \"general\" channel", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "cant_leave_general", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsLeaveErrorSchema", + "type": "object", "description": "Schema for error response from conversations.leave method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -12211,13 +12169,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.leave error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "cant_leave_general", + "ok": false + } + } } } - }, - "description": "Typical error response when attempting to leave a workspace's \"general\" channel" + } } }, "security": [ @@ -12230,57 +12193,58 @@ ] } ], - "tags": [ - "conversations" - ] + "operationId": "conversations_leave", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.leave" + } } }, "/conversations.list": { "get": { "description": "Lists all channels in a Slack team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.list" - }, - "operationId": "conversations_list", - "parameters": [ - { - "description": "Set to `true` to exclude archived channels from the list", - "in": "query", - "name": "exclude_archived", - "schema": { - "type": "boolean" - } - }, - { - "description": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`", - "in": "query", - "name": "types", - "schema": { - "type": "string" - } - }, - { - "description": "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.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } - }, - { - "description": "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](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - } + "tags": [ + "conversations" ], "responses": { "200": { + "description": "Typical success response with only public channels", "content": { "application/json": { + "schema": { + "title": "ConversationsListSuccessSchema", + "type": "object", + "description": "Schema for successful response from conversations.list method", + "additionalProperties": false, + "properties": { + "channels": { + "items": { + "$ref": "#/components/schemas/objs_conversation" + }, + "type": "array", + "uniqueItems": true + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "response_metadata": { + "additionalProperties": false, + "properties": { + "next_cursor": { + "type": "string" + } + }, + "required": [ + "next_cursor" + ], + "type": "object" + } + }, + "required": [ + "ok", + "channels" + ] + }, "examples": { "response": { "value": { @@ -12358,59 +12322,19 @@ } } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.list method", - "properties": { - "channels": { - "items": { - "$ref": "#/components/schemas/objs_conversation" - }, - "type": "array", - "uniqueItems": true - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "response_metadata": { - "additionalProperties": false, - "properties": { - "next_cursor": { - "type": "string" - } - }, - "required": [ - "next_cursor" - ], - "type": "object" - } - }, - "required": [ - "ok", - "channels" - ], - "title": "conversations.list success schema", - "type": "object" } } - }, - "description": "Typical success response with only public channels" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsListErrorSchema", + "type": "object", "description": "Schema for error response from conversations.list method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -12448,13 +12372,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.list error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -12467,19 +12396,53 @@ ] } ], - "tags": [ - "conversations" + "operationId": "conversations_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.list" + }, + "parameters": [ + { + "description": "Set to `true` to exclude archived channels from the list", + "in": "query", + "name": "exclude_archived", + "schema": { + "type": "boolean" + } + }, + { + "description": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`", + "in": "query", + "name": "types", + "schema": { + "type": "string" + } + }, + { + "description": "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.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + }, + { + "description": "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](\/docs\/pagination) for more detail.", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + } ] } }, "/conversations.mark": { "post": { "description": "Sets the read cursor in a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.mark" - }, - "operationId": "conversations_mark", + "tags": [ + "conversations" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -12501,18 +12464,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsMarkSuccessSchema", + "type": "object", "description": "Schema for successful response conversations.mark method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -12520,28 +12479,27 @@ }, "required": [ "ok" - ], - "title": "conversations.mark success schema", - "type": "object" - } - } - }, - "description": "Typical success response" - }, - "default": { - "content": { - "application/json": { + ] + }, "examples": { "response": { "value": { - "error": "invalid_auth", - "ok": false + "ok": true } } - }, + } + } + } + }, + "default": { + "description": "Typical error response", + "content": { + "application/json": { "schema": { - "additionalProperties": false, + "title": "ConversationsMarkErrorSchema", + "type": "object", "description": "Schema for error response from conversations.mark method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -12584,13 +12542,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.mark error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -12603,67 +12566,29 @@ ] } ], - "tags": [ - "conversations" - ] + "operationId": "conversations_mark", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.mark" + } } }, "/conversations.members": { "get": { "description": "Retrieve members of a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.members" - }, - "operationId": "conversations_members", - "parameters": [ - { - "description": "ID of the conversation to retrieve members for", - "in": "query", - "name": "channel", - "schema": { - "type": "string" - } - }, - { - "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } - }, - { - "description": "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](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - } + "tags": [ + "conversations" ], "responses": { "200": { + "description": "Typical paginated success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "members": [ - "U023BECGF", - "U061F7AUR", - "W012A3CDE" - ], - "ok": true, - "response_metadata": { - "next_cursor": "e3VzZXJfaWQ6IFcxMjM0NTY3fQ==" - } - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsMembersSuccessSchema", + "type": "object", "description": "Schema for successful response conversations.members method", + "additionalProperties": false, "properties": { "members": { "items": { @@ -12693,28 +12618,35 @@ "ok", "members", "response_metadata" - ], - "title": "conversations.members success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "members": [ + "U023BECGF", + "U061F7AUR", + "W012A3CDE" + ], + "ok": true, + "response_metadata": { + "next_cursor": "e3VzZXJfaWQ6IFcxMjM0NTY3fQ==" + } + } + } } } - }, - "description": "Typical paginated success response" + } }, "default": { + "description": "Typical error response when an invalid cursor is provided", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_cursor", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsMembersErrorSchema", + "type": "object", "description": "Schema for error response conversations.members method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -12750,13 +12682,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.members error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_cursor", + "ok": false + } + } } } - }, - "description": "Typical error response when an invalid cursor is provided" + } } }, "security": [ @@ -12769,19 +12706,45 @@ ] } ], - "tags": [ - "conversations" + "operationId": "conversations_members", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.members" + }, + "parameters": [ + { + "description": "ID of the conversation to retrieve members for", + "in": "query", + "name": "channel", + "schema": { + "type": "string" + } + }, + { + "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + }, + { + "description": "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](\/docs\/pagination) for more detail.", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + } ] } }, "/conversations.open": { "post": { "description": "Opens or resumes a direct message or multi-person direct message.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.open" - }, - "operationId": "conversations_open", + "tags": [ + "conversations" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -12807,21 +12770,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "channel": { - "id": "D069C7QFK" - }, - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsOpenSuccessSchema", + "type": "object", "description": "Schema for successful response from conversations.open method when opening channels, ims, mpims", + "additionalProperties": false, "properties": { "already_open": { "type": "boolean" @@ -12881,28 +12837,30 @@ "required": [ "ok", "channel" - ], - "title": "conversations.open success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "channel": { + "id": "D069C7QFK" + }, + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "channel_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsOpenErrorSchema", + "type": "object", "description": "Schema for error response from conversations.open method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -12943,13 +12901,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.open error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "channel_not_found", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -12962,19 +12925,19 @@ ] } ], - "tags": [ - "conversations" - ] + "operationId": "conversations_open", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.open" + } } }, "/conversations.rename": { "post": { "description": "Renames a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.rename" - }, - "operationId": "conversations_rename", + "tags": [ + "conversations" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -12996,8 +12959,27 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "ConversationsRenameSuccessSchema", + "type": "object", + "description": "Schema for successful response from conversations.rename method", + "additionalProperties": false, + "properties": { + "channel": { + "$ref": "#/components/schemas/objs_conversation" + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok", + "channel" + ] + }, "examples": { "response": { "value": { @@ -13033,54 +13015,30 @@ "creator": "W012A3BCD", "last_set": 1449709364, "value": "This part of the workspace is for fun. Make fun here." - }, - "topic": { - "creator": "W012A3BCD", - "last_set": 1449709364, - "value": "For public discussion of generalities" - }, - "unlinked": 0 - }, - "ok": true - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from conversations.rename method", - "properties": { - "channel": { - "$ref": "#/components/schemas/objs_conversation" - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" + }, + "topic": { + "creator": "W012A3BCD", + "last_set": 1449709364, + "value": "For public discussion of generalities" + }, + "unlinked": 0 + }, + "ok": true } - }, - "required": [ - "ok", - "channel" - ], - "title": "conversations.rename success schema", - "type": "object" + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response when the calling user is not a member of the conversation", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "not_in_channel", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsRenameErrorSchema", + "type": "object", "description": "Schema for error response from conversations.rename method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -13129,13 +13087,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.rename error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "not_in_channel", + "ok": false + } + } } } - }, - "description": "Typical error response when the calling user is not a member of the conversation" + } } }, "security": [ @@ -13148,132 +13111,29 @@ ] } ], - "tags": [ - "conversations" - ] + "operationId": "conversations_rename", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.rename" + } } }, "/conversations.replies": { "get": { "description": "Retrieve a thread of messages posted to a conversation", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.replies" - }, - "operationId": "conversations_replies", - "parameters": [ - { - "description": "Conversation ID to fetch thread from.", - "in": "query", - "name": "channel", - "schema": { - "type": "string" - } - }, - { - "description": "Unique identifier of a thread's parent message. `ts` must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by `ts` will return - it is just an ordinary, unthreaded message.", - "in": "query", - "name": "ts", - "schema": { - "type": "number" - } - }, - { - "description": "End of time range of messages to include in results.", - "in": "query", - "name": "latest", - "schema": { - "type": "number" - } - }, - { - "description": "Start of time range of messages to include in results.", - "in": "query", - "name": "oldest", - "schema": { - "type": "number" - } - }, - { - "description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", - "in": "query", - "name": "inclusive", - "schema": { - "type": "boolean" - } - }, - { - "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } - }, - { - "description": "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](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - } + "tags": [ + "conversations" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "has_more": true, - "messages": [ - { - "last_read": "1484678597.521003", - "reply_count": 3, - "subscribed": true, - "text": "island", - "thread_ts": "1482960137.003543", - "ts": "1482960137.003543", - "type": "message", - "unread_count": 0, - "user": "U061F7AUR" - }, - { - "parent_user_id": "U061F7AUR", - "text": "one island", - "thread_ts": "1482960137.003543", - "ts": "1483037603.017503", - "type": "message", - "user": "U061F7AUR" - }, - { - "parent_user_id": "U061F7AUR", - "text": "two island", - "thread_ts": "1482960137.003543", - "ts": "1483051909.018632", - "type": "message", - "user": "U061F7AUR" - }, - { - "parent_user_id": "U061F7AUR", - "text": "three for the land", - "thread_ts": "1482960137.003543", - "ts": "1483125339.020269", - "type": "message", - "user": "U061F7AUR" - } - ], - "ok": true, - "response_metadata": { - "next_cursor": "bmV4dF90czoxNDg0Njc4MjkwNTE3MDkx" - } - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsRepliesSuccessSchema", + "type": "object", "description": "Schema for successful response from conversations.replies method", + "additionalProperties": false, "properties": { "has_more": { "type": "boolean" @@ -13408,28 +13268,68 @@ "required": [ "ok", "messages" - ], - "title": "conversations.replies success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "has_more": true, + "messages": [ + { + "last_read": "1484678597.521003", + "reply_count": 3, + "subscribed": true, + "text": "island", + "thread_ts": "1482960137.003543", + "ts": "1482960137.003543", + "type": "message", + "unread_count": 0, + "user": "U061F7AUR" + }, + { + "parent_user_id": "U061F7AUR", + "text": "one island", + "thread_ts": "1482960137.003543", + "ts": "1483037603.017503", + "type": "message", + "user": "U061F7AUR" + }, + { + "parent_user_id": "U061F7AUR", + "text": "two island", + "thread_ts": "1482960137.003543", + "ts": "1483051909.018632", + "type": "message", + "user": "U061F7AUR" + }, + { + "parent_user_id": "U061F7AUR", + "text": "three for the land", + "thread_ts": "1482960137.003543", + "ts": "1483125339.020269", + "type": "message", + "user": "U061F7AUR" + } + ], + "ok": true, + "response_metadata": { + "next_cursor": "bmV4dF90czoxNDg0Njc4MjkwNTE3MDkx" + } + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "thread_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsRepliesErrorSchema", + "type": "object", "description": "Schema for error response from conversations.replies method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -13470,38 +13370,101 @@ "required": [ "ok", "error" - ], - "title": "conversations.replies error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "thread_not_found", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ { - "slackAuth": [ - "channels:history", - "groups:history", - "im:history", - "mpim:history" - ] + "slackAuth": [ + "channels:history", + "groups:history", + "im:history", + "mpim:history" + ] + } + ], + "operationId": "conversations_replies", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.replies" + }, + "parameters": [ + { + "description": "Conversation ID to fetch thread from.", + "in": "query", + "name": "channel", + "schema": { + "type": "string" + } + }, + { + "description": "Unique identifier of a thread's parent message. `ts` must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by `ts` will return - it is just an ordinary, unthreaded message.", + "in": "query", + "name": "ts", + "schema": { + "type": "number" + } + }, + { + "description": "End of time range of messages to include in results.", + "in": "query", + "name": "latest", + "schema": { + "type": "number" + } + }, + { + "description": "Start of time range of messages to include in results.", + "in": "query", + "name": "oldest", + "schema": { + "type": "number" + } + }, + { + "description": "Include messages with latest or oldest timestamp in results only when either timestamp is specified.", + "in": "query", + "name": "inclusive", + "schema": { + "type": "boolean" + } + }, + { + "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + }, + { + "description": "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](\/docs\/pagination) for more detail.", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } } - ], - "tags": [ - "conversations" ] } }, "/conversations.setPurpose": { "post": { "description": "Sets the purpose for a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.setPurpose" - }, - "operationId": "conversations_setPurpose", + "tags": [ + "conversations" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -13523,18 +13486,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsSetPurposeSuccessSchema", + "type": "object", "description": "Schema for successful response from conversations.setPurpose method", + "additionalProperties": false, "properties": { "channel": { "$ref": "#/components/schemas/objs_conversation" @@ -13546,28 +13505,27 @@ "required": [ "ok", "channel" - ], - "title": "conversations.setPurpose success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsSetPurposeErrorSchema", + "type": "object", "description": "Schema for error response from conversations.setPurpose method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -13612,13 +13570,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.setPurpose error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -13631,19 +13594,19 @@ ] } ], - "tags": [ - "conversations" - ] + "operationId": "conversations_setPurpose", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.setPurpose" + } } }, "/conversations.setTopic": { "post": { "description": "Sets the topic for a conversation.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.setTopic" - }, - "operationId": "conversations_setTopic", + "tags": [ + "conversations" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -13665,18 +13628,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsSetTopicSuccessSchema", + "type": "object", "description": "Schema for successful response from conversations.setTopic method", + "additionalProperties": false, "properties": { "channel": { "$ref": "#/components/schemas/objs_conversation" @@ -13688,28 +13647,27 @@ "required": [ "ok", "channel" - ], - "title": "conversations.setTopic success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsSetTopicErrorSchema", + "type": "object", "description": "Schema for error response from conversations.setTopic method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -13754,13 +13712,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.setTopic error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -13773,19 +13736,19 @@ ] } ], - "tags": [ - "conversations" - ] + "operationId": "conversations_setTopic", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.setTopic" + } } }, "/conversations.unarchive": { "post": { "description": "Reverses conversation archival.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/conversations.unarchive" - }, - "operationId": "conversations_unarchive", + "tags": [ + "conversations" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -13803,18 +13766,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsUnarchiveSuccessSchema", + "type": "object", "description": "Schema for successful response from conversations.unarchive method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -13822,28 +13781,27 @@ }, "required": [ "ok" - ], - "title": "conversations.unarchive success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "channel_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ConversationsUnarchiveErrorSchema", + "type": "object", "description": "Schema for error response from conversations.unarchive method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -13890,13 +13848,18 @@ "required": [ "ok", "error" - ], - "title": "conversations.unarchive error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "channel_not_found", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -13906,56 +13869,32 @@ "groups:write", "im:write", "mpim:write" - ] - } - ], - "tags": [ - "conversations" - ] - } - }, - "/dialog.open": { - "get": { - "description": "Open a dialog with a user", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/dialog.open" - }, - "operationId": "dialog_open", - "parameters": [ - { - "description": "The dialog definition. This must be a JSON-encoded string.", - "in": "query", - "name": "dialog", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Exchange a trigger to post to the user.", - "in": "query", - "name": "trigger_id", - "required": true, - "schema": { - "type": "string" - } + ] } ], + "operationId": "conversations_unarchive", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/conversations.unarchive" + } + } + }, + "/dialog.open": { + "get": { + "description": "Open a dialog with a user", + "tags": [ + "dialog" + ], "responses": { "200": { + "description": "Typical success response is quite minimal.", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "DialogOpenSchema", + "type": "object", "description": "Schema for successful response from dialog.open method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -13963,28 +13902,27 @@ }, "required": [ "ok" - ], - "title": "dialog.open schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response is quite minimal." + } }, "default": { + "description": "Typical error response, before getting to any possible validation errors.", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "missing_trigger", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "DialogOpenErrorSchema", + "type": "object", "description": "Schema for error response from dialog.open method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -14029,13 +13967,18 @@ "required": [ "ok", "error" - ], - "title": "dialog.open error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "missing_trigger", + "ok": false + } + } } } - }, - "description": "Typical error response, before getting to any possible validation errors." + } } }, "security": [ @@ -14045,33 +13988,49 @@ ] } ], - "tags": [ - "dialog" + "operationId": "dialog_open", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/dialog.open" + }, + "parameters": [ + { + "description": "The dialog definition. This must be a JSON-encoded string.", + "in": "query", + "name": "dialog", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Exchange a trigger to post to the user.", + "in": "query", + "name": "trigger_id", + "required": true, + "schema": { + "type": "string" + } + } ] } }, "/dnd.endDnd": { "post": { "description": "Ends the current user's Do Not Disturb session immediately.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/dnd.endDnd" - }, - "operationId": "dnd_endDnd", + "tags": [ + "dnd" + ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "DndEndDndSchema", + "type": "object", "description": "Schema for successful response from dnd.endDnd method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -14079,28 +14038,27 @@ }, "required": [ "ok" - ], - "title": "dnd.endDnd schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "DndEndDndErrorSchema", + "type": "object", "description": "Schema for error response from dnd.endDnd method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -14138,13 +14096,18 @@ "required": [ "ok", "error" - ], - "title": "dnd.endDnd error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -14154,33 +14117,29 @@ ] } ], - "tags": [ - "dnd" - ] + "operationId": "dnd_endDnd", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/dnd.endDnd" + } } }, "/dnd.endSnooze": { "post": { "description": "Ends the current user's snooze mode immediately.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/dnd.endSnooze" - }, - "operationId": "dnd_endSnooze", + "tags": [ + "dnd" + ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "DndEndSnoozeSchema", + "type": "object", "description": "Schema for successful response from dnd.endSnooze method", + "additionalProperties": false, "properties": { "dnd_enabled": { "type": "boolean" @@ -14204,28 +14163,27 @@ "next_dnd_start_ts", "next_dnd_end_ts", "snooze_enabled" - ], - "title": "dnd.endSnooze schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "DndEndSnoozeErrorSchema", + "type": "object", "description": "Schema for error response from dnd.endSnooze method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -14264,13 +14222,18 @@ "required": [ "ok", "error" - ], - "title": "dnd.endSnooze error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -14280,43 +14243,29 @@ ] } ], - "tags": [ - "dnd" - ] + "operationId": "dnd_endSnooze", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/dnd.endSnooze" + } } }, "/dnd.info": { "get": { "description": "Retrieves a user's current Do Not Disturb status.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/dnd.info" - }, - "operationId": "dnd_info", - "parameters": [ - { - "description": "User to fetch status for (defaults to current user)", - "in": "query", - "name": "user", - "schema": { - "type": "string" - } - } + "tags": [ + "dnd" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "DndInfoSchema", + "type": "object", "description": "Schema for successful response from dnd.info method", + "additionalProperties": false, "properties": { "dnd_enabled": { "type": "boolean" @@ -14345,28 +14294,27 @@ "dnd_enabled", "next_dnd_start_ts", "next_dnd_end_ts" - ], - "title": "dnd.info schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "DndInfoErrorSchema", + "type": "object", "description": "Schema for error response from dnd.info method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -14403,13 +14351,18 @@ "required": [ "ok", "error" - ], - "title": "dnd.info error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -14419,19 +14372,29 @@ ] } ], - "tags": [ - "dnd" + "operationId": "dnd_info", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/dnd.info" + }, + "parameters": [ + { + "description": "User to fetch status for (defaults to current user)", + "in": "query", + "name": "user", + "schema": { + "type": "string" + } + } ] } }, "/dnd.setSnooze": { "post": { "description": "Turns on Do Not Disturb mode for the current user, or changes its duration.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/dnd.setSnooze" - }, - "operationId": "dnd_setSnooze", + "tags": [ + "dnd" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -14458,18 +14421,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "DndSetSnoozeSchema", + "type": "object", "description": "Schema for successful response from dnd.setSnooze method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -14489,28 +14448,27 @@ "snooze_enabled", "snooze_endtime", "snooze_remaining" - ], - "title": "dnd.setSnooze schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "DndSetSnoozeErrorSchema", + "type": "object", "description": "Schema for error response from dnd.setSnooze method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -14550,13 +14508,18 @@ "required": [ "ok", "error" - ], - "title": "dnd.setSnooze error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -14566,33 +14529,38 @@ ] } ], - "tags": [ - "dnd" - ] + "operationId": "dnd_setSnooze", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/dnd.setSnooze" + } } }, "/dnd.teamInfo": { "get": { "description": "Retrieves the Do Not Disturb status for up to 50 users on a team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/dnd.teamInfo" - }, - "operationId": "dnd_teamInfo", - "parameters": [ - { - "description": "Comma-separated list of users to fetch Do Not Disturb status for", - "in": "query", - "name": "users", - "schema": { - "type": "string" - } - } + "tags": [ + "dnd" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -14611,39 +14579,19 @@ } } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -14651,13 +14599,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -14667,33 +14620,39 @@ ] } ], - "tags": [ - "dnd" + "operationId": "dnd_teamInfo", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/dnd.teamInfo" + }, + "parameters": [ + { + "description": "Comma-separated list of users to fetch Do Not Disturb status for", + "in": "query", + "name": "users", + "schema": { + "type": "string" + } + } ] } }, "/emoji.list": { "get": { "description": "Lists custom emoji for a team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/emoji.list" - }, - "operationId": "emoji_list", + "tags": [ + "emoji" + ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -14701,28 +14660,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -14730,13 +14688,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -14746,19 +14709,20 @@ ] } ], - "tags": [ - "emoji" - ] + "operationId": "emoji_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/emoji.list" + } } }, "/files.comments.delete": { "post": { "description": "Deletes an existing comment on a file.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.comments.delete" - }, - "operationId": "files_comments_delete", + "tags": [ + "files.comments", + "files" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -14780,18 +14744,14 @@ }, "responses": { "200": { + "description": "Standard success response is very simple", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "FilesCommentsDeleteSchema", + "type": "object", "description": "Schema for successful response files.comments.delete method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -14799,28 +14759,27 @@ }, "required": [ "ok" - ], - "title": "files.comments.delete schema", - "type": "object" - } - } - }, - "description": "Standard success response is very simple" - }, - "default": { - "content": { - "application/json": { + ] + }, "examples": { "response": { "value": { - "error": "file_not_found", - "ok": false + "ok": true } } - }, + } + } + } + }, + "default": { + "description": "Standard failure response when used with an invalid token", + "content": { + "application/json": { "schema": { - "additionalProperties": false, + "title": "FilesCommentsDeleteErrorSchema", + "type": "object", "description": "Schema for error response files.comments.delete method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -14854,13 +14813,18 @@ "required": [ "ok", "error" - ], - "title": "files.comments.delete error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "file_not_found", + "ok": false + } + } } } - }, - "description": "Standard failure response when used with an invalid token" + } } }, "security": [ @@ -14870,20 +14834,19 @@ ] } ], - "tags": [ - "files.comments", - "files" - ] + "operationId": "files_comments_delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/files.comments.delete" + } } }, "/files.delete": { "post": { "description": "Deletes a file.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.delete" - }, - "operationId": "files_delete", + "tags": [ + "files" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -14901,18 +14864,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "FilesDeleteSchema", + "type": "object", "description": "Schema for successful response files.delete method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -14920,28 +14879,27 @@ }, "required": [ "ok" - ], - "title": "files.delete schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "FilesDeleteErrorSchema", + "type": "object", "description": "Schema for error response files.delete method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -14977,13 +14935,18 @@ "required": [ "ok", "error" - ], - "title": "files.delete error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -14993,63 +14956,58 @@ ] } ], - "tags": [ - "files" - ] + "operationId": "files_delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/files.delete" + } } }, "/files.info": { "get": { "description": "Gets information about a file.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.info" - }, - "operationId": "files_info", - "parameters": [ - { - "description": "Specify a file by providing its ID.", - "in": "query", - "name": "file", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "count", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "schema": { - "type": "string" - } - }, - { - "description": "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.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } - }, - { - "description": "Parameter for pagination. File comments are paginated for a single file. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection of comments. See [pagination](/docs/pagination) for more details.", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - } + "tags": [ + "files" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "FilesInfoSchema", + "type": "object", + "description": "Schema for successful response from files.info method", + "additionalProperties": false, + "properties": { + "comments": { + "$ref": "#/components/schemas/objs_comments" + }, + "content_html": { + "nullable": true + }, + "editor": { + "$ref": "#/components/schemas/defs_user_id" + }, + "file": { + "$ref": "#/components/schemas/objs_file" + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "paging": { + "$ref": "#/components/schemas/objs_paging" + }, + "response_metadata": { + "$ref": "#/components/schemas/objs_response_metadata" + } + }, + "required": [ + "ok", + "file", + "comments" + ] + }, "examples": { "response": { "value": { @@ -15122,59 +15080,19 @@ } } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from files.info method", - "properties": { - "comments": { - "$ref": "#/components/schemas/objs_comments" - }, - "content_html": { - "nullable": true - }, - "editor": { - "$ref": "#/components/schemas/defs_user_id" - }, - "file": { - "$ref": "#/components/schemas/objs_file" - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "paging": { - "$ref": "#/components/schemas/objs_paging" - }, - "response_metadata": { - "$ref": "#/components/schemas/objs_response_metadata" - } - }, - "required": [ - "ok", - "file", - "comments" - ], - "title": "files.info schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "FilesInfoErrorSchema", + "type": "object", "description": "Schema for error response from files.info method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -15210,13 +15128,18 @@ "required": [ "ok", "error" - ], - "title": "files.info error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -15225,88 +15148,92 @@ "files:read" ] } - ], - "tags": [ - "files" - ] - } - }, - "/files.list": { - "get": { - "description": "List for a team, in a channel, or from a user with applied filters.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.list" - }, - "operationId": "files_list", - "parameters": [ - { - "description": "Filter files created by a single user.", - "in": "query", - "name": "user", - "schema": { - "type": "string" - } - }, - { - "description": "Filter files appearing in a specific channel, indicated by its ID.", - "in": "query", - "name": "channel", - "schema": { - "type": "string" - } - }, - { - "description": "Filter files created after this timestamp (inclusive).", - "in": "query", - "name": "ts_from", - "schema": { - "type": "number" - } - }, + ], + "operationId": "files_info", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/files.info" + }, + "parameters": [ { - "description": "Filter files created before this timestamp (inclusive).", + "description": "Specify a file by providing its ID.", "in": "query", - "name": "ts_to", + "name": "file", "schema": { - "type": "number" + "type": "string" } }, { - "description": "Filter files by type ([see below](#file_types)). You can pass multiple values in the types argument, like `types=spaces,snippets`.The default value is `all`, which does not filter the list.", "in": "query", - "name": "types", + "name": "count", "schema": { "type": "string" } }, { "in": "query", - "name": "count", + "name": "page", "schema": { "type": "string" } }, { + "description": "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.", "in": "query", - "name": "page", + "name": "limit", "schema": { - "type": "string" + "type": "integer" } }, { - "description": "Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.", + "description": "Parameter for pagination. File comments are paginated for a single file. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection of comments. See [pagination](\/docs\/pagination) for more details.", "in": "query", - "name": "show_files_hidden_by_limit", + "name": "cursor", "schema": { - "type": "boolean" + "type": "string" } } + ] + } + }, + "/files.list": { + "get": { + "description": "List for a team, in a channel, or from a user with applied filters.", + "tags": [ + "files" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "FilesListSchema", + "type": "object", + "description": "Schema for successful response from files.list method", + "additionalProperties": false, + "properties": { + "files": { + "items": { + "$ref": "#/components/schemas/objs_file" + }, + "minItems": 0, + "type": "array", + "uniqueItems": true + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "paging": { + "$ref": "#/components/schemas/objs_paging" + } + }, + "required": [ + "ok", + "files", + "paging" + ] + }, "examples": { "response": { "value": { @@ -15405,52 +15332,19 @@ } } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from files.list method", - "properties": { - "files": { - "items": { - "$ref": "#/components/schemas/objs_file" - }, - "minItems": 0, - "type": "array", - "uniqueItems": true - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "paging": { - "$ref": "#/components/schemas/objs_paging" - } - }, - "required": [ - "ok", - "files", - "paging" - ], - "title": "files.list schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "FilesListErrorSchema", + "type": "object", "description": "Schema for error response from files.list method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -15486,13 +15380,18 @@ "required": [ "ok", "error" - ], - "title": "files.list error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -15502,19 +15401,84 @@ ] } ], - "tags": [ - "files" + "operationId": "files_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/files.list" + }, + "parameters": [ + { + "description": "Filter files created by a single user.", + "in": "query", + "name": "user", + "schema": { + "type": "string" + } + }, + { + "description": "Filter files appearing in a specific channel, indicated by its ID.", + "in": "query", + "name": "channel", + "schema": { + "type": "string" + } + }, + { + "description": "Filter files created after this timestamp (inclusive).", + "in": "query", + "name": "ts_from", + "schema": { + "type": "number" + } + }, + { + "description": "Filter files created before this timestamp (inclusive).", + "in": "query", + "name": "ts_to", + "schema": { + "type": "number" + } + }, + { + "description": "Filter files by type ([see below](#file_types)). You can pass multiple values in the types argument, like `types=spaces,snippets`.The default value is `all`, which does not filter the list.", + "in": "query", + "name": "types", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "count", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "type": "string" + } + }, + { + "description": "Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit.", + "in": "query", + "name": "show_files_hidden_by_limit", + "schema": { + "type": "boolean" + } + } ] } }, "/files.remote.add": { "post": { "description": "Adds a file from a remote service", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.remote.add" - }, - "operationId": "files_remote_add", + "tags": [ + "files.remote", + "files" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -15556,18 +15520,94 @@ }, "responses": { "200": { + "description": "Typical success response", + "content": { + "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } + } + } + } + }, + "default": { + "description": "Typical error response", + "content": { + "application/json": { + "schema": { + "title": "DefaultErrorTemplate", + "type": "object", + "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_false" + } + }, + "required": [ + "ok" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } + } + } + } + } + }, + "security": [ + { + "slackAuth": [ + "remote_files:write" + ] + } + ], + "operationId": "files_remote_add", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/files.remote.add" + } + } + }, + "/files.remote.info": { + "get": { + "description": "Retrieve information about a remote file added to Slack", + "tags": [ + "files.remote", + "files" + ], + "responses": { + "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -15575,28 +15615,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -15604,36 +15643,32 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ { "slackAuth": [ - "remote_files:write" + "remote_files:read" ] } ], - "tags": [ - "files.remote", - "files" - ] - } - }, - "/files.remote.info": { - "get": { - "description": "Retrieve information about a remote file added to Slack", + "operationId": "files_remote_info", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/files.remote.info" }, - "operationId": "files_remote_info", "parameters": [ { "description": "Specify a file by providing its ID.", @@ -15651,21 +15686,26 @@ "type": "string" } } + ] + } + }, + "/files.remote.list": { + "get": { + "description": "Retrieve information about a remote file added to Slack", + "tags": [ + "files.remote", + "files" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -15673,28 +15713,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -15702,13 +15741,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -15718,20 +15762,11 @@ ] } ], - "tags": [ - "files.remote", - "files" - ] - } - }, - "/files.remote.list": { - "get": { - "description": "Retrieve information about a remote file added to Slack", + "operationId": "files_remote_list", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/files.remote.list" }, - "operationId": "files_remote_list", "parameters": [ { "description": "Filter files appearing in a specific channel, indicated by its ID.", @@ -15766,28 +15801,56 @@ } }, { - "description": "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](/docs/pagination) for more detail.", + "description": "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](\/docs\/pagination) for more detail.", "in": "query", "name": "cursor", "schema": { "type": "string" } } + ] + } + }, + "/files.remote.remove": { + "post": { + "description": "Remove a remote file.", + "tags": [ + "files.remote", + "files" ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "external_id": { + "description": "Creator defined GUID for the file.", + "type": "string" + }, + "file": { + "description": "Specify a file by providing its ID.", + "type": "string" + }, + "token": { + "description": "Authentication token. Requires scope: `remote_files:write`", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -15795,28 +15858,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -15824,73 +15886,51 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ { "slackAuth": [ - "remote_files:read" + "remote_files:write" ] } ], - "tags": [ - "files.remote", - "files" - ] - } - }, - "/files.remote.remove": { - "post": { - "description": "Remove a remote file.", + "operationId": "files_remote_remove", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/files.remote.remove" - }, - "operationId": "files_remote_remove", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "external_id": { - "description": "Creator defined GUID for the file.", - "type": "string" - }, - "file": { - "description": "Specify a file by providing its ID.", - "type": "string" - }, - "token": { - "description": "Authentication token. Requires scope: `remote_files:write`", - "type": "string" - } - }, - "type": "object" - } - } - } - }, + } + } + }, + "/files.remote.share": { + "get": { + "description": "Share a remote file into a channel.", + "tags": [ + "files.remote", + "files" + ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -15898,28 +15938,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -15927,36 +15966,32 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ { "slackAuth": [ - "remote_files:write" + "remote_files:share" ] } ], - "tags": [ - "files.remote", - "files" - ] - } - }, - "/files.remote.share": { - "get": { - "description": "Share a remote file into a channel.", + "operationId": "files_remote_share", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/files.remote.share" }, - "operationId": "files_remote_share", "parameters": [ { "description": "Specify a file registered with Slack by providing its ID. Either this field or `external_id` or both are required.", @@ -15982,87 +16017,16 @@ "type": "string" } } - ], - "responses": { - "200": { - "content": { - "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" - } - } - }, - "description": "Typical success response" - }, - "default": { - "content": { - "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" - } - } - }, - "description": "Typical error response" - } - }, - "security": [ - { - "slackAuth": [ - "remote_files:share" - ] - } - ], - "tags": [ - "files.remote", - "files" ] } }, "/files.remote.update": { "post": { "description": "Updates an existing remote file.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.remote.update" - }, - "operationId": "files_remote_update", + "tags": [ + "files.remote", + "files" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -16108,18 +16072,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -16127,28 +16087,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -16156,13 +16115,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -16172,20 +16136,19 @@ ] } ], - "tags": [ - "files.remote", - "files" - ] + "operationId": "files_remote_update", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/files.remote.update" + } } }, "/files.revokePublicURL": { "post": { "description": "Revokes public/external sharing access for a file", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.revokePublicURL" - }, - "operationId": "files_revokePublicURL", + "tags": [ + "files" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -16203,18 +16166,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "FilesRevokePublicURLSchema", + "type": "object", "description": "Schema for successful response from files.revokePublicURL method", + "additionalProperties": false, "properties": { "file": { "$ref": "#/components/schemas/objs_file" @@ -16226,28 +16185,27 @@ "required": [ "ok", "file" - ], - "title": "files.revokePublicURL schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "FilesRevokePublicURLErrorSchema", + "type": "object", "description": "Schema for error response from files.revokePublicURL method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -16286,13 +16244,18 @@ "required": [ "ok", "error" - ], - "title": "files.revokePublicURL error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -16302,19 +16265,19 @@ ] } ], - "tags": [ - "files" - ] + "operationId": "files_revokePublicURL", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/files.revokePublicURL" + } } }, "/files.sharedPublicURL": { "post": { "description": "Enables a file for public/external sharing.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.sharedPublicURL" - }, - "operationId": "files_sharedPublicURL", + "tags": [ + "files" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -16332,18 +16295,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "FilesSharedPublicURLSchema", + "type": "object", "description": "Schema for successful response from files.sharedPublicURL method", + "additionalProperties": false, "properties": { "file": { "$ref": "#/components/schemas/objs_file" @@ -16355,28 +16314,27 @@ "required": [ "ok", "file" - ], - "title": "files.sharedPublicURL schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "FilesSharedPublicURLErrorSchema", + "type": "object", "description": "Schema for error response from files.sharedPublicURL method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -16416,13 +16374,18 @@ "required": [ "ok", "error" - ], - "title": "files.sharedPublicURL error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -16432,19 +16395,19 @@ ] } ], - "tags": [ - "files" - ] + "operationId": "files_sharedPublicURL", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/files.sharedPublicURL" + } } }, "/files.upload": { "post": { "description": "Uploads or creates a file.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/files.upload" - }, - "operationId": "files_upload", + "tags": [ + "files" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -16494,8 +16457,27 @@ }, "responses": { "200": { + "description": "Success response after uploading a file to a channel with an initial message", "content": { "application/json": { + "schema": { + "title": "FilesUploadSchema", + "type": "object", + "description": "Schema for successful response files.upload method", + "additionalProperties": false, + "properties": { + "file": { + "$ref": "#/components/schemas/objs_file" + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok", + "file" + ] + }, "examples": { "response": { "value": { @@ -16558,43 +16540,19 @@ "ok": true } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response files.upload method", - "properties": { - "file": { - "$ref": "#/components/schemas/objs_file" - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok", - "file" - ], - "title": "files.upload schema", - "type": "object" } } - }, - "description": "Success response after uploading a file to a channel with an initial message" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "FilesUploadErrorSchema", + "type": "object", "description": "Schema for error response files.upload method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -16632,13 +16590,18 @@ "required": [ "ok", "error" - ], - "title": "files.upload error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -16648,72 +16611,29 @@ ] } ], - "tags": [ - "files" - ] + "operationId": "files_upload", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/files.upload" + } } }, "/migration.exchange": { "get": { "description": "For Enterprise Grid workspaces, map local user IDs to global user IDs", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/migration.exchange" - }, - "operationId": "migration_exchange", - "parameters": [ - { - "description": "A comma-separated list of user ids, up to 400 per request", - "in": "query", - "name": "users", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Specify team_id starts with `T` in case of Org Token", - "in": "query", - "name": "team_id", - "schema": { - "type": "string" - } - }, - { - "description": "Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`.", - "in": "query", - "name": "to_old", - "schema": { - "type": "boolean" - } - } + "tags": [ + "migration" ], "responses": { "200": { + "description": "Typical success response when mappings exist for the specified user IDs", "content": { "application/json": { - "examples": { - "response": { - "value": { - "enterprise_id": "E1KQTNXE1", - "invalid_user_ids": [ - "U21ABZZXX" - ], - "ok": true, - "team_id": "T1KR7PE1W", - "user_id_map": { - "U06UBSUN5": "W06M56XJM", - "U06UBSVB3": "W06PUUDLY", - "U06UBSVDX": "W06PUUDMW", - "U06UEB62U": "W06PTT6GH", - "W06UAZ65Q": "W06UAZ65Q" - } - } - } - }, "schema": { - "additionalProperties": true, + "title": "MigrationExchangeSuccessSchema", + "type": "object", "description": "Schema for successful response from migration.exchange method", + "additionalProperties": true, "properties": { "enterprise_id": { "title": "The enterprise grid organization ID containing the workspace/team.", @@ -16742,28 +16662,39 @@ "ok", "team_id", "enterprise_id" - ], - "title": "migration.exchange success schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "enterprise_id": "E1KQTNXE1", + "invalid_user_ids": [ + "U21ABZZXX" + ], + "ok": true, + "team_id": "T1KR7PE1W", + "user_id_map": { + "U06UBSUN5": "W06M56XJM", + "U06UBSVB3": "W06PUUDLY", + "U06UBSVDX": "W06PUUDMW", + "U06UEB62U": "W06PTT6GH", + "W06UAZ65Q": "W06UAZ65Q" + } + } + } } } - }, - "description": "Typical success response when mappings exist for the specified user IDs" + } }, "default": { + "description": "Typical error response when there are no mappings to provide", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "not_enterprise_team", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "MigrationExchangeErrorSchema", + "type": "object", "description": "Schema for error response from migration.exchange method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -16801,81 +16732,86 @@ "required": [ "ok", "error" - ], - "title": "migration.exchange error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "not_enterprise_team", + "ok": false + } + } } } - }, - "description": "Typical error response when there are no mappings to provide" + } } }, "security": [ { "slackAuth": [ "tokens.basic" - ] - } - ], - "tags": [ - "migration" - ] - } - }, - "/oauth.access": { - "get": { - "description": "Exchanges a temporary OAuth verifier code for an access token.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/oauth.access" - }, - "operationId": "oauth_access", - "parameters": [ - { - "description": "Issued when you created your application.", - "in": "query", - "name": "client_id", - "schema": { - "type": "string" - } - }, - { - "description": "Issued when you created your application.", - "in": "query", - "name": "client_secret", - "schema": { - "type": "string" - } - }, + ] + } + ], + "operationId": "migration_exchange", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/migration.exchange" + }, + "parameters": [ { - "description": "The `code` param returned via the OAuth callback.", + "description": "A comma-separated list of user ids, up to 400 per request", "in": "query", - "name": "code", + "name": "users", + "required": true, "schema": { "type": "string" } }, { - "description": "This must match the originally submitted URI (if one was sent).", + "description": "Specify team_id starts with `T` in case of Org Token", "in": "query", - "name": "redirect_uri", + "name": "team_id", "schema": { "type": "string" } }, { - "description": "Request the user to add your app only to a single channel. Only valid with a [legacy workspace app](https://api.slack.com/legacy-workspace-apps).", + "description": "Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`.", "in": "query", - "name": "single_channel", + "name": "to_old", "schema": { "type": "boolean" } } + ] + } + }, + "/oauth.access": { + "get": { + "description": "Exchanges a temporary OAuth verifier code for an access token.", + "tags": [ + "oauth" ], "responses": { "200": { + "description": "Successful user token negotiation for a single scope", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -16886,39 +16822,19 @@ "team_name": "Wyld Stallyns LLC" } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Successful user token negotiation for a single scope" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_client_id", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -16926,13 +16842,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_client_id", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -16942,19 +16863,11 @@ ] } ], - "tags": [ - "oauth" - ] - } - }, - "/oauth.token": { - "get": { - "description": "Exchanges a temporary OAuth verifier code for a workspace token.", + "operationId": "oauth_access", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/oauth.token" + "url": "https://api.slack.com/methods/oauth.access" }, - "operationId": "oauth_token", "parameters": [ { "description": "Issued when you created your application.", @@ -16989,18 +16902,41 @@ } }, { - "description": "Request the user to add your app only to a single channel.", + "description": "Request the user to add your app only to a single channel. Only valid with a [legacy workspace app](https://api.slack.com/legacy-workspace-apps).", "in": "query", "name": "single_channel", "schema": { "type": "boolean" } } + ] + } + }, + "/oauth.token": { + "get": { + "description": "Exchanges a temporary OAuth verifier code for a workspace token.", + "tags": [ + "oauth" ], "responses": { "200": { + "description": "Success example using a workspace app produces a very different kind of response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -17026,39 +16962,19 @@ "token_type": "app" } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Success example using a workspace app produces a very different kind of response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_client_id", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -17066,13 +16982,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_client_id", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -17082,19 +17003,11 @@ ] } ], - "tags": [ - "oauth" - ] - } - }, - "/oauth.v2.access": { - "get": { - "description": "Exchanges a temporary OAuth verifier code for an access token.", + "operationId": "oauth_token", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/oauth.v2.access" + "url": "https://api.slack.com/methods/oauth.token" }, - "operationId": "oauth_v2_access", "parameters": [ { "description": "Issued when you created your application.", @@ -17116,7 +17029,6 @@ "description": "The `code` param returned via the OAuth callback.", "in": "query", "name": "code", - "required": true, "schema": { "type": "string" } @@ -17128,12 +17040,44 @@ "schema": { "type": "string" } + }, + { + "description": "Request the user to add your app only to a single channel.", + "in": "query", + "name": "single_channel", + "schema": { + "type": "boolean" + } } + ] + } + }, + "/oauth.v2.access": { + "get": { + "description": "Exchanges a temporary OAuth verifier code for an access token.", + "tags": [ + "oauth.v2", + "oauth" ], "responses": { "200": { + "description": "Successful token request with scopes for both a bot user and a user token", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -17159,39 +17103,19 @@ "token_type": "bot" } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Successful token request with scopes for both a bot user and a user token" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_client_id", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -17199,36 +17123,75 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_client_id", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ { - "slackAuth": [ - "none" - ] + "slackAuth": [ + "none" + ] + } + ], + "operationId": "oauth_v2_access", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/oauth.v2.access" + }, + "parameters": [ + { + "description": "Issued when you created your application.", + "in": "query", + "name": "client_id", + "schema": { + "type": "string" + } + }, + { + "description": "Issued when you created your application.", + "in": "query", + "name": "client_secret", + "schema": { + "type": "string" + } + }, + { + "description": "The `code` param returned via the OAuth callback.", + "in": "query", + "name": "code", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "This must match the originally submitted URI (if one was sent).", + "in": "query", + "name": "redirect_uri", + "schema": { + "type": "string" + } } - ], - "tags": [ - "oauth.v2", - "oauth" ] } }, "/pins.add": { "post": { "description": "Pins an item to a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/pins.add" - }, - "operationId": "pins_add", + "tags": [ + "pins" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -17254,18 +17217,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "PinsAddSchema", + "type": "object", "description": "Schema for successful response from pins.add method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -17273,28 +17232,27 @@ }, "required": [ "ok" - ], - "title": "pins.add schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "channel_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "PinsAddErrorSchema", + "type": "object", "description": "Schema for error response from pins.add method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -17335,13 +17293,18 @@ "required": [ "ok", "error" - ], - "title": "pins.add error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "channel_not_found", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -17351,76 +17314,26 @@ ] } ], - "tags": [ - "pins" - ] + "operationId": "pins_add", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/pins.add" + } } }, "/pins.list": { "get": { "description": "Lists items pinned to a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/pins.list" - }, - "operationId": "pins_list", - "parameters": [ - { - "description": "Channel to get pinned items for.", - "in": "query", - "name": "channel", - "required": true, - "schema": { - "type": "string" - } - } + "tags": [ + "pins" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "items": [ - { - "channel": "C2U86NC6H", - "created": 1508881078, - "created_by": "U2U85N1RZ", - "message": { - "permalink": "https://hitchhikers.slack.com/archives/C2U86NC6H/p1508197641000151", - "pinned_to": [ - "C2U86NC6H" - ], - "text": "What is the meaning of life?", - "ts": "1508197641.000151", - "type": "message", - "user": "U2U85N1RZ" - }, - "type": "message" - }, - { - "channel": "C2U86NC6H", - "created": 1508880991, - "created_by": "U2U85N1RZ", - "message": { - "permalink": "https://hitchhikers.slack.com/archives/C2U86NC6H/p1508284197000015", - "pinned_to": [ - "C2U86NC6H" - ], - "text": "The meaning of life, the universe, and everything is 42.", - "ts": "1503289197.000015", - "type": "message", - "user": "U2U85N1RZ" - }, - "type": "message" - } - ], - "ok": true - } - } - }, "schema": { + "title": "PinsListSuccessSchema", "description": "Schema for successful response from pins.list method", "items": { "anyOf": [ @@ -17509,27 +17422,61 @@ "type": "object" } ] - }, - "title": "pins.list success schema" + } + }, + "examples": { + "response": { + "value": { + "items": [ + { + "channel": "C2U86NC6H", + "created": 1508881078, + "created_by": "U2U85N1RZ", + "message": { + "permalink": "https://hitchhikers.slack.com/archives/C2U86NC6H/p1508197641000151", + "pinned_to": [ + "C2U86NC6H" + ], + "text": "What is the meaning of life?", + "ts": "1508197641.000151", + "type": "message", + "user": "U2U85N1RZ" + }, + "type": "message" + }, + { + "channel": "C2U86NC6H", + "created": 1508880991, + "created_by": "U2U85N1RZ", + "message": { + "permalink": "https://hitchhikers.slack.com/archives/C2U86NC6H/p1508284197000015", + "pinned_to": [ + "C2U86NC6H" + ], + "text": "The meaning of life, the universe, and everything is 42.", + "ts": "1503289197.000015", + "type": "message", + "user": "U2U85N1RZ" + }, + "type": "message" + } + ], + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "PinsListErrorSchema", + "type": "object", "description": "Schema for error response from pins.list method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -17563,13 +17510,18 @@ "required": [ "ok", "error" - ], - "title": "pins.list error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -17579,19 +17531,30 @@ ] } ], - "tags": [ - "pins" + "operationId": "pins_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/pins.list" + }, + "parameters": [ + { + "description": "Channel to get pinned items for.", + "in": "query", + "name": "channel", + "required": true, + "schema": { + "type": "string" + } + } ] } }, "/pins.remove": { "post": { "description": "Un-pins an item from a channel.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/pins.remove" - }, - "operationId": "pins_remove", + "tags": [ + "pins" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -17617,47 +17580,42 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "PinsRemoveSchema", + "type": "object", "description": "Schema for successful response from pins.remove method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" } - }, - "required": [ - "ok" - ], - "title": "pins.remove schema", - "type": "object" + }, + "required": [ + "ok" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "no_pin", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "PinsRemoveErrorSchema", + "type": "object", "description": "Schema for error response from pins.remove method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -17697,13 +17655,18 @@ "required": [ "ok", "error" - ], - "title": "pins.remove error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "no_pin", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -17713,19 +17676,19 @@ ] } ], - "tags": [ - "pins" - ] + "operationId": "pins_remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/pins.remove" + } } }, "/reactions.add": { "post": { "description": "Adds a reaction to an item.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reactions.add" - }, - "operationId": "reactions_add", + "tags": [ + "reactions" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -17757,18 +17720,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ReactionsAddSchema", + "type": "object", "description": "Schema for successful response from reactions.add method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -17776,28 +17735,27 @@ }, "required": [ "ok" - ], - "title": "reactions.add schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "already_reacted", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ReactionsAddErrorSchema", + "type": "object", "description": "Schema for error response from reactions.add method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -17837,13 +17795,18 @@ "required": [ "ok", "error" - ], - "title": "reactions.add error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "already_reacted", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -17853,97 +17816,27 @@ ] } ], - "tags": [ - "reactions" - ] + "operationId": "reactions_add", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/reactions.add" + } } }, "/reactions.get": { "get": { "description": "Gets reactions for an item.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reactions.get" - }, - "operationId": "reactions_get", - "parameters": [ - { - "description": "Channel where the message to get reactions for was posted.", - "in": "query", - "name": "channel", - "schema": { - "type": "string" - } - }, - { - "description": "File to get reactions for.", - "in": "query", - "name": "file", - "schema": { - "type": "string" - } - }, - { - "description": "File comment to get reactions for.", - "in": "query", - "name": "file_comment", - "schema": { - "type": "string" - } - }, - { - "description": "If true always return the complete reaction list.", - "in": "query", - "name": "full", - "schema": { - "type": "boolean" - } - }, - { - "description": "Timestamp of the message to get reactions for.", - "in": "query", - "name": "timestamp", - "schema": { - "type": "string" - } - } + "tags": [ + "reactions" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "file": { - "channels": [ - "C2U7V2YA2" - ], - "comments_count": 1, - "created": 1507850315, - "groups": [], - "id": "F7H0D7ZA4", - "ims": [], - "name": "computer.gif", - "reactions": [ - { - "count": 1, - "name": "stuck_out_tongue_winking_eye", - "users": [ - "U2U85N1RV" - ] - } - ], - "timestamp": 1507850315, - "title": "computer.gif", - "user": "U2U85N1RV" - }, - "ok": true, - "type": "file" - } - } - }, "schema": { + "title": "ReactionsGetSuccessSchema", + "type": "object", "description": "Schema for successful response from reactions.get method", "items": { "anyOf": [ @@ -18022,28 +17915,51 @@ ] } ] - }, - "title": "reactions.get success schema", - "type": "object" + } + }, + "examples": { + "response": { + "value": { + "file": { + "channels": [ + "C2U7V2YA2" + ], + "comments_count": 1, + "created": 1507850315, + "groups": [], + "id": "F7H0D7ZA4", + "ims": [], + "name": "computer.gif", + "reactions": [ + { + "count": 1, + "name": "stuck_out_tongue_winking_eye", + "users": [ + "U2U85N1RV" + ] + } + ], + "timestamp": 1507850315, + "title": "computer.gif", + "user": "U2U85N1RV" + }, + "ok": true, + "type": "file" + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ReactionsGetErrorSchema", + "type": "object", "description": "Schema for error response from reactions.get method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -18080,13 +17996,18 @@ "required": [ "ok", "error" - ], - "title": "reactions.get error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -18096,71 +18017,161 @@ ] } ], - "tags": [ - "reactions" - ] - } - }, - "/reactions.list": { - "get": { - "description": "Lists reactions made by a user.", + "operationId": "reactions_get", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/reactions.list" + "url": "https://api.slack.com/methods/reactions.get" }, - "operationId": "reactions_list", "parameters": [ { - "description": "Show reactions made by this user. Defaults to the authed user.", - "in": "query", - "name": "user", - "schema": { - "type": "string" - } - }, - { - "description": "If true always return the complete reaction list.", + "description": "Channel where the message to get reactions for was posted.", "in": "query", - "name": "full", + "name": "channel", "schema": { - "type": "boolean" + "type": "string" } }, { + "description": "File to get reactions for.", "in": "query", - "name": "count", + "name": "file", "schema": { - "type": "integer" + "type": "string" } }, { + "description": "File comment to get reactions for.", "in": "query", - "name": "page", + "name": "file_comment", "schema": { - "type": "integer" + "type": "string" } }, { - "description": "Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more details.", + "description": "If true always return the complete reaction list.", "in": "query", - "name": "cursor", + "name": "full", "schema": { - "type": "string" + "type": "boolean" } }, { - "description": "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.", + "description": "Timestamp of the message to get reactions for.", "in": "query", - "name": "limit", + "name": "timestamp", "schema": { - "type": "integer" + "type": "string" } } + ] + } + }, + "/reactions.list": { + "get": { + "description": "Lists reactions made by a user.", + "tags": [ + "reactions" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "ReactionsListSchema", + "type": "object", + "description": "Schema for successful response from reactions.list method", + "additionalProperties": false, + "properties": { + "items": { + "items": { + "items": { + "anyOf": [ + { + "additionalProperties": false, + "properties": { + "channel": { + "$ref": "#/components/schemas/defs_channel" + }, + "message": { + "$ref": "#/components/schemas/objs_message" + }, + "type": { + "enum": [ + "message" + ], + "type": "string" + } + }, + "required": [ + "type", + "channel", + "message" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "file": { + "$ref": "#/components/schemas/objs_file" + }, + "type": { + "enum": [ + "file" + ], + "type": "string" + } + }, + "required": [ + "type", + "file" + ], + "type": "object" + }, + { + "additionalProperties": false, + "properties": { + "comment": { + "$ref": "#/components/schemas/objs_comment" + }, + "file": { + "$ref": "#/components/schemas/objs_file" + }, + "type": { + "enum": [ + "file_comment" + ], + "type": "string" + } + }, + "required": [ + "type", + "file", + "comment" + ], + "type": "object" + } + ] + } + }, + "type": "array" + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "paging": { + "$ref": "#/components/schemas/objs_paging" + }, + "response_metadata": { + "$ref": "#/components/schemas/objs_response_metadata" + } + }, + "required": [ + "ok", + "items" + ] + }, "examples": { "response": { "value": { @@ -18255,120 +18266,19 @@ } } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from reactions.list method", - "properties": { - "items": { - "items": { - "items": { - "anyOf": [ - { - "additionalProperties": false, - "properties": { - "channel": { - "$ref": "#/components/schemas/defs_channel" - }, - "message": { - "$ref": "#/components/schemas/objs_message" - }, - "type": { - "enum": [ - "message" - ], - "type": "string" - } - }, - "required": [ - "type", - "channel", - "message" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "file": { - "$ref": "#/components/schemas/objs_file" - }, - "type": { - "enum": [ - "file" - ], - "type": "string" - } - }, - "required": [ - "type", - "file" - ], - "type": "object" - }, - { - "additionalProperties": false, - "properties": { - "comment": { - "$ref": "#/components/schemas/objs_comment" - }, - "file": { - "$ref": "#/components/schemas/objs_file" - }, - "type": { - "enum": [ - "file_comment" - ], - "type": "string" - } - }, - "required": [ - "type", - "file", - "comment" - ], - "type": "object" - } - ] - } - }, - "type": "array" - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "paging": { - "$ref": "#/components/schemas/objs_paging" - }, - "response_metadata": { - "$ref": "#/components/schemas/objs_response_metadata" - } - }, - "required": [ - "ok", - "items" - ], - "title": "reactions.list schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ReactionsListErrorSchema", + "type": "object", "description": "Schema for error response from reactions.list method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -18403,35 +18313,88 @@ "required": [ "ok", "error" - ], - "title": "reactions.list error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } + } + }, + "security": [ + { + "slackAuth": [ + "reactions:read" + ] } + ], + "operationId": "reactions_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/reactions.list" }, - "security": [ + "parameters": [ { - "slackAuth": [ - "reactions:read" - ] + "description": "Show reactions made by this user. Defaults to the authed user.", + "in": "query", + "name": "user", + "schema": { + "type": "string" + } + }, + { + "description": "If true always return the complete reaction list.", + "in": "query", + "name": "full", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "name": "count", + "schema": { + "type": "integer" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "type": "integer" + } + }, + { + "description": "Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection. See [pagination](\/docs\/pagination) for more details.", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + }, + { + "description": "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.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } } - ], - "tags": [ - "reactions" ] } }, "/reactions.remove": { "post": { "description": "Removes a reaction from an item.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reactions.remove" - }, - "operationId": "reactions_remove", + "tags": [ + "reactions" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -18469,18 +18432,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "ReactionsRemoveSchema", + "type": "object", "description": "Schema for successful response from reactions.remove method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -18488,28 +18447,27 @@ }, "required": [ "ok" - ], - "title": "reactions.remove schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "no_reaction", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "ReactionsRemoveErrorSchema", + "type": "object", "description": "Schema for error response from reactions.remove method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -18550,13 +18508,18 @@ "required": [ "ok", "error" - ], - "title": "reactions.remove error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "no_reaction", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -18566,19 +18529,19 @@ ] } ], - "tags": [ - "reactions" - ] + "operationId": "reactions_remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/reactions.remove" + } } }, "/reminders.add": { "post": { "description": "Creates a reminder.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reminders.add" - }, - "operationId": "reminders_add", + "tags": [ + "reminders" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -18609,18 +18572,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "RemindersAddSchema", + "type": "object", "description": "Schema for successful response from reminders.add method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -18632,28 +18591,27 @@ "required": [ "ok", "reminder" - ], - "title": "reminders.add schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "RemindersAddErrorSchema", + "type": "object", "description": "Schema for error response from reminders.add method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -18696,13 +18654,18 @@ "required": [ "ok", "error" - ], - "title": "reminders.add error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -18712,19 +18675,19 @@ ] } ], - "tags": [ - "reminders" - ] + "operationId": "reminders_add", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/reminders.add" + } } }, "/reminders.complete": { "post": { "description": "Marks a reminder as complete.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reminders.complete" - }, - "operationId": "reminders_complete", + "tags": [ + "reminders" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -18742,18 +18705,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "RemindersCompleteSchema", + "type": "object", "description": "Schema for successful response from reminders.complete method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -18761,28 +18720,27 @@ }, "required": [ "ok" - ], - "title": "reminders.complete schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "RemindersCompleteErrorSchema", + "type": "object", "description": "Schema for error response from reminders.complete method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -18822,13 +18780,18 @@ "required": [ "ok", "error" - ], - "title": "reminders.complete error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -18838,19 +18801,19 @@ ] } ], - "tags": [ - "reminders" - ] + "operationId": "reminders_complete", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/reminders.complete" + } } }, "/reminders.delete": { "post": { "description": "Deletes a reminder.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reminders.delete" - }, - "operationId": "reminders_delete", + "tags": [ + "reminders" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -18868,18 +18831,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "RemindersDeleteSchema", + "type": "object", "description": "Schema for successful response from reminders.delete method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -18887,28 +18846,27 @@ }, "required": [ "ok" - ], - "title": "reminders.delete schema", - "type": "object" - } - } - }, - "description": "Typical success response" - }, - "default": { - "content": { - "application/json": { + ] + }, "examples": { "response": { "value": { - "error": "invalid_auth", - "ok": false + "ok": true } } - }, + } + } + } + }, + "default": { + "description": "Typical error response", + "content": { + "application/json": { "schema": { - "additionalProperties": false, + "title": "RemindersDeleteErrorSchema", + "type": "object", "description": "Schema for error response from reminders.delete method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -18946,13 +18904,18 @@ "required": [ "ok", "error" - ], - "title": "reminders.delete error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -18962,43 +18925,29 @@ ] } ], - "tags": [ - "reminders" - ] + "operationId": "reminders_delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/reminders.delete" + } } }, "/reminders.info": { "get": { "description": "Gets information about a reminder.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reminders.info" - }, - "operationId": "reminders_info", - "parameters": [ - { - "description": "The ID of the reminder", - "in": "query", - "name": "reminder", - "schema": { - "type": "string" - } - } + "tags": [ + "reminders" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "RemindersInfoSchema", + "type": "object", "description": "Schema for successful response from reminders.info method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -19010,28 +18959,27 @@ "required": [ "ok", "reminder" - ], - "title": "reminders.info schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "RemindersInfoErrorSchema", + "type": "object", "description": "Schema for error response from reminders.info method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -19069,13 +19017,18 @@ "required": [ "ok", "error" - ], - "title": "reminders.info error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -19085,33 +19038,39 @@ ] } ], - "tags": [ - "reminders" + "operationId": "reminders_info", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/reminders.info" + }, + "parameters": [ + { + "description": "The ID of the reminder", + "in": "query", + "name": "reminder", + "schema": { + "type": "string" + } + } ] } }, "/reminders.list": { "get": { "description": "Lists all reminders created by or for a given user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/reminders.list" - }, - "operationId": "reminders_list", + "tags": [ + "reminders" + ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "RemindersListSchema", + "type": "object", "description": "Schema for successful response from reminders.list method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -19126,28 +19085,27 @@ "required": [ "ok", "reminders" - ], - "title": "reminders.list schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "RemindersListErrorSchema", + "type": "object", "description": "Schema for error response from reminders.list method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -19184,13 +19142,18 @@ "required": [ "ok", "error" - ], - "title": "reminders.list error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -19200,61 +19163,29 @@ ] } ], - "tags": [ - "reminders" - ] + "operationId": "reminders_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/reminders.list" + } } }, "/rtm.connect": { "get": { "description": "Starts a Real Time Messaging session.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/rtm.connect" - }, - "operationId": "rtm_connect", - "parameters": [ - { - "description": "Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching).", - "in": "query", - "name": "batch_presence_aware", - "schema": { - "type": "boolean" - } - }, - { - "description": "Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions).", - "in": "query", - "name": "presence_sub", - "schema": { - "type": "boolean" - } - } + "tags": [ + "rtm" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true, - "self": { - "id": "U4X318ZMZ", - "name": "robotoverlord" - }, - "team": { - "domain": "slackdemo", - "id": "T2U81E2FP", - "name": "SlackDemo" - }, - "url": "wss://..." - } - } - }, "schema": { - "additionalProperties": false, + "title": "RtmConnectSchema", + "type": "object", "description": "Schema for successful response from rtm.connect method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -19305,28 +19236,37 @@ "url", "team", "self" - ], - "title": "rtm.connect schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true, + "self": { + "id": "U4X318ZMZ", + "name": "robotoverlord" + }, + "team": { + "domain": "slackdemo", + "id": "T2U81E2FP", + "name": "SlackDemo" + }, + "url": "wss://..." + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "RtmConnectErrorSchema", + "type": "object", "description": "Schema for error response from rtm.connect method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -19361,13 +19301,18 @@ "required": [ "ok", "error" - ], - "title": "rtm.connect error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -19377,73 +19322,56 @@ ] } ], - "tags": [ - "rtm" - ] - } - }, - "/search.messages": { - "get": { - "description": "Searches for messages matching a query.", + "operationId": "rtm_connect", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/search.messages" + "url": "https://api.slack.com/methods/rtm.connect" }, - "operationId": "search_messages", "parameters": [ { - "description": "Pass the number of results you want per \"page\". Maximum of `100`.", - "in": "query", - "name": "count", - "schema": { - "type": "integer" - } - }, - { - "description": "Pass a value of `true` to enable query highlight markers (see below).", + "description": "Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching).", "in": "query", - "name": "highlight", + "name": "batch_presence_aware", "schema": { "type": "boolean" } }, { + "description": "Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions).", "in": "query", - "name": "page", - "schema": { - "type": "integer" - } - }, - { - "description": "Search query.", - "in": "query", - "name": "query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Return matches sorted by either `score` or `timestamp`.", - "in": "query", - "name": "sort", - "schema": { - "type": "string" - } - }, - { - "description": "Change sort direction to ascending (`asc`) or descending (`desc`).", - "in": "query", - "name": "sort_dir", + "name": "presence_sub", "schema": { - "type": "string" + "type": "boolean" } } + ] + } + }, + "/search.messages": { + "get": { + "description": "Searches for messages matching a query.", + "tags": [ + "search" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -19512,39 +19440,19 @@ "query": "The meaning of life the universe and everything" } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "No query passed", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -19552,13 +19460,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "No query passed", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -19568,19 +19481,69 @@ ] } ], - "tags": [ - "search" + "operationId": "search_messages", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/search.messages" + }, + "parameters": [ + { + "description": "Pass the number of results you want per \"page\". Maximum of `100`.", + "in": "query", + "name": "count", + "schema": { + "type": "integer" + } + }, + { + "description": "Pass a value of `true` to enable query highlight markers (see below).", + "in": "query", + "name": "highlight", + "schema": { + "type": "boolean" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "type": "integer" + } + }, + { + "description": "Search query.", + "in": "query", + "name": "query", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Return matches sorted by either `score` or `timestamp`.", + "in": "query", + "name": "sort", + "schema": { + "type": "string" + } + }, + { + "description": "Change sort direction to ascending (`asc`) or descending (`desc`).", + "in": "query", + "name": "sort_dir", + "schema": { + "type": "string" + } + } ] } }, "/stars.add": { "post": { "description": "Adds a star to an item.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/stars.add" - }, - "operationId": "stars_add", + "tags": [ + "stars" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -19610,18 +19573,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "StarsAddSchema", + "type": "object", "description": "Schema for successful response from stars.add method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -19629,28 +19588,27 @@ }, "required": [ "ok" - ], - "title": "stars.add schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "StarsAddErrorSchema", + "type": "object", "description": "Schema for error response from stars.add method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -19693,81 +19651,50 @@ "required": [ "ok", "error" - ], - "title": "stars.add error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ { "slackAuth": [ "stars:write" - ] - } - ], - "tags": [ - "stars" - ] - } - }, - "/stars.list": { - "get": { - "description": "Lists stars for a user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/stars.list" - }, - "operationId": "stars_list", - "parameters": [ - { - "in": "query", - "name": "count", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "schema": { - "type": "string" - } - }, - { - "description": "Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more details.", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - }, - { - "description": "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.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } + ] } ], + "operationId": "stars_add", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/stars.add" + } + } + }, + "/stars.list": { + "get": { + "description": "Lists stars for a user.", + "tags": [ + "stars" + ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "StarsListSchema", + "type": "object", "description": "Schema for successful response from stars.list method", + "additionalProperties": false, "properties": { "items": { "items": { @@ -19934,28 +19861,27 @@ "required": [ "ok", "items" - ], - "title": "stars.list schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "StarsListErrorSchema", + "type": "object", "description": "Schema for error response from stars.list method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -19992,13 +19918,18 @@ "required": [ "ok", "error" - ], - "title": "stars.list error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -20008,19 +19939,51 @@ ] } ], - "tags": [ - "stars" + "operationId": "stars_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/stars.list" + }, + "parameters": [ + { + "in": "query", + "name": "count", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "type": "string" + } + }, + { + "description": "Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first \"page\" of the collection. See [pagination](\/docs\/pagination) for more details.", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + }, + { + "description": "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.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + } ] } }, "/stars.remove": { "post": { "description": "Removes a star from an item.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/stars.remove" - }, - "operationId": "stars_remove", + "tags": [ + "stars" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -20050,18 +20013,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "StarsRemoveSchema", + "type": "object", "description": "Schema for successful response from stars.remove method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -20069,28 +20028,27 @@ }, "required": [ "ok" - ], - "title": "stars.remove schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "StarsRemoveErrorSchema", + "type": "object", "description": "Schema for error response from stars.remove method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -20133,13 +20091,18 @@ "required": [ "ok", "error" - ], - "title": "stars.remove error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -20149,89 +20112,29 @@ ] } ], - "tags": [ - "stars" - ] + "operationId": "stars_remove", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/stars.remove" + } } }, "/team.accessLogs": { "get": { "description": "Gets the access logs for the current team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/team.accessLogs" - }, - "operationId": "team_accessLogs", - "parameters": [ - { - "description": "End of time range of logs to include in results (inclusive).", - "in": "query", - "name": "before", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "count", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "schema": { - "type": "string" - } - } + "tags": [ + "team" ], "responses": { "200": { + "description": "This response demonstrates pagination and two access log entries.", "content": { "application/json": { - "examples": { - "response": { - "value": { - "logins": [ - { - "count": 1, - "country": "US", - "date_first": 1422922864, - "date_last": 1422922864, - "ip": "127.0.0.1", - "isp": "BigCo ISP", - "region": "CA", - "user_agent": "SlackWeb Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.35 Safari/537.36", - "user_id": "U45678", - "username": "alice" - }, - { - "count": 1, - "country": "US", - "date_first": 1422922493, - "date_last": 1422922493, - "ip": "127.0.0.1", - "isp": "BigCo ISP", - "region": "CA", - "user_agent": "SlackWeb Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_3 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B466 Safari/600.1.4", - "user_id": "U12345", - "username": "white_rabbit" - } - ], - "ok": true, - "paging": { - "count": 100, - "page": 1, - "pages": 1, - "total": 2 - } - } - } - }, "schema": { - "additionalProperties": false, + "title": "TeamAccessLogsSchema", + "type": "object", "description": "Schema for successful response from team.accessLogs method", + "additionalProperties": false, "properties": { "logins": { "items": { @@ -20296,33 +20199,64 @@ "paging": { "$ref": "#/components/schemas/objs_paging" } - }, - "required": [ - "ok", - "logins", - "paging" - ], - "title": "team.accessLogs schema", - "type": "object" + }, + "required": [ + "ok", + "logins", + "paging" + ] + }, + "examples": { + "response": { + "value": { + "logins": [ + { + "count": 1, + "country": "US", + "date_first": 1422922864, + "date_last": 1422922864, + "ip": "127.0.0.1", + "isp": "BigCo ISP", + "region": "CA", + "user_agent": "SlackWeb Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.35 Safari/537.36", + "user_id": "U45678", + "username": "alice" + }, + { + "count": 1, + "country": "US", + "date_first": 1422922493, + "date_last": 1422922493, + "ip": "127.0.0.1", + "isp": "BigCo ISP", + "region": "CA", + "user_agent": "SlackWeb Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_3 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B466 Safari/600.1.4", + "user_id": "U12345", + "username": "white_rabbit" + } + ], + "ok": true, + "paging": { + "count": 100, + "page": 1, + "pages": 1, + "total": 2 + } + } + } } } - }, - "description": "This response demonstrates pagination and two access log entries." + } }, "default": { + "description": "A workspace must be on a paid plan to use this method, otherwise the `paid_only` error is thrown:", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "paid_only", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "TeamAccessLogsErrorSchema", + "type": "object", "description": "Schema for error response from team.accessLogs method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -20361,13 +20295,18 @@ "required": [ "ok", "error" - ], - "title": "team.accessLogs error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "paid_only", + "ok": false + } + } } } - }, - "description": "A workspace must be on a paid plan to use this method, otherwise the `paid_only` error is thrown:" + } } }, "security": [ @@ -20377,33 +20316,62 @@ ] } ], - "tags": [ - "team" - ] - } - }, - "/team.billableInfo": { - "get": { - "description": "Gets billable users information for the current team.", + "operationId": "team_accessLogs", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/team.billableInfo" + "url": "https://api.slack.com/methods/team.accessLogs" }, - "operationId": "team_billableInfo", "parameters": [ { - "description": "A user to retrieve the billable information for. Defaults to all users.", + "description": "End of time range of logs to include in results (inclusive).", "in": "query", - "name": "user", + "name": "before", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "count", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "page", "schema": { "type": "string" } } + ] + } + }, + "/team.billableInfo": { + "get": { + "description": "Gets billable users information for the current team.", + "tags": [ + "team" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -20421,39 +20389,19 @@ "ok": true } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -20461,13 +20409,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -20477,33 +20430,52 @@ ] } ], - "tags": [ - "team" - ] - } - }, - "/team.info": { - "get": { - "description": "Gets information about the current team.", + "operationId": "team_billableInfo", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/team.info" + "url": "https://api.slack.com/methods/team.billableInfo" }, - "operationId": "team_info", "parameters": [ { - "description": "Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels", + "description": "A user to retrieve the billable information for. Defaults to all users.", "in": "query", - "name": "team", + "name": "user", "schema": { "type": "string" } } + ] + } + }, + "/team.info": { + "get": { + "description": "Gets information about the current team.", + "tags": [ + "team" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "TeamInfoSchema", + "type": "object", + "description": "Schema for successful response from team.info method", + "additionalProperties": false, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "team": { + "$ref": "#/components/schemas/objs_team" + } + }, + "required": [ + "ok", + "team" + ] + }, "examples": { "response": { "value": { @@ -20527,43 +20499,19 @@ } } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from team.info method", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "team": { - "$ref": "#/components/schemas/objs_team" - } - }, - "required": [ - "ok", - "team" - ], - "title": "team.info schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "TeamInfoErrorSchema", + "type": "object", "description": "Schema for error response from team.info method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -20597,99 +20545,61 @@ }, "required": [ "ok", - "error" - ], - "title": "team.info error schema", - "type": "object" - } - } - }, - "description": "Typical error response" - } - }, - "security": [ - { - "slackAuth": [ - "team:read" - ] - } - ], - "tags": [ - "team" - ] - } - }, - "/team.integrationLogs": { - "get": { - "description": "Gets the integration logs for the current team.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/team.integrationLogs" - }, - "operationId": "team_integrationLogs", - "parameters": [ - - { - "description": "Filter logs to this Slack app. Defaults to all logs.", - "in": "query", - "name": "app_id", - "schema": { - "type": "string" - } - }, - { - "description": "Filter logs with this change type. Defaults to all logs.", - "in": "query", - "name": "change_type", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "count", - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "page", - "schema": { - "type": "string" + "error" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } + } + } } - }, + } + }, + "security": [ { - "description": "Filter logs to this service. Defaults to all logs.", - "in": "query", - "name": "service_id", - "schema": { - "type": "string" - } - }, + "slackAuth": [ + "team:read" + ] + } + ], + "operationId": "team_info", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/team.info" + }, + "parameters": [ { - "description": "Filter logs generated by this user’s actions. Defaults to all logs.", + "description": "Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels", "in": "query", - "name": "user", + "name": "team", "schema": { "type": "string" } } + ] + } + }, + "/team.integrationLogs": { + "get": { + "description": "Gets the integration logs for the current team.", + "tags": [ + "team" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "TeamIntegrationLogsSchema", + "type": "object", "description": "Schema for successful response from team.integrationLogs method", + "additionalProperties": false, "properties": { "logs": { "items": { @@ -20755,28 +20665,27 @@ "ok", "logs", "paging" - ], - "title": "team.integrationLogs schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "TeamIntegrationLogsErrorSchema", + "type": "object", "description": "Schema for error response from team.integrationLogs method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -20813,13 +20722,18 @@ "required": [ "ok", "error" - ], - "title": "team.integrationLogs error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -20829,33 +20743,104 @@ ] } ], - "tags": [ - "team" - ] - } - }, - "/team.profile.get": { - "get": { - "description": "Retrieve a team's profile.", + "operationId": "team_integrationLogs", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/team.profile.get" + "url": "https://api.slack.com/methods/team.integrationLogs" }, - "operationId": "team_profile_get", "parameters": [ { - "description": "Filter by visibility.", + "description": "Filter logs to this Slack app. Defaults to all logs.", "in": "query", - "name": "visibility", + "name": "app_id", + "schema": { + "type": "string" + } + }, + { + "description": "Filter logs with this change type. Defaults to all logs.", + "in": "query", + "name": "change_type", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "count", + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "type": "string" + } + }, + { + "description": "Filter logs to this service. Defaults to all logs.", + "in": "query", + "name": "service_id", + "schema": { + "type": "string" + } + }, + { + "description": "Filter logs generated by this user’s actions. Defaults to all logs.", + "in": "query", + "name": "user", "schema": { "type": "string" } } + ] + } + }, + "/team.profile.get": { + "get": { + "description": "Retrieve a team's profile.", + "tags": [ + "team.profile", + "team" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "TeamProfileGetSuccessSchema", + "type": "object", + "description": "Schema for successful response from team.profile.get method", + "additionalProperties": false, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "profile": { + "additionalProperties": false, + "properties": { + "fields": { + "items": { + "$ref": "#/components/schemas/objs_team_profile_field" + }, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "fields" + ], + "type": "object" + } + }, + "required": [ + "ok", + "profile" + ] + }, "examples": { "response": { "value": { @@ -20928,56 +20913,19 @@ } } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from team.profile.get method", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "profile": { - "additionalProperties": false, - "properties": { - "fields": { - "items": { - "$ref": "#/components/schemas/objs_team_profile_field" - }, - "type": "array", - "uniqueItems": true - } - }, - "required": [ - "fields" - ], - "type": "object" - } - }, - "required": [ - "ok", - "profile" - ], - "title": "team.profile.get success schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "TeamProfileGetErrorSchema", + "type": "object", "description": "Schema for error response from team.profile.get method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -21011,13 +20959,18 @@ "required": [ "ok", "error" - ], - "title": "team.profile.get error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -21027,20 +20980,29 @@ ] } ], - "tags": [ - "team.profile", - "team" + "operationId": "team_profile_get", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/team.profile.get" + }, + "parameters": [ + { + "description": "Filter by visibility.", + "in": "query", + "name": "visibility", + "schema": { + "type": "string" + } + } ] } }, "/usergroups.create": { "post": { "description": "Create a User Group", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.create" - }, - "operationId": "usergroups_create", + "tags": [ + "usergroups" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21077,18 +21039,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsergroupsCreateSchema", + "type": "object", "description": "Schema for successful response from usergroups.create method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -21100,28 +21058,27 @@ "required": [ "ok", "usergroup" - ], - "title": "usergroups.create schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsergroupsCreateErrorSchema", + "type": "object", "description": "Schema for error response from usergroups.create method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -21160,13 +21117,18 @@ "required": [ "ok", "error" - ], - "title": "usergroups.create error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -21176,19 +21138,19 @@ ] } ], - "tags": [ - "usergroups" - ] + "operationId": "usergroups_create", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/usergroups.create" + } } }, "/usergroups.disable": { "post": { "description": "Disable an existing User Group", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.disable" - }, - "operationId": "usergroups_disable", + "tags": [ + "usergroups" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21213,18 +21175,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsergroupsDisableSchema", + "type": "object", "description": "Schema for successful response from usergroups.disable method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -21236,28 +21194,27 @@ "required": [ "ok", "usergroup" - ], - "title": "usergroups.disable schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsergroupsDisableErrorSchema", + "type": "object", "description": "Schema for error response from usergroups.disable method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -21296,13 +21253,18 @@ "required": [ "ok", "error" - ], - "title": "usergroups.disable error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -21312,19 +21274,19 @@ ] } ], - "tags": [ - "usergroups" - ] + "operationId": "usergroups_disable", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/usergroups.disable" + } } }, "/usergroups.enable": { "post": { "description": "Enable a User Group", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.enable" - }, - "operationId": "usergroups_enable", + "tags": [ + "usergroups" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21349,18 +21311,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsergroupsEnableSchema", + "type": "object", "description": "Schema for successful response from usergroups.enable method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -21372,28 +21330,27 @@ "required": [ "ok", "usergroup" - ], - "title": "usergroups.enable schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsergroupsEnableErrorSchema", + "type": "object", "description": "Schema for error response from usergroups.enable method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -21433,13 +21390,18 @@ "required": [ "ok", "error" - ], - "title": "usergroups.enable error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -21449,49 +21411,45 @@ ] } ], - "tags": [ - "usergroups" - ] + "operationId": "usergroups_enable", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/usergroups.enable" + } } }, "/usergroups.list": { "get": { "description": "List all User Groups for a team", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.list" - }, - "operationId": "usergroups_list", - "parameters": [ - { - "description": "Include the list of users for each User Group.", - "in": "query", - "name": "include_users", - "schema": { - "type": "boolean" - } - }, - { - "description": "Include the number of users in each User Group.", - "in": "query", - "name": "include_count", - "schema": { - "type": "boolean" - } - }, - { - "description": "Include disabled User Groups.", - "in": "query", - "name": "include_disabled", - "schema": { - "type": "boolean" - } - } + "tags": [ + "usergroups" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "UsergroupsListSchema", + "type": "object", + "description": "Schema for successful response from usergroups.list method", + "additionalProperties": false, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "usergroups": { + "items": { + "$ref": "#/components/schemas/objs_subteam" + }, + "type": "array" + } + }, + "required": [ + "ok", + "usergroups" + ] + }, "examples": { "response": { "value": { @@ -21563,46 +21521,19 @@ ] } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from usergroups.list method", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "usergroups": { - "items": { - "$ref": "#/components/schemas/objs_subteam" - }, - "type": "array" - } - }, - "required": [ - "ok", - "usergroups" - ], - "title": "usergroups.list schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsergroupsListErrorSchema", + "type": "object", "description": "Schema for error response from usergroups.list method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -21642,13 +21573,18 @@ "required": [ "ok", "error" - ], - "title": "usergroups.list error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -21658,19 +21594,45 @@ ] } ], - "tags": [ - "usergroups" + "operationId": "usergroups_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/usergroups.list" + }, + "parameters": [ + { + "description": "Include the list of users for each User Group.", + "in": "query", + "name": "include_users", + "schema": { + "type": "boolean" + } + }, + { + "description": "Include the number of users in each User Group.", + "in": "query", + "name": "include_count", + "schema": { + "type": "boolean" + } + }, + { + "description": "Include disabled User Groups.", + "in": "query", + "name": "include_disabled", + "schema": { + "type": "boolean" + } + } ] } }, "/usergroups.update": { "post": { "description": "Update an existing User Group", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.update" - }, - "operationId": "usergroups_update", + "tags": [ + "usergroups" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -21711,8 +21673,27 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "UsergroupsUpdateSchema", + "type": "object", + "description": "Schema for successful response from usergroups.update method", + "additionalProperties": false, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "usergroup": { + "$ref": "#/components/schemas/objs_subteam" + } + }, + "required": [ + "ok", + "usergroup" + ] + }, "examples": { "response": { "value": { @@ -21744,43 +21725,19 @@ } } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from usergroups.update method", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "usergroup": { - "$ref": "#/components/schemas/objs_subteam" - } - }, - "required": [ - "ok", - "usergroup" - ], - "title": "usergroups.update schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsergroupsUpdateErrorSchema", + "type": "object", "description": "Schema for error response from usergroups.update method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -21821,13 +21778,18 @@ "required": [ "ok", "error" - ], - "title": "usergroups.update error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -21837,56 +21799,30 @@ ] } ], - "tags": [ - "usergroups" - ] + "operationId": "usergroups_update", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/usergroups.update" + } } }, "/usergroups.users.list": { "get": { "description": "List all users in a User Group", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.users.list" - }, - "operationId": "usergroups_users_list", - "parameters": [ - { - "description": "Allow results that involve disabled User Groups.", - "in": "query", - "name": "include_disabled", - "schema": { - "type": "boolean" - } - }, - { - "description": "The encoded ID of the User Group to update.", - "in": "query", - "name": "usergroup", - "required": true, - "schema": { - "type": "string" - } - } + "tags": [ + "usergroups.users", + "usergroups" ], "responses": { "200": { + "description": "Standard success response when used with a user token", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true, - "users": [ - "U060R4BJ4", - "W123A4BC5" - ] - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsergroupsUsersListSchema", + "type": "object", "description": "Schema for successful response from usergroups.users.list method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -21901,28 +21837,31 @@ "required": [ "ok", "users" - ], - "title": "usergroups.users.list schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true, + "users": [ + "U060R4BJ4", + "W123A4BC5" + ] + } + } } } - }, - "description": "Standard success response when used with a user token" + } }, "default": { + "description": "Standard failure response when used with an invalid token", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsergroupsUsersListErrorSchema", + "type": "object", "description": "Schema for error response from usergroups.users.list method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -21962,13 +21901,18 @@ "required": [ "ok", "error" - ], - "title": "usergroups.users.list error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Standard failure response when used with an invalid token" + } } }, "security": [ @@ -21978,20 +21922,39 @@ ] } ], - "tags": [ - "usergroups.users", - "usergroups" + "operationId": "usergroups_users_list", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/usergroups.users.list" + }, + "parameters": [ + { + "description": "Allow results that involve disabled User Groups.", + "in": "query", + "name": "include_disabled", + "schema": { + "type": "boolean" + } + }, + { + "description": "The encoded ID of the User Group to update.", + "in": "query", + "name": "usergroup", + "required": true, + "schema": { + "type": "string" + } + } ] } }, "/usergroups.users.update": { "post": { "description": "Update the list of users for a User Group", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/usergroups.users.update" - }, - "operationId": "usergroups_users_update", + "tags": [ + "usergroups.users", + "usergroups" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -22021,8 +21984,27 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "UsergroupsUsersUpdateSchema", + "type": "object", + "description": "Schema for successful response from usergroups.users.update method", + "additionalProperties": false, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "usergroup": { + "$ref": "#/components/schemas/objs_subteam" + } + }, + "required": [ + "ok", + "usergroup" + ] + }, "examples": { "response": { "value": { @@ -22043,54 +22025,30 @@ "prefs": { "channels": [], "groups": [] - }, - "team_id": "T060R4BHN", - "updated_by": "U060R4BJ4", - "user_count": 1, - "users": [ - "U060R4BJ4", - "U060RNRCZ" - ] - } - } - } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from usergroups.users.update method", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "usergroup": { - "$ref": "#/components/schemas/objs_subteam" + }, + "team_id": "T060R4BHN", + "updated_by": "U060R4BJ4", + "user_count": 1, + "users": [ + "U060R4BJ4", + "U060RNRCZ" + ] + } } - }, - "required": [ - "ok", - "usergroup" - ], - "title": "usergroups.users.update schema", - "type": "object" + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsergroupsUsersUpdateErrorSchema", + "type": "object", "description": "Schema for error response from usergroups.users.update method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -22131,13 +22089,18 @@ "required": [ "ok", "error" - ], - "title": "usergroups.users.update error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -22147,66 +22110,58 @@ ] } ], - "tags": [ - "usergroups.users", - "usergroups" - ] + "operationId": "usergroups_users_update", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/usergroups.users.update" + } } }, "/users.conversations": { "get": { "description": "List conversations the calling user may access.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.conversations" - }, - "operationId": "users_conversations", - "parameters": [ - { - "description": "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.", - "in": "query", - "name": "user", - "schema": { - "type": "string" - } - }, - { - "description": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`", - "in": "query", - "name": "types", - "schema": { - "type": "string" - } - }, - { - "description": "Set to `true` to exclude archived channels from the list", - "in": "query", - "name": "exclude_archived", - "schema": { - "type": "boolean" - } - }, - { - "description": "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.", - "in": "query", - "name": "limit", - "schema": { - "type": "integer" - } - }, - { - "description": "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](/docs/pagination) for more detail.", - "in": "query", - "name": "cursor", - "schema": { - "type": "string" - } - } + "tags": [ + "users" ], "responses": { "200": { + "description": "Typical success response with only public channels. Note how `num_members` and `is_member` are not returned like typical `conversations` objects.", "content": { "application/json": { + "schema": { + "title": "UsersConversationsSuccessSchema", + "type": "object", + "description": "Schema for successful response from users.conversations method. Returned conversation objects do not include `num_members` or `is_member`", + "additionalProperties": true, + "properties": { + "channels": { + "items": { + "$ref": "#/components/schemas/objs_conversation" + }, + "type": "array", + "uniqueItems": true + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "response_metadata": { + "additionalProperties": false, + "properties": { + "next_cursor": { + "type": "string" + } + }, + "required": [ + "next_cursor" + ], + "type": "object" + } + }, + "required": [ + "ok", + "channels" + ] + }, "examples": { "response": { "value": { @@ -22280,59 +22235,19 @@ } } } - }, - "schema": { - "additionalProperties": true, - "description": "Schema for successful response from users.conversations method. Returned conversation objects do not include `num_members` or `is_member`", - "properties": { - "channels": { - "items": { - "$ref": "#/components/schemas/objs_conversation" - }, - "type": "array", - "uniqueItems": true - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "response_metadata": { - "additionalProperties": false, - "properties": { - "next_cursor": { - "type": "string" - } - }, - "required": [ - "next_cursor" - ], - "type": "object" - } - }, - "required": [ - "ok", - "channels" - ], - "title": "users.conversations success schema", - "type": "object" } } - }, - "description": "Typical success response with only public channels. Note how `num_members` and `is_member` are not returned like typical `conversations` objects." + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersConversationsErrorSchema", + "type": "object", "description": "Schema for error response from users.conversations method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -22372,13 +22287,18 @@ "required": [ "ok", "error" - ], - "title": "users.conversations error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -22391,19 +22311,61 @@ ] } ], - "tags": [ - "users" + "operationId": "users_conversations", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/users.conversations" + }, + "parameters": [ + { + "description": "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.", + "in": "query", + "name": "user", + "schema": { + "type": "string" + } + }, + { + "description": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`", + "in": "query", + "name": "types", + "schema": { + "type": "string" + } + }, + { + "description": "Set to `true` to exclude archived channels from the list", + "in": "query", + "name": "exclude_archived", + "schema": { + "type": "boolean" + } + }, + { + "description": "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.", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + }, + { + "description": "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](\/docs\/pagination) for more detail.", + "in": "query", + "name": "cursor", + "schema": { + "type": "string" + } + } ] } }, "/users.deletePhoto": { "post": { "description": "Delete the user profile photo", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.deletePhoto" - }, - "operationId": "users_deletePhoto", + "tags": [ + "users" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -22425,18 +22387,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersDeletePhotoSchema", + "type": "object", "description": "Schema for successful response from users.deletePhoto method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -22444,28 +22402,27 @@ }, "required": [ "ok" - ], - "title": "users.deletePhoto schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersDeletePhotoErrorSchema", + "type": "object", "description": "Schema for error response from users.deletePhoto method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -22502,13 +22459,18 @@ "required": [ "ok", "error" - ], - "title": "users.deletePhoto error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -22518,44 +22480,29 @@ ] } ], - "tags": [ - "users" - ] + "operationId": "users_deletePhoto", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/users.deletePhoto" + } } }, "/users.getPresence": { "get": { "description": "Gets user presence information.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.getPresence" - }, - "operationId": "users_getPresence", - "parameters": [ - { - "description": "User to get presence info on. Defaults to the authed user.", - "in": "query", - "name": "user", - "schema": { - "type": "string" - } - } + "tags": [ + "users" ], "responses": { "200": { + "description": "When requesting information for a different user, this method just returns the current presence (either `active` or `away`).", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true, - "presence": "active" - } - } - }, "schema": { - "additionalProperties": true, + "title": "APIMethod:UsersGetPresence", + "type": "object", "description": "Generated from users.getPresence with shasum e7251aec575d8863f9e0eb38663ae9dc26655f65", + "additionalProperties": true, "properties": { "auto_away": { "type": "boolean" @@ -22582,30 +22529,30 @@ "required": [ "ok", "presence" - ], - "title": "API method: users.getPresence", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true, + "presence": "active" + } + } } } - }, - "description": "When requesting information for a different user, this method just returns the current presence (either `active` or `away`)." + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { + "title": "UsersCountsErrorSchema", + "type": "object", + "description": "Schema for error response users.getPresence method", "additionalProperties": { "type": "object" }, - "description": "Schema for error response users.getPresence method", "properties": { "error": { "type": "string" @@ -22617,13 +22564,18 @@ "required": [ "ok", "error" - ], - "title": "users.counts error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -22633,38 +22585,36 @@ ] } ], - "tags": [ - "users" + "operationId": "users_getPresence", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/users.getPresence" + }, + "parameters": [ + { + "description": "User to get presence info on. Defaults to the authed user.", + "in": "query", + "name": "user", + "schema": { + "type": "string" + } + } ] } }, "/users.identity": { "get": { "description": "Get a user's identity.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.identity" - }, - "operationId": "users_identity", + "tags": [ + "users" + ], "responses": { "200": { + "description": "You will receive at a minimum the following information:", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true, - "team": { - "id": "T0G9PQBBK" - }, - "user": { - "id": "U0G9QF9C6", - "name": "Sonny Whether" - } - } - } - }, "schema": { + "title": "UsersIdentitySchema", "description": "Schema for successful response from users.identity method", "items": { "anyOf": [ @@ -22923,27 +22873,34 @@ "type": "object" } ] - }, - "title": "users.identity schema" + } + }, + "examples": { + "response": { + "value": { + "ok": true, + "team": { + "id": "T0G9PQBBK" + }, + "user": { + "id": "U0G9QF9C6", + "name": "Sonny Whether" + } + } + } } } - }, - "description": "You will receive at a minimum the following information:" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "account_inactive", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersIdentityErrorSchema", + "type": "object", "description": "Schema for error response from users.identity method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -22980,13 +22937,18 @@ "required": [ "ok", "error" - ], - "title": "users.identity error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "account_inactive", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -22996,41 +22958,42 @@ ] } ], - "tags": [ - "users" - ] + "operationId": "users_identity", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/users.identity" + } } }, "/users.info": { "get": { "description": "Gets information about a user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.info" - }, - "operationId": "users_info", - "parameters": [ - { - "description": "Set this to `true` to receive the locale for this user. Defaults to `false`", - "in": "query", - "name": "include_locale", - "schema": { - "type": "boolean" - } - }, - { - "description": "User to get info on", - "in": "query", - "name": "user", - "schema": { - "type": "string" - } - } + "tags": [ + "users" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "UsersInfoSuccessSchema", + "type": "object", + "description": "Schema for successful response from users.info method", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "user": { + "$ref": "#/components/schemas/objs_user" + } + }, + "required": [ + "ok", + "user" + ] + }, "examples": { "response": { "value": { @@ -23075,43 +23038,19 @@ } } } - }, - "schema": { - "additionalProperties": true, - "description": "Schema for successful response from users.info method", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "user": { - "$ref": "#/components/schemas/objs_user" - } - }, - "required": [ - "ok", - "user" - ], - "title": "users.info success schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "user_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersInfoErrorSchema", + "type": "object", "description": "Schema for error response from users.info method", + "additionalProperties": false, "properties": { "callstack": { "type": "string" @@ -23140,17 +23079,22 @@ "ok": { "$ref": "#/components/schemas/defs_ok_false" } - }, - "required": [ - "ok", - "error" - ], - "title": "users.info error schema", - "type": "object" + }, + "required": [ + "ok", + "error" + ] + }, + "examples": { + "response": { + "value": { + "error": "user_not_found", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -23160,49 +23104,72 @@ ] } ], - "tags": [ - "users" - ] - } - }, - "/users.list": { - "get": { - "description": "Lists all users in a Slack team.", + "operationId": "users_info", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/users.list" + "url": "https://api.slack.com/methods/users.info" }, - "operationId": "users_list", "parameters": [ { - "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no `limit` value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience `limit_required` or HTTP 500 errors.", + "description": "Set this to `true` to receive the locale for this user. Defaults to `false`", "in": "query", - "name": "limit", + "name": "include_locale", "schema": { - "type": "integer" + "type": "boolean" } }, { - "description": "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](/docs/pagination) for more detail.", + "description": "User to get info on", "in": "query", - "name": "cursor", + "name": "user", "schema": { "type": "string" } - }, - { - "description": "Set this to `true` to receive the locale for users. Defaults to `false`", - "in": "query", - "name": "include_locale", - "schema": { - "type": "boolean" - } } + ] + } + }, + "/users.list": { + "get": { + "description": "Lists all users in a Slack team.", + "tags": [ + "users" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "UsersListSchema", + "type": "object", + "description": "Schema for successful response from users.list method", + "additionalProperties": false, + "properties": { + "cache_ts": { + "type": "integer" + }, + "members": { + "items": { + "$ref": "#/components/schemas/objs_user" + }, + "minItems": 1, + "type": "array", + "uniqueItems": true + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "response_metadata": { + "$ref": "#/components/schemas/objs_response_metadata" + } + }, + "required": [ + "ok", + "members", + "cache_ts" + ] + }, "examples": { "response": { "value": { @@ -23292,55 +23259,19 @@ } } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from users.list method", - "properties": { - "cache_ts": { - "type": "integer" - }, - "members": { - "items": { - "$ref": "#/components/schemas/objs_user" - }, - "minItems": 1, - "type": "array", - "uniqueItems": true - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "response_metadata": { - "$ref": "#/components/schemas/objs_response_metadata" - } - }, - "required": [ - "ok", - "members", - "cache_ts" - ], - "title": "users.list schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_cursor", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersListErrorSchema", + "type": "object", "description": "Schema for error response from users.list method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -23376,13 +23307,18 @@ "required": [ "ok", "error" - ], - "title": "users.list error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_cursor", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -23392,34 +23328,68 @@ ] } ], - "tags": [ - "users" - ] - } - }, - "/users.lookupByEmail": { - "get": { - "description": "Find a user with an email address.", + "operationId": "users_list", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/users.lookupByEmail" + "url": "https://api.slack.com/methods/users.list" }, - "operationId": "users_lookupByEmail", "parameters": [ { - "description": "An email address belonging to a user in the workspace", + "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no `limit` value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience `limit_required` or HTTP 500 errors.", "in": "query", - "name": "email", - "required": true, + "name": "limit", + "schema": { + "type": "integer" + } + }, + { + "description": "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](\/docs\/pagination) for more detail.", + "in": "query", + "name": "cursor", "schema": { "type": "string" } + }, + { + "description": "Set this to `true` to receive the locale for users. Defaults to `false`", + "in": "query", + "name": "include_locale", + "schema": { + "type": "boolean" + } } + ] + } + }, + "/users.lookupByEmail": { + "get": { + "description": "Find a user with an email address.", + "tags": [ + "users" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "UsersLookupByEmailSuccessSchema", + "type": "object", + "description": "Schema for successful response from users.lookupByEmail method", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "user": { + "$ref": "#/components/schemas/objs_user" + } + }, + "required": [ + "ok", + "user" + ] + }, "examples": { "response": { "value": { @@ -23463,43 +23433,19 @@ } } } - }, - "schema": { - "additionalProperties": true, - "description": "Schema for successful response from users.lookupByEmail method", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "user": { - "$ref": "#/components/schemas/objs_user" - } - }, - "required": [ - "ok", - "user" - ], - "title": "users.lookupByEmail success schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "users_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersLookupByEmailErrorSchema", + "type": "object", "description": "Schema for error response from users.lookupByEmail method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -23535,13 +23481,18 @@ "required": [ "ok", "error" - ], - "title": "users.lookupByEmail error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "users_not_found", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -23551,41 +23502,54 @@ ] } ], - "tags": [ - "users" - ] - } - }, - "/users.profile.get": { - "get": { - "description": "Retrieves a user's profile information.", + "operationId": "users_lookupByEmail", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/users.profile.get" + "url": "https://api.slack.com/methods/users.lookupByEmail" }, - "operationId": "users_profile_get", "parameters": [ { - "description": "Include labels for each ID in custom profile fields", - "in": "query", - "name": "include_labels", - "schema": { - "type": "boolean" - } - }, - { - "description": "User to retrieve profile info for", + "description": "An email address belonging to a user in the workspace", "in": "query", - "name": "user", + "name": "email", + "required": true, "schema": { "type": "string" } } + ] + } + }, + "/users.profile.get": { + "get": { + "description": "Retrieves a user's profile information.", + "tags": [ + "users.profile", + "users" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "UsersProfileGetSchema", + "type": "object", + "description": "Schema for successful response from users.profile.get method", + "additionalProperties": false, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "profile": { + "$ref": "#/components/schemas/objs_user_profile" + } + }, + "required": [ + "ok", + "profile" + ] + }, "examples": { "response": { "value": { @@ -23611,43 +23575,19 @@ } } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from users.profile.get method", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "profile": { - "$ref": "#/components/schemas/objs_user_profile" - } - }, - "required": [ - "ok", - "profile" - ], - "title": "users.profile.get schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "user_not_found", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersProfileGetErrorSchema", + "type": "object", "description": "Schema for error response from users.profile.get method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -23685,13 +23625,18 @@ "required": [ "ok", "error" - ], - "title": "users.profile.get error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "user_not_found", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -23701,20 +23646,38 @@ ] } ], - "tags": [ - "users.profile", - "users" + "operationId": "users_profile_get", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/users.profile.get" + }, + "parameters": [ + { + "description": "Include labels for each ID in custom profile fields", + "in": "query", + "name": "include_labels", + "schema": { + "type": "boolean" + } + }, + { + "description": "User to retrieve profile info for", + "in": "query", + "name": "user", + "schema": { + "type": "string" + } + } ] } }, "/users.profile.set": { "post": { "description": "Set the profile information for a user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.profile.set" - }, - "operationId": "users_profile_set", + "tags": [ + "users.profile", + "users" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -23744,8 +23707,35 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "UsersProfileSetSchema", + "type": "object", + "description": "Schema for successful response from users.profile.set method", + "additionalProperties": false, + "properties": { + "email_pending": { + "format": "email", + "type": "string" + }, + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + }, + "profile": { + "$ref": "#/components/schemas/objs_user_profile" + }, + "username": { + "type": "string" + } + }, + "required": [ + "ok", + "username", + "profile" + ] + }, "examples": { "response": { "value": { @@ -23770,51 +23760,19 @@ } } } - }, - "schema": { - "additionalProperties": false, - "description": "Schema for successful response from users.profile.set method", - "properties": { - "email_pending": { - "format": "email", - "type": "string" - }, - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - }, - "profile": { - "$ref": "#/components/schemas/objs_user_profile" - }, - "username": { - "type": "string" - } - }, - "required": [ - "ok", - "username", - "profile" - ], - "title": "users.profile.set schema", - "type": "object" } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_profile", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersProfileSetErrorSchema", + "type": "object", "description": "Schema for error response from users.profile.set method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -23857,13 +23815,18 @@ "required": [ "ok", "error" - ], - "title": "users.profile.set error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_profile", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -23873,34 +23836,29 @@ ] } ], - "tags": [ - "users.profile", - "users" - ] + "operationId": "users_profile_set", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/users.profile.set" + } } }, "/users.setActive": { "post": { "description": "Marked a user as active. Deprecated and non-functional.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.setActive" - }, - "operationId": "users_setActive", + "tags": [ + "users" + ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersSetActiveSchema", + "type": "object", "description": "Schema for successful response from users.setActive method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -23908,28 +23866,27 @@ }, "required": [ "ok" - ], - "title": "users.setActive schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersSetActiveErrorSchema", + "type": "object", "description": "Schema for error response from users.setActive method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -23965,13 +23922,18 @@ "required": [ "ok", "error" - ], - "title": "users.setActive error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -23981,19 +23943,19 @@ ] } ], - "tags": [ - "users" - ] + "operationId": "users_setActive", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/users.setActive" + } } }, "/users.setPhoto": { "post": { "description": "Set the user profile photo", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.setPhoto" - }, - "operationId": "users_setPhoto", + "tags": [ + "users" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -24031,18 +23993,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersSetPhotoSchema", + "type": "object", "description": "Schema for successful response from users.setPhoto method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -24104,28 +24062,27 @@ "required": [ "ok", "profile" - ], - "title": "users.setPhoto schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersSetPhotoErrorSchema", + "type": "object", "description": "Schema for error response from users.setPhoto method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -24178,13 +24135,18 @@ "required": [ "ok", "error" - ], - "title": "users.setPhoto error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -24194,19 +24156,19 @@ ] } ], - "tags": [ - "users" - ] + "operationId": "users_setPhoto", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/users.setPhoto" + } } }, "/users.setPresence": { "post": { "description": "Manually sets user presence.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/users.setPresence" - }, - "operationId": "users_setPresence", + "tags": [ + "users" + ], "requestBody": { "content": { "application/x-www-form-urlencoded": { @@ -24228,18 +24190,14 @@ }, "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersSetPresenceSchema", + "type": "object", "description": "Schema for successful response from users.setPresence method", + "additionalProperties": false, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -24247,28 +24205,27 @@ }, "required": [ "ok" - ], - "title": "users.setPresence schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": false, + "title": "UsersSetPresenceErrorSchema", + "type": "object", "description": "Schema for error response from users.setPresence method", + "additionalProperties": false, "properties": { "callstack": { "description": "Note: PHP callstack is only visible in dev/qa", @@ -24305,13 +24262,18 @@ "required": [ "ok", "error" - ], - "title": "users.setPresence error schema", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -24321,43 +24283,38 @@ ] } ], - "tags": [ - "users" - ] + "operationId": "users_setPresence", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/users.setPresence" + } } }, "/views.open": { "get": { "description": "Open a view for a user.", - "externalDocs": { - "description": "API method documentation", - "url": "https://api.slack.com/methods/views.open" - }, - "operationId": "views_open", - "parameters": [ - { - "description": "Exchange a trigger to post to the user.", - "in": "query", - "name": "trigger_id", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.", - "in": "query", - "name": "view", - "required": true, - "schema": { - "type": "string" - } - } + "tags": [ + "views" ], "responses": { "200": { + "description": "Typical success response includes the opened view payload.", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -24405,28 +24362,28 @@ } } } - }, + } + } + } + }, + "default": { + "description": "Typical error response, before getting to any possible validation errors.", + "content": { + "application/json": { "schema": { + "title": "DefaultErrorTemplate", + "type": "object", + "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/defs_ok_false" } }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" - } - } - }, - "description": "Typical success response includes the opened view payload." - }, - "default": { - "content": { - "application/json": { + ] + }, "examples": { "response": { "value": { @@ -24439,24 +24396,9 @@ } } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" } } - }, - "description": "Typical error response, before getting to any possible validation errors." + } } }, "security": [ @@ -24466,24 +24408,16 @@ ] } ], - "tags": [ - "views" - ] - } - }, - "/views.publish": { - "get": { - "description": "Publish a static view for a User.", + "operationId": "views_open", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/views.publish" + "url": "https://api.slack.com/methods/views.open" }, - "operationId": "views_publish", "parameters": [ { - "description": "`id` of the user you want publish a view to.", + "description": "Exchange a trigger to post to the user.", "in": "query", - "name": "user_id", + "name": "trigger_id", "required": true, "schema": { "type": "string" @@ -24497,20 +24431,35 @@ "schema": { "type": "string" } - }, - { - "description": "A string that represents view state to protect against possible race conditions.", - "in": "query", - "name": "hash", - "schema": { - "type": "string" - } } + ] + } + }, + "/views.publish": { + "get": { + "description": "Publish a static view for a User.", + "tags": [ + "views" ], "responses": { "200": { + "description": "Typical success response includes the published view payload.", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -24548,44 +24497,19 @@ } } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" } } - }, - "description": "Typical success response includes the published view payload." + } }, "default": { + "description": "Typical error response, before getting to any possible validation errors.", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_arguments", - "ok": false, - "response_metadata": { - "messages": [ - "invalid `user_id`" - ] - } - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -24593,13 +24517,23 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_arguments", + "ok": false, + "response_metadata": { + "messages": [ + "invalid `user_id`" + ] + } + } + } } } - }, - "description": "Typical error response, before getting to any possible validation errors." + } } }, "security": [ @@ -24609,24 +24543,16 @@ ] } ], - "tags": [ - "views" - ] - } - }, - "/views.push": { - "get": { - "description": "Push a view onto the stack of a root view.", + "operationId": "views_publish", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/views.push" + "url": "https://api.slack.com/methods/views.publish" }, - "operationId": "views_push", "parameters": [ { - "description": "Exchange a trigger to post to the user.", + "description": "`id` of the user you want publish a view to.", "in": "query", - "name": "trigger_id", + "name": "user_id", "required": true, "schema": { "type": "string" @@ -24640,12 +24566,43 @@ "schema": { "type": "string" } + }, + { + "description": "A string that represents view state to protect against possible race conditions.", + "in": "query", + "name": "hash", + "schema": { + "type": "string" + } } + ] + } + }, + "/views.push": { + "get": { + "description": "Push a view onto the stack of a root view.", + "tags": [ + "views" ], "responses": { "200": { + "description": "Typical success response includes the pushed view payload.", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -24699,28 +24656,28 @@ } } } - }, + } + } + } + }, + "default": { + "description": "Typical error response.", + "content": { + "application/json": { "schema": { + "title": "DefaultErrorTemplate", + "type": "object", + "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/defs_ok_false" } }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" - } - } - }, - "description": "Typical success response includes the pushed view payload." - }, - "default": { - "content": { - "application/json": { + ] + }, "examples": { "response": { "value": { @@ -24733,24 +24690,9 @@ } } } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" } } - }, - "description": "Typical error response." + } } }, "security": [ @@ -24760,57 +24702,58 @@ ] } ], - "tags": [ - "views" - ] - } - }, - "/views.update": { - "get": { - "description": "Update an existing view.", + "operationId": "views_push", "externalDocs": { "description": "API method documentation", - "url": "https://api.slack.com/methods/views.update" + "url": "https://api.slack.com/methods/views.push" }, - "operationId": "views_update", "parameters": [ { - "description": "A unique identifier of the view to be updated. Either `view_id` or `external_id` is required.", - "in": "query", - "name": "view_id", - "schema": { - "type": "string" - } - }, - { - "description": "A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either `view_id` or `external_id` is required.", + "description": "Exchange a trigger to post to the user.", "in": "query", - "name": "external_id", + "name": "trigger_id", + "required": true, "schema": { "type": "string" } }, { - "description": "A [view object](/reference/surfaces/views). This must be a JSON-encoded string.", + "description": "A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.", "in": "query", "name": "view", - "schema": { - "type": "string" - } - }, - { - "description": "A string that represents view state to protect against possible race conditions.", - "in": "query", - "name": "hash", + "required": true, "schema": { "type": "string" } } + ] + } + }, + "/views.update": { + "get": { + "description": "Update an existing view.", + "tags": [ + "views" ], "responses": { "200": { + "description": "Typical success response includes the updated view payload.", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { @@ -24865,39 +24808,132 @@ } } } - }, + } + } + } + }, + "default": { + "description": "Typical error response.", + "content": { + "application/json": { "schema": { + "title": "DefaultErrorTemplate", + "type": "object", + "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/defs_ok_false" } }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "not_found", + "ok": false + } + } } } - }, - "description": "Typical success response includes the updated view payload." + } + } + }, + "security": [ + { + "slackAuth": [ + "none" + ] + } + ], + "operationId": "views_update", + "externalDocs": { + "description": "API method documentation", + "url": "https://api.slack.com/methods/views.update" + }, + "parameters": [ + { + "description": "A unique identifier of the view to be updated. Either `view_id` or `external_id` is required.", + "in": "query", + "name": "view_id", + "schema": { + "type": "string" + } }, - "default": { + { + "description": "A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either `view_id` or `external_id` is required.", + "in": "query", + "name": "external_id", + "schema": { + "type": "string" + } + }, + { + "description": "A [view object](/reference/surfaces/views). This must be a JSON-encoded string.", + "in": "query", + "name": "view", + "schema": { + "type": "string" + } + }, + { + "description": "A string that represents view state to protect against possible race conditions.", + "in": "query", + "name": "hash", + "schema": { + "type": "string" + } + } + ] + } + }, + "/workflows.stepCompleted": { + "get": { + "description": "Indicate that an app's step in a workflow completed execution.", + "tags": [ + "workflows" + ], + "responses": { + "200": { + "description": "Typical success response", "content": { "application/json": { + "schema": { + "title": "DefaultSuccessResponse", + "type": "object", + "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, + "properties": { + "ok": { + "$ref": "#/components/schemas/defs_ok_true" + } + }, + "required": [ + "ok" + ] + }, "examples": { "response": { "value": { - "error": "not_found", - "ok": false + "ok": true } } - }, + } + } + } + }, + "default": { + "description": "Typical error response", + "content": { + "application/json": { "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -24905,35 +24941,32 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response." + } } }, "security": [ { "slackAuth": [ - "none" + "workflow.steps:execute" ] } ], - "tags": [ - "views" - ] - } - }, - "/workflows.stepCompleted": { - "get": { - "description": "Indicate that an app's step in a workflow completed execution.", + "operationId": "workflows_stepCompleted", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/workflows.stepCompleted" }, - "operationId": "workflows_stepCompleted", "parameters": [ { "description": "Context identifier that maps to the correct workflow step execution.", @@ -24952,21 +24985,25 @@ "type": "string" } } + ] + } + }, + "/workflows.stepFailed": { + "get": { + "description": "Indicate that an app's step in a workflow failed to execute.", + "tags": [ + "workflows" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -24974,28 +25011,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -25003,13 +25039,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -25019,19 +25060,11 @@ ] } ], - "tags": [ - "workflows" - ] - } - }, - "/workflows.stepFailed": { - "get": { - "description": "Indicate that an app's step in a workflow failed to execute.", + "operationId": "workflows_stepFailed", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/workflows.stepFailed" }, - "operationId": "workflows_stepFailed", "parameters": [ { "description": "Context identifier that maps to the correct workflow step execution.", @@ -25051,21 +25084,25 @@ "type": "string" } } + ] + } + }, + "/workflows.updateStep": { + "get": { + "description": "Update the configuration for a workflow extension step.", + "tags": [ + "workflows" ], "responses": { "200": { + "description": "Typical success response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultSuccessResponse", + "type": "object", "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_true" @@ -25073,28 +25110,27 @@ }, "required": [ "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "ok": true + } + } } } - }, - "description": "Typical success response" + } }, "default": { + "description": "Typical error response", "content": { "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, "schema": { - "additionalProperties": true, + "title": "DefaultErrorTemplate", + "type": "object", "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", + "additionalProperties": true, "properties": { "ok": { "$ref": "#/components/schemas/defs_ok_false" @@ -25102,13 +25138,18 @@ }, "required": [ "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" + ] + }, + "examples": { + "response": { + "value": { + "error": "invalid_auth", + "ok": false + } + } } } - }, - "description": "Typical error response" + } } }, "security": [ @@ -25118,19 +25159,11 @@ ] } ], - "tags": [ - "workflows" - ] - } - }, - "/workflows.updateStep": { - "get": { - "description": "Update the configuration for a workflow extension step.", + "operationId": "workflows_updateStep", "externalDocs": { "description": "API method documentation", "url": "https://api.slack.com/methods/workflows.updateStep" }, - "operationId": "workflows_updateStep", "parameters": [ { "description": "A context identifier provided with `view_submission` payloads used to call back to `workflows.updateStep`.", @@ -25173,75 +25206,6 @@ "type": "string" } } - ], - "responses": { - "200": { - "content": { - "application/json": { - "examples": { - "response": { - "value": { - "ok": true - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_true" - } - }, - "required": [ - "ok" - ], - "title": "DefaultSuccessResponse", - "type": "object" - } - } - }, - "description": "Typical success response" - }, - "default": { - "content": { - "application/json": { - "examples": { - "response": { - "value": { - "error": "invalid_auth", - "ok": false - } - } - }, - "schema": { - "additionalProperties": true, - "description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.", - "properties": { - "ok": { - "$ref": "#/components/schemas/defs_ok_false" - } - }, - "required": [ - "ok" - ], - "title": "DefaultErrorTemplate", - "type": "object" - } - } - }, - "description": "Typical error response" - } - }, - "security": [ - { - "slackAuth": [ - "workflow.steps:execute" - ] - } - ], - "tags": [ - "workflows" ] } } @@ -28176,5 +28140,40 @@ "type": "oauth2" } } - } + }, + "servers": [ + { + "url": "https://slack.com/api" + } + ], + "openapi": "3.0.0", + "externalDocs": { + "description": "Learn more about the Slack Web API", + "url": "https://api.slack.com/web" + }, + "info": { + "contact": { + "name": "Slack developer relations", + "url": "https://api.slack.com/support" + }, + "description": "One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens blessed with related OAuth scopes.", + "title": "Slack Web API", + "version": "1.7.0", + "x-apisguru-categories": [ + "collaboration", + "messaging" + ], + "x-logo": { + "url": "https://api.apis.guru/v2/cache/logo/http_static.tumblr.com_wvuzcz9_LlKncfhmp_slack_logo_240.png" + }, + "x-origin": [ + { + "format": "openapi", + "url": "https://raw.githubusercontent.com/slackapi/slack-api-specs/master/web-api/slack_web_openapi_v2.json", + "version": "3.0" + } + ], + "x-providerName": "slack.com" + }, + "tags": [] } \ No newline at end of file diff --git a/docs/spec/sanitations.bal b/docs/spec/sanitations.bal new file mode 100644 index 0000000..fe735db --- /dev/null +++ b/docs/spec/sanitations.bal @@ -0,0 +1,105 @@ +// Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org) All Rights Reserved. +// +// WSO2 LLC. licenses this file to you under the Apache License, +// Version 2.0 (the "License"); you may not use this file except +// in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +import ballerina/io; +import ballerina/lang.regexp; + +type Specification record { + map paths; +}; + +type Path record { + Get get?; + Post post?; +}; + +type Get record { + string summary?; + string description?; + string[] tags?; + map responses?; +}; + +type Post record { + string summary?; + string description?; + string[] tags?; + json requestBody?; + map responses?; +}; + +type ResponseCode record { + string description?; + map content?; +}; + +type ResponseHeader record { + ResponseSchema schema?; +}; + +type ResponseSchema record { + string title?; + string 'type?; + string schemaType?; +}; + +const SPEC_PATH = "openapi.json"; +const CONTENT_TYPE_JSON = "application/json"; +final regexp:RegExp MALFORMED_TITLE_REGEX = re `\w+[\.\s]\w+.*`; + +public function main() returns error? { + json openAPISpec = check io:fileReadJson(SPEC_PATH); + Specification spec = check openAPISpec.cloneWithType(Specification); + Specification sanitisedSpec = check sanitizeResponseSchemaNames(spec); + check io:fileWriteJson(SPEC_PATH, sanitisedSpec.toJson()); +} + +function sanitizeResponseSchemaNames(Specification spec) returns Specification|error { + map paths = spec.paths; + foreach var [_, value] in paths.entries() { + map? responses = (); + if value.get !is () { + responses = value?.get?.responses; + } else if value.post !is () { + responses = value?.post?.responses; + } + + if responses !is map { + continue; + } + foreach [string, ResponseCode] [_, item] in responses.entries() { + map content = item.content ?: {}; + ResponseHeader app = content[CONTENT_TYPE_JSON] ?: {}; + ResponseSchema schema = app.schema ?: {}; + string? title = schema.title; + if title !is string { + continue; + } + + // if the title is malformed, sanitize it by removing special characters and converting to pascal case + if MALFORMED_TITLE_REGEX.isFullMatch(title) { + string tempTitle = re `\.`.replaceAll(title, " "); + string[] nameParts = re ` `.split(tempTitle); + string[] capitalizedTitle = from string namePart in nameParts + select namePart[0].toUpperAscii() + namePart.substring(1, namePart.length()); + string sanitizedTitle = string:'join("", ...capitalizedTitle); + schema.title = sanitizedTitle; + } + } + } + + return spec; +} diff --git a/docs/spec/sanitations.md b/docs/spec/sanitations.md index ff37a43..aa25a53 100644 --- a/docs/spec/sanitations.md +++ b/docs/spec/sanitations.md @@ -28,7 +28,8 @@ These changes are done in order to improve the overall usability, and to address * users.deletePhoto * users.setPhoto -2. Changed the schema name `Default success template` to `DefaultSuccessResponse` in the components section of the OpenAPI specification, to improve the usability of the counterpart Ballerina record name. +2. Sanitized the inline response schema titles by removing the whitespaces and special characters and, converting them to pascal case. + * This was done using the `sanitations.bal` script. ## OpenAPI cli command From c6f011d7b3bc34161e18c86ac4e0ea5f78a291f5 Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Thu, 11 Jul 2024 20:57:44 +0530 Subject: [PATCH 04/12] Add more sanitation to inline response names --- docs/spec/openapi.json | 402 +++++++++++++++++++------------------- docs/spec/sanitations.bal | 7 +- 2 files changed, 206 insertions(+), 203 deletions(-) diff --git a/docs/spec/openapi.json b/docs/spec/openapi.json index 0c819fb..3bca984 100644 --- a/docs/spec/openapi.json +++ b/docs/spec/openapi.json @@ -710,7 +710,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsArchiveSchema", + "title": "AdminConversationsArchiveResponse", "type": "object", "description": "Schema for successful response of admin.conversations.archive", "additionalProperties": false, @@ -738,7 +738,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsArchiveErrorSchema", + "title": "AdminConversationsArchiveErrorResponse", "type": "object", "description": "Schema for error response from admin.conversations.archive", "additionalProperties": false, @@ -823,7 +823,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsConvertToPrivateSchema", + "title": "AdminConversationsConvertToPrivateResponse", "type": "object", "description": "Schema for successful response of admin.conversations.convertToPrivate", "additionalProperties": false, @@ -851,7 +851,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsConvertToPrivateErrorSchema", + "title": "AdminConversationsConvertToPrivateErrorResponse", "type": "object", "description": "Schema for error response from admin.conversations.convertToPrivate", "additionalProperties": false, @@ -954,7 +954,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsCreateSchema", + "title": "AdminConversationsCreateResponse", "type": "object", "description": "Schema for successful response of admin.conversations.create", "additionalProperties": false, @@ -986,7 +986,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsCreateErrorSchema", + "title": "AdminConversationsCreateErrorResponse", "type": "object", "description": "Schema for error response from admin.conversations.create", "additionalProperties": false, @@ -1071,7 +1071,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsDeleteSchema", + "title": "AdminConversationsDeleteResponse", "type": "object", "description": "Schema for successful response of admin.conversations.delete", "additionalProperties": false, @@ -1099,7 +1099,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsDeleteErrorSchema", + "title": "AdminConversationsDeleteErrorResponse", "type": "object", "description": "Schema for error response from admin.conversations.delete", "additionalProperties": false, @@ -1188,7 +1188,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsRenameSchema", + "title": "AdminConversationsRenameResponse", "type": "object", "description": "Schema for successful response of admin.conversations.disconnectShared", "additionalProperties": false, @@ -1216,7 +1216,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsDisconnectSharedErrorSchema", + "title": "AdminConversationsDisconnectSharedErrorResponse", "type": "object", "description": "Schema for error response from admin.conversations.disconnectShared", "additionalProperties": false, @@ -1409,7 +1409,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsGetConversationPrefsSchema", + "title": "AdminConversationsGetConversationPrefsResponse", "type": "object", "description": "Schema for successful response of admin.conversations.getConversationPrefs", "additionalProperties": false, @@ -1476,7 +1476,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsUnarchiveErrorSchema", + "title": "AdminConversationsUnarchiveErrorResponse", "type": "object", "description": "Schema for error response from admin.conversations.getConversationPrefs", "additionalProperties": false, @@ -1553,7 +1553,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsGetTeamsSchema", + "title": "AdminConversationsGetTeamsResponse", "type": "object", "description": "Schema for successful response of admin.conversations.getTeams", "additionalProperties": false, @@ -1604,7 +1604,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsGetTeamsErrorSchema", + "title": "AdminConversationsGetTeamsErrorResponse", "type": "object", "description": "Schema for error response from admin.conversations.getTeams", "additionalProperties": false, @@ -1721,7 +1721,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsInviteSchema", + "title": "AdminConversationsInviteResponse", "type": "object", "description": "Schema for successful response of admin.conversations.invite", "additionalProperties": false, @@ -1749,7 +1749,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsInviteErrorSchema", + "title": "AdminConversationsInviteErrorResponse", "type": "object", "description": "Schema for error response from admin.conversations.invite", "additionalProperties": true, @@ -1837,7 +1837,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsRenameSchema", + "title": "AdminConversationsRenameResponse", "type": "object", "description": "Schema for successful response of admin.conversations.rename", "additionalProperties": false, @@ -1865,7 +1865,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsUnarchiveErrorSchema", + "title": "AdminConversationsUnarchiveErrorResponse", "type": "object", "description": "Schema for error response from admin.conversations.rename", "additionalProperties": false, @@ -2258,7 +2258,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsSearchSchema", + "title": "AdminConversationsSearchResponse", "type": "object", "description": "Schema for successful response of admin.conversations.search", "additionalProperties": false, @@ -2331,7 +2331,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsSearchErrorSchema", + "title": "AdminConversationsSearchErrorResponse", "type": "object", "description": "Schema for error response from admin.conversations.search", "additionalProperties": false, @@ -2481,7 +2481,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsSetConversationPrefsSchema", + "title": "AdminConversationsSetConversationPrefsResponse", "type": "object", "description": "Schema for successful response of admin.conversations.setConversationPrefs", "additionalProperties": false, @@ -2509,7 +2509,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsSetConversationPrefsErrorSchema", + "title": "AdminConversationsSetConversationPrefsErrorResponse", "type": "object", "description": "Schema for error response from admin.conversations.setConversationPrefs", "additionalProperties": false, @@ -2705,7 +2705,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsUnarchiveSchema", + "title": "AdminConversationsUnarchiveResponse", "type": "object", "description": "Schema for successful response of admin.conversations.unarchive", "additionalProperties": false, @@ -2733,7 +2733,7 @@ "content": { "application/json": { "schema": { - "title": "AdminConversationsUnarchiveErrorSchema", + "title": "AdminConversationsUnarchiveErrorResponse", "type": "object", "description": "Schema for error response from admin.conversations.unarchive", "additionalProperties": false, @@ -6480,7 +6480,7 @@ "content": { "application/json": { "schema": { - "title": "ApiTestSuccessSchema", + "title": "ApiTestResponse", "type": "object", "description": "Schema for successful response api.test method", "additionalProperties": { @@ -6510,7 +6510,7 @@ "content": { "application/json": { "schema": { - "title": "ApiTestErrorSchema", + "title": "ApiTestErrorResponse", "type": "object", "description": "Schema for error response api.test method", "additionalProperties": { @@ -6691,7 +6691,7 @@ "content": { "application/json": { "schema": { - "title": "AppsPermissionsInfoSchema", + "title": "AppsPermissionsInfoResponse", "type": "object", "description": "Schema for successful response from apps.permissions.info method", "additionalProperties": false, @@ -6854,7 +6854,7 @@ "content": { "application/json": { "schema": { - "title": "AppsPermissionsInfoErrorSchema", + "title": "AppsPermissionsInfoErrorResponse", "type": "object", "description": "Schema for error response from apps.permissions.info method", "additionalProperties": false, @@ -6935,7 +6935,7 @@ "content": { "application/json": { "schema": { - "title": "AppsPermissionsRequestSchema", + "title": "AppsPermissionsRequestResponse", "type": "object", "description": "Schema for successful response from apps.permissions.request method", "additionalProperties": false, @@ -6963,7 +6963,7 @@ "content": { "application/json": { "schema": { - "title": "AppsPermissionsRequestErrorSchema", + "title": "AppsPermissionsRequestErrorResponse", "type": "object", "description": "Schema for error response from apps.permissions.request method", "additionalProperties": false, @@ -7068,7 +7068,7 @@ "content": { "application/json": { "schema": { - "title": "AppsPermissionsResourcesListSuccessSchema", + "title": "AppsPermissionsResourcesListResponse", "type": "object", "description": "Schema for successful response apps.permissions.resources.list method", "additionalProperties": true, @@ -7154,7 +7154,7 @@ "content": { "application/json": { "schema": { - "title": "AppsPermissionsResourcesListErrorSchema", + "title": "AppsPermissionsResourcesListErrorResponse", "type": "object", "description": "Schema for error response from apps.permissions.resources.list method", "additionalProperties": false, @@ -7254,7 +7254,7 @@ "content": { "application/json": { "schema": { - "title": "ApiPermissionsScopesListSuccessSchema", + "title": "ApiPermissionsScopesListResponse", "type": "object", "description": "Schema for successful response api.permissions.scopes.list method", "additionalProperties": true, @@ -7334,7 +7334,7 @@ "content": { "application/json": { "schema": { - "title": "AppsPermissionsScopesListErrorSchema", + "title": "AppsPermissionsScopesListErrorResponse", "type": "object", "description": "Schema for error response from apps.permissions.scopes.list method", "additionalProperties": false, @@ -7639,7 +7639,7 @@ "content": { "application/json": { "schema": { - "title": "AppsUninstallSchema", + "title": "AppsUninstallResponse", "type": "object", "description": "Schema for successful response from apps.uninstall method", "additionalProperties": false, @@ -7667,7 +7667,7 @@ "content": { "application/json": { "schema": { - "title": "AppsUninstallErrorSchema", + "title": "AppsUninstallErrorResponse", "type": "object", "description": "Schema for error response from apps.uninstall method", "additionalProperties": false, @@ -7768,7 +7768,7 @@ "content": { "application/json": { "schema": { - "title": "AuthRevokeSchema", + "title": "AuthRevokeResponse", "type": "object", "description": "Schema for successful response from auth.revoke method", "additionalProperties": false, @@ -7801,7 +7801,7 @@ "content": { "application/json": { "schema": { - "title": "AuthRevokeErrorSchema", + "title": "AuthRevokeErrorResponse", "type": "object", "description": "Schema for error response from auth.revoke method", "additionalProperties": false, @@ -7890,7 +7890,7 @@ "content": { "application/json": { "schema": { - "title": "AuthTestSuccessSchema", + "title": "AuthTestResponse", "type": "object", "description": "Schema for successful response auth.test method", "additionalProperties": false, @@ -7949,7 +7949,7 @@ "content": { "application/json": { "schema": { - "title": "AuthTestErrorSchema", + "title": "AuthTestErrorResponse", "type": "object", "description": "Schema for error response auth.test method", "additionalProperties": false, @@ -8024,7 +8024,7 @@ "content": { "application/json": { "schema": { - "title": "BotsInfoSchema", + "title": "BotsInfoResponse", "type": "object", "description": "Schema for successful response from bots.info method", "additionalProperties": false, @@ -8121,7 +8121,7 @@ "content": { "application/json": { "schema": { - "title": "BotsInfoErrorSchema", + "title": "BotsInfoErrorResponse", "type": "object", "description": "Schema for error response from bots.info method", "additionalProperties": false, @@ -8871,7 +8871,7 @@ "content": { "application/json": { "schema": { - "title": "ChatDeleteSuccessSchema", + "title": "ChatDeleteResponse", "type": "object", "description": "Schema for successful response of chat.delete method", "additionalProperties": false, @@ -8909,7 +8909,7 @@ "content": { "application/json": { "schema": { - "title": "ChatDeleteErrorSchema", + "title": "ChatDeleteErrorResponse", "type": "object", "description": "Schema for error response from chat.delete method", "additionalProperties": false, @@ -9019,7 +9019,7 @@ "content": { "application/json": { "schema": { - "title": "ChatDeleteScheduledMessageSchema", + "title": "ChatDeleteScheduledMessageResponse", "type": "object", "description": "Schema for successful response from chat.deleteScheduledMessage method", "additionalProperties": false, @@ -9047,7 +9047,7 @@ "content": { "application/json": { "schema": { - "title": "ChatDeleteScheduledMessageErrorSchema", + "title": "ChatDeleteScheduledMessageErrorResponse", "type": "object", "description": "Schema for error response from chat.deleteScheduledMessage method", "additionalProperties": false, @@ -9132,7 +9132,7 @@ "content": { "application/json": { "schema": { - "title": "ChatGetPermalinkSuccessSchema", + "title": "ChatGetPermalinkResponse", "type": "object", "description": "Schema for successful response chat.getPermalink", "additionalProperties": false, @@ -9171,7 +9171,7 @@ "content": { "application/json": { "schema": { - "title": "ChatGetPermalinkErrorSchema", + "title": "ChatGetPermalinkErrorResponse", "type": "object", "description": "Schema for error response from chat.getPermalink method", "additionalProperties": false, @@ -9291,7 +9291,7 @@ "content": { "application/json": { "schema": { - "title": "ChatMeMessageSchema", + "title": "ChatMeMessageResponse", "type": "object", "description": "Schema for successful response from chat.meMessage method", "additionalProperties": false, @@ -9327,7 +9327,7 @@ "content": { "application/json": { "schema": { - "title": "ChatMeMessageErrorSchema", + "title": "ChatMeMessageErrorResponse", "type": "object", "description": "Schema for error response from chat.meMessage method", "additionalProperties": false, @@ -9476,7 +9476,7 @@ "content": { "application/json": { "schema": { - "title": "ChatPostEphemeralSuccessSchema", + "title": "ChatPostEphemeralResponse", "type": "object", "description": "Schema for successful response from chat.postEphemeral method", "additionalProperties": false, @@ -9509,7 +9509,7 @@ "content": { "application/json": { "schema": { - "title": "ChatPostEphemeralErrorSchema", + "title": "ChatPostEphemeralErrorResponse", "type": "object", "description": "Schema for error response from chat.postEphemeral method", "additionalProperties": false, @@ -9670,7 +9670,7 @@ "content": { "application/json": { "schema": { - "title": "ChatPostMessageSuccessSchema", + "title": "ChatPostMessageResponse", "type": "object", "description": "Schema for successful response of chat.postMessage method", "additionalProperties": false, @@ -9727,7 +9727,7 @@ "content": { "application/json": { "schema": { - "title": "ChatPostMessageErrorSchema", + "title": "ChatPostMessageErrorResponse", "type": "object", "description": "Schema for error response chat.postMessage method", "additionalProperties": false, @@ -9864,7 +9864,7 @@ "content": { "application/json": { "schema": { - "title": "ChatScheduleMessageSuccessSchema", + "title": "ChatScheduleMessageResponse", "type": "object", "description": "Schema for successful response of chat.scheduleMessage method", "additionalProperties": false, @@ -9959,7 +9959,7 @@ "content": { "application/json": { "schema": { - "title": "ChatScheduleMessageErrorSchema", + "title": "ChatScheduleMessageErrorResponse", "type": "object", "description": "Schema for error response chat.scheduleMessage method", "additionalProperties": false, @@ -10056,7 +10056,7 @@ "content": { "application/json": { "schema": { - "title": "ChatScheduledMessagesListSchema", + "title": "ChatScheduledMessagesListResponse", "type": "object", "description": "Schema for successful response from chat.scheduledMessages.list method", "additionalProperties": false, @@ -10143,7 +10143,7 @@ "content": { "application/json": { "schema": { - "title": "ChatScheduledMessagesListErrorSchema", + "title": "ChatScheduledMessagesListErrorResponse", "type": "object", "description": "Schema for error response from chat.scheduledMessages.list method", "additionalProperties": false, @@ -10307,7 +10307,7 @@ "content": { "application/json": { "schema": { - "title": "ChatUnfurlSuccessSchema", + "title": "ChatUnfurlResponse", "type": "object", "description": "Schema for successful response from chat.unfurl method", "additionalProperties": false, @@ -10335,7 +10335,7 @@ "content": { "application/json": { "schema": { - "title": "ChatUnfurlErrorSchema", + "title": "ChatUnfurlErrorResponse", "type": "object", "description": "Schema for error response from chat.unfurl method", "additionalProperties": false, @@ -10466,7 +10466,7 @@ "content": { "application/json": { "schema": { - "title": "ChatUpdateSuccessSchema", + "title": "ChatUpdateResponse", "type": "object", "description": "Schema for successful response of chat.update method", "additionalProperties": false, @@ -10535,7 +10535,7 @@ "content": { "application/json": { "schema": { - "title": "ChatUpdateErrorSchema", + "title": "ChatUpdateErrorResponse", "type": "object", "description": "Schema for error response chat.update method", "additionalProperties": false, @@ -10637,7 +10637,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsArchiveSuccessSchema", + "title": "ConversationsArchiveResponse", "type": "object", "description": "Schema for successful response conversations.archive method", "additionalProperties": false, @@ -10665,7 +10665,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsArchiveErrorSchema", + "title": "ConversationsArchiveErrorResponse", "type": "object", "description": "Schema for error response from conversations.archive method", "additionalProperties": false, @@ -10776,7 +10776,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsCloseSuccessSchema", + "title": "ConversationsCloseResponse", "type": "object", "description": "Schema for successful response conversations.close method", "additionalProperties": false, @@ -10810,7 +10810,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsCloseErrorSchema", + "title": "ConversationsCloseErrorResponse", "type": "object", "description": "Schema for error response from conversations.close method", "additionalProperties": false, @@ -10917,7 +10917,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsCreateSuccessSchema", + "title": "ConversationsCreateResponse", "type": "object", "description": "Schema for successful response conversations.create method", "additionalProperties": false, @@ -10986,7 +10986,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsCreateErrorSchema", + "title": "ConversationsCreateErrorResponse", "type": "object", "description": "Schema for error response from conversations.create method", "additionalProperties": false, @@ -11085,7 +11085,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsHistorySuccessSchema", + "title": "ConversationsHistoryResponse", "type": "object", "description": "Schema for successful response from conversations.history method", "additionalProperties": false, @@ -11166,7 +11166,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsHistoryErrorSchema", + "title": "ConversationsHistoryErrorResponse", "type": "object", "description": "Schema for error response from conversations.history method", "additionalProperties": false, @@ -11303,7 +11303,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsInfoSuccessSchema", + "title": "ConversationsInfoResponse", "type": "object", "description": "Schema for successful response conversations.info", "additionalProperties": false, @@ -11375,7 +11375,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsInfoErrorSchema", + "title": "ConversationsInfoErrorResponse", "type": "object", "description": "Schema for error response from conversations.info method", "additionalProperties": false, @@ -11506,7 +11506,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsInviteErrorSchema", + "title": "ConversationsInviteErrorResponse", "type": "object", "description": "Schema for successful response from conversations.invite method", "additionalProperties": false, @@ -11578,7 +11578,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsInviteErrorSchema", + "title": "ConversationsInviteErrorResponse", "type": "object", "description": "Schema for error response from conversations.invite method", "additionalProperties": false, @@ -11751,7 +11751,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsJoinSuccessSchema", + "title": "ConversationsJoinResponse", "type": "object", "description": "Schema for successful response from conversations.join method", "additionalProperties": false, @@ -11838,7 +11838,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsJoinErrorSchema", + "title": "ConversationsJoinErrorResponse", "type": "object", "description": "Schema for error response from conversations.join method", "additionalProperties": false, @@ -11947,7 +11947,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsKickSuccessSchema", + "title": "ConversationsKickResponse", "type": "object", "description": "Schema for successful response conversations.kick method", "additionalProperties": false, @@ -11975,7 +11975,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsKickErrorSchema", + "title": "ConversationsKickErrorResponse", "type": "object", "description": "Schema for error response conversations.kick method", "additionalProperties": false, @@ -12083,7 +12083,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsLeaveSuccessSchema", + "title": "ConversationsLeaveResponse", "type": "object", "description": "Schema for successful response from conversations.leave method", "additionalProperties": false, @@ -12117,7 +12117,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsLeaveErrorSchema", + "title": "ConversationsLeaveErrorResponse", "type": "object", "description": "Schema for error response from conversations.leave method", "additionalProperties": false, @@ -12212,7 +12212,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsListSuccessSchema", + "title": "ConversationsListResponse", "type": "object", "description": "Schema for successful response from conversations.list method", "additionalProperties": false, @@ -12331,7 +12331,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsListErrorSchema", + "title": "ConversationsListErrorResponse", "type": "object", "description": "Schema for error response from conversations.list method", "additionalProperties": false, @@ -12468,7 +12468,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsMarkSuccessSchema", + "title": "ConversationsMarkResponse", "type": "object", "description": "Schema for successful response conversations.mark method", "additionalProperties": false, @@ -12496,7 +12496,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsMarkErrorSchema", + "title": "ConversationsMarkErrorResponse", "type": "object", "description": "Schema for error response from conversations.mark method", "additionalProperties": false, @@ -12585,7 +12585,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsMembersSuccessSchema", + "title": "ConversationsMembersResponse", "type": "object", "description": "Schema for successful response conversations.members method", "additionalProperties": false, @@ -12643,7 +12643,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsMembersErrorSchema", + "title": "ConversationsMembersErrorResponse", "type": "object", "description": "Schema for error response conversations.members method", "additionalProperties": false, @@ -12774,7 +12774,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsOpenSuccessSchema", + "title": "ConversationsOpenResponse", "type": "object", "description": "Schema for successful response from conversations.open method when opening channels, ims, mpims", "additionalProperties": false, @@ -12857,7 +12857,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsOpenErrorSchema", + "title": "ConversationsOpenErrorResponse", "type": "object", "description": "Schema for error response from conversations.open method", "additionalProperties": false, @@ -12963,7 +12963,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsRenameSuccessSchema", + "title": "ConversationsRenameResponse", "type": "object", "description": "Schema for successful response from conversations.rename method", "additionalProperties": false, @@ -13035,7 +13035,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsRenameErrorSchema", + "title": "ConversationsRenameErrorResponse", "type": "object", "description": "Schema for error response from conversations.rename method", "additionalProperties": false, @@ -13130,7 +13130,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsRepliesSuccessSchema", + "title": "ConversationsRepliesResponse", "type": "object", "description": "Schema for successful response from conversations.replies method", "additionalProperties": false, @@ -13326,7 +13326,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsRepliesErrorSchema", + "title": "ConversationsRepliesErrorResponse", "type": "object", "description": "Schema for error response from conversations.replies method", "additionalProperties": false, @@ -13490,7 +13490,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsSetPurposeSuccessSchema", + "title": "ConversationsSetPurposeResponse", "type": "object", "description": "Schema for successful response from conversations.setPurpose method", "additionalProperties": false, @@ -13522,7 +13522,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsSetPurposeErrorSchema", + "title": "ConversationsSetPurposeErrorResponse", "type": "object", "description": "Schema for error response from conversations.setPurpose method", "additionalProperties": false, @@ -13632,7 +13632,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsSetTopicSuccessSchema", + "title": "ConversationsSetTopicResponse", "type": "object", "description": "Schema for successful response from conversations.setTopic method", "additionalProperties": false, @@ -13664,7 +13664,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsSetTopicErrorSchema", + "title": "ConversationsSetTopicErrorResponse", "type": "object", "description": "Schema for error response from conversations.setTopic method", "additionalProperties": false, @@ -13770,7 +13770,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsUnarchiveSuccessSchema", + "title": "ConversationsUnarchiveResponse", "type": "object", "description": "Schema for successful response from conversations.unarchive method", "additionalProperties": false, @@ -13798,7 +13798,7 @@ "content": { "application/json": { "schema": { - "title": "ConversationsUnarchiveErrorSchema", + "title": "ConversationsUnarchiveErrorResponse", "type": "object", "description": "Schema for error response from conversations.unarchive method", "additionalProperties": false, @@ -13891,7 +13891,7 @@ "content": { "application/json": { "schema": { - "title": "DialogOpenSchema", + "title": "DialogOpenResponse", "type": "object", "description": "Schema for successful response from dialog.open method", "additionalProperties": false, @@ -13919,7 +13919,7 @@ "content": { "application/json": { "schema": { - "title": "DialogOpenErrorSchema", + "title": "DialogOpenErrorResponse", "type": "object", "description": "Schema for error response from dialog.open method", "additionalProperties": false, @@ -14027,7 +14027,7 @@ "content": { "application/json": { "schema": { - "title": "DndEndDndSchema", + "title": "DndEndDndResponse", "type": "object", "description": "Schema for successful response from dnd.endDnd method", "additionalProperties": false, @@ -14055,7 +14055,7 @@ "content": { "application/json": { "schema": { - "title": "DndEndDndErrorSchema", + "title": "DndEndDndErrorResponse", "type": "object", "description": "Schema for error response from dnd.endDnd method", "additionalProperties": false, @@ -14136,7 +14136,7 @@ "content": { "application/json": { "schema": { - "title": "DndEndSnoozeSchema", + "title": "DndEndSnoozeResponse", "type": "object", "description": "Schema for successful response from dnd.endSnooze method", "additionalProperties": false, @@ -14180,7 +14180,7 @@ "content": { "application/json": { "schema": { - "title": "DndEndSnoozeErrorSchema", + "title": "DndEndSnoozeErrorResponse", "type": "object", "description": "Schema for error response from dnd.endSnooze method", "additionalProperties": false, @@ -14262,7 +14262,7 @@ "content": { "application/json": { "schema": { - "title": "DndInfoSchema", + "title": "DndInfoResponse", "type": "object", "description": "Schema for successful response from dnd.info method", "additionalProperties": false, @@ -14311,7 +14311,7 @@ "content": { "application/json": { "schema": { - "title": "DndInfoErrorSchema", + "title": "DndInfoErrorResponse", "type": "object", "description": "Schema for error response from dnd.info method", "additionalProperties": false, @@ -14425,7 +14425,7 @@ "content": { "application/json": { "schema": { - "title": "DndSetSnoozeSchema", + "title": "DndSetSnoozeResponse", "type": "object", "description": "Schema for successful response from dnd.setSnooze method", "additionalProperties": false, @@ -14465,7 +14465,7 @@ "content": { "application/json": { "schema": { - "title": "DndSetSnoozeErrorSchema", + "title": "DndSetSnoozeErrorResponse", "type": "object", "description": "Schema for error response from dnd.setSnooze method", "additionalProperties": false, @@ -14748,7 +14748,7 @@ "content": { "application/json": { "schema": { - "title": "FilesCommentsDeleteSchema", + "title": "FilesCommentsDeleteResponse", "type": "object", "description": "Schema for successful response files.comments.delete method", "additionalProperties": false, @@ -14776,7 +14776,7 @@ "content": { "application/json": { "schema": { - "title": "FilesCommentsDeleteErrorSchema", + "title": "FilesCommentsDeleteErrorResponse", "type": "object", "description": "Schema for error response files.comments.delete method", "additionalProperties": false, @@ -14868,7 +14868,7 @@ "content": { "application/json": { "schema": { - "title": "FilesDeleteSchema", + "title": "FilesDeleteResponse", "type": "object", "description": "Schema for successful response files.delete method", "additionalProperties": false, @@ -14896,7 +14896,7 @@ "content": { "application/json": { "schema": { - "title": "FilesDeleteErrorSchema", + "title": "FilesDeleteErrorResponse", "type": "object", "description": "Schema for error response files.delete method", "additionalProperties": false, @@ -14975,7 +14975,7 @@ "content": { "application/json": { "schema": { - "title": "FilesInfoSchema", + "title": "FilesInfoResponse", "type": "object", "description": "Schema for successful response from files.info method", "additionalProperties": false, @@ -15089,7 +15089,7 @@ "content": { "application/json": { "schema": { - "title": "FilesInfoErrorSchema", + "title": "FilesInfoErrorResponse", "type": "object", "description": "Schema for error response from files.info method", "additionalProperties": false, @@ -15208,7 +15208,7 @@ "content": { "application/json": { "schema": { - "title": "FilesListSchema", + "title": "FilesListResponse", "type": "object", "description": "Schema for successful response from files.list method", "additionalProperties": false, @@ -15341,7 +15341,7 @@ "content": { "application/json": { "schema": { - "title": "FilesListErrorSchema", + "title": "FilesListErrorResponse", "type": "object", "description": "Schema for error response from files.list method", "additionalProperties": false, @@ -16170,7 +16170,7 @@ "content": { "application/json": { "schema": { - "title": "FilesRevokePublicURLSchema", + "title": "FilesRevokePublicURLResponse", "type": "object", "description": "Schema for successful response from files.revokePublicURL method", "additionalProperties": false, @@ -16202,7 +16202,7 @@ "content": { "application/json": { "schema": { - "title": "FilesRevokePublicURLErrorSchema", + "title": "FilesRevokePublicURLErrorResponse", "type": "object", "description": "Schema for error response from files.revokePublicURL method", "additionalProperties": false, @@ -16299,7 +16299,7 @@ "content": { "application/json": { "schema": { - "title": "FilesSharedPublicURLSchema", + "title": "FilesSharedPublicURLResponse", "type": "object", "description": "Schema for successful response from files.sharedPublicURL method", "additionalProperties": false, @@ -16331,7 +16331,7 @@ "content": { "application/json": { "schema": { - "title": "FilesSharedPublicURLErrorSchema", + "title": "FilesSharedPublicURLErrorResponse", "type": "object", "description": "Schema for error response from files.sharedPublicURL method", "additionalProperties": false, @@ -16461,7 +16461,7 @@ "content": { "application/json": { "schema": { - "title": "FilesUploadSchema", + "title": "FilesUploadResponse", "type": "object", "description": "Schema for successful response files.upload method", "additionalProperties": false, @@ -16549,7 +16549,7 @@ "content": { "application/json": { "schema": { - "title": "FilesUploadErrorSchema", + "title": "FilesUploadErrorResponse", "type": "object", "description": "Schema for error response files.upload method", "additionalProperties": false, @@ -16630,7 +16630,7 @@ "content": { "application/json": { "schema": { - "title": "MigrationExchangeSuccessSchema", + "title": "MigrationExchangeResponse", "type": "object", "description": "Schema for successful response from migration.exchange method", "additionalProperties": true, @@ -16691,7 +16691,7 @@ "content": { "application/json": { "schema": { - "title": "MigrationExchangeErrorSchema", + "title": "MigrationExchangeErrorResponse", "type": "object", "description": "Schema for error response from migration.exchange method", "additionalProperties": false, @@ -17221,7 +17221,7 @@ "content": { "application/json": { "schema": { - "title": "PinsAddSchema", + "title": "PinsAddResponse", "type": "object", "description": "Schema for successful response from pins.add method", "additionalProperties": false, @@ -17249,7 +17249,7 @@ "content": { "application/json": { "schema": { - "title": "PinsAddErrorSchema", + "title": "PinsAddErrorResponse", "type": "object", "description": "Schema for error response from pins.add method", "additionalProperties": false, @@ -17333,7 +17333,7 @@ "content": { "application/json": { "schema": { - "title": "PinsListSuccessSchema", + "title": "PinsListResponse", "description": "Schema for successful response from pins.list method", "items": { "anyOf": [ @@ -17473,7 +17473,7 @@ "content": { "application/json": { "schema": { - "title": "PinsListErrorSchema", + "title": "PinsListErrorResponse", "type": "object", "description": "Schema for error response from pins.list method", "additionalProperties": false, @@ -17584,7 +17584,7 @@ "content": { "application/json": { "schema": { - "title": "PinsRemoveSchema", + "title": "PinsRemoveResponse", "type": "object", "description": "Schema for successful response from pins.remove method", "additionalProperties": false, @@ -17612,7 +17612,7 @@ "content": { "application/json": { "schema": { - "title": "PinsRemoveErrorSchema", + "title": "PinsRemoveErrorResponse", "type": "object", "description": "Schema for error response from pins.remove method", "additionalProperties": false, @@ -17724,7 +17724,7 @@ "content": { "application/json": { "schema": { - "title": "ReactionsAddSchema", + "title": "ReactionsAddResponse", "type": "object", "description": "Schema for successful response from reactions.add method", "additionalProperties": false, @@ -17752,7 +17752,7 @@ "content": { "application/json": { "schema": { - "title": "ReactionsAddErrorSchema", + "title": "ReactionsAddErrorResponse", "type": "object", "description": "Schema for error response from reactions.add method", "additionalProperties": false, @@ -17835,7 +17835,7 @@ "content": { "application/json": { "schema": { - "title": "ReactionsGetSuccessSchema", + "title": "ReactionsGetResponse", "type": "object", "description": "Schema for successful response from reactions.get method", "items": { @@ -17956,7 +17956,7 @@ "content": { "application/json": { "schema": { - "title": "ReactionsGetErrorSchema", + "title": "ReactionsGetErrorResponse", "type": "object", "description": "Schema for error response from reactions.get method", "additionalProperties": false, @@ -18078,7 +18078,7 @@ "content": { "application/json": { "schema": { - "title": "ReactionsListSchema", + "title": "ReactionsListResponse", "type": "object", "description": "Schema for successful response from reactions.list method", "additionalProperties": false, @@ -18275,7 +18275,7 @@ "content": { "application/json": { "schema": { - "title": "ReactionsListErrorSchema", + "title": "ReactionsListErrorResponse", "type": "object", "description": "Schema for error response from reactions.list method", "additionalProperties": false, @@ -18436,7 +18436,7 @@ "content": { "application/json": { "schema": { - "title": "ReactionsRemoveSchema", + "title": "ReactionsRemoveResponse", "type": "object", "description": "Schema for successful response from reactions.remove method", "additionalProperties": false, @@ -18464,7 +18464,7 @@ "content": { "application/json": { "schema": { - "title": "ReactionsRemoveErrorSchema", + "title": "ReactionsRemoveErrorResponse", "type": "object", "description": "Schema for error response from reactions.remove method", "additionalProperties": false, @@ -18576,7 +18576,7 @@ "content": { "application/json": { "schema": { - "title": "RemindersAddSchema", + "title": "RemindersAddResponse", "type": "object", "description": "Schema for successful response from reminders.add method", "additionalProperties": false, @@ -18608,7 +18608,7 @@ "content": { "application/json": { "schema": { - "title": "RemindersAddErrorSchema", + "title": "RemindersAddErrorResponse", "type": "object", "description": "Schema for error response from reminders.add method", "additionalProperties": false, @@ -18709,7 +18709,7 @@ "content": { "application/json": { "schema": { - "title": "RemindersCompleteSchema", + "title": "RemindersCompleteResponse", "type": "object", "description": "Schema for successful response from reminders.complete method", "additionalProperties": false, @@ -18737,7 +18737,7 @@ "content": { "application/json": { "schema": { - "title": "RemindersCompleteErrorSchema", + "title": "RemindersCompleteErrorResponse", "type": "object", "description": "Schema for error response from reminders.complete method", "additionalProperties": false, @@ -18835,7 +18835,7 @@ "content": { "application/json": { "schema": { - "title": "RemindersDeleteSchema", + "title": "RemindersDeleteResponse", "type": "object", "description": "Schema for successful response from reminders.delete method", "additionalProperties": false, @@ -18863,7 +18863,7 @@ "content": { "application/json": { "schema": { - "title": "RemindersDeleteErrorSchema", + "title": "RemindersDeleteErrorResponse", "type": "object", "description": "Schema for error response from reminders.delete method", "additionalProperties": false, @@ -18944,7 +18944,7 @@ "content": { "application/json": { "schema": { - "title": "RemindersInfoSchema", + "title": "RemindersInfoResponse", "type": "object", "description": "Schema for successful response from reminders.info method", "additionalProperties": false, @@ -18976,7 +18976,7 @@ "content": { "application/json": { "schema": { - "title": "RemindersInfoErrorSchema", + "title": "RemindersInfoErrorResponse", "type": "object", "description": "Schema for error response from reminders.info method", "additionalProperties": false, @@ -19067,7 +19067,7 @@ "content": { "application/json": { "schema": { - "title": "RemindersListSchema", + "title": "RemindersListResponse", "type": "object", "description": "Schema for successful response from reminders.list method", "additionalProperties": false, @@ -19102,7 +19102,7 @@ "content": { "application/json": { "schema": { - "title": "RemindersListErrorSchema", + "title": "RemindersListErrorResponse", "type": "object", "description": "Schema for error response from reminders.list method", "additionalProperties": false, @@ -19182,7 +19182,7 @@ "content": { "application/json": { "schema": { - "title": "RtmConnectSchema", + "title": "RtmConnectResponse", "type": "object", "description": "Schema for successful response from rtm.connect method", "additionalProperties": false, @@ -19263,7 +19263,7 @@ "content": { "application/json": { "schema": { - "title": "RtmConnectErrorSchema", + "title": "RtmConnectErrorResponse", "type": "object", "description": "Schema for error response from rtm.connect method", "additionalProperties": false, @@ -19577,7 +19577,7 @@ "content": { "application/json": { "schema": { - "title": "StarsAddSchema", + "title": "StarsAddResponse", "type": "object", "description": "Schema for successful response from stars.add method", "additionalProperties": false, @@ -19605,7 +19605,7 @@ "content": { "application/json": { "schema": { - "title": "StarsAddErrorSchema", + "title": "StarsAddErrorResponse", "type": "object", "description": "Schema for error response from stars.add method", "additionalProperties": false, @@ -19691,7 +19691,7 @@ "content": { "application/json": { "schema": { - "title": "StarsListSchema", + "title": "StarsListResponse", "type": "object", "description": "Schema for successful response from stars.list method", "additionalProperties": false, @@ -19878,7 +19878,7 @@ "content": { "application/json": { "schema": { - "title": "StarsListErrorSchema", + "title": "StarsListErrorResponse", "type": "object", "description": "Schema for error response from stars.list method", "additionalProperties": false, @@ -20017,7 +20017,7 @@ "content": { "application/json": { "schema": { - "title": "StarsRemoveSchema", + "title": "StarsRemoveResponse", "type": "object", "description": "Schema for successful response from stars.remove method", "additionalProperties": false, @@ -20045,7 +20045,7 @@ "content": { "application/json": { "schema": { - "title": "StarsRemoveErrorSchema", + "title": "StarsRemoveErrorResponse", "type": "object", "description": "Schema for error response from stars.remove method", "additionalProperties": false, @@ -20131,7 +20131,7 @@ "content": { "application/json": { "schema": { - "title": "TeamAccessLogsSchema", + "title": "TeamAccessLogsResponse", "type": "object", "description": "Schema for successful response from team.accessLogs method", "additionalProperties": false, @@ -20253,7 +20253,7 @@ "content": { "application/json": { "schema": { - "title": "TeamAccessLogsErrorSchema", + "title": "TeamAccessLogsErrorResponse", "type": "object", "description": "Schema for error response from team.accessLogs method", "additionalProperties": false, @@ -20459,7 +20459,7 @@ "content": { "application/json": { "schema": { - "title": "TeamInfoSchema", + "title": "TeamInfoResponse", "type": "object", "description": "Schema for successful response from team.info method", "additionalProperties": false, @@ -20508,7 +20508,7 @@ "content": { "application/json": { "schema": { - "title": "TeamInfoErrorSchema", + "title": "TeamInfoErrorResponse", "type": "object", "description": "Schema for error response from team.info method", "additionalProperties": false, @@ -20596,7 +20596,7 @@ "content": { "application/json": { "schema": { - "title": "TeamIntegrationLogsSchema", + "title": "TeamIntegrationLogsResponse", "type": "object", "description": "Schema for successful response from team.integrationLogs method", "additionalProperties": false, @@ -20682,7 +20682,7 @@ "content": { "application/json": { "schema": { - "title": "TeamIntegrationLogsErrorSchema", + "title": "TeamIntegrationLogsErrorResponse", "type": "object", "description": "Schema for error response from team.integrationLogs method", "additionalProperties": false, @@ -20811,7 +20811,7 @@ "content": { "application/json": { "schema": { - "title": "TeamProfileGetSuccessSchema", + "title": "TeamProfileGetResponse", "type": "object", "description": "Schema for successful response from team.profile.get method", "additionalProperties": false, @@ -20922,7 +20922,7 @@ "content": { "application/json": { "schema": { - "title": "TeamProfileGetErrorSchema", + "title": "TeamProfileGetErrorResponse", "type": "object", "description": "Schema for error response from team.profile.get method", "additionalProperties": false, @@ -21043,7 +21043,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsCreateSchema", + "title": "UsergroupsCreateResponse", "type": "object", "description": "Schema for successful response from usergroups.create method", "additionalProperties": false, @@ -21075,7 +21075,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsCreateErrorSchema", + "title": "UsergroupsCreateErrorResponse", "type": "object", "description": "Schema for error response from usergroups.create method", "additionalProperties": false, @@ -21179,7 +21179,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsDisableSchema", + "title": "UsergroupsDisableResponse", "type": "object", "description": "Schema for successful response from usergroups.disable method", "additionalProperties": false, @@ -21211,7 +21211,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsDisableErrorSchema", + "title": "UsergroupsDisableErrorResponse", "type": "object", "description": "Schema for error response from usergroups.disable method", "additionalProperties": false, @@ -21315,7 +21315,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsEnableSchema", + "title": "UsergroupsEnableResponse", "type": "object", "description": "Schema for successful response from usergroups.enable method", "additionalProperties": false, @@ -21347,7 +21347,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsEnableErrorSchema", + "title": "UsergroupsEnableErrorResponse", "type": "object", "description": "Schema for error response from usergroups.enable method", "additionalProperties": false, @@ -21430,7 +21430,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsListSchema", + "title": "UsergroupsListResponse", "type": "object", "description": "Schema for successful response from usergroups.list method", "additionalProperties": false, @@ -21530,7 +21530,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsListErrorSchema", + "title": "UsergroupsListErrorResponse", "type": "object", "description": "Schema for error response from usergroups.list method", "additionalProperties": false, @@ -21677,7 +21677,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsUpdateSchema", + "title": "UsergroupsUpdateResponse", "type": "object", "description": "Schema for successful response from usergroups.update method", "additionalProperties": false, @@ -21734,7 +21734,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsUpdateErrorSchema", + "title": "UsergroupsUpdateErrorResponse", "type": "object", "description": "Schema for error response from usergroups.update method", "additionalProperties": false, @@ -21819,7 +21819,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsUsersListSchema", + "title": "UsergroupsUsersListResponse", "type": "object", "description": "Schema for successful response from usergroups.users.list method", "additionalProperties": false, @@ -21858,7 +21858,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsUsersListErrorSchema", + "title": "UsergroupsUsersListErrorResponse", "type": "object", "description": "Schema for error response from usergroups.users.list method", "additionalProperties": false, @@ -21988,7 +21988,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsUsersUpdateSchema", + "title": "UsergroupsUsersUpdateResponse", "type": "object", "description": "Schema for successful response from usergroups.users.update method", "additionalProperties": false, @@ -22045,7 +22045,7 @@ "content": { "application/json": { "schema": { - "title": "UsergroupsUsersUpdateErrorSchema", + "title": "UsergroupsUsersUpdateErrorResponse", "type": "object", "description": "Schema for error response from usergroups.users.update method", "additionalProperties": false, @@ -22129,7 +22129,7 @@ "content": { "application/json": { "schema": { - "title": "UsersConversationsSuccessSchema", + "title": "UsersConversationsResponse", "type": "object", "description": "Schema for successful response from users.conversations method. Returned conversation objects do not include `num_members` or `is_member`", "additionalProperties": true, @@ -22244,7 +22244,7 @@ "content": { "application/json": { "schema": { - "title": "UsersConversationsErrorSchema", + "title": "UsersConversationsErrorResponse", "type": "object", "description": "Schema for error response from users.conversations method", "additionalProperties": false, @@ -22391,7 +22391,7 @@ "content": { "application/json": { "schema": { - "title": "UsersDeletePhotoSchema", + "title": "UsersDeletePhotoResponse", "type": "object", "description": "Schema for successful response from users.deletePhoto method", "additionalProperties": false, @@ -22419,7 +22419,7 @@ "content": { "application/json": { "schema": { - "title": "UsersDeletePhotoErrorSchema", + "title": "UsersDeletePhotoErrorResponse", "type": "object", "description": "Schema for error response from users.deletePhoto method", "additionalProperties": false, @@ -22547,7 +22547,7 @@ "content": { "application/json": { "schema": { - "title": "UsersCountsErrorSchema", + "title": "UsersCountsErrorResponse", "type": "object", "description": "Schema for error response users.getPresence method", "additionalProperties": { @@ -22614,7 +22614,7 @@ "content": { "application/json": { "schema": { - "title": "UsersIdentitySchema", + "title": "UsersIdentityResponse", "description": "Schema for successful response from users.identity method", "items": { "anyOf": [ @@ -22897,7 +22897,7 @@ "content": { "application/json": { "schema": { - "title": "UsersIdentityErrorSchema", + "title": "UsersIdentityErrorResponse", "type": "object", "description": "Schema for error response from users.identity method", "additionalProperties": false, @@ -22977,7 +22977,7 @@ "content": { "application/json": { "schema": { - "title": "UsersInfoSuccessSchema", + "title": "UsersInfoResponse", "type": "object", "description": "Schema for successful response from users.info method", "additionalProperties": true, @@ -23047,7 +23047,7 @@ "content": { "application/json": { "schema": { - "title": "UsersInfoErrorSchema", + "title": "UsersInfoErrorResponse", "type": "object", "description": "Schema for error response from users.info method", "additionalProperties": false, @@ -23141,7 +23141,7 @@ "content": { "application/json": { "schema": { - "title": "UsersListSchema", + "title": "UsersListResponse", "type": "object", "description": "Schema for successful response from users.list method", "additionalProperties": false, @@ -23268,7 +23268,7 @@ "content": { "application/json": { "schema": { - "title": "UsersListErrorSchema", + "title": "UsersListErrorResponse", "type": "object", "description": "Schema for error response from users.list method", "additionalProperties": false, @@ -23373,7 +23373,7 @@ "content": { "application/json": { "schema": { - "title": "UsersLookupByEmailSuccessSchema", + "title": "UsersLookupByEmailResponse", "type": "object", "description": "Schema for successful response from users.lookupByEmail method", "additionalProperties": true, @@ -23442,7 +23442,7 @@ "content": { "application/json": { "schema": { - "title": "UsersLookupByEmailErrorSchema", + "title": "UsersLookupByEmailErrorResponse", "type": "object", "description": "Schema for error response from users.lookupByEmail method", "additionalProperties": false, @@ -23533,7 +23533,7 @@ "content": { "application/json": { "schema": { - "title": "UsersProfileGetSchema", + "title": "UsersProfileGetResponse", "type": "object", "description": "Schema for successful response from users.profile.get method", "additionalProperties": false, @@ -23584,7 +23584,7 @@ "content": { "application/json": { "schema": { - "title": "UsersProfileGetErrorSchema", + "title": "UsersProfileGetErrorResponse", "type": "object", "description": "Schema for error response from users.profile.get method", "additionalProperties": false, @@ -23711,7 +23711,7 @@ "content": { "application/json": { "schema": { - "title": "UsersProfileSetSchema", + "title": "UsersProfileSetResponse", "type": "object", "description": "Schema for successful response from users.profile.set method", "additionalProperties": false, @@ -23769,7 +23769,7 @@ "content": { "application/json": { "schema": { - "title": "UsersProfileSetErrorSchema", + "title": "UsersProfileSetErrorResponse", "type": "object", "description": "Schema for error response from users.profile.set method", "additionalProperties": false, @@ -23855,7 +23855,7 @@ "content": { "application/json": { "schema": { - "title": "UsersSetActiveSchema", + "title": "UsersSetActiveResponse", "type": "object", "description": "Schema for successful response from users.setActive method", "additionalProperties": false, @@ -23883,7 +23883,7 @@ "content": { "application/json": { "schema": { - "title": "UsersSetActiveErrorSchema", + "title": "UsersSetActiveErrorResponse", "type": "object", "description": "Schema for error response from users.setActive method", "additionalProperties": false, @@ -23997,7 +23997,7 @@ "content": { "application/json": { "schema": { - "title": "UsersSetPhotoSchema", + "title": "UsersSetPhotoResponse", "type": "object", "description": "Schema for successful response from users.setPhoto method", "additionalProperties": false, @@ -24079,7 +24079,7 @@ "content": { "application/json": { "schema": { - "title": "UsersSetPhotoErrorSchema", + "title": "UsersSetPhotoErrorResponse", "type": "object", "description": "Schema for error response from users.setPhoto method", "additionalProperties": false, @@ -24194,7 +24194,7 @@ "content": { "application/json": { "schema": { - "title": "UsersSetPresenceSchema", + "title": "UsersSetPresenceResponse", "type": "object", "description": "Schema for successful response from users.setPresence method", "additionalProperties": false, @@ -24222,7 +24222,7 @@ "content": { "application/json": { "schema": { - "title": "UsersSetPresenceErrorSchema", + "title": "UsersSetPresenceErrorResponse", "type": "object", "description": "Schema for error response from users.setPresence method", "additionalProperties": false, diff --git a/docs/spec/sanitations.bal b/docs/spec/sanitations.bal index fe735db..bfed0d5 100644 --- a/docs/spec/sanitations.bal +++ b/docs/spec/sanitations.bal @@ -93,9 +93,12 @@ function sanitizeResponseSchemaNames(Specification spec) returns Specification|e if MALFORMED_TITLE_REGEX.isFullMatch(title) { string tempTitle = re `\.`.replaceAll(title, " "); string[] nameParts = re ` `.split(tempTitle); - string[] capitalizedTitle = from string namePart in nameParts + string[] capitalizedNameParts = from string namePart in nameParts select namePart[0].toUpperAscii() + namePart.substring(1, namePart.length()); - string sanitizedTitle = string:'join("", ...capitalizedTitle); + + string sanitizedTitle = string:'join("", ...capitalizedNameParts); + sanitizedTitle = re `SuccessSchema`.replaceAll(sanitizedTitle, "Response"); + sanitizedTitle = re `Schema`.replaceAll(sanitizedTitle, "Response"); schema.title = sanitizedTitle; } } From 3095b016065ddc8a41310d2e3598994154b28fc5 Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Thu, 11 Jul 2024 21:00:44 +0530 Subject: [PATCH 05/12] Generate sanitized client and update tests --- ballerina/client.bal | 196 +++--- ballerina/tests/test_cases.bal | 18 +- ballerina/types.bal | 1048 ++++++++++++++++++++++++++++++++ 3 files changed, 1155 insertions(+), 107 deletions(-) diff --git a/ballerina/client.bal b/ballerina/client.bal index 5d0259a..08c18b4 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -79,13 +79,13 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get admin\.conversations\.getConversationPrefs(map headers = {}, *Admin_conversations_getConversationPrefsQueries queries) returns json|error { + resource isolated function get admin\.conversations\.getConversationPrefs(map headers = {}, *Admin_conversations_getConversationPrefsQueries queries) returns AdminConversationsGetConversationPrefsResponse|error { string resourcePath = string `/admin.conversations.getConversationPrefs`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get admin\.conversations\.getTeams(map headers = {}, *Admin_conversations_getTeamsQueries queries) returns json|error { + resource isolated function get admin\.conversations\.getTeams(map headers = {}, *Admin_conversations_getTeamsQueries queries) returns AdminConversationsGetTeamsResponse|error { string resourcePath = string `/admin.conversations.getTeams`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); @@ -97,7 +97,7 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get admin\.conversations\.search(map headers = {}, *Admin_conversations_searchQueries queries) returns json|error { + resource isolated function get admin\.conversations\.search(map headers = {}, *Admin_conversations_searchQueries queries) returns AdminConversationsSearchResponse|error { string resourcePath = string `/admin.conversations.search`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); @@ -163,7 +163,7 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get api\.test(map headers = {}, *Api_testQueries queries) returns json|error { + resource isolated function get api\.test(map headers = {}, *Api_testQueries queries) returns ApiTestResponse|error { string resourcePath = string `/api.test`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); @@ -175,24 +175,24 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get apps\.permissions\.info(map headers = {}) returns json|error { + resource isolated function get apps\.permissions\.info(map headers = {}) returns AppsPermissionsInfoResponse|error { string resourcePath = string `/apps.permissions.info`; return self.clientEp->get(resourcePath, headers); } - resource isolated function get apps\.permissions\.request(map headers = {}, *Apps_permissions_requestQueries queries) returns json|error { + resource isolated function get apps\.permissions\.request(map headers = {}, *Apps_permissions_requestQueries queries) returns AppsPermissionsRequestResponse|error { string resourcePath = string `/apps.permissions.request`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get apps\.permissions\.resources\.list(map headers = {}, *Apps_permissions_resources_listQueries queries) returns json|error { + resource isolated function get apps\.permissions\.resources\.list(map headers = {}, *Apps_permissions_resources_listQueries queries) returns AppsPermissionsResourcesListResponse|error { string resourcePath = string `/apps.permissions.resources.list`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get apps\.permissions\.scopes\.list(map headers = {}) returns json|error { + resource isolated function get apps\.permissions\.scopes\.list(map headers = {}) returns ApiPermissionsScopesListResponse|error { string resourcePath = string `/apps.permissions.scopes.list`; return self.clientEp->get(resourcePath, headers); } @@ -209,24 +209,24 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get apps\.uninstall(map headers = {}, *Apps_uninstallQueries queries) returns json|error { + resource isolated function get apps\.uninstall(map headers = {}, *Apps_uninstallQueries queries) returns AppsUninstallResponse|error { string resourcePath = string `/apps.uninstall`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get auth\.revoke(map headers = {}, *Auth_revokeQueries queries) returns json|error { + resource isolated function get auth\.revoke(map headers = {}, *Auth_revokeQueries queries) returns AuthRevokeResponse|error { string resourcePath = string `/auth.revoke`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get auth\.test(map headers = {}) returns json|error { + resource isolated function get auth\.test(map headers = {}) returns AuthTestResponse|error { string resourcePath = string `/auth.test`; return self.clientEp->get(resourcePath, headers); } - resource isolated function get bots\.info(map headers = {}, *Bots_infoQueries queries) returns json|error { + resource isolated function get bots\.info(map headers = {}, *Bots_infoQueries queries) returns BotsInfoResponse|error { string resourcePath = string `/bots.info`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); @@ -238,55 +238,55 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get chat\.getPermalink(map headers = {}, *Chat_getPermalinkQueries queries) returns json|error { + resource isolated function get chat\.getPermalink(map headers = {}, *Chat_getPermalinkQueries queries) returns ChatGetPermalinkResponse|error { string resourcePath = string `/chat.getPermalink`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get chat\.scheduledMessages\.list(map headers = {}, *Chat_scheduledMessages_listQueries queries) returns json|error { + resource isolated function get chat\.scheduledMessages\.list(map headers = {}, *Chat_scheduledMessages_listQueries queries) returns ChatScheduledMessagesListResponse|error { string resourcePath = string `/chat.scheduledMessages.list`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get conversations\.history(map headers = {}, *Conversations_historyQueries queries) returns json|error { + resource isolated function get conversations\.history(map headers = {}, *Conversations_historyQueries queries) returns ConversationsHistoryResponse|error { string resourcePath = string `/conversations.history`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get conversations\.info(map headers = {}, *Conversations_infoQueries queries) returns json|error { + resource isolated function get conversations\.info(map headers = {}, *Conversations_infoQueries queries) returns ConversationsInfoResponse|error { string resourcePath = string `/conversations.info`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get conversations\.list(map headers = {}, *Conversations_listQueries queries) returns json|error { + resource isolated function get conversations\.list(map headers = {}, *Conversations_listQueries queries) returns ConversationsListResponse|error { string resourcePath = string `/conversations.list`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get conversations\.members(map headers = {}, *Conversations_membersQueries queries) returns json|error { + resource isolated function get conversations\.members(map headers = {}, *Conversations_membersQueries queries) returns ConversationsMembersResponse|error { string resourcePath = string `/conversations.members`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get conversations\.replies(map headers = {}, *Conversations_repliesQueries queries) returns json|error { + resource isolated function get conversations\.replies(map headers = {}, *Conversations_repliesQueries queries) returns ConversationsRepliesResponse|error { string resourcePath = string `/conversations.replies`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get dialog\.open(map headers = {}, *Dialog_openQueries queries) returns json|error { + resource isolated function get dialog\.open(map headers = {}, *Dialog_openQueries queries) returns DialogOpenResponse|error { string resourcePath = string `/dialog.open`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get dnd\.info(map headers = {}, *Dnd_infoQueries queries) returns json|error { + resource isolated function get dnd\.info(map headers = {}, *Dnd_infoQueries queries) returns DndInfoResponse|error { string resourcePath = string `/dnd.info`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); @@ -303,13 +303,13 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get files\.info(map headers = {}, *Files_infoQueries queries) returns json|error { + resource isolated function get files\.info(map headers = {}, *Files_infoQueries queries) returns FilesInfoResponse|error { string resourcePath = string `/files.info`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get files\.list(map headers = {}, *Files_listQueries queries) returns json|error { + resource isolated function get files\.list(map headers = {}, *Files_listQueries queries) returns FilesListResponse|error { string resourcePath = string `/files.list`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); @@ -333,7 +333,7 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get migration\.exchange(map headers = {}, *Migration_exchangeQueries queries) returns json|error { + resource isolated function get migration\.exchange(map headers = {}, *Migration_exchangeQueries queries) returns MigrationExchangeResponse|error { string resourcePath = string `/migration.exchange`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); @@ -369,24 +369,24 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get reactions\.list(map headers = {}, *Reactions_listQueries queries) returns json|error { + resource isolated function get reactions\.list(map headers = {}, *Reactions_listQueries queries) returns ReactionsListResponse|error { string resourcePath = string `/reactions.list`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get reminders\.info(map headers = {}, *Reminders_infoQueries queries) returns json|error { + resource isolated function get reminders\.info(map headers = {}, *Reminders_infoQueries queries) returns RemindersInfoResponse|error { string resourcePath = string `/reminders.info`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get reminders\.list(map headers = {}) returns json|error { + resource isolated function get reminders\.list(map headers = {}) returns RemindersListResponse|error { string resourcePath = string `/reminders.list`; return self.clientEp->get(resourcePath, headers); } - resource isolated function get rtm\.connect(map headers = {}, *Rtm_connectQueries queries) returns json|error { + resource isolated function get rtm\.connect(map headers = {}, *Rtm_connectQueries queries) returns RtmConnectResponse|error { string resourcePath = string `/rtm.connect`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); @@ -398,13 +398,13 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get stars\.list(map headers = {}, *Stars_listQueries queries) returns json|error { + resource isolated function get stars\.list(map headers = {}, *Stars_listQueries queries) returns StarsListResponse|error { string resourcePath = string `/stars.list`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get team\.accessLogs(map headers = {}, *Team_accessLogsQueries queries) returns json|error { + resource isolated function get team\.accessLogs(map headers = {}, *Team_accessLogsQueries queries) returns TeamAccessLogsResponse|error { string resourcePath = string `/team.accessLogs`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); @@ -416,43 +416,43 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get team\.info(map headers = {}, *Team_infoQueries queries) returns json|error { + resource isolated function get team\.info(map headers = {}, *Team_infoQueries queries) returns TeamInfoResponse|error { string resourcePath = string `/team.info`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get team\.integrationLogs(map headers = {}, *Team_integrationLogsQueries queries) returns json|error { + resource isolated function get team\.integrationLogs(map headers = {}, *Team_integrationLogsQueries queries) returns TeamIntegrationLogsResponse|error { string resourcePath = string `/team.integrationLogs`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get team\.profile\.get(map headers = {}, *Team_profile_getQueries queries) returns json|error { + resource isolated function get team\.profile\.get(map headers = {}, *Team_profile_getQueries queries) returns TeamProfileGetResponse|error { string resourcePath = string `/team.profile.get`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get usergroups\.list(map headers = {}, *Usergroups_listQueries queries) returns json|error { + resource isolated function get usergroups\.list(map headers = {}, *Usergroups_listQueries queries) returns UsergroupsListResponse|error { string resourcePath = string `/usergroups.list`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get usergroups\.users\.list(map headers = {}, *Usergroups_users_listQueries queries) returns json|error { + resource isolated function get usergroups\.users\.list(map headers = {}, *Usergroups_users_listQueries queries) returns UsergroupsUsersListResponse|error { string resourcePath = string `/usergroups.users.list`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get users\.conversations(map headers = {}, *Users_conversationsQueries queries) returns json|error { + resource isolated function get users\.conversations(map headers = {}, *Users_conversationsQueries queries) returns UsersConversationsResponse|error { string resourcePath = string `/users.conversations`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get users\.getPresence(map headers = {}, *Users_getPresenceQueries queries) returns json|error { + resource isolated function get users\.getPresence(map headers = {}, *Users_getPresenceQueries queries) returns APIMethodUsersGetPresence|error { string resourcePath = string `/users.getPresence`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); @@ -463,25 +463,25 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get users\.info(map headers = {}, *Users_infoQueries queries) returns json|error { + resource isolated function get users\.info(map headers = {}, *Users_infoQueries queries) returns UsersInfoResponse|error { string resourcePath = string `/users.info`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get users\.list(map headers = {}, *Users_listQueries queries) returns json|error { + resource isolated function get users\.list(map headers = {}, *Users_listQueries queries) returns UsersListResponse|error { string resourcePath = string `/users.list`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get users\.lookupByEmail(map headers = {}, *Users_lookupByEmailQueries queries) returns json|error { + resource isolated function get users\.lookupByEmail(map headers = {}, *Users_lookupByEmailQueries queries) returns UsersLookupByEmailResponse|error { string resourcePath = string `/users.lookupByEmail`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get users\.profile\.get(map headers = {}, *Users_profile_getQueries queries) returns json|error { + resource isolated function get users\.profile\.get(map headers = {}, *Users_profile_getQueries queries) returns UsersProfileGetResponse|error { string resourcePath = string `/users.profile.get`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); @@ -545,7 +545,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post admin\.conversations\.archive(admin_conversations_archive_body payload, map headers = {}) returns json|error { + resource isolated function post admin\.conversations\.archive(admin_conversations_archive_body payload, map headers = {}) returns AdminConversationsArchiveResponse|error { string resourcePath = string `/admin.conversations.archive`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -553,7 +553,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post admin\.conversations\.convertToPrivate(admin_conversations_convertToPrivate_body payload, map headers = {}) returns json|error { + resource isolated function post admin\.conversations\.convertToPrivate(admin_conversations_convertToPrivate_body payload, map headers = {}) returns AdminConversationsConvertToPrivateResponse|error { string resourcePath = string `/admin.conversations.convertToPrivate`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -561,7 +561,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post admin\.conversations\.create(admin_conversations_create_body payload, map headers = {}) returns json|error { + resource isolated function post admin\.conversations\.create(admin_conversations_create_body payload, map headers = {}) returns AdminConversationsCreateResponse|error { string resourcePath = string `/admin.conversations.create`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -569,7 +569,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post admin\.conversations\.delete(admin_conversations_delete_body payload, map headers = {}) returns json|error { + resource isolated function post admin\.conversations\.delete(admin_conversations_delete_body payload, map headers = {}) returns AdminConversationsDeleteResponse|error { string resourcePath = string `/admin.conversations.delete`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -577,7 +577,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post admin\.conversations\.disconnectShared(admin_conversations_disconnectShared_body payload, map headers = {}) returns json|error { + resource isolated function post admin\.conversations\.disconnectShared(admin_conversations_disconnectShared_body payload, map headers = {}) returns AdminConversationsRenameResponse|error { string resourcePath = string `/admin.conversations.disconnectShared`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -585,7 +585,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post admin\.conversations\.invite(admin_conversations_invite_body payload, map headers = {}) returns json|error { + resource isolated function post admin\.conversations\.invite(admin_conversations_invite_body payload, map headers = {}) returns AdminConversationsInviteResponse|error { string resourcePath = string `/admin.conversations.invite`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -593,7 +593,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post admin\.conversations\.rename(admin_conversations_rename_body payload, map headers = {}) returns json|error { + resource isolated function post admin\.conversations\.rename(admin_conversations_rename_body payload, map headers = {}) returns AdminConversationsRenameResponse_1|error { string resourcePath = string `/admin.conversations.rename`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -617,7 +617,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post admin\.conversations\.setConversationPrefs(admin_conversations_setConversationPrefs_body payload, map headers = {}) returns json|error { + resource isolated function post admin\.conversations\.setConversationPrefs(admin_conversations_setConversationPrefs_body payload, map headers = {}) returns AdminConversationsSetConversationPrefsResponse|error { string resourcePath = string `/admin.conversations.setConversationPrefs`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -633,7 +633,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post admin\.conversations\.unarchive(admin_conversations_unarchive_body payload, map headers = {}) returns json|error { + resource isolated function post admin\.conversations\.unarchive(admin_conversations_unarchive_body payload, map headers = {}) returns AdminConversationsUnarchiveResponse|error { string resourcePath = string `/admin.conversations.unarchive`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -874,7 +874,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post chat\.delete(chat_delete_body payload, map headers = {}) returns json|error { + resource isolated function post chat\.delete(chat_delete_body payload, map headers = {}) returns ChatDeleteResponse|error { string resourcePath = string `/chat.delete`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -882,7 +882,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post chat\.deleteScheduledMessage(chat_deleteScheduledMessage_body payload, map headers = {}) returns json|error { + resource isolated function post chat\.deleteScheduledMessage(chat_deleteScheduledMessage_body payload, map headers = {}) returns ChatDeleteScheduledMessageResponse|error { string resourcePath = string `/chat.deleteScheduledMessage`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -890,7 +890,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post chat\.meMessage(chat_meMessage_body payload, map headers = {}) returns json|error { + resource isolated function post chat\.meMessage(chat_meMessage_body payload, map headers = {}) returns ChatMeMessageResponse|error { string resourcePath = string `/chat.meMessage`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -898,7 +898,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post chat\.postEphemeral(chat_postEphemeral_body payload, map headers = {}) returns json|error { + resource isolated function post chat\.postEphemeral(chat_postEphemeral_body payload, map headers = {}) returns ChatPostEphemeralResponse|error { string resourcePath = string `/chat.postEphemeral`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -906,7 +906,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post chat\.postMessage(chat_postMessage_body payload, map headers = {}) returns json|error { + resource isolated function post chat\.postMessage(chat_postMessage_body payload, map headers = {}) returns ChatPostMessageResponse|error { string resourcePath = string `/chat.postMessage`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -914,7 +914,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post chat\.scheduleMessage(chat_scheduleMessage_body payload, map headers = {}) returns json|error { + resource isolated function post chat\.scheduleMessage(chat_scheduleMessage_body payload, map headers = {}) returns ChatScheduleMessageResponse|error { string resourcePath = string `/chat.scheduleMessage`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -922,7 +922,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post chat\.unfurl(chat_unfurl_body payload, map headers = {}) returns json|error { + resource isolated function post chat\.unfurl(chat_unfurl_body payload, map headers = {}) returns ChatUnfurlResponse|error { string resourcePath = string `/chat.unfurl`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -930,7 +930,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post chat\.update(chat_update_body payload, map headers = {}) returns json|error { + resource isolated function post chat\.update(chat_update_body payload, map headers = {}) returns ChatUpdateResponse|error { string resourcePath = string `/chat.update`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -938,7 +938,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post conversations\.archive(conversations_archive_body payload, map headers = {}) returns json|error { + resource isolated function post conversations\.archive(conversations_archive_body payload, map headers = {}) returns ConversationsArchiveResponse|error { string resourcePath = string `/conversations.archive`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -946,7 +946,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post conversations\.close(conversations_close_body payload, map headers = {}) returns json|error { + resource isolated function post conversations\.close(conversations_close_body payload, map headers = {}) returns ConversationsCloseResponse|error { string resourcePath = string `/conversations.close`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -954,7 +954,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post conversations\.create(conversations_create_body payload, map headers = {}) returns json|error { + resource isolated function post conversations\.create(conversations_create_body payload, map headers = {}) returns ConversationsCreateResponse|error { string resourcePath = string `/conversations.create`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -962,7 +962,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post conversations\.invite(conversations_invite_body payload, map headers = {}) returns json|error { + resource isolated function post conversations\.invite(conversations_invite_body payload, map headers = {}) returns ConversationsInviteErrorResponse|error { string resourcePath = string `/conversations.invite`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -970,7 +970,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post conversations\.join(conversations_join_body payload, map headers = {}) returns json|error { + resource isolated function post conversations\.join(conversations_join_body payload, map headers = {}) returns ConversationsJoinResponse|error { string resourcePath = string `/conversations.join`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -978,7 +978,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post conversations\.kick(conversations_kick_body payload, map headers = {}) returns json|error { + resource isolated function post conversations\.kick(conversations_kick_body payload, map headers = {}) returns ConversationsKickResponse|error { string resourcePath = string `/conversations.kick`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -986,7 +986,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post conversations\.leave(conversations_leave_body payload, map headers = {}) returns json|error { + resource isolated function post conversations\.leave(conversations_leave_body payload, map headers = {}) returns ConversationsLeaveResponse|error { string resourcePath = string `/conversations.leave`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -994,7 +994,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post conversations\.mark(conversations_mark_body payload, map headers = {}) returns json|error { + resource isolated function post conversations\.mark(conversations_mark_body payload, map headers = {}) returns ConversationsMarkResponse|error { string resourcePath = string `/conversations.mark`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1002,7 +1002,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post conversations\.open(conversations_open_body payload, map headers = {}) returns json|error { + resource isolated function post conversations\.open(conversations_open_body payload, map headers = {}) returns ConversationsOpenResponse|error { string resourcePath = string `/conversations.open`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1010,7 +1010,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post conversations\.rename(conversations_rename_body payload, map headers = {}) returns json|error { + resource isolated function post conversations\.rename(conversations_rename_body payload, map headers = {}) returns ConversationsRenameResponse|error { string resourcePath = string `/conversations.rename`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1018,7 +1018,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post conversations\.setPurpose(conversations_setPurpose_body payload, map headers = {}) returns json|error { + resource isolated function post conversations\.setPurpose(conversations_setPurpose_body payload, map headers = {}) returns ConversationsSetPurposeResponse|error { string resourcePath = string `/conversations.setPurpose`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1026,7 +1026,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post conversations\.setTopic(conversations_setTopic_body payload, map headers = {}) returns json|error { + resource isolated function post conversations\.setTopic(conversations_setTopic_body payload, map headers = {}) returns ConversationsSetTopicResponse|error { string resourcePath = string `/conversations.setTopic`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1034,7 +1034,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post conversations\.unarchive(conversations_unarchive_body payload, map headers = {}) returns json|error { + resource isolated function post conversations\.unarchive(conversations_unarchive_body payload, map headers = {}) returns ConversationsUnarchiveResponse|error { string resourcePath = string `/conversations.unarchive`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1042,19 +1042,19 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post dnd\.endDnd(map headers = {}) returns json|error { + resource isolated function post dnd\.endDnd(map headers = {}) returns DndEndDndResponse|error { string resourcePath = string `/dnd.endDnd`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post dnd\.endSnooze(map headers = {}) returns json|error { + resource isolated function post dnd\.endSnooze(map headers = {}) returns DndEndSnoozeResponse|error { string resourcePath = string `/dnd.endSnooze`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post dnd\.setSnooze(dnd_setSnooze_body payload, map headers = {}) returns json|error { + resource isolated function post dnd\.setSnooze(dnd_setSnooze_body payload, map headers = {}) returns DndSetSnoozeResponse|error { string resourcePath = string `/dnd.setSnooze`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1062,7 +1062,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post files\.comments\.delete(files_comments_delete_body payload, map headers = {}) returns json|error { + resource isolated function post files\.comments\.delete(files_comments_delete_body payload, map headers = {}) returns FilesCommentsDeleteResponse|error { string resourcePath = string `/files.comments.delete`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1070,7 +1070,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post files\.delete(files_delete_body payload, map headers = {}) returns json|error { + resource isolated function post files\.delete(files_delete_body payload, map headers = {}) returns FilesDeleteResponse|error { string resourcePath = string `/files.delete`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1102,7 +1102,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post files\.revokePublicURL(files_revokePublicURL_body payload, map headers = {}) returns json|error { + resource isolated function post files\.revokePublicURL(files_revokePublicURL_body payload, map headers = {}) returns FilesRevokePublicURLResponse|error { string resourcePath = string `/files.revokePublicURL`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1110,7 +1110,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post files\.sharedPublicURL(files_sharedPublicURL_body payload, map headers = {}) returns json|error { + resource isolated function post files\.sharedPublicURL(files_sharedPublicURL_body payload, map headers = {}) returns FilesSharedPublicURLResponse|error { string resourcePath = string `/files.sharedPublicURL`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1118,7 +1118,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post files\.upload(files_upload_body payload, map headers = {}) returns json|error { + resource isolated function post files\.upload(files_upload_body payload, map headers = {}) returns FilesUploadResponse|error { string resourcePath = string `/files.upload`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1126,7 +1126,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post pins\.add(pins_add_body payload, map headers = {}) returns json|error { + resource isolated function post pins\.add(pins_add_body payload, map headers = {}) returns PinsAddResponse|error { string resourcePath = string `/pins.add`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1134,7 +1134,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post pins\.remove(pins_remove_body payload, map headers = {}) returns json|error { + resource isolated function post pins\.remove(pins_remove_body payload, map headers = {}) returns PinsRemoveResponse|error { string resourcePath = string `/pins.remove`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1142,7 +1142,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post reactions\.add(reactions_add_body payload, map headers = {}) returns json|error { + resource isolated function post reactions\.add(reactions_add_body payload, map headers = {}) returns ReactionsAddResponse|error { string resourcePath = string `/reactions.add`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1150,7 +1150,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post reactions\.remove(reactions_remove_body payload, map headers = {}) returns json|error { + resource isolated function post reactions\.remove(reactions_remove_body payload, map headers = {}) returns ReactionsRemoveResponse|error { string resourcePath = string `/reactions.remove`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1158,7 +1158,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post reminders\.add(reminders_add_body payload, map headers = {}) returns json|error { + resource isolated function post reminders\.add(reminders_add_body payload, map headers = {}) returns RemindersAddResponse|error { string resourcePath = string `/reminders.add`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1166,7 +1166,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post reminders\.complete(reminders_complete_body payload, map headers = {}) returns json|error { + resource isolated function post reminders\.complete(reminders_complete_body payload, map headers = {}) returns RemindersCompleteResponse|error { string resourcePath = string `/reminders.complete`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1174,7 +1174,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post reminders\.delete(reminders_delete_body payload, map headers = {}) returns json|error { + resource isolated function post reminders\.delete(reminders_delete_body payload, map headers = {}) returns RemindersDeleteResponse|error { string resourcePath = string `/reminders.delete`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1182,7 +1182,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post stars\.add(stars_add_body payload, map headers = {}) returns json|error { + resource isolated function post stars\.add(stars_add_body payload, map headers = {}) returns StarsAddResponse|error { string resourcePath = string `/stars.add`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1190,7 +1190,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post stars\.remove(stars_remove_body payload, map headers = {}) returns json|error { + resource isolated function post stars\.remove(stars_remove_body payload, map headers = {}) returns StarsRemoveResponse|error { string resourcePath = string `/stars.remove`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1198,7 +1198,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post usergroups\.create(usergroups_create_body payload, map headers = {}) returns json|error { + resource isolated function post usergroups\.create(usergroups_create_body payload, map headers = {}) returns UsergroupsCreateResponse|error { string resourcePath = string `/usergroups.create`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1206,7 +1206,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post usergroups\.disable(usergroups_disable_body payload, map headers = {}) returns json|error { + resource isolated function post usergroups\.disable(usergroups_disable_body payload, map headers = {}) returns UsergroupsDisableResponse|error { string resourcePath = string `/usergroups.disable`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1214,7 +1214,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post usergroups\.enable(usergroups_enable_body payload, map headers = {}) returns json|error { + resource isolated function post usergroups\.enable(usergroups_enable_body payload, map headers = {}) returns UsergroupsEnableResponse|error { string resourcePath = string `/usergroups.enable`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1222,7 +1222,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post usergroups\.update(usergroups_update_body payload, map headers = {}) returns json|error { + resource isolated function post usergroups\.update(usergroups_update_body payload, map headers = {}) returns UsergroupsUpdateResponse|error { string resourcePath = string `/usergroups.update`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1230,7 +1230,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post usergroups\.users\.update(usergroups_users_update_body payload, map headers = {}) returns json|error { + resource isolated function post usergroups\.users\.update(usergroups_users_update_body payload, map headers = {}) returns UsergroupsUsersUpdateResponse|error { string resourcePath = string `/usergroups.users.update`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1238,7 +1238,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post users\.deletePhoto(users_deletePhoto_body payload, map headers = {}) returns json|error { + resource isolated function post users\.deletePhoto(users_deletePhoto_body payload, map headers = {}) returns UsersDeletePhotoResponse|error { string resourcePath = string `/users.deletePhoto`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1246,7 +1246,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post users\.profile\.set(users_profile_set_body payload, map headers = {}) returns json|error { + resource isolated function post users\.profile\.set(users_profile_set_body payload, map headers = {}) returns UsersProfileSetResponse|error { string resourcePath = string `/users.profile.set`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1254,13 +1254,13 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post users\.setActive(map headers = {}) returns json|error { + resource isolated function post users\.setActive(map headers = {}) returns UsersSetActiveResponse|error { string resourcePath = string `/users.setActive`; http:Request request = new; return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post users\.setPhoto(users_setPhoto_body payload, map headers = {}) returns json|error { + resource isolated function post users\.setPhoto(users_setPhoto_body payload, map headers = {}) returns UsersSetPhotoResponse|error { string resourcePath = string `/users.setPhoto`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); @@ -1268,7 +1268,7 @@ public isolated client class Client { return self.clientEp->post(resourcePath, request, headers); } - resource isolated function post users\.setPresence(users_setPresence_body payload, map headers = {}) returns json|error { + resource isolated function post users\.setPresence(users_setPresence_body payload, map headers = {}) returns UsersSetPresenceResponse|error { string resourcePath = string `/users.setPresence`; http:Request request = new; string encodedRequestBody = createFormURLEncodedRequestBody(payload); diff --git a/ballerina/tests/test_cases.bal b/ballerina/tests/test_cases.bal index 06fe722..5c6fd65 100644 --- a/ballerina/tests/test_cases.bal +++ b/ballerina/tests/test_cases.bal @@ -45,31 +45,31 @@ function setup() returns error? { groups: ["live_tests", "mock_tests"] } function testGetPresence() returns error? { - json response = check slack->/users\.getPresence(); - test:assertTrue(check response.ok, "The ok attribute was not equal to true"); + APIMethodUsersGetPresence response = check slack->/users\.getPresence(); + test:assertTrue(response.ok, "The ok attribute was not equal to true"); } @test:Config { groups: ["live_tests", "mock_tests"] } function testPostMessage_1() returns error? { - json response = check slack->/chat\.postMessage.post({channel: "general", text: "This is a Test"}); - test:assertTrue(check response.ok, "The ok attribute should be true"); - test:assertEquals(check response.message.text, "This is a Test", "The message text is not equal to the expected value"); + ChatPostMessageResponse response = check slack->/chat\.postMessage.post({channel: "general", text: "This is a Test"}); + test:assertTrue(response.ok, "The ok attribute should be true"); + test:assertEquals(response.message.text, "This is a Test", "The message text is not equal to the expected value"); } @test:Config { groups: ["live_tests", "mock_tests"] } function testUsersList() returns error? { - json response = check slack->/users\.list(); - test:assertTrue(check response.ok, "The ok attribute should be true"); + UsersListResponse response = check slack->/users\.list(); + test:assertTrue(response.ok, "The ok attribute should be true"); } @test:Config { groups: ["live_tests", "mock_tests"] } function testUsersProfileGet() returns error? { - json response = check slack->/users\.profile\.get(); - test:assertTrue(check response.ok, "The ok attribute should be true"); + UsersProfileGetResponse response = check slack->/users\.profile\.get(); + test:assertTrue(response.ok, "The ok attribute should be true"); } diff --git a/ballerina/types.bal b/ballerina/types.bal index 7e21d20..7bfeeba 100644 --- a/ballerina/types.bal +++ b/ballerina/types.bal @@ -52,6 +52,16 @@ public type usergroups_disable_body record { string usergroup; }; +public type objs_reminder record {| + int complete_ts?; + defs_user_id creator; + defs_reminder_id id; + boolean recurring; + string text; + int time?; + defs_user_id user; +|}; + public type reminders_complete_body record { # The ID of the reminder to be marked as complete string reminder?; @@ -66,6 +76,12 @@ public type admin_usergroups_addTeams_body record { string usergroup_id; }; +# Schema for successful response from usergroups.users.list method +public type UsergroupsUsersListResponse record {| + defs_ok_true ok; + defs_user_id[] users; +|}; + public type admin_teams_settings_setDiscoverability_body record { # This workspace's discovery setting. It must be set to one of `open`, `invite_only`, `closed`, or `unlisted`. string discoverability; @@ -73,6 +89,14 @@ public type admin_teams_settings_setDiscoverability_body record { string team_id; }; +# Schema for successful response from users.profile.set method +public type UsersProfileSetResponse record {| + string email_pending?; + defs_ok_true ok; + objs_user_profile profile; + string username; +|}; + public type admin_conversations_disconnectShared_body record { # The channel to be disconnected from some workspaces. string channel_id; @@ -108,6 +132,17 @@ public type stars_remove_body record { string timestamp?; }; +# Schema for successful response from users.lookupByEmail method +public type UsersLookupByEmailResponse record { + defs_ok_true ok; + objs_user user; +}; + +# Schema for successful response conversations.archive method +public type ConversationsArchiveResponse record {| + defs_ok_true ok; +|}; + # Represents the Queries record for the operation: apps_permissions_users_list public type Apps_permissions_users_listQueries record { # 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](/docs/pagination) for more detail. @@ -138,6 +173,17 @@ public type Admin_conversations_restrictAccess_listGroupsQueries record { string channel_id; }; +# Schema for successful response from dnd.info method +public type DndInfoResponse record {| + boolean dnd_enabled; + int next_dnd_end_ts; + int next_dnd_start_ts; + defs_ok_true ok; + boolean snooze_enabled?; + int snooze_endtime?; + int snooze_remaining?; +|}; + # Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. @display {label: "Connection Config"} public type ConnectionConfig record {| @@ -173,6 +219,11 @@ public type ConnectionConfig record {| boolean validation = true; |}; +# Schema for successful response of admin.conversations.unarchive +public type AdminConversationsUnarchiveResponse record {| + defs_ok_true ok; +|}; + public type files_comments_delete_body record { # File to delete a comment from. string file?; @@ -208,12 +259,36 @@ public type Files_remote_listQueries record { int 'limit?; }; +# Schema for successful response of chat.delete method +public type ChatDeleteResponse record {| + defs_channel channel; + defs_ok_true ok; + defs_ts ts; +|}; + # Represents the Queries record for the operation: dnd_info public type Dnd_infoQueries record { # User to fetch status for (defaults to current user) string user?; }; +# Schema for successful response of admin.conversations.archive +public type AdminConversationsArchiveResponse record {| + defs_ok_true ok; +|}; + +# Schema for successful response from chat.postEphemeral method +public type ChatPostEphemeralResponse record {| + defs_ts message_ts; + defs_ok_true ok; +|}; + +# Schema for successful response from usergroups.enable method +public type UsergroupsEnableResponse record {| + defs_ok_true ok; + objs_subteam usergroup; +|}; + # Represents the Queries record for the operation: workflows_stepCompleted public type Workflows_stepCompletedQueries record { # Key-value object of outputs from your step. Keys of this object reflect the configured `key` properties of your [`outputs`](/reference/workflows/workflow_step#output) array from your `workflow_step` object. @@ -222,6 +297,8 @@ public type Workflows_stepCompletedQueries record { string workflow_step_execute_id; }; +public type defs_enterprise_name string; + # Represents the Queries record for the operation: conversations_members public type Conversations_membersQueries record { # 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](/docs/pagination) for more detail. @@ -232,11 +309,102 @@ public type Conversations_membersQueries record { int 'limit?; }; +public type objs_user_profile record {| + boolean always_active?; + defs_optional_app_id api_app_id?; + string avatar_hash; + defs_bot_id bot_id?; + string display_name; + string display_name_normalized; + string? email?; + record {}[]? fields; + string? first_name?; + int? guest_expiration_ts?; + string? guest_invited_by?; + string? image_1024?; + string? image_192?; + string? image_24?; + string? image_32?; + string? image_48?; + string? image_512?; + string? image_72?; + string? image_original?; + boolean is_app_user?; + boolean is_custom_image?; + boolean? is_restricted?; + boolean? is_ultra_restricted?; + string last_avatar_image_hash?; + string? last_name?; + int memberships_count?; + string? name?; + string phone; + string pronouns?; + string real_name; + string real_name_normalized; + string skype; + string status_default_emoji?; + string status_default_text?; + string? status_default_text_canonical?; + string status_emoji; + int status_expiration?; + string status_text; + string? status_text_canonical?; + defs_workspace_id team?; + string title; + int updated?; + string user_id?; + string? username?; +|}; + +public type objs_conversation (anydata)[]; + +# Schema for successful response from auth.revoke method +public type AuthRevokeResponse record {| + defs_ok_true ok; + boolean revoked; +|}; + +# Schema for successful response from usergroups.update method +public type UsergroupsUpdateResponse record {| + defs_ok_true ok; + objs_subteam usergroup; +|}; + +public type objs_subteam record {| + boolean auto_provision; + (anydata)[] auto_type; + int channel_count?; + defs_user_id created_by; + int date_create; + int date_delete; + int date_update; + (anydata)[] deleted_by; + string description; + string enterprise_subteam_id; + string 'handle; + defs_subteam_id id; + boolean is_external; + boolean is_subteam; + boolean is_usergroup; + string name; + objs_subteam_prefs prefs; + defs_team team_id; + defs_user_id updated_by; + int user_count?; + defs_user_id[] users?; +|}; + public type conversations_archive_body record { # ID of conversation to archive string channel?; }; +public type RtmConnectResponse_team record {| + string domain; + defs_team id; + string name; +|}; + public type stars_add_body record { # Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`). string channel?; @@ -267,6 +435,12 @@ public type Admin_emoji_listQueries record { int 'limit?; }; +public type objs_channel_purpose record {| + defs_topic_purpose_creator creator; + int last_set; + string value; +|}; + public type admin_users_setRegular_body record { # The ID (`T1234`) of the workspace. string team_id; @@ -285,6 +459,27 @@ public type objs_file_shares record {| record {||} 'public?; |}; +public type AppsPermissionsResourcesListResponse_response_metadata record {| + string next_cursor; +|}; + +# Schema for successful response from conversations.setPurpose method +public type ConversationsSetPurposeResponse record {| + objs_conversation channel; + defs_ok_true ok; +|}; + +# Schema for successful response from apps.uninstall method +public type AppsUninstallResponse record {| + defs_ok_true ok; +|}; + +# Schema for successful response from usergroups.create method +public type UsergroupsCreateResponse record {| + defs_ok_true ok; + objs_subteam usergroup; +|}; + # Represents the Queries record for the operation: chat_scheduledMessages_list public type Chat_scheduledMessages_listQueries record { # For pagination purposes, this is the `cursor` value returned from a previous call to `chat.scheduledmessages.list` indicating where you want to start this call from. @@ -313,6 +508,17 @@ public type objs_user_profile_short record {| defs_workspace_id team; |}; +# Schema for successful response from pins.remove method +public type PinsRemoveResponse record {| + defs_ok_true ok; +|}; + +# Schema for successful response of admin.conversations.create +public type AdminConversationsCreateResponse record {| + defs_channel_id channel_id?; + defs_ok_true ok; +|}; + @constraint:String {pattern: re `^B[A-Z0-9]{8,}$`} public type defs_bot_id string; @@ -322,6 +528,12 @@ public type admin_conversations_rename_body record { string name; }; +# Schema for successful response from files.revokePublicURL method +public type FilesRevokePublicURLResponse record {| + objs_file file; + defs_ok_true ok; +|}; + public type conversations_leave_body record { # Conversation to leave string channel?; @@ -447,6 +659,11 @@ public type admin_apps_restrict_body record { string team_id?; }; +# Schema for successful response of admin.conversations.invite +public type AdminConversationsInviteResponse record {| + defs_ok_true ok; +|}; + # Provides settings related to HTTP/1.x protocol. public type ClientHttp1Settings record {| # Specifies whether to reuse a connection for multiple requests @@ -480,6 +697,12 @@ public type admin_users_remove_body record { string user_id; }; +# Schema for successful response from users.setPhoto method +public type UsersSetPhotoResponse record {| + defs_ok_true ok; + UsersSetPhotoResponse_profile profile; +|}; + public type admin_teams_settings_setDescription_body record { # The new description for the workspace. string description; @@ -487,6 +710,30 @@ public type admin_teams_settings_setDescription_body record { string team_id; }; +# Schema for successful response from users.setActive method +public type UsersSetActiveResponse record {| + defs_ok_true ok; +|}; + +public type TeamProfileGetResponse_profile record {| + objs_team_profile_field[] fields; +|}; + +public type AppsPermissionsInfoResponse_info record { + AppsPermissionsInfoResponse_info_app_home app_home; + AppsPermissionsInfoResponse_info_app_home channel; + AppsPermissionsInfoResponse_info_app_home group; + AppsPermissionsInfoResponse_info_app_home im; + AppsPermissionsInfoResponse_info_app_home mpim; + AppsPermissionsInfoResponse_info_team team; +}; + +# Schema for successful response from conversations.rename method +public type ConversationsRenameResponse record {| + objs_conversation channel; + defs_ok_true ok; +|}; + public type calls_participants_remove_body record { # `id` returned by the [`calls.add`](/methods/calls.add) method. string id; @@ -494,15 +741,83 @@ public type calls_participants_remove_body record { string users; }; +public type objs_team record {| + boolean archived?; + string avatar_base_url?; + int created?; + int date_create?; + boolean deleted?; + string? description?; + (anydata)[] discoverable?; + string domain; + string email_domain; + defs_enterprise_id enterprise_id?; + defs_enterprise_name enterprise_name?; + objs_external_org_migrations external_org_migrations?; + boolean has_compliance_export?; + objs_icon icon; + defs_workspace_id id; + boolean is_assigned?; + int is_enterprise?; + boolean is_over_storage_limit?; + int limit_ts?; + string locale?; + int messages_count?; + int msg_edit_window_mins?; + string name; + boolean over_integrations_limit?; + boolean over_storage_limit?; + string pay_prod_cur?; + ""|"std"|"plus"|"compliance"|"enterprise" plan?; + objs_primary_owner primary_owner?; + objs_team_sso_provider sso_provider?; +|}; + +# Schema for successful response from team.info method +public type TeamInfoResponse record {| + defs_ok_true ok; + objs_team team; +|}; + +# Schema for successful response from team.integrationLogs method +public type TeamIntegrationLogsResponse record {| + @constraint:Array {minLength: 1} + TeamIntegrationLogsResponse_logs[] logs; + defs_ok_true ok; + objs_paging paging; +|}; + @constraint:String {pattern: re `^[D][A-Z0-9]{8,}$`} public type defs_dm_id string; +public type objs_team_profile_field record {| + string? field_name?; + string hint; + @constraint:String {pattern: re `^X[a-zA-Z0-9]{9,}$`} + string id; + boolean is_hidden?; + string label; + (anydata)[] options?; + decimal ordering; + string[]? possible_values?; + "text"|"date"|"link"|"mailto"|"options_list"|"user" 'type; +|}; + +public type ObjsuserItemsnull anydata; + # Represents the Queries record for the operation: pins_list public type Pins_listQueries record { # Channel to get pinned items for. string channel; }; +# Schema for successful response chat.getPermalink +public type ChatGetPermalinkResponse record {| + defs_channel channel; + defs_ok_true ok; + string permalink; +|}; + public type conversations_create_body record { # Create a private channel instead of a public one boolean is_private?; @@ -527,6 +842,11 @@ public type reminders_add_body record { string user?; }; +# Schema for successful response files.delete method +public type FilesDeleteResponse record {| + defs_ok_true ok; +|}; + public type admin_usergroups_addChannels_body record { # Comma separated string of channel IDs. string channel_ids; @@ -536,6 +856,23 @@ public type admin_usergroups_addChannels_body record { string usergroup_id; }; +# Schema for successful response from chat.scheduledMessages.list method +public type ChatScheduledMessagesListResponse record {| + defs_ok_true ok; + AdminConversationsGetTeamsResponse_response_metadata response_metadata; + ChatScheduledMessagesListResponse_scheduled_messages[] scheduled_messages; +|}; + +# Schema for successful response of chat.scheduleMessage method +public type ChatScheduleMessageResponse record {| + defs_channel channel; + ChatScheduleMessageResponse_message message; + defs_ok_true ok; + int post_at; + @constraint:String {pattern: re `^[Q][A-Z0-9]{8,}$`} + string scheduled_message_id; +|}; + public type objs_comment record {| string comment; int created; @@ -550,6 +887,24 @@ public type objs_comment record {| defs_user_id user; |}; +public type objs_enterprise_user record {| + defs_enterprise_id enterprise_id; + defs_enterprise_name enterprise_name; + defs_enterprise_user_id id; + boolean is_admin; + boolean is_owner; + defs_team[] teams; +|}; + +public type AdminConversationsGetTeamsResponse_response_metadata record {| + string next_cursor; +|}; + +# Schema for successful response of admin.conversations.rename +public type AdminConversationsRenameResponse_1 record {| + defs_ok_true ok; +|}; + public type usergroups_users_update_body record { # Include the number of users in the User Group. boolean include_count?; @@ -581,12 +936,41 @@ public type conversations_open_body record { string users?; }; +public type objs_icon record { + string image_102?; + string image_132?; + string image_230?; + string image_34?; + string image_44?; + string image_68?; + string image_88?; + boolean image_default?; +}; + # Represents the Queries record for the operation: team_info public type Team_infoQueries record { # Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels string team?; }; +public type UsersSetPhotoResponse_profile record {| + @constraint:String {pattern: re `^[0-9a-f]{12}$`} + string avatar_hash; + string image_1024; + string image_192; + string image_24; + string image_32; + string image_48; + string image_512; + string image_72; + string image_original; +|}; + +# Schema for successful response of admin.conversations.setConversationPrefs +public type AdminConversationsSetConversationPrefsResponse record {| + defs_ok_true ok; +|}; + # Represents the Queries record for the operation: oauth_v2_access public type Oauth_v2_accessQueries record { # The `code` param returned via the OAuth callback. @@ -614,6 +998,17 @@ public type chat_unfurl_body record { string user_auth_url?; }; +# Schema for successful response from files.info method +public type FilesInfoResponse record {| + objs_comments comments; + anydata? content_html?; + defs_user_id editor?; + objs_file file; + defs_ok_true ok; + objs_paging paging?; + objs_response_metadata response_metadata?; +|}; + # Represents the Queries record for the operation: admin_inviteRequests_denied_list public type Admin_inviteRequests_denied_listQueries record { # Value of the `next_cursor` field sent as part of the previous api response @@ -627,11 +1022,27 @@ public type Admin_inviteRequests_denied_listQueries record { @constraint:String {pattern: re `^[C][A-Z0-9]{2,}$`} public type defs_channel_id string; +public type objs_resources record {| + (defs_channel|defs_team)[][] excluded_ids?; + (defs_channel|defs_team)[][] ids; + boolean wildcard?; +|}; + +public type AppsPermissionsInfoResponse_info_app_home record { + objs_resources resources?; + objs_scopes scopes?; +}; + public type objs_message_icons record {| string emoji?; string image_64?; |}; +public type objs_subteam_prefs record {| + defs_channel_id[] channels; + defs_group_id[] groups; +|}; + # Represents the Queries record for the operation: search_messages public type Search_messagesQueries record { # Pass a value of `true` to enable query highlight markers (see below). @@ -647,6 +1058,12 @@ public type Search_messagesQueries record { string sort_dir?; }; +# Schema for successful response api.permissions.scopes.list method +public type ApiPermissionsScopesListResponse record { + defs_ok_true ok; + ApiPermissionsScopesListResponse_scopes scopes; +}; + # Represents the Queries record for the operation: admin_inviteRequests_approved_list public type Admin_inviteRequests_approved_listQueries record { # Value of the `next_cursor` field sent as part of the previous API response @@ -667,6 +1084,19 @@ public type admin_users_setOwner_body record { string user_id; }; +public type TeamAccessLogsResponse_logins record {| + int count; + string? country; + int date_first; + int date_last; + string? ip; + string? isp; + string? region; + string user_agent; + defs_user_id user_id; + string username; +|}; + # Represents the Queries record for the operation: admin_conversations_search public type Admin_conversations_searchQueries record { # Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. @@ -712,6 +1142,11 @@ public type Admin_apps_approved_listQueries record { string enterprise_id?; }; +# Schema for successful response of admin.conversations.disconnectShared +public type AdminConversationsRenameResponse record {| + defs_ok_true ok; +|}; + public type objs_message_attachments record {| string fallback?; int id; @@ -777,6 +1212,11 @@ public type admin_teams_settings_setName_body record { string team_id; }; +# Schema for successful response from users.deletePhoto method +public type UsersDeletePhotoResponse record {| + defs_ok_true ok; +|}; + public type users_setPhoto_body record { # Width/height of crop box (always square) string crop_w?; @@ -790,6 +1230,21 @@ public type users_setPhoto_body record { string token; }; +public type AdminConversationsGetConversationPrefsResponse_prefs_can_thread record { + string[] 'type?; + string[] user?; +}; + +public type ChatScheduleMessageResponse_message record {| + defs_bot_id bot_id; + objs_bot_profile bot_profile?; + defs_team team; + string text; + string 'type; + defs_user_id user; + string username?; +|}; + # Represents the Queries record for the operation: admin_inviteRequests_list public type Admin_inviteRequests_listQueries record { # Value of the `next_cursor` field sent as part of the previous API response @@ -808,6 +1263,11 @@ public type Team_accessLogsQueries record { string page?; }; +# Schema for successful response from dialog.open method +public type DialogOpenResponse record {| + defs_ok_true ok; +|}; + # Represents the Queries record for the operation: files_list public type Files_listQueries record { # Filter files created after this timestamp (inclusive). @@ -832,6 +1292,21 @@ public type Team_profile_getQueries record { string visibility?; }; +# Schema for successful response from users.setPresence method +public type UsersSetPresenceResponse record {| + defs_ok_true ok; +|}; + +public type BotsInfoResponse_bot record {| + defs_app_id app_id; + boolean deleted; + objs_bot_profile_icons icons; + defs_bot_id id; + string name; + int updated; + defs_user_id user_id?; +|}; + # Represents the Queries record for the operation: conversations_history public type Conversations_historyQueries record { # 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](/docs/pagination) for more detail. @@ -860,6 +1335,11 @@ public type conversations_close_body record { string channel?; }; +# Schema for successful response from reactions.remove method +public type ReactionsRemoveResponse record {| + defs_ok_true ok; +|}; + public type admin_apps_approve_body record { # The id of the app to approve. string app_id?; @@ -893,20 +1373,62 @@ public type reactions_add_body record { string timestamp; }; +# Schema for successful response from users.profile.get method +public type UsersProfileGetResponse record {| + defs_ok_true ok; + objs_user_profile profile; +|}; + # This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace. public type blocks blocks_inner[]; +# Schema for successful response from chat.deleteScheduledMessage method +public type ChatDeleteScheduledMessageResponse record {| + defs_ok_true ok; +|}; + +@constraint:String {pattern: re `^(A[A-Z0-9]{1,})?$`} +public type defs_optional_app_id string; + public type files_sharedPublicURL_body record { # File to share string file?; }; +# Schema for successful response from conversations.join method +public type ConversationsJoinResponse record {| + objs_conversation channel; + defs_ok_true ok; + Response\ metadata response_metadata?; + string warning?; +|}; + +public type AppsPermissionsResourcesListResponse_resources record { + string id?; + string 'type?; +}; + @constraint:String {pattern: re `^[CGD][A-Z0-9]{8,}$`} public type defs_channel string; public type defs_pinned_info record {| |}; +# Schema for successful response from stars.list method +public type StarsListResponse record {| + (record {|defs_channel channel; int date_create; objs_message message; "message" 'type;|}|record {|int date_create; objs_file file; "file" 'type;|}|record {|objs_comment comment; int date_create; objs_file file; "file_comment" 'type;|}|record {|defs_channel channel; int date_create; "channel" 'type;|}|record {|defs_dm_id channel; int date_create; "im" 'type;|}|record {|defs_group_id channel; int date_create; "group" 'type;|})[][] items; + defs_ok_true ok; + objs_paging paging?; +|}; + +# Schema for successful response conversations.members method +public type ConversationsMembersResponse record {| + @constraint:Array {minLength: 1} + defs_user_id[] members; + defs_ok_true ok; + AdminConversationsGetTeamsResponse_response_metadata response_metadata; +|}; + public type admin_users_assign_body record { # Comma separated values of channel IDs to add user in the new workspace. string channel_ids?; @@ -937,18 +1459,54 @@ public type Apps_permissions_requestQueries record { string scopes; }; +public type objs_scopes string[]; + +# Schema for successful response from conversations.list method +public type ConversationsListResponse record {| + objs_conversation[] channels; + defs_ok_true ok; + AdminConversationsGetTeamsResponse_response_metadata response_metadata?; +|}; + # Represents the Queries record for the operation: users_getPresence public type Users_getPresenceQueries record { # User to get presence info on. Defaults to the authed user. string user?; }; +public type TeamIntegrationLogsResponse_logs record {| + defs_app_id admin_app_id?; + defs_app_id app_id; + string app_type; + string change_type; + defs_channel channel?; + string date; + string scope; + string service_id?; + string service_type?; + defs_user_id user_id; + string user_name; +|}; + # Represents the Queries record for the operation: team_billableInfo public type Team_billableInfoQueries record { # A user to retrieve the billable information for. Defaults to all users. string user?; }; +# Schema for successful response from team.accessLogs method +public type TeamAccessLogsResponse record {| + @constraint:Array {minLength: 1} + TeamAccessLogsResponse_logins[] logins; + defs_ok_true ok; + objs_paging paging; +|}; + +# Schema for successful response from apps.permissions.request method +public type AppsPermissionsRequestResponse record {| + defs_ok_true ok; +|}; + # Represents the Queries record for the operation: reactions_list public type Reactions_listQueries record { # Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See [pagination](/docs/pagination) for more details. @@ -1003,6 +1561,9 @@ public type admin_emoji_remove_body record { string token; }; +@constraint:String {pattern: re `^S[A-Z0-9]{2,}$`} +public type defs_subteam_id string; + # Represents the Queries record for the operation: views_push public type Views_pushQueries record { # A [view payload](/reference/surfaces/views). This must be a JSON-encoded string. @@ -1011,6 +1572,14 @@ public type Views_pushQueries record { string trigger_id; }; +# Schema for successful response from reminders.delete method +public type RemindersDeleteResponse record {| + defs_ok_true ok; +|}; + +@constraint:String {pattern: re `^Rm[A-Z0-9]{8,}$`} +public type defs_reminder_id string; + public type objs_message record {| @constraint:Array {minLength: 1} objs_message_attachments[] attachments?; @@ -1058,6 +1627,11 @@ public type objs_message record {| string username?; |}; +public type objs_primary_owner record { + string email; + string id; +}; + public type admin_users_setExpiration_body record { # Timestamp when guest account should be disabled. int expiration_ts; @@ -1074,6 +1648,9 @@ public type conversations_setTopic_body record { string topic?; }; +@constraint:String {pattern: re `^[UW][A-Z0-9]{8,}$|^$`} +public type defs_topic_purpose_creator string; + # Represents the Queries record for the operation: apps_permissions_users_request public type Apps_permissions_users_requestQueries record { # Token used to trigger the request @@ -1087,6 +1664,20 @@ public type Apps_permissions_users_requestQueries record { @constraint:String {pattern: re `^[T][A-Z0-9]{2,}$`} public type defs_team string; +public type objs_external_org_migrations record { + objs_external_org_migrations_current[] current; + int date_updated; +}; + +public type objs_paging record {| + int count?; + int page; + int pages?; + int per_page?; + int spill?; + int total; +|}; + public type files_remote_add_body record { # Creator defined GUID for the file. string external_id?; @@ -1104,6 +1695,11 @@ public type files_remote_add_body record { string token?; }; +# Schema for successful response from conversations.unarchive method +public type ConversationsUnarchiveResponse record {| + defs_ok_true ok; +|}; + public type admin_teams_settings_setIcon_body record { # Image URL for the icon string image_url; @@ -1116,6 +1712,24 @@ public type admin_teams_settings_setIcon_body record { @constraint:String {pattern: re `^[G][A-Z0-9]{8,}$`} public type defs_group_id string; +# Schema for successful response of admin.conversations.convertToPrivate +public type AdminConversationsConvertToPrivateResponse record {| + defs_ok_true ok; +|}; + +# Schema for successful response from chat.meMessage method +public type ChatMeMessageResponse record {| + defs_channel channel?; + defs_ok_true ok; + defs_ts ts?; +|}; + +# Schema for successful response of admin.conversations.search +public type AdminConversationsSearchResponse record {| + objs_channel[] channels; + string next_cursor; +|}; + public type chat_meMessage_body record { # Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name. string channel?; @@ -1123,6 +1737,17 @@ public type chat_meMessage_body record { string text?; }; +# Schema for successful response from chat.unfurl method +public type ChatUnfurlResponse record {| + defs_ok_true ok; +|}; + +# Schema for successful response from reminders.info method +public type RemindersInfoResponse record {| + defs_ok_true ok; + objs_reminder reminder; +|}; + public type calls_add_body record { # The valid Slack user ID of the user who created this Call. When this method is called with a user token, the `created_by` field is optional and defaults to the authed user of the token. Otherwise, the field is required. string created_by?; @@ -1142,13 +1767,41 @@ public type calls_add_body record { string users?; }; +# Schema for successful response of admin.conversations.delete +public type AdminConversationsDeleteResponse record {| + defs_ok_true ok; +|}; + +# Schema for successful response from reactions.add method +public type ReactionsAddResponse record {| + defs_ok_true ok; +|}; + +public type objs_user (anydata)[]; + public type blocks_inner record { string 'type; }; +# Schema for successful response from pins.add method +public type PinsAddResponse record {| + defs_ok_true ok; +|}; + +public type objs_response_metadata (record {|string next_cursor;|}|record {|string[] messages; ("method_deprecated")[] warnings;|}|record {|string[] messages; string next_cursor; ("method_deprecated")[] warnings;|})[]; + @constraint:String {pattern: re `^[TE][A-Z0-9]{8,}$`} public type defs_workspace_id string; +# Schema for successful response from users.list method +public type UsersListResponse record {| + int cache_ts; + @constraint:Array {minLength: 1} + objs_user[] members; + defs_ok_true ok; + objs_response_metadata response_metadata?; +|}; + # Represents the Queries record for the operation: chat_getPermalink public type Chat_getPermalinkQueries record { # The ID of the conversation or channel containing the message @@ -1183,6 +1836,13 @@ public type Conversations_infoQueries record { boolean include_locale?; }; +# Schema for successful response from conversations.replies method +public type ConversationsRepliesResponse record {| + boolean has_more?; + (record {|defs_ts last_read?; defs_ts latest_reply?; int reply_count; defs_user_id[] reply_users?; int reply_users_count?; defs_team source_team?; boolean subscribed; defs_team team?; string text; defs_ts thread_ts; defs_ts ts; string 'type; int unread_count?; defs_user_id user; objs_user_profile_short user_profile?; defs_team user_team?;|}|record {|boolean is_starred?; defs_user_id parent_user_id; defs_team source_team?; defs_team team?; string text; defs_ts thread_ts; defs_ts ts; string 'type; defs_user_id user; objs_user_profile_short user_profile?; defs_team user_team?;|})[][] messages; + defs_ok_true ok; +|}; + # Represents the Queries record for the operation: migration_exchange public type Migration_exchangeQueries record { # Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`. @@ -1209,6 +1869,11 @@ public type reactions_remove_body record { string timestamp?; }; +# Schema for successful response from reminders.complete method +public type RemindersCompleteResponse record {| + defs_ok_true ok; +|}; + # Represents the Queries record for the operation: bots_info public type Bots_infoQueries record { # Bot user to get info on @@ -1238,6 +1903,17 @@ public type conversations_invite_body record { string users?; }; +# Schema for successful response conversations.create method +public type ConversationsCreateResponse record {| + objs_conversation channel; + defs_ok_true ok; +|}; + +public type RtmConnectResponse_self record {| + defs_user_id id; + string name; +|}; + # Represents the Queries record for the operation: workflows_updateStep public type Workflows_updateStepQueries record { # An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed. @@ -1258,6 +1934,11 @@ public type Auth_revokeQueries record { boolean test?; }; +public type objs_external_org_migrations_current record { + int date_started; + string team_id; +}; + # Represents the Queries record for the operation: files_info public type Files_infoQueries record { # Parameter for pagination. File comments are paginated for a single file. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection of comments. See [pagination](/docs/pagination) for more details. @@ -1283,6 +1964,12 @@ public type admin_conversations_create_body record { string team_id?; }; +# Schema for successful response conversations.info +public type ConversationsInfoResponse record {| + objs_conversation channel; + defs_ok_true ok; +|}; + public type chat_update_body record { # Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users. string as_user?; @@ -1302,6 +1989,12 @@ public type chat_update_body record { string ts; }; +# Schema for successful response from bots.info method +public type BotsInfoResponse record {| + BotsInfoResponse_bot bot; + defs_ok_true ok; +|}; + # Represents the Queries record for the operation: reactions_get public type Reactions_getQueries record { # File to get reactions for. @@ -1316,6 +2009,29 @@ public type Reactions_getQueries record { string timestamp?; }; +# Schema for successful response from usergroups.users.update method +public type UsergroupsUsersUpdateResponse record {| + defs_ok_true ok; + objs_subteam usergroup; +|}; + +public type ObjsconversationItemsnull anydata; + +# Schema for successful response from dnd.setSnooze method +public type DndSetSnoozeResponse record {| + defs_ok_true ok; + boolean snooze_enabled; + int snooze_endtime; + int snooze_remaining; +|}; + +public type objs_team_profile_field_option record {| + boolean? is_custom?; + boolean? is_multiple_entry?; + boolean? is_protected?; + boolean? is_scim?; +|}; + public type pins_remove_body record { # Channel where the item is pinned to. string channel; @@ -1335,6 +2051,8 @@ public type admin_emoji_rename_body record { string token; }; +public type defs_channel_name string; + public type objs_bot_profile_icons record {| string image_36; string image_48; @@ -1368,6 +2086,13 @@ public type Oauth_accessQueries record { string client_id?; }; +# Schema for successful response conversations.close method +public type ConversationsCloseResponse record {| + boolean already_closed?; + boolean no_op?; + defs_ok_true ok; +|}; + # Represents the Queries record for the operation: apps_uninstall public type Apps_uninstallQueries record { # Issued when you created your application. @@ -1386,6 +2111,14 @@ public type Admin_conversations_getTeamsQueries record { string channel_id; }; +# Schema for successful response from reactions.list method +public type ReactionsListResponse record {| + (record {|defs_channel channel; objs_message message; "message" 'type;|}|record {|objs_file file; "file" 'type;|}|record {|objs_comment comment; objs_file file; "file_comment" 'type;|})[][] items; + defs_ok_true ok; + objs_paging paging?; + objs_response_metadata response_metadata?; +|}; + public type chat_scheduleMessage_body record { # Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [chat.postMessage](chat.postMessage#authorship). boolean as_user?; @@ -1438,6 +2171,41 @@ public type admin_conversations_invite_body record { string user_ids; }; +public type objs_channel record {| + defs_user_id accepted_user?; + int created; + defs_user_id creator; + defs_channel_id id; + boolean is_archived?; + boolean is_channel; + boolean is_frozen?; + boolean is_general?; + boolean is_member?; + int is_moved?; + boolean is_mpim; + boolean is_non_threadable?; + boolean is_org_shared; + boolean is_pending_ext_shared?; + boolean is_private; + boolean is_read_only?; + boolean is_shared; + boolean is_thread_only?; + defs_ts last_read?; + (anydata)[] latest?; + defs_user_id[] members; + string name; + string name_normalized; + int num_members?; + defs_team[] pending_shared?; + defs_channel_name[] previous_names?; + decimal priority?; + objs_channel_purpose purpose; + objs_channel_purpose topic; + int unlinked?; + int unread_count?; + int unread_count_display?; +|}; + public type admin_conversations_restrictAccess_removeGroup_body record { # The channel to remove the linked group from. string channel_id; @@ -1449,12 +2217,48 @@ public type admin_conversations_restrictAccess_removeGroup_body record { string token; }; +public type Response\ metadata record { + string[] warnings?; +}; + public type admin_users_session_invalidate_body record { int session_id; # ID of the team that the session belongs to string team_id; }; +# Schema for successful response of admin.conversations.getConversationPrefs +public type AdminConversationsGetConversationPrefsResponse record {| + defs_ok_true ok; + AdminConversationsGetConversationPrefsResponse_prefs prefs?; +|}; + +# Schema for successful response files.comments.delete method +public type FilesCommentsDeleteResponse record {| + defs_ok_true ok; +|}; + +# Schema for successful response from dnd.endSnooze method +public type DndEndSnoozeResponse record {| + boolean dnd_enabled; + int next_dnd_end_ts; + int next_dnd_start_ts; + defs_ok_true ok; + boolean snooze_enabled; +|}; + +public type objs_team_sso_provider record { + string label?; + string name?; + string 'type?; +}; + +public type Message\ object record { + record {}[] attachments?; + record {} blocks?; + string text; +}; + public type usergroups_update_body record { # A comma separated string of encoded channel IDs for which the User Group uses as a default. string channels?; @@ -1477,6 +2281,32 @@ public type admin_conversations_setConversationPrefs_body record { string prefs; }; +# Schema for successful response of chat.postMessage method +public type ChatPostMessageResponse record {| + defs_channel channel; + objs_message message; + defs_ok_true ok; + defs_ts ts; +|}; + +# Schema for successful response of chat.update method +public type ChatUpdateResponse record {| + string channel; + Message\ object message; + defs_ok_true ok; + string text; + string ts; +|}; + +public type objs_comments anydata[]; + +# Schema for successful response from users.conversations method. Returned conversation objects do not include `num_members` or `is_member` +public type UsersConversationsResponse record { + objs_conversation[] channels; + defs_ok_true ok; + AdminConversationsGetTeamsResponse_response_metadata response_metadata?; +}; + # Represents the Queries record for the operation: views_update public type Views_updateQueries record { # A [view object](/reference/surfaces/views). This must be a JSON-encoded string. @@ -1489,6 +2319,14 @@ public type Views_updateQueries record { string hash?; }; +# Schema for successful response from conversations.open method when opening channels, ims, mpims +public type ConversationsOpenResponse record {| + boolean already_open?; + (objs_conversation|record {|string created?; defs_dm_id id; boolean is_im?; boolean is_open?; defs_ts last_read?; objs_message latest?; decimal unread_count?; decimal unread_count_display?; defs_user_id user?;|})[] channel; + boolean no_op?; + defs_ok_true ok; +|}; + # Represents the Queries record for the operation: users_info public type Users_infoQueries record { # Set this to `true` to receive the locale for this user. Defaults to `false` @@ -1497,6 +2335,28 @@ public type Users_infoQueries record { string user?; }; +# Schema for successful response from conversations.invite method +public type ConversationsInviteErrorResponse record {| + objs_conversation channel; + defs_ok_true ok; +|}; + +public type AppsPermissionsInfoResponse_info_team record { + objs_resources resources; + objs_scopes scopes; +}; + +# Generated from users.getPresence with shasum e7251aec575d8863f9e0eb38663ae9dc26655f65 +public type APIMethodUsersGetPresence record { + boolean auto_away?; + int connection_count?; + int last_activity?; + boolean manual_away?; + defs_ok_true ok; + boolean online?; + string presence; +}; + public type files_upload_body record { # Comma-separated list of channel names or IDs where the file will be shared. string channels?; @@ -1523,6 +2383,21 @@ public type files_delete_body record { string file?; }; +@constraint:String {pattern: re `^[E][A-Z0-9]{8,}$`} +public type defs_enterprise_id string; + +# Schema for successful response from users.info method +public type UsersInfoResponse record { + defs_ok_true ok; + objs_user user; +}; + +# Schema for successful response api.test method +public type ApiTestResponse record {| + defs_ok_true ok; + record {}...; +|}; + public type users_profile_set_body record { # Name of a single key to set. Usable only if `profile` is not passed. string name?; @@ -1534,6 +2409,15 @@ public type users_profile_set_body record { string value?; }; +# Schema for successful response from migration.exchange method +public type MigrationExchangeResponse record { + string enterprise_id; + string[] invalid_user_ids?; + defs_ok_true ok; + defs_team team_id; + record {} user_id_map?; +}; + # Represents the Queries record for the operation: api_test public type Api_testQueries record { # example property to return @@ -1624,6 +2508,34 @@ public type admin_conversations_restrictAccess_addGroup_body record { string token; }; +# Schema for successful response from stars.remove method +public type StarsRemoveResponse record {| + defs_ok_true ok; +|}; + +# Schema for successful response from usergroups.disable method +public type UsergroupsDisableResponse record {| + defs_ok_true ok; + objs_subteam usergroup; +|}; + +# Schema for successful response from usergroups.list method +public type UsergroupsListResponse record {| + defs_ok_true ok; + objs_subteam[] usergroups; +|}; + +# Schema for successful response from conversations.history method +public type ConversationsHistoryResponse record {| + int channel_actions_count; + (anydata)[] channel_actions_ts; + boolean has_more; + @constraint:Array {minLength: 1} + objs_message[] messages; + defs_ok_true ok; + int pin_count; +|}; + # Represents the Queries record for the operation: admin_teams_settings_info public type Admin_teams_settings_infoQueries record { string team_id; @@ -1639,6 +2551,17 @@ public type objs_bot_profile record {| int updated; |}; +# Schema for successful response from dnd.endDnd method +public type DndEndDndResponse record {| + defs_ok_true ok; +|}; + +# Schema for successful response from conversations.leave method +public type ConversationsLeaveResponse record {| + true not_in_channel?; + defs_ok_true ok; +|}; + @constraint:String {pattern: re `^[F][A-Z0-9]{8,}$`} public type defs_file_id string; @@ -1651,6 +2574,30 @@ public type chat_delete_body record { decimal ts?; }; +# Schema for successful response from files.list method +public type FilesListResponse record {| + objs_file[] files; + defs_ok_true ok; + objs_paging paging; +|}; + +public type ChatScheduledMessagesListResponse_scheduled_messages record {| + defs_channel_id channel_id; + int date_created; + @constraint:String {pattern: re `^[Q][A-Z0-9]{8,}$`} + string id; + int post_at; + string text?; +|}; + +# Schema for successful response from rtm.connect method +public type RtmConnectResponse record {| + defs_ok_true ok; + RtmConnectResponse_self self; + RtmConnectResponse_team team; + string url; +|}; + # This method either only returns a brief _OK_ response or a verbose schema is not available for this method. public type DefaultSuccessResponse record { defs_ok_true ok; @@ -1666,6 +2613,12 @@ public type Users_listQueries record { boolean include_locale?; }; +# Schema for successful response from reminders.list method +public type RemindersListResponse record {| + defs_ok_true ok; + objs_reminder[] reminders; +|}; + # Represents the Queries record for the operation: admin_teams_owners_list public type Admin_teams_owners_listQueries record { # Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. @@ -1695,6 +2648,12 @@ public type Users_lookupByEmailQueries record { string email; }; +# Schema for successful response from apps.permissions.info method +public type AppsPermissionsInfoResponse record {| + AppsPermissionsInfoResponse_info info; + defs_ok_true ok; +|}; + # Represents the Queries record for the operation: admin_conversations_ekm_listOriginalConnectedChannelInfo public type Admin_conversations_ekm_listOriginalConnectedChannelInfoQueries record { # A comma-separated list of channels to filter to. @@ -1716,6 +2675,12 @@ public type admin_emoji_add_body record { string url; }; +# Schema for successful response from reminders.add method +public type RemindersAddResponse record {| + defs_ok_true ok; + objs_reminder reminder; +|}; + # Represents the Queries record for the operation: views_publish public type Views_publishQueries record { # A [view payload](/reference/surfaces/views). This must be a JSON-encoded string. @@ -1726,6 +2691,13 @@ public type Views_publishQueries record { string hash?; }; +# Schema for successful response of admin.conversations.getTeams +public type AdminConversationsGetTeamsResponse record {| + defs_ok_true ok; + AdminConversationsGetTeamsResponse_response_metadata response_metadata?; + defs_team[] team_ids; +|}; + # Represents the Queries record for the operation: admin_usergroups_listChannels public type Admin_usergroups_listChannelsQueries record { # Flag to include or exclude the count of members per channel. @@ -1736,6 +2708,16 @@ public type Admin_usergroups_listChannelsQueries record { string team_id?; }; +public type ApiPermissionsScopesListResponse_scopes record { + objs_scopes app_home?; + objs_scopes channel?; + objs_scopes group?; + objs_scopes im?; + objs_scopes mpim?; + objs_scopes team?; + objs_scopes user?; +}; + public type admin_conversations_delete_body record { # The channel to delete. string channel_id; @@ -1753,6 +2735,19 @@ public type admin_users_setAdmin_body record { string user_id; }; +# Schema for successful response from team.profile.get method +public type TeamProfileGetResponse record {| + defs_ok_true ok; + TeamProfileGetResponse_profile profile; +|}; + +# Schema for successful response apps.permissions.resources.list method +public type AppsPermissionsResourcesListResponse record { + defs_ok_true ok; + AppsPermissionsResourcesListResponse_resources[] resources; + AppsPermissionsResourcesListResponse_response_metadata response_metadata?; +}; + public type files_revokePublicURL_body record { # File to revoke string file?; @@ -1815,6 +2810,11 @@ public type dnd_setSnooze_body record { string token; }; +# Schema for successful response conversations.mark method +public type ConversationsMarkResponse record {| + defs_ok_true ok; +|}; + public type admin_users_invite_body record { # A comma-separated list of `channel_id`s for this user to join. At least one channel is required. string channel_ids; @@ -1848,6 +2848,11 @@ public type users_setPresence_body record { string presence; }; +# Schema for successful response from stars.add method +public type StarsAddResponse record {| + defs_ok_true ok; +|}; + # Represents the Queries record for the operation: users_profile_get public type Users_profile_getQueries record { # Include labels for each ID in custom profile fields @@ -1856,6 +2861,11 @@ public type Users_profile_getQueries record { string user?; }; +# Schema for successful response conversations.kick method +public type ConversationsKickResponse record {| + defs_ok_true ok; +|}; + # Represents the Queries record for the operation: conversations_replies public type Conversations_repliesQueries record { # 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](/docs/pagination) for more detail. @@ -1881,6 +2891,29 @@ public type usergroups_enable_body record { string usergroup; }; +public type AdminConversationsGetConversationPrefsResponse_prefs record { + AdminConversationsGetConversationPrefsResponse_prefs_can_thread can_thread?; + AdminConversationsGetConversationPrefsResponse_prefs_can_thread who_can_post?; +}; + +# Schema for successful response from conversations.setTopic method +public type ConversationsSetTopicResponse record {| + objs_conversation channel; + defs_ok_true ok; +|}; + +# Schema for successful response auth.test method +public type AuthTestResponse record {| + defs_bot_id bot_id?; + boolean is_enterprise_install?; + defs_ok_true ok; + string team; + defs_team team_id; + string url; + string user; + defs_user_id user_id; +|}; + # Represents the Queries record for the operation: admin_teams_list public type Admin_teams_listQueries record { # Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. @@ -1888,3 +2921,18 @@ public type Admin_teams_listQueries record { # The maximum number of items to return. Must be between 1 - 100 both inclusive. int 'limit?; }; + +@constraint:String {pattern: re `^[WU][A-Z0-9]{8,}$`} +public type defs_enterprise_user_id string; + +# Schema for successful response files.upload method +public type FilesUploadResponse record {| + objs_file file; + defs_ok_true ok; +|}; + +# Schema for successful response from files.sharedPublicURL method +public type FilesSharedPublicURLResponse record {| + objs_file file; + defs_ok_true ok; +|}; From 2add59a0506f43b63f2b33573922d1e991c56a0e Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Thu, 11 Jul 2024 22:55:33 +0530 Subject: [PATCH 06/12] Improve sanitation script to sanitize component schema names --- ballerina/client.bal | 6 +- ballerina/types.bal | 1346 +++++++++++++++++----------------- docs/spec/openapi.json | 1428 ++++++++++++++++++------------------- docs/spec/sanitations.bal | 57 +- 4 files changed, 1445 insertions(+), 1392 deletions(-) diff --git a/ballerina/client.bal b/ballerina/client.bal index 08c18b4..dcd2d36 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -357,13 +357,13 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get pins\.list(map headers = {}, *Pins_listQueries queries) returns record {|(record {|int created?; defs_user_id created_by?; objs_file file?; "file" 'type?;|}|record {|defs_channel channel?; int created?; defs_user_id created_by?; objs_message message?; "message" 'type?;|})[] items; defs_ok_true ok;|}|record {|int count; defs_ok_true ok;|}[]|error { + resource isolated function get pins\.list(map headers = {}, *Pins_listQueries queries) returns record {|(record {|int created?; UserIdDef created_by?; FileObj file?; "file" 'type?;|}|record {|ChannelDef channel?; int created?; UserIdDef created_by?; MessageObj message?; "message" 'type?;|})[] items; OkTrueDef ok;|}|record {|int count; OkTrueDef ok;|}[]|error { string resourcePath = string `/pins.list`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); } - resource isolated function get reactions\.get(map headers = {}, *Reactions_getQueries queries) returns record {|defs_channel channel; objs_message message; defs_ok_true ok; "message" 'type;|}|record {|objs_file file; defs_ok_true ok; "file" 'type;|}|record {|objs_comment comment; objs_file file; defs_ok_true ok; "file_comment" 'type;|}[]|error { + resource isolated function get reactions\.get(map headers = {}, *Reactions_getQueries queries) returns record {|ChannelDef channel; MessageObj message; OkTrueDef ok; "message" 'type;|}|record {|FileObj file; OkTrueDef ok; "file" 'type;|}|record {|CommentObj comment; FileObj file; OkTrueDef ok; "file_comment" 'type;|}[]|error { string resourcePath = string `/reactions.get`; resourcePath = resourcePath + check getPathForQueryParam(queries); return self.clientEp->get(resourcePath, headers); @@ -458,7 +458,7 @@ public isolated client class Client { return self.clientEp->get(resourcePath, headers); } - resource isolated function get users\.identity(map headers = {}) returns record {|defs_ok_true ok; record {|defs_team id;|} team; record {|defs_user_id id; string name;|} user;|}|record {|defs_ok_true ok; record {|defs_team id;|} team; record {|string email; defs_user_id id; string name;|} user;|}|record {|defs_ok_true ok; record {|defs_team id;|} team; record {|defs_user_id id; string image_192; string image_24; string image_32; string image_48; string image_512; string image_72; string name;|} user;|}|record {|defs_ok_true ok; record {|string domain; defs_team id; string image_102; string image_132; string image_230; string image_34; string image_44; string image_68; string image_88; boolean image_default; string name;|} team; record {|defs_user_id id; string name;|} user;|}[]|error { + resource isolated function get users\.identity(map headers = {}) returns record {|OkTrueDef ok; record {|TeamDef id;|} team; record {|UserIdDef id; string name;|} user;|}|record {|OkTrueDef ok; record {|TeamDef id;|} team; record {|string email; UserIdDef id; string name;|} user;|}|record {|OkTrueDef ok; record {|TeamDef id;|} team; record {|UserIdDef id; string image_192; string image_24; string image_32; string image_48; string image_512; string image_72; string name;|} user;|}|record {|OkTrueDef ok; record {|string domain; TeamDef id; string image_102; string image_132; string image_230; string image_34; string image_44; string image_68; string image_88; boolean image_default; string name;|} team; record {|UserIdDef id; string name;|} user;|}[]|error { string resourcePath = string `/users.identity`; return self.clientEp->get(resourcePath, headers); } diff --git a/ballerina/types.bal b/ballerina/types.bal index 7bfeeba..83b8933 100644 --- a/ballerina/types.bal +++ b/ballerina/types.bal @@ -30,6 +30,12 @@ public type Usergroups_listQueries record { boolean include_count?; }; +@constraint:String {pattern: re `^[UW][A-Z0-9]{8,}$|^$`} +public type TopicPurposeCreatorDef string; + +@constraint:String {pattern: re `^Rm[A-Z0-9]{8,}$`} +public type ReminderIdDef string; + # Represents the Queries record for the operation: dialog_open public type Dialog_openQueries record { # The dialog definition. This must be a JSON-encoded string. @@ -52,16 +58,6 @@ public type usergroups_disable_body record { string usergroup; }; -public type objs_reminder record {| - int complete_ts?; - defs_user_id creator; - defs_reminder_id id; - boolean recurring; - string text; - int time?; - defs_user_id user; -|}; - public type reminders_complete_body record { # The ID of the reminder to be marked as complete string reminder?; @@ -78,8 +74,8 @@ public type admin_usergroups_addTeams_body record { # Schema for successful response from usergroups.users.list method public type UsergroupsUsersListResponse record {| - defs_ok_true ok; - defs_user_id[] users; + OkTrueDef ok; + UserIdDef[] users; |}; public type admin_teams_settings_setDiscoverability_body record { @@ -92,8 +88,8 @@ public type admin_teams_settings_setDiscoverability_body record { # Schema for successful response from users.profile.set method public type UsersProfileSetResponse record {| string email_pending?; - defs_ok_true ok; - objs_user_profile profile; + OkTrueDef ok; + UserProfileObj profile; string username; |}; @@ -134,13 +130,16 @@ public type stars_remove_body record { # Schema for successful response from users.lookupByEmail method public type UsersLookupByEmailResponse record { - defs_ok_true ok; - objs_user user; + OkTrueDef ok; + UserObj user; }; +@constraint:String {pattern: re `^Fc[A-Z0-9]{8,}$`} +public type CommentIdDef string; + # Schema for successful response conversations.archive method public type ConversationsArchiveResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Represents the Queries record for the operation: apps_permissions_users_list @@ -178,12 +177,19 @@ public type DndInfoResponse record {| boolean dnd_enabled; int next_dnd_end_ts; int next_dnd_start_ts; - defs_ok_true ok; + OkTrueDef ok; boolean snooze_enabled?; int snooze_endtime?; int snooze_remaining?; |}; +public type TeamProfileFieldOptionObj record {| + boolean? is_custom?; + boolean? is_multiple_entry?; + boolean? is_protected?; + boolean? is_scim?; +|}; + # Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. @display {label: "Connection Config"} public type ConnectionConfig record {| @@ -221,7 +227,7 @@ public type ConnectionConfig record {| # Schema for successful response of admin.conversations.unarchive public type AdminConversationsUnarchiveResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; public type files_comments_delete_body record { @@ -261,9 +267,9 @@ public type Files_remote_listQueries record { # Schema for successful response of chat.delete method public type ChatDeleteResponse record {| - defs_channel channel; - defs_ok_true ok; - defs_ts ts; + ChannelDef channel; + OkTrueDef ok; + TsDef ts; |}; # Represents the Queries record for the operation: dnd_info @@ -274,19 +280,19 @@ public type Dnd_infoQueries record { # Schema for successful response of admin.conversations.archive public type AdminConversationsArchiveResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Schema for successful response from chat.postEphemeral method public type ChatPostEphemeralResponse record {| - defs_ts message_ts; - defs_ok_true ok; + TsDef message_ts; + OkTrueDef ok; |}; # Schema for successful response from usergroups.enable method public type UsergroupsEnableResponse record {| - defs_ok_true ok; - objs_subteam usergroup; + OkTrueDef ok; + SubteamObj usergroup; |}; # Represents the Queries record for the operation: workflows_stepCompleted @@ -297,8 +303,6 @@ public type Workflows_stepCompletedQueries record { string workflow_step_execute_id; }; -public type defs_enterprise_name string; - # Represents the Queries record for the operation: conversations_members public type Conversations_membersQueries record { # 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](/docs/pagination) for more detail. @@ -309,72 +313,52 @@ public type Conversations_membersQueries record { int 'limit?; }; -public type objs_user_profile record {| - boolean always_active?; - defs_optional_app_id api_app_id?; - string avatar_hash; - defs_bot_id bot_id?; - string display_name; - string display_name_normalized; - string? email?; - record {}[]? fields; - string? first_name?; - int? guest_expiration_ts?; - string? guest_invited_by?; - string? image_1024?; - string? image_192?; - string? image_24?; - string? image_32?; - string? image_48?; - string? image_512?; - string? image_72?; - string? image_original?; - boolean is_app_user?; - boolean is_custom_image?; - boolean? is_restricted?; - boolean? is_ultra_restricted?; - string last_avatar_image_hash?; - string? last_name?; - int memberships_count?; - string? name?; - string phone; - string pronouns?; - string real_name; - string real_name_normalized; - string skype; - string status_default_emoji?; - string status_default_text?; - string? status_default_text_canonical?; - string status_emoji; - int status_expiration?; - string status_text; - string? status_text_canonical?; - defs_workspace_id team?; - string title; - int updated?; - string user_id?; - string? username?; -|}; +@constraint:String {pattern: re `^\d{10}\.\d{6}$`} +public type TsDef string; -public type objs_conversation (anydata)[]; +public type TeamProfileFieldObj record {| + string? field_name?; + string hint; + @constraint:String {pattern: re `^X[a-zA-Z0-9]{9,}$`} + string id; + boolean is_hidden?; + string label; + (anydata)[] options?; + decimal ordering; + string[]? possible_values?; + "text"|"date"|"link"|"mailto"|"options_list"|"user" 'type; +|}; # Schema for successful response from auth.revoke method public type AuthRevokeResponse record {| - defs_ok_true ok; + OkTrueDef ok; boolean revoked; |}; # Schema for successful response from usergroups.update method public type UsergroupsUpdateResponse record {| - defs_ok_true ok; - objs_subteam usergroup; + OkTrueDef ok; + SubteamObj usergroup; +|}; + +public type conversations_archive_body record { + # ID of conversation to archive + string channel?; +}; + +public type FileObj_shares record {| + record {||} 'private?; + record {||} 'public?; |}; -public type objs_subteam record {| +@constraint:String {pattern: re `^[E][A-Z0-9]{8,}$`} +public type EnterpriseIdDef string; + +public type SubteamObj record {| boolean auto_provision; (anydata)[] auto_type; int channel_count?; - defs_user_id created_by; + UserIdDef created_by; int date_create; int date_delete; int date_update; @@ -382,26 +366,21 @@ public type objs_subteam record {| string description; string enterprise_subteam_id; string 'handle; - defs_subteam_id id; + SubteamIdDef id; boolean is_external; boolean is_subteam; boolean is_usergroup; string name; - objs_subteam_prefs prefs; - defs_team team_id; - defs_user_id updated_by; + SubteamObj_prefs prefs; + TeamDef team_id; + UserIdDef updated_by; int user_count?; - defs_user_id[] users?; + UserIdDef[] users?; |}; -public type conversations_archive_body record { - # ID of conversation to archive - string channel?; -}; - public type RtmConnectResponse_team record {| string domain; - defs_team id; + TeamDef id; string name; |}; @@ -435,11 +414,11 @@ public type Admin_emoji_listQueries record { int 'limit?; }; -public type objs_channel_purpose record {| - defs_topic_purpose_creator creator; - int last_set; - string value; -|}; +public type TeamObj_sso_provider record { + string label?; + string name?; + string 'type?; +}; public type admin_users_setRegular_body record { # The ID (`T1234`) of the workspace. @@ -454,9 +433,18 @@ public type Admin_users_setOwnerHeaders record { string token; }; -public type objs_file_shares record {| - record {||} 'private?; - record {||} 'public?; +public type CommentObj record {| + string comment; + int created; + CommentIdDef id; + boolean is_intro; + boolean is_starred?; + int num_stars?; + PinnedInfoDef pinned_info?; + ChannelDef[] pinned_to?; + ReactionObj[] reactions?; + int timestamp; + UserIdDef user; |}; public type AppsPermissionsResourcesListResponse_response_metadata record {| @@ -465,19 +453,56 @@ public type AppsPermissionsResourcesListResponse_response_metadata record {| # Schema for successful response from conversations.setPurpose method public type ConversationsSetPurposeResponse record {| - objs_conversation channel; - defs_ok_true ok; + ConversationObj channel; + OkTrueDef ok; +|}; + +public type TeamObj record {| + boolean archived?; + string avatar_base_url?; + int created?; + int date_create?; + boolean deleted?; + string? description?; + (anydata)[] discoverable?; + string domain; + string email_domain; + EnterpriseIdDef enterprise_id?; + EnterpriseNameDef enterprise_name?; + ExternalOrgMigrationsObj external_org_migrations?; + boolean has_compliance_export?; + IconObj icon; + WorkspaceIdDef id; + boolean is_assigned?; + int is_enterprise?; + boolean is_over_storage_limit?; + int limit_ts?; + string locale?; + int messages_count?; + int msg_edit_window_mins?; + string name; + boolean over_integrations_limit?; + boolean over_storage_limit?; + string pay_prod_cur?; + ""|"std"|"plus"|"compliance"|"enterprise" plan?; + PrimaryOwnerObj primary_owner?; + TeamObj_sso_provider sso_provider?; |}; # Schema for successful response from apps.uninstall method public type AppsUninstallResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; +public type ExternalOrgMigrationsObj_current record { + int date_started; + string team_id; +}; + # Schema for successful response from usergroups.create method public type UsergroupsCreateResponse record {| - defs_ok_true ok; - objs_subteam usergroup; + OkTrueDef ok; + SubteamObj usergroup; |}; # Represents the Queries record for the operation: chat_scheduledMessages_list @@ -494,33 +519,27 @@ public type Chat_scheduledMessages_listQueries record { decimal latest?; }; -public type objs_user_profile_short record {| - string avatar_hash; - string display_name; - string display_name_normalized?; - string? first_name; - string image_72; - boolean is_restricted; - boolean is_ultra_restricted; - string name; - string real_name; - string real_name_normalized?; - defs_workspace_id team; -|}; - # Schema for successful response from pins.remove method public type PinsRemoveResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Schema for successful response of admin.conversations.create public type AdminConversationsCreateResponse record {| - defs_channel_id channel_id?; - defs_ok_true ok; + ChannelIdDef channel_id?; + OkTrueDef ok; |}; -@constraint:String {pattern: re `^B[A-Z0-9]{8,}$`} -public type defs_bot_id string; +public type ResourcesObj record {| + (ChannelDef|TeamDef)[][] excluded_ids?; + (ChannelDef|TeamDef)[][] ids; + boolean wildcard?; +|}; + +public type MessageObj_icons record {| + string emoji?; + string image_64?; +|}; public type admin_conversations_rename_body record { # The channel to rename. @@ -530,8 +549,8 @@ public type admin_conversations_rename_body record { # Schema for successful response from files.revokePublicURL method public type FilesRevokePublicURLResponse record {| - objs_file file; - defs_ok_true ok; + FileObj file; + OkTrueDef ok; |}; public type conversations_leave_body record { @@ -557,6 +576,8 @@ public type Admin_apps_restricted_listQueries record { string enterprise_id?; }; +public type EnterpriseNameDef string; + public type admin_conversations_setTeams_body record { # The encoded `channel_id` to add or remove to workspaces. string channel_id; @@ -615,6 +636,15 @@ public type Dnd_teamInfoQueries record { string users?; }; +public type PagingObj record {| + int count?; + int page; + int pages?; + int per_page?; + int spill?; + int total; +|}; + # Represents the Queries record for the operation: stars_list public type Stars_listQueries record { # Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See [pagination](/docs/pagination) for more details. @@ -651,6 +681,9 @@ public type files_remote_update_body record { string token?; }; +@constraint:String {pattern: re `^[C][A-Z0-9]{2,}$`} +public type ChannelIdDef string; + public type admin_apps_restrict_body record { # The id of the app to restrict. string app_id?; @@ -661,7 +694,7 @@ public type admin_apps_restrict_body record { # Schema for successful response of admin.conversations.invite public type AdminConversationsInviteResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Provides settings related to HTTP/1.x protocol. @@ -699,7 +732,7 @@ public type admin_users_remove_body record { # Schema for successful response from users.setPhoto method public type UsersSetPhotoResponse record {| - defs_ok_true ok; + OkTrueDef ok; UsersSetPhotoResponse_profile profile; |}; @@ -712,11 +745,11 @@ public type admin_teams_settings_setDescription_body record { # Schema for successful response from users.setActive method public type UsersSetActiveResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; public type TeamProfileGetResponse_profile record {| - objs_team_profile_field[] fields; + TeamProfileFieldObj[] fields; |}; public type AppsPermissionsInfoResponse_info record { @@ -730,8 +763,8 @@ public type AppsPermissionsInfoResponse_info record { # Schema for successful response from conversations.rename method public type ConversationsRenameResponse record {| - objs_conversation channel; - defs_ok_true ok; + ConversationObj channel; + OkTrueDef ok; |}; public type calls_participants_remove_body record { @@ -741,70 +774,20 @@ public type calls_participants_remove_body record { string users; }; -public type objs_team record {| - boolean archived?; - string avatar_base_url?; - int created?; - int date_create?; - boolean deleted?; - string? description?; - (anydata)[] discoverable?; - string domain; - string email_domain; - defs_enterprise_id enterprise_id?; - defs_enterprise_name enterprise_name?; - objs_external_org_migrations external_org_migrations?; - boolean has_compliance_export?; - objs_icon icon; - defs_workspace_id id; - boolean is_assigned?; - int is_enterprise?; - boolean is_over_storage_limit?; - int limit_ts?; - string locale?; - int messages_count?; - int msg_edit_window_mins?; - string name; - boolean over_integrations_limit?; - boolean over_storage_limit?; - string pay_prod_cur?; - ""|"std"|"plus"|"compliance"|"enterprise" plan?; - objs_primary_owner primary_owner?; - objs_team_sso_provider sso_provider?; -|}; - # Schema for successful response from team.info method public type TeamInfoResponse record {| - defs_ok_true ok; - objs_team team; + OkTrueDef ok; + TeamObj team; |}; # Schema for successful response from team.integrationLogs method public type TeamIntegrationLogsResponse record {| @constraint:Array {minLength: 1} TeamIntegrationLogsResponse_logs[] logs; - defs_ok_true ok; - objs_paging paging; -|}; - -@constraint:String {pattern: re `^[D][A-Z0-9]{8,}$`} -public type defs_dm_id string; - -public type objs_team_profile_field record {| - string? field_name?; - string hint; - @constraint:String {pattern: re `^X[a-zA-Z0-9]{9,}$`} - string id; - boolean is_hidden?; - string label; - (anydata)[] options?; - decimal ordering; - string[]? possible_values?; - "text"|"date"|"link"|"mailto"|"options_list"|"user" 'type; + OkTrueDef ok; + PagingObj paging; |}; -public type ObjsuserItemsnull anydata; - # Represents the Queries record for the operation: pins_list public type Pins_listQueries record { # Channel to get pinned items for. @@ -813,8 +796,8 @@ public type Pins_listQueries record { # Schema for successful response chat.getPermalink public type ChatGetPermalinkResponse record {| - defs_channel channel; - defs_ok_true ok; + ChannelDef channel; + OkTrueDef ok; string permalink; |}; @@ -844,7 +827,7 @@ public type reminders_add_body record { # Schema for successful response files.delete method public type FilesDeleteResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; public type admin_usergroups_addChannels_body record { @@ -858,51 +841,33 @@ public type admin_usergroups_addChannels_body record { # Schema for successful response from chat.scheduledMessages.list method public type ChatScheduledMessagesListResponse record {| - defs_ok_true ok; + OkTrueDef ok; AdminConversationsGetTeamsResponse_response_metadata response_metadata; ChatScheduledMessagesListResponse_scheduled_messages[] scheduled_messages; |}; # Schema for successful response of chat.scheduleMessage method public type ChatScheduleMessageResponse record {| - defs_channel channel; + ChannelDef channel; ChatScheduleMessageResponse_message message; - defs_ok_true ok; + OkTrueDef ok; int post_at; @constraint:String {pattern: re `^[Q][A-Z0-9]{8,}$`} string scheduled_message_id; |}; -public type objs_comment record {| - string comment; - int created; - defs_comment_id id; - boolean is_intro; - boolean is_starred?; - int num_stars?; - defs_pinned_info pinned_info?; - defs_channel[] pinned_to?; - objs_reaction[] reactions?; - int timestamp; - defs_user_id user; -|}; - -public type objs_enterprise_user record {| - defs_enterprise_id enterprise_id; - defs_enterprise_name enterprise_name; - defs_enterprise_user_id id; - boolean is_admin; - boolean is_owner; - defs_team[] teams; -|}; - public type AdminConversationsGetTeamsResponse_response_metadata record {| string next_cursor; |}; +public type SubteamObj_prefs record {| + ChannelIdDef[] channels; + GroupIdDef[] groups; +|}; + # Schema for successful response of admin.conversations.rename public type AdminConversationsRenameResponse_1 record {| - defs_ok_true ok; + OkTrueDef ok; |}; public type usergroups_users_update_body record { @@ -914,6 +879,9 @@ public type usergroups_users_update_body record { string users; }; +@constraint:String {pattern: re `^[D][A-Z0-9]{8,}$`} +public type DmIdDef string; + public type admin_usergroups_removeChannels_body record { # Comma-separated string of channel IDs string channel_ids; @@ -921,11 +889,7 @@ public type admin_usergroups_removeChannels_body record { string usergroup_id; }; -public type objs_reaction record { - int count; - string name; - defs_user_id[] users; -}; +public type CommentsObj anydata[]; public type conversations_open_body record { # Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead. @@ -936,17 +900,6 @@ public type conversations_open_body record { string users?; }; -public type objs_icon record { - string image_102?; - string image_132?; - string image_230?; - string image_34?; - string image_44?; - string image_68?; - string image_88?; - boolean image_default?; -}; - # Represents the Queries record for the operation: team_info public type Team_infoQueries record { # Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels @@ -968,7 +921,7 @@ public type UsersSetPhotoResponse_profile record {| # Schema for successful response of admin.conversations.setConversationPrefs public type AdminConversationsSetConversationPrefsResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Represents the Queries record for the operation: oauth_v2_access @@ -1000,13 +953,13 @@ public type chat_unfurl_body record { # Schema for successful response from files.info method public type FilesInfoResponse record {| - objs_comments comments; + CommentsObj comments; anydata? content_html?; - defs_user_id editor?; - objs_file file; - defs_ok_true ok; - objs_paging paging?; - objs_response_metadata response_metadata?; + UserIdDef editor?; + FileObj file; + OkTrueDef ok; + PagingObj paging?; + ResponseMetadataObj response_metadata?; |}; # Represents the Queries record for the operation: admin_inviteRequests_denied_list @@ -1019,30 +972,11 @@ public type Admin_inviteRequests_denied_listQueries record { string team_id?; }; -@constraint:String {pattern: re `^[C][A-Z0-9]{2,}$`} -public type defs_channel_id string; - -public type objs_resources record {| - (defs_channel|defs_team)[][] excluded_ids?; - (defs_channel|defs_team)[][] ids; - boolean wildcard?; -|}; - public type AppsPermissionsInfoResponse_info_app_home record { - objs_resources resources?; - objs_scopes scopes?; + ResourcesObj resources?; + ScopesObj scopes?; }; -public type objs_message_icons record {| - string emoji?; - string image_64?; -|}; - -public type objs_subteam_prefs record {| - defs_channel_id[] channels; - defs_group_id[] groups; -|}; - # Represents the Queries record for the operation: search_messages public type Search_messagesQueries record { # Pass a value of `true` to enable query highlight markers (see below). @@ -1058,24 +992,56 @@ public type Search_messagesQueries record { string sort_dir?; }; -# Schema for successful response api.permissions.scopes.list method -public type ApiPermissionsScopesListResponse record { - defs_ok_true ok; - ApiPermissionsScopesListResponse_scopes scopes; -}; - -# Represents the Queries record for the operation: admin_inviteRequests_approved_list -public type Admin_inviteRequests_approved_listQueries record { - # Value of the `next_cursor` field sent as part of the previous API response - string cursor?; - # The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive - int 'limit?; - # ID for the workspace where the invite requests were made. - string team_id?; -}; - -@constraint:String {pattern: re `^[UW][A-Z0-9]{2,}$`} -public type defs_user_id string; +public type ChannelObj record {| + UserIdDef accepted_user?; + int created; + UserIdDef creator; + ChannelIdDef id; + boolean is_archived?; + boolean is_channel; + boolean is_frozen?; + boolean is_general?; + boolean is_member?; + int is_moved?; + boolean is_mpim; + boolean is_non_threadable?; + boolean is_org_shared; + boolean is_pending_ext_shared?; + boolean is_private; + boolean is_read_only?; + boolean is_shared; + boolean is_thread_only?; + TsDef last_read?; + (anydata)[] latest?; + UserIdDef[] members; + string name; + string name_normalized; + int num_members?; + TeamDef[] pending_shared?; + ChannelNameDef[] previous_names?; + decimal priority?; + ChannelObj_purpose purpose; + ChannelObj_purpose topic; + int unlinked?; + int unread_count?; + int unread_count_display?; +|}; + +# Schema for successful response api.permissions.scopes.list method +public type ApiPermissionsScopesListResponse record { + OkTrueDef ok; + ApiPermissionsScopesListResponse_scopes scopes; +}; + +# Represents the Queries record for the operation: admin_inviteRequests_approved_list +public type Admin_inviteRequests_approved_listQueries record { + # Value of the `next_cursor` field sent as part of the previous API response + string cursor?; + # The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive + int 'limit?; + # ID for the workspace where the invite requests were made. + string team_id?; +}; public type admin_users_setOwner_body record { # The ID (`T1234`) of the workspace. @@ -1093,7 +1059,7 @@ public type TeamAccessLogsResponse_logins record {| string? isp; string? region; string user_agent; - defs_user_id user_id; + UserIdDef user_id; string username; |}; @@ -1144,16 +1110,7 @@ public type Admin_apps_approved_listQueries record { # Schema for successful response of admin.conversations.disconnectShared public type AdminConversationsRenameResponse record {| - defs_ok_true ok; -|}; - -public type objs_message_attachments record {| - string fallback?; - int id; - int image_bytes?; - int image_height?; - string image_url?; - int image_width?; + OkTrueDef ok; |}; # Represents the Queries record for the operation: users_conversations @@ -1214,9 +1171,11 @@ public type admin_teams_settings_setName_body record { # Schema for successful response from users.deletePhoto method public type UsersDeletePhotoResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; +public type ConversationObj (anydata)[]; + public type users_setPhoto_body record { # Width/height of crop box (always square) string crop_w?; @@ -1236,12 +1195,12 @@ public type AdminConversationsGetConversationPrefsResponse_prefs_can_thread reco }; public type ChatScheduleMessageResponse_message record {| - defs_bot_id bot_id; - objs_bot_profile bot_profile?; - defs_team team; + BotIdDef bot_id; + BotProfileObj bot_profile?; + TeamDef team; string text; string 'type; - defs_user_id user; + UserIdDef user; string username?; |}; @@ -1265,7 +1224,7 @@ public type Team_accessLogsQueries record { # Schema for successful response from dialog.open method public type DialogOpenResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Represents the Queries record for the operation: files_list @@ -1294,17 +1253,17 @@ public type Team_profile_getQueries record { # Schema for successful response from users.setPresence method public type UsersSetPresenceResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; public type BotsInfoResponse_bot record {| - defs_app_id app_id; + AppIdDef app_id; boolean deleted; - objs_bot_profile_icons icons; - defs_bot_id id; + BotProfileObj_icons icons; + BotIdDef id; string name; int updated; - defs_user_id user_id?; + UserIdDef user_id?; |}; # Represents the Queries record for the operation: conversations_history @@ -1337,7 +1296,7 @@ public type conversations_close_body record { # Schema for successful response from reactions.remove method public type ReactionsRemoveResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; public type admin_apps_approve_body record { @@ -1375,8 +1334,8 @@ public type reactions_add_body record { # Schema for successful response from users.profile.get method public type UsersProfileGetResponse record {| - defs_ok_true ok; - objs_user_profile profile; + OkTrueDef ok; + UserProfileObj profile; |}; # This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace. @@ -1384,11 +1343,10 @@ public type blocks blocks_inner[]; # Schema for successful response from chat.deleteScheduledMessage method public type ChatDeleteScheduledMessageResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; -@constraint:String {pattern: re `^(A[A-Z0-9]{1,})?$`} -public type defs_optional_app_id string; +public type ResponseMetadataObj (record {|string next_cursor;|}|record {|string[] messages; ("method_deprecated")[] warnings;|}|record {|string[] messages; string next_cursor; ("method_deprecated")[] warnings;|})[]; public type files_sharedPublicURL_body record { # File to share @@ -1397,8 +1355,8 @@ public type files_sharedPublicURL_body record { # Schema for successful response from conversations.join method public type ConversationsJoinResponse record {| - objs_conversation channel; - defs_ok_true ok; + ConversationObj channel; + OkTrueDef ok; Response\ metadata response_metadata?; string warning?; |}; @@ -1408,24 +1366,18 @@ public type AppsPermissionsResourcesListResponse_resources record { string 'type?; }; -@constraint:String {pattern: re `^[CGD][A-Z0-9]{8,}$`} -public type defs_channel string; - -public type defs_pinned_info record {| -|}; - # Schema for successful response from stars.list method public type StarsListResponse record {| - (record {|defs_channel channel; int date_create; objs_message message; "message" 'type;|}|record {|int date_create; objs_file file; "file" 'type;|}|record {|objs_comment comment; int date_create; objs_file file; "file_comment" 'type;|}|record {|defs_channel channel; int date_create; "channel" 'type;|}|record {|defs_dm_id channel; int date_create; "im" 'type;|}|record {|defs_group_id channel; int date_create; "group" 'type;|})[][] items; - defs_ok_true ok; - objs_paging paging?; + (record {|ChannelDef channel; int date_create; MessageObj message; "message" 'type;|}|record {|int date_create; FileObj file; "file" 'type;|}|record {|CommentObj comment; int date_create; FileObj file; "file_comment" 'type;|}|record {|ChannelDef channel; int date_create; "channel" 'type;|}|record {|DmIdDef channel; int date_create; "im" 'type;|}|record {|GroupIdDef channel; int date_create; "group" 'type;|})[][] items; + OkTrueDef ok; + PagingObj paging?; |}; # Schema for successful response conversations.members method public type ConversationsMembersResponse record {| @constraint:Array {minLength: 1} - defs_user_id[] members; - defs_ok_true ok; + UserIdDef[] members; + OkTrueDef ok; AdminConversationsGetTeamsResponse_response_metadata response_metadata; |}; @@ -1442,6 +1394,12 @@ public type admin_users_assign_body record { string user_id; }; +public type ChannelObj_purpose record {| + TopicPurposeCreatorDef creator; + int last_set; + string value; +|}; + public type admin_emoji_addAlias_body record { # The alias of the emoji. string alias_for; @@ -1459,12 +1417,10 @@ public type Apps_permissions_requestQueries record { string scopes; }; -public type objs_scopes string[]; - # Schema for successful response from conversations.list method public type ConversationsListResponse record {| - objs_conversation[] channels; - defs_ok_true ok; + ConversationObj[] channels; + OkTrueDef ok; AdminConversationsGetTeamsResponse_response_metadata response_metadata?; |}; @@ -1475,16 +1431,16 @@ public type Users_getPresenceQueries record { }; public type TeamIntegrationLogsResponse_logs record {| - defs_app_id admin_app_id?; - defs_app_id app_id; + AppIdDef admin_app_id?; + AppIdDef app_id; string app_type; string change_type; - defs_channel channel?; + ChannelDef channel?; string date; string scope; string service_id?; string service_type?; - defs_user_id user_id; + UserIdDef user_id; string user_name; |}; @@ -1498,13 +1454,32 @@ public type Team_billableInfoQueries record { public type TeamAccessLogsResponse record {| @constraint:Array {minLength: 1} TeamAccessLogsResponse_logins[] logins; - defs_ok_true ok; - objs_paging paging; + OkTrueDef ok; + PagingObj paging; |}; +public type UserProfileShortObj record {| + string avatar_hash; + string display_name; + string display_name_normalized?; + string? first_name; + string image_72; + boolean is_restricted; + boolean is_ultra_restricted; + string name; + string real_name; + string real_name_normalized?; + WorkspaceIdDef team; +|}; + +public type ExternalOrgMigrationsObj record { + ExternalOrgMigrationsObj_current[] current; + int date_updated; +}; + # Schema for successful response from apps.permissions.request method public type AppsPermissionsRequestResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Represents the Queries record for the operation: reactions_list @@ -1561,8 +1536,15 @@ public type admin_emoji_remove_body record { string token; }; -@constraint:String {pattern: re `^S[A-Z0-9]{2,}$`} -public type defs_subteam_id string; +public type ReminderObj record {| + int complete_ts?; + UserIdDef creator; + ReminderIdDef id; + boolean recurring; + string text; + int time?; + UserIdDef user; +|}; # Represents the Queries record for the operation: views_push public type Views_pushQueries record { @@ -1574,64 +1556,9 @@ public type Views_pushQueries record { # Schema for successful response from reminders.delete method public type RemindersDeleteResponse record {| - defs_ok_true ok; -|}; - -@constraint:String {pattern: re `^Rm[A-Z0-9]{8,}$`} -public type defs_reminder_id string; - -public type objs_message record {| - @constraint:Array {minLength: 1} - objs_message_attachments[] attachments?; - blocks blocks?; - (anydata)[] bot_id?; - objs_bot_profile bot_profile?; - string client_msg_id?; - objs_comment comment?; - boolean display_as_bot?; - objs_file file?; - @constraint:Array {minLength: 1} - objs_file[] files?; - objs_message_icons icons?; - defs_user_id inviter?; - boolean is_delayed_message?; - boolean is_intro?; - boolean is_starred?; - defs_ts last_read?; - defs_ts latest_reply?; - string name?; - string old_name?; - defs_user_id parent_user_id?; - string permalink?; - defs_channel[] pinned_to?; - string purpose?; - objs_reaction[] reactions?; - int reply_count?; - @constraint:Array {minLength: 1} - defs_user_id[] reply_users?; - int reply_users_count?; - defs_workspace_id source_team?; - boolean subscribed?; - string subtype?; - defs_workspace_id team?; - string text; - defs_ts thread_ts?; - string topic?; - defs_ts ts; - string 'type; - int unread_count?; - boolean upload?; - defs_user_id user?; - objs_user_profile_short user_profile?; - defs_workspace_id user_team?; - string username?; + OkTrueDef ok; |}; -public type objs_primary_owner record { - string email; - string id; -}; - public type admin_users_setExpiration_body record { # Timestamp when guest account should be disabled. int expiration_ts; @@ -1641,6 +1568,9 @@ public type admin_users_setExpiration_body record { string user_id; }; +@constraint:String {pattern: re `^[F][A-Z0-9]{8,}$`} +public type FileIdDef string; + public type conversations_setTopic_body record { # Conversation to set the topic of string channel?; @@ -1648,8 +1578,9 @@ public type conversations_setTopic_body record { string topic?; }; -@constraint:String {pattern: re `^[UW][A-Z0-9]{8,}$|^$`} -public type defs_topic_purpose_creator string; +public type UserObjItemsnull anydata; + +public type OkTrueDef true; # Represents the Queries record for the operation: apps_permissions_users_request public type Apps_permissions_users_requestQueries record { @@ -1661,23 +1592,6 @@ public type Apps_permissions_users_requestQueries record { string user; }; -@constraint:String {pattern: re `^[T][A-Z0-9]{2,}$`} -public type defs_team string; - -public type objs_external_org_migrations record { - objs_external_org_migrations_current[] current; - int date_updated; -}; - -public type objs_paging record {| - int count?; - int page; - int pages?; - int per_page?; - int spill?; - int total; -|}; - public type files_remote_add_body record { # Creator defined GUID for the file. string external_id?; @@ -1697,7 +1611,7 @@ public type files_remote_add_body record { # Schema for successful response from conversations.unarchive method public type ConversationsUnarchiveResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; public type admin_teams_settings_setIcon_body record { @@ -1709,24 +1623,30 @@ public type admin_teams_settings_setIcon_body record { string token; }; -@constraint:String {pattern: re `^[G][A-Z0-9]{8,}$`} -public type defs_group_id string; +public type EnterpriseUserObj record {| + EnterpriseIdDef enterprise_id; + EnterpriseNameDef enterprise_name; + EnterpriseUserIdDef id; + boolean is_admin; + boolean is_owner; + TeamDef[] teams; +|}; # Schema for successful response of admin.conversations.convertToPrivate public type AdminConversationsConvertToPrivateResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Schema for successful response from chat.meMessage method public type ChatMeMessageResponse record {| - defs_channel channel?; - defs_ok_true ok; - defs_ts ts?; + ChannelDef channel?; + OkTrueDef ok; + TsDef ts?; |}; # Schema for successful response of admin.conversations.search public type AdminConversationsSearchResponse record {| - objs_channel[] channels; + ChannelObj[] channels; string next_cursor; |}; @@ -1737,17 +1657,32 @@ public type chat_meMessage_body record { string text?; }; +public type BotProfileObj record {| + AppIdDef app_id; + boolean deleted; + BotProfileObj_icons icons; + BotIdDef id; + string name; + TeamDef team_id; + int updated; +|}; + # Schema for successful response from chat.unfurl method public type ChatUnfurlResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Schema for successful response from reminders.info method public type RemindersInfoResponse record {| - defs_ok_true ok; - objs_reminder reminder; + OkTrueDef ok; + ReminderObj reminder; |}; +public type PrimaryOwnerObj record { + string email; + string id; +}; + public type calls_add_body record { # The valid Slack user ID of the user who created this Call. When this method is called with a user token, the `created_by` field is optional and defaults to the authed user of the token. Otherwise, the field is required. string created_by?; @@ -1767,17 +1702,24 @@ public type calls_add_body record { string users?; }; +@constraint:String {pattern: re `^[T][A-Z0-9]{2,}$`} +public type TeamDef string; + # Schema for successful response of admin.conversations.delete public type AdminConversationsDeleteResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Schema for successful response from reactions.add method public type ReactionsAddResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; -public type objs_user (anydata)[]; +public type BotProfileObj_icons record {| + string image_36; + string image_48; + string image_72; +|}; public type blocks_inner record { string 'type; @@ -1785,21 +1727,25 @@ public type blocks_inner record { # Schema for successful response from pins.add method public type PinsAddResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; -public type objs_response_metadata (record {|string next_cursor;|}|record {|string[] messages; ("method_deprecated")[] warnings;|}|record {|string[] messages; string next_cursor; ("method_deprecated")[] warnings;|})[]; - -@constraint:String {pattern: re `^[TE][A-Z0-9]{8,}$`} -public type defs_workspace_id string; +public type MessageObj_attachments record {| + string fallback?; + int id; + int image_bytes?; + int image_height?; + string image_url?; + int image_width?; +|}; # Schema for successful response from users.list method public type UsersListResponse record {| int cache_ts; @constraint:Array {minLength: 1} - objs_user[] members; - defs_ok_true ok; - objs_response_metadata response_metadata?; + UserObj[] members; + OkTrueDef ok; + ResponseMetadataObj response_metadata?; |}; # Represents the Queries record for the operation: chat_getPermalink @@ -1839,8 +1785,8 @@ public type Conversations_infoQueries record { # Schema for successful response from conversations.replies method public type ConversationsRepliesResponse record {| boolean has_more?; - (record {|defs_ts last_read?; defs_ts latest_reply?; int reply_count; defs_user_id[] reply_users?; int reply_users_count?; defs_team source_team?; boolean subscribed; defs_team team?; string text; defs_ts thread_ts; defs_ts ts; string 'type; int unread_count?; defs_user_id user; objs_user_profile_short user_profile?; defs_team user_team?;|}|record {|boolean is_starred?; defs_user_id parent_user_id; defs_team source_team?; defs_team team?; string text; defs_ts thread_ts; defs_ts ts; string 'type; defs_user_id user; objs_user_profile_short user_profile?; defs_team user_team?;|})[][] messages; - defs_ok_true ok; + (record {|TsDef last_read?; TsDef latest_reply?; int reply_count; UserIdDef[] reply_users?; int reply_users_count?; TeamDef source_team?; boolean subscribed; TeamDef team?; string text; TsDef thread_ts; TsDef ts; string 'type; int unread_count?; UserIdDef user; UserProfileShortObj user_profile?; TeamDef user_team?;|}|record {|boolean is_starred?; UserIdDef parent_user_id; TeamDef source_team?; TeamDef team?; string text; TsDef thread_ts; TsDef ts; string 'type; UserIdDef user; UserProfileShortObj user_profile?; TeamDef user_team?;|})[][] messages; + OkTrueDef ok; |}; # Represents the Queries record for the operation: migration_exchange @@ -1853,8 +1799,7 @@ public type Migration_exchangeQueries record { string users; }; -@constraint:String {pattern: re `^A[A-Z0-9]{1,}$`} -public type defs_app_id string; +public type ScopesObj string[]; public type reactions_remove_body record { # Channel where the message to remove reaction from was posted. @@ -1871,7 +1816,7 @@ public type reactions_remove_body record { # Schema for successful response from reminders.complete method public type RemindersCompleteResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Represents the Queries record for the operation: bots_info @@ -1893,9 +1838,6 @@ public type admin_conversations_archive_body record { string channel_id; }; -@constraint:String {pattern: re `^\d{10}\.\d{6}$`} -public type defs_ts string; - public type conversations_invite_body record { # The ID of the public or private channel to invite user(s) to. string channel?; @@ -1903,14 +1845,17 @@ public type conversations_invite_body record { string users?; }; +@constraint:String {pattern: re `^A[A-Z0-9]{1,}$`} +public type AppIdDef string; + # Schema for successful response conversations.create method public type ConversationsCreateResponse record {| - objs_conversation channel; - defs_ok_true ok; + ConversationObj channel; + OkTrueDef ok; |}; public type RtmConnectResponse_self record {| - defs_user_id id; + UserIdDef id; string name; |}; @@ -1928,17 +1873,14 @@ public type Workflows_updateStepQueries record { string workflow_step_edit_id; }; +public type ChannelNameDef string; + # Represents the Queries record for the operation: auth_revoke public type Auth_revokeQueries record { # Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked. boolean test?; }; -public type objs_external_org_migrations_current record { - int date_started; - string team_id; -}; - # Represents the Queries record for the operation: files_info public type Files_infoQueries record { # Parameter for pagination. File comments are paginated for a single file. Set `cursor` equal to the `next_cursor` attribute returned by the previous request's `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection of comments. See [pagination](/docs/pagination) for more details. @@ -1966,8 +1908,8 @@ public type admin_conversations_create_body record { # Schema for successful response conversations.info public type ConversationsInfoResponse record {| - objs_conversation channel; - defs_ok_true ok; + ConversationObj channel; + OkTrueDef ok; |}; public type chat_update_body record { @@ -1992,7 +1934,7 @@ public type chat_update_body record { # Schema for successful response from bots.info method public type BotsInfoResponse record {| BotsInfoResponse_bot bot; - defs_ok_true ok; + OkTrueDef ok; |}; # Represents the Queries record for the operation: reactions_get @@ -2011,25 +1953,63 @@ public type Reactions_getQueries record { # Schema for successful response from usergroups.users.update method public type UsergroupsUsersUpdateResponse record {| - defs_ok_true ok; - objs_subteam usergroup; + OkTrueDef ok; + SubteamObj usergroup; |}; -public type ObjsconversationItemsnull anydata; - # Schema for successful response from dnd.setSnooze method public type DndSetSnoozeResponse record {| - defs_ok_true ok; + OkTrueDef ok; boolean snooze_enabled; int snooze_endtime; int snooze_remaining; |}; -public type objs_team_profile_field_option record {| - boolean? is_custom?; - boolean? is_multiple_entry?; - boolean? is_protected?; - boolean? is_scim?; +public type UserProfileObj record {| + boolean always_active?; + OptionalAppIdDef api_app_id?; + string avatar_hash; + BotIdDef bot_id?; + string display_name; + string display_name_normalized; + string? email?; + record {}[]? fields; + string? first_name?; + int? guest_expiration_ts?; + string? guest_invited_by?; + string? image_1024?; + string? image_192?; + string? image_24?; + string? image_32?; + string? image_48?; + string? image_512?; + string? image_72?; + string? image_original?; + boolean is_app_user?; + boolean is_custom_image?; + boolean? is_restricted?; + boolean? is_ultra_restricted?; + string last_avatar_image_hash?; + string? last_name?; + int memberships_count?; + string? name?; + string phone; + string pronouns?; + string real_name; + string real_name_normalized; + string skype; + string status_default_emoji?; + string status_default_text?; + string? status_default_text_canonical?; + string status_emoji; + int status_expiration?; + string status_text; + string? status_text_canonical?; + WorkspaceIdDef team?; + string title; + int updated?; + string user_id?; + string? username?; |}; public type pins_remove_body record { @@ -2039,9 +2019,6 @@ public type pins_remove_body record { string timestamp?; }; -@constraint:String {pattern: re `^Fc[A-Z0-9]{8,}$`} -public type defs_comment_id string; - public type admin_emoji_rename_body record { # The name of the emoji to be renamed. Colons (`:myemoji:`) around the value are not required, although they may be included. string name; @@ -2051,13 +2028,8 @@ public type admin_emoji_rename_body record { string token; }; -public type defs_channel_name string; - -public type objs_bot_profile_icons record {| - string image_36; - string image_48; - string image_72; -|}; +@constraint:String {pattern: re `^[WU][A-Z0-9]{8,}$`} +public type EnterpriseUserIdDef string; public type conversations_mark_body record { # Channel or conversation to set the read cursor for. @@ -2090,7 +2062,7 @@ public type Oauth_accessQueries record { public type ConversationsCloseResponse record {| boolean already_closed?; boolean no_op?; - defs_ok_true ok; + OkTrueDef ok; |}; # Represents the Queries record for the operation: apps_uninstall @@ -2113,10 +2085,10 @@ public type Admin_conversations_getTeamsQueries record { # Schema for successful response from reactions.list method public type ReactionsListResponse record {| - (record {|defs_channel channel; objs_message message; "message" 'type;|}|record {|objs_file file; "file" 'type;|}|record {|objs_comment comment; objs_file file; "file_comment" 'type;|})[][] items; - defs_ok_true ok; - objs_paging paging?; - objs_response_metadata response_metadata?; + (record {|ChannelDef channel; MessageObj message; "message" 'type;|}|record {|FileObj file; "file" 'type;|}|record {|CommentObj comment; FileObj file; "file_comment" 'type;|})[][] items; + OkTrueDef ok; + PagingObj paging?; + ResponseMetadataObj response_metadata?; |}; public type chat_scheduleMessage_body record { @@ -2171,41 +2143,6 @@ public type admin_conversations_invite_body record { string user_ids; }; -public type objs_channel record {| - defs_user_id accepted_user?; - int created; - defs_user_id creator; - defs_channel_id id; - boolean is_archived?; - boolean is_channel; - boolean is_frozen?; - boolean is_general?; - boolean is_member?; - int is_moved?; - boolean is_mpim; - boolean is_non_threadable?; - boolean is_org_shared; - boolean is_pending_ext_shared?; - boolean is_private; - boolean is_read_only?; - boolean is_shared; - boolean is_thread_only?; - defs_ts last_read?; - (anydata)[] latest?; - defs_user_id[] members; - string name; - string name_normalized; - int num_members?; - defs_team[] pending_shared?; - defs_channel_name[] previous_names?; - decimal priority?; - objs_channel_purpose purpose; - objs_channel_purpose topic; - int unlinked?; - int unread_count?; - int unread_count_display?; -|}; - public type admin_conversations_restrictAccess_removeGroup_body record { # The channel to remove the linked group from. string channel_id; @@ -2221,6 +2158,17 @@ public type Response\ metadata record { string[] warnings?; }; +public type IconObj record { + string image_102?; + string image_132?; + string image_230?; + string image_34?; + string image_44?; + string image_68?; + string image_88?; + boolean image_default?; +}; + public type admin_users_session_invalidate_body record { int session_id; # ID of the team that the session belongs to @@ -2229,13 +2177,13 @@ public type admin_users_session_invalidate_body record { # Schema for successful response of admin.conversations.getConversationPrefs public type AdminConversationsGetConversationPrefsResponse record {| - defs_ok_true ok; + OkTrueDef ok; AdminConversationsGetConversationPrefsResponse_prefs prefs?; |}; # Schema for successful response files.comments.delete method public type FilesCommentsDeleteResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Schema for successful response from dnd.endSnooze method @@ -2243,16 +2191,10 @@ public type DndEndSnoozeResponse record {| boolean dnd_enabled; int next_dnd_end_ts; int next_dnd_start_ts; - defs_ok_true ok; + OkTrueDef ok; boolean snooze_enabled; |}; -public type objs_team_sso_provider record { - string label?; - string name?; - string 'type?; -}; - public type Message\ object record { record {}[] attachments?; record {} blocks?; @@ -2283,27 +2225,30 @@ public type admin_conversations_setConversationPrefs_body record { # Schema for successful response of chat.postMessage method public type ChatPostMessageResponse record {| - defs_channel channel; - objs_message message; - defs_ok_true ok; - defs_ts ts; + ChannelDef channel; + MessageObj message; + OkTrueDef ok; + TsDef ts; |}; +public type UserObj (anydata)[]; + # Schema for successful response of chat.update method public type ChatUpdateResponse record {| string channel; Message\ object message; - defs_ok_true ok; + OkTrueDef ok; string text; string ts; |}; -public type objs_comments anydata[]; +@constraint:String {pattern: re `^B[A-Z0-9]{8,}$`} +public type BotIdDef string; # Schema for successful response from users.conversations method. Returned conversation objects do not include `num_members` or `is_member` public type UsersConversationsResponse record { - objs_conversation[] channels; - defs_ok_true ok; + ConversationObj[] channels; + OkTrueDef ok; AdminConversationsGetTeamsResponse_response_metadata response_metadata?; }; @@ -2322,9 +2267,9 @@ public type Views_updateQueries record { # Schema for successful response from conversations.open method when opening channels, ims, mpims public type ConversationsOpenResponse record {| boolean already_open?; - (objs_conversation|record {|string created?; defs_dm_id id; boolean is_im?; boolean is_open?; defs_ts last_read?; objs_message latest?; decimal unread_count?; decimal unread_count_display?; defs_user_id user?;|})[] channel; + (ConversationObj|record {|string created?; DmIdDef id; boolean is_im?; boolean is_open?; TsDef last_read?; MessageObj latest?; decimal unread_count?; decimal unread_count_display?; UserIdDef user?;|})[] channel; boolean no_op?; - defs_ok_true ok; + OkTrueDef ok; |}; # Represents the Queries record for the operation: users_info @@ -2337,13 +2282,13 @@ public type Users_infoQueries record { # Schema for successful response from conversations.invite method public type ConversationsInviteErrorResponse record {| - objs_conversation channel; - defs_ok_true ok; + ConversationObj channel; + OkTrueDef ok; |}; public type AppsPermissionsInfoResponse_info_team record { - objs_resources resources; - objs_scopes scopes; + ResourcesObj resources; + ScopesObj scopes; }; # Generated from users.getPresence with shasum e7251aec575d8863f9e0eb38663ae9dc26655f65 @@ -2352,7 +2297,7 @@ public type APIMethodUsersGetPresence record { int connection_count?; int last_activity?; boolean manual_away?; - defs_ok_true ok; + OkTrueDef ok; boolean online?; string presence; }; @@ -2383,18 +2328,71 @@ public type files_delete_body record { string file?; }; -@constraint:String {pattern: re `^[E][A-Z0-9]{8,}$`} -public type defs_enterprise_id string; +@constraint:String {pattern: re `^[CGD][A-Z0-9]{8,}$`} +public type ChannelDef string; + +public type PinnedInfoDef record {| +|}; + +public type MessageObj record {| + @constraint:Array {minLength: 1} + MessageObj_attachments[] attachments?; + blocks blocks?; + (anydata)[] bot_id?; + BotProfileObj bot_profile?; + string client_msg_id?; + CommentObj comment?; + boolean display_as_bot?; + FileObj file?; + @constraint:Array {minLength: 1} + FileObj[] files?; + MessageObj_icons icons?; + UserIdDef inviter?; + boolean is_delayed_message?; + boolean is_intro?; + boolean is_starred?; + TsDef last_read?; + TsDef latest_reply?; + string name?; + string old_name?; + UserIdDef parent_user_id?; + string permalink?; + ChannelDef[] pinned_to?; + string purpose?; + ReactionObj[] reactions?; + int reply_count?; + @constraint:Array {minLength: 1} + UserIdDef[] reply_users?; + int reply_users_count?; + WorkspaceIdDef source_team?; + boolean subscribed?; + string subtype?; + WorkspaceIdDef team?; + string text; + TsDef thread_ts?; + string topic?; + TsDef ts; + string 'type; + int unread_count?; + boolean upload?; + UserIdDef user?; + UserProfileShortObj user_profile?; + WorkspaceIdDef user_team?; + string username?; +|}; + +@constraint:String {pattern: re `^(A[A-Z0-9]{1,})?$`} +public type OptionalAppIdDef string; # Schema for successful response from users.info method public type UsersInfoResponse record { - defs_ok_true ok; - objs_user user; + OkTrueDef ok; + UserObj user; }; # Schema for successful response api.test method public type ApiTestResponse record {| - defs_ok_true ok; + OkTrueDef ok; record {}...; |}; @@ -2413,8 +2411,8 @@ public type users_profile_set_body record { public type MigrationExchangeResponse record { string enterprise_id; string[] invalid_user_ids?; - defs_ok_true ok; - defs_team team_id; + OkTrueDef ok; + TeamDef team_id; record {} user_id_map?; }; @@ -2424,79 +2422,6 @@ public type Api_testQueries record { string foo?; }; -public type objs_file record {| - defs_channel_id[] channels?; - int comments_count?; - int created?; - int date_delete?; - boolean display_as_bot?; - boolean editable?; - defs_user_id editor?; - string external_id?; - string external_type?; - string external_url?; - string filetype?; - defs_group_id[] groups?; - boolean has_rich_preview?; - defs_file_id id?; - int image_exif_rotation?; - defs_dm_id[] ims?; - boolean is_external?; - boolean is_public?; - boolean is_starred?; - boolean is_tombstoned?; - defs_user_id last_editor?; - string mimetype?; - string mode?; - string name?; - boolean non_owner_editable?; - int num_stars?; - int original_h?; - int original_w?; - string permalink?; - string permalink_public?; - defs_pinned_info pinned_info?; - defs_channel[] pinned_to?; - string pretty_type?; - string preview?; - boolean public_url_shared?; - objs_reaction[] reactions?; - objs_file_shares shares?; - int size?; - defs_team source_team?; - string state?; - string thumb_1024?; - int thumb_1024_h?; - int thumb_1024_w?; - string thumb_160?; - string thumb_360?; - int thumb_360_h?; - int thumb_360_w?; - string thumb_480?; - int thumb_480_h?; - int thumb_480_w?; - string thumb_64?; - string thumb_720?; - int thumb_720_h?; - int thumb_720_w?; - string thumb_80?; - string thumb_800?; - int thumb_800_h?; - int thumb_800_w?; - string thumb_960?; - int thumb_960_h?; - int thumb_960_w?; - string thumb_tiny?; - int timestamp?; - string title?; - int updated?; - string url_private?; - string url_private_download?; - string user?; - defs_team user_team?; - string username?; -|}; - public type admin_conversations_restrictAccess_addGroup_body record { # The channel to link this group to. string channel_id; @@ -2510,19 +2435,19 @@ public type admin_conversations_restrictAccess_addGroup_body record { # Schema for successful response from stars.remove method public type StarsRemoveResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Schema for successful response from usergroups.disable method public type UsergroupsDisableResponse record {| - defs_ok_true ok; - objs_subteam usergroup; + OkTrueDef ok; + SubteamObj usergroup; |}; # Schema for successful response from usergroups.list method public type UsergroupsListResponse record {| - defs_ok_true ok; - objs_subteam[] usergroups; + OkTrueDef ok; + SubteamObj[] usergroups; |}; # Schema for successful response from conversations.history method @@ -2531,8 +2456,8 @@ public type ConversationsHistoryResponse record {| (anydata)[] channel_actions_ts; boolean has_more; @constraint:Array {minLength: 1} - objs_message[] messages; - defs_ok_true ok; + MessageObj[] messages; + OkTrueDef ok; int pin_count; |}; @@ -2541,30 +2466,17 @@ public type Admin_teams_settings_infoQueries record { string team_id; }; -public type objs_bot_profile record {| - defs_app_id app_id; - boolean deleted; - objs_bot_profile_icons icons; - defs_bot_id id; - string name; - defs_team team_id; - int updated; -|}; - # Schema for successful response from dnd.endDnd method public type DndEndDndResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Schema for successful response from conversations.leave method public type ConversationsLeaveResponse record {| true not_in_channel?; - defs_ok_true ok; + OkTrueDef ok; |}; -@constraint:String {pattern: re `^[F][A-Z0-9]{8,}$`} -public type defs_file_id string; - public type chat_delete_body record { # Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope. boolean as_user?; @@ -2576,13 +2488,13 @@ public type chat_delete_body record { # Schema for successful response from files.list method public type FilesListResponse record {| - objs_file[] files; - defs_ok_true ok; - objs_paging paging; + FileObj[] files; + OkTrueDef ok; + PagingObj paging; |}; public type ChatScheduledMessagesListResponse_scheduled_messages record {| - defs_channel_id channel_id; + ChannelIdDef channel_id; int date_created; @constraint:String {pattern: re `^[Q][A-Z0-9]{8,}$`} string id; @@ -2592,7 +2504,7 @@ public type ChatScheduledMessagesListResponse_scheduled_messages record {| # Schema for successful response from rtm.connect method public type RtmConnectResponse record {| - defs_ok_true ok; + OkTrueDef ok; RtmConnectResponse_self self; RtmConnectResponse_team team; string url; @@ -2600,7 +2512,7 @@ public type RtmConnectResponse record {| # This method either only returns a brief _OK_ response or a verbose schema is not available for this method. public type DefaultSuccessResponse record { - defs_ok_true ok; + OkTrueDef ok; }; # Represents the Queries record for the operation: users_list @@ -2615,8 +2527,8 @@ public type Users_listQueries record { # Schema for successful response from reminders.list method public type RemindersListResponse record {| - defs_ok_true ok; - objs_reminder[] reminders; + OkTrueDef ok; + ReminderObj[] reminders; |}; # Represents the Queries record for the operation: admin_teams_owners_list @@ -2633,6 +2545,9 @@ public type admin_conversations_convertToPrivate_body record { string channel_id; }; +@constraint:String {pattern: re `^[TE][A-Z0-9]{8,}$`} +public type WorkspaceIdDef string; + public type admin_users_session_reset_body record { # Only expire mobile sessions (default: false) boolean mobile_only?; @@ -2651,7 +2566,7 @@ public type Users_lookupByEmailQueries record { # Schema for successful response from apps.permissions.info method public type AppsPermissionsInfoResponse record {| AppsPermissionsInfoResponse_info info; - defs_ok_true ok; + OkTrueDef ok; |}; # Represents the Queries record for the operation: admin_conversations_ekm_listOriginalConnectedChannelInfo @@ -2666,6 +2581,12 @@ public type Admin_conversations_ekm_listOriginalConnectedChannelInfoQueries reco int 'limit?; }; +@constraint:String {pattern: re `^[UW][A-Z0-9]{2,}$`} +public type UserIdDef string; + +@constraint:String {pattern: re `^[G][A-Z0-9]{8,}$`} +public type GroupIdDef string; + public type admin_emoji_add_body record { # The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included. string name; @@ -2677,8 +2598,8 @@ public type admin_emoji_add_body record { # Schema for successful response from reminders.add method public type RemindersAddResponse record {| - defs_ok_true ok; - objs_reminder reminder; + OkTrueDef ok; + ReminderObj reminder; |}; # Represents the Queries record for the operation: views_publish @@ -2693,9 +2614,9 @@ public type Views_publishQueries record { # Schema for successful response of admin.conversations.getTeams public type AdminConversationsGetTeamsResponse record {| - defs_ok_true ok; + OkTrueDef ok; AdminConversationsGetTeamsResponse_response_metadata response_metadata?; - defs_team[] team_ids; + TeamDef[] team_ids; |}; # Represents the Queries record for the operation: admin_usergroups_listChannels @@ -2709,13 +2630,13 @@ public type Admin_usergroups_listChannelsQueries record { }; public type ApiPermissionsScopesListResponse_scopes record { - objs_scopes app_home?; - objs_scopes channel?; - objs_scopes group?; - objs_scopes im?; - objs_scopes mpim?; - objs_scopes team?; - objs_scopes user?; + ScopesObj app_home?; + ScopesObj channel?; + ScopesObj group?; + ScopesObj im?; + ScopesObj mpim?; + ScopesObj team?; + ScopesObj user?; }; public type admin_conversations_delete_body record { @@ -2723,6 +2644,12 @@ public type admin_conversations_delete_body record { string channel_id; }; +public type ReactionObj record { + int count; + string name; + UserIdDef[] users; +}; + public type admin_conversations_unarchive_body record { # The channel to unarchive. string channel_id; @@ -2737,13 +2664,13 @@ public type admin_users_setAdmin_body record { # Schema for successful response from team.profile.get method public type TeamProfileGetResponse record {| - defs_ok_true ok; + OkTrueDef ok; TeamProfileGetResponse_profile profile; |}; # Schema for successful response apps.permissions.resources.list method public type AppsPermissionsResourcesListResponse record { - defs_ok_true ok; + OkTrueDef ok; AppsPermissionsResourcesListResponse_resources[] resources; AppsPermissionsResourcesListResponse_response_metadata response_metadata?; }; @@ -2767,7 +2694,8 @@ public type Team_integrationLogsQueries record { string user?; }; -public type defs_ok_true true; +@constraint:String {pattern: re `^S[A-Z0-9]{2,}$`} +public type SubteamIdDef string; # Proxy server configurations to be used with the HTTP client endpoint. public type ProxyConfig record {| @@ -2782,6 +2710,8 @@ public type ProxyConfig record {| string password = ""; |}; +public type ConversationObjItemsnull anydata; + # Represents the Queries record for the operation: views_open public type Views_openQueries record { # A [view payload](/reference/surfaces/views). This must be a JSON-encoded string. @@ -2812,7 +2742,7 @@ public type dnd_setSnooze_body record { # Schema for successful response conversations.mark method public type ConversationsMarkResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; public type admin_users_invite_body record { @@ -2850,7 +2780,7 @@ public type users_setPresence_body record { # Schema for successful response from stars.add method public type StarsAddResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Represents the Queries record for the operation: users_profile_get @@ -2863,7 +2793,7 @@ public type Users_profile_getQueries record { # Schema for successful response conversations.kick method public type ConversationsKickResponse record {| - defs_ok_true ok; + OkTrueDef ok; |}; # Represents the Queries record for the operation: conversations_replies @@ -2896,22 +2826,95 @@ public type AdminConversationsGetConversationPrefsResponse_prefs record { AdminConversationsGetConversationPrefsResponse_prefs_can_thread who_can_post?; }; +public type FileObj record {| + ChannelIdDef[] channels?; + int comments_count?; + int created?; + int date_delete?; + boolean display_as_bot?; + boolean editable?; + UserIdDef editor?; + string external_id?; + string external_type?; + string external_url?; + string filetype?; + GroupIdDef[] groups?; + boolean has_rich_preview?; + FileIdDef id?; + int image_exif_rotation?; + DmIdDef[] ims?; + boolean is_external?; + boolean is_public?; + boolean is_starred?; + boolean is_tombstoned?; + UserIdDef last_editor?; + string mimetype?; + string mode?; + string name?; + boolean non_owner_editable?; + int num_stars?; + int original_h?; + int original_w?; + string permalink?; + string permalink_public?; + PinnedInfoDef pinned_info?; + ChannelDef[] pinned_to?; + string pretty_type?; + string preview?; + boolean public_url_shared?; + ReactionObj[] reactions?; + FileObj_shares shares?; + int size?; + TeamDef source_team?; + string state?; + string thumb_1024?; + int thumb_1024_h?; + int thumb_1024_w?; + string thumb_160?; + string thumb_360?; + int thumb_360_h?; + int thumb_360_w?; + string thumb_480?; + int thumb_480_h?; + int thumb_480_w?; + string thumb_64?; + string thumb_720?; + int thumb_720_h?; + int thumb_720_w?; + string thumb_80?; + string thumb_800?; + int thumb_800_h?; + int thumb_800_w?; + string thumb_960?; + int thumb_960_h?; + int thumb_960_w?; + string thumb_tiny?; + int timestamp?; + string title?; + int updated?; + string url_private?; + string url_private_download?; + string user?; + TeamDef user_team?; + string username?; +|}; + # Schema for successful response from conversations.setTopic method public type ConversationsSetTopicResponse record {| - objs_conversation channel; - defs_ok_true ok; + ConversationObj channel; + OkTrueDef ok; |}; # Schema for successful response auth.test method public type AuthTestResponse record {| - defs_bot_id bot_id?; + BotIdDef bot_id?; boolean is_enterprise_install?; - defs_ok_true ok; + OkTrueDef ok; string team; - defs_team team_id; + TeamDef team_id; string url; string user; - defs_user_id user_id; + UserIdDef user_id; |}; # Represents the Queries record for the operation: admin_teams_list @@ -2922,17 +2925,14 @@ public type Admin_teams_listQueries record { int 'limit?; }; -@constraint:String {pattern: re `^[WU][A-Z0-9]{8,}$`} -public type defs_enterprise_user_id string; - # Schema for successful response files.upload method public type FilesUploadResponse record {| - objs_file file; - defs_ok_true ok; + FileObj file; + OkTrueDef ok; |}; # Schema for successful response from files.sharedPublicURL method public type FilesSharedPublicURLResponse record {| - objs_file file; - defs_ok_true ok; + FileObj file; + OkTrueDef ok; |}; diff --git a/docs/spec/openapi.json b/docs/spec/openapi.json index 3bca984..30bd0b0 100644 --- a/docs/spec/openapi.json +++ b/docs/spec/openapi.json @@ -41,7 +41,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -69,7 +69,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -121,7 +121,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -194,7 +194,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -278,7 +278,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -359,7 +359,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -460,7 +460,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -488,7 +488,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -540,7 +540,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -613,7 +613,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -716,7 +716,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -757,7 +757,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -829,7 +829,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -871,7 +871,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -960,10 +960,10 @@ "additionalProperties": false, "properties": { "channel_id": { - "$ref": "#/components/schemas/defs_channel_id" + "$ref": "#/components/schemas/ChannelIdDef" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -1005,7 +1005,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -1077,7 +1077,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -1118,7 +1118,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -1194,7 +1194,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -1240,7 +1240,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -1293,7 +1293,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -1329,7 +1329,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -1415,7 +1415,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "prefs": { "properties": { @@ -1495,7 +1495,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -1559,7 +1559,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "response_metadata": { "additionalProperties": false, @@ -1575,7 +1575,7 @@ }, "team_ids": { "items": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "type": "array" } @@ -1623,7 +1623,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -1727,7 +1727,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -1767,7 +1767,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -1843,7 +1843,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -1883,7 +1883,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -1969,7 +1969,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -1997,7 +1997,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -2049,7 +2049,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -2080,7 +2080,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -2184,7 +2184,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -2212,7 +2212,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -2265,7 +2265,7 @@ "properties": { "channels": { "items": { - "$ref": "#/components/schemas/objs_channel" + "$ref": "#/components/schemas/ChannelObj" }, "type": "array" }, @@ -2352,7 +2352,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -2487,7 +2487,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -2528,7 +2528,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -2612,7 +2612,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -2640,7 +2640,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -2711,7 +2711,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -2752,7 +2752,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -2834,7 +2834,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -2862,7 +2862,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -2943,7 +2943,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -2971,7 +2971,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -3023,7 +3023,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -3083,7 +3083,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -3177,7 +3177,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -3205,7 +3205,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -3286,7 +3286,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -3314,7 +3314,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -3369,7 +3369,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -3397,7 +3397,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -3449,7 +3449,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -3477,7 +3477,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -3555,7 +3555,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -3583,7 +3583,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -3664,7 +3664,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -3692,7 +3692,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -3744,7 +3744,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -3772,7 +3772,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -3850,7 +3850,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -3881,7 +3881,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -3991,7 +3991,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -4020,7 +4020,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -4072,7 +4072,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -4112,7 +4112,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -4182,7 +4182,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -4213,7 +4213,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -4291,7 +4291,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -4329,7 +4329,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -4420,7 +4420,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -4448,7 +4448,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -4524,7 +4524,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -4552,7 +4552,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -4628,7 +4628,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -4656,7 +4656,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -4737,7 +4737,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -4765,7 +4765,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -4841,7 +4841,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -4869,7 +4869,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -4949,7 +4949,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -4977,7 +4977,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -5057,7 +5057,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -5085,7 +5085,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -5137,7 +5137,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -5190,7 +5190,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -5293,7 +5293,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -5321,7 +5321,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -5409,7 +5409,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -5437,7 +5437,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -5542,7 +5542,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -5570,7 +5570,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -5622,7 +5622,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -5662,7 +5662,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -5765,7 +5765,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -5793,7 +5793,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -5868,7 +5868,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -5896,7 +5896,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -5975,7 +5975,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -6003,7 +6003,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -6079,7 +6079,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -6107,7 +6107,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -6188,7 +6188,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -6216,7 +6216,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -6292,7 +6292,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -6320,7 +6320,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -6407,7 +6407,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -6435,7 +6435,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -6488,7 +6488,7 @@ }, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -6521,7 +6521,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -6587,7 +6587,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -6621,7 +6621,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -6701,10 +6701,10 @@ "app_home": { "properties": { "resources": { - "$ref": "#/components/schemas/objs_resources" + "$ref": "#/components/schemas/ResourcesObj" }, "scopes": { - "$ref": "#/components/schemas/objs_scopes" + "$ref": "#/components/schemas/ScopesObj" } }, "type": "object" @@ -6712,10 +6712,10 @@ "channel": { "properties": { "resources": { - "$ref": "#/components/schemas/objs_resources" + "$ref": "#/components/schemas/ResourcesObj" }, "scopes": { - "$ref": "#/components/schemas/objs_scopes" + "$ref": "#/components/schemas/ScopesObj" } }, "type": "object" @@ -6723,10 +6723,10 @@ "group": { "properties": { "resources": { - "$ref": "#/components/schemas/objs_resources" + "$ref": "#/components/schemas/ResourcesObj" }, "scopes": { - "$ref": "#/components/schemas/objs_scopes" + "$ref": "#/components/schemas/ScopesObj" } }, "type": "object" @@ -6734,10 +6734,10 @@ "im": { "properties": { "resources": { - "$ref": "#/components/schemas/objs_resources" + "$ref": "#/components/schemas/ResourcesObj" }, "scopes": { - "$ref": "#/components/schemas/objs_scopes" + "$ref": "#/components/schemas/ScopesObj" } }, "type": "object" @@ -6745,10 +6745,10 @@ "mpim": { "properties": { "resources": { - "$ref": "#/components/schemas/objs_resources" + "$ref": "#/components/schemas/ResourcesObj" }, "scopes": { - "$ref": "#/components/schemas/objs_scopes" + "$ref": "#/components/schemas/ScopesObj" } }, "type": "object" @@ -6756,10 +6756,10 @@ "team": { "properties": { "resources": { - "$ref": "#/components/schemas/objs_resources" + "$ref": "#/components/schemas/ResourcesObj" }, "scopes": { - "$ref": "#/components/schemas/objs_scopes" + "$ref": "#/components/schemas/ScopesObj" } }, "required": [ @@ -6780,7 +6780,7 @@ "type": "object" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -6888,7 +6888,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -6941,7 +6941,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -7001,7 +7001,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -7074,7 +7074,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "resources": { "items": { @@ -7189,7 +7189,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -7260,31 +7260,31 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "scopes": { "additionalProperties": true, "properties": { "app_home": { - "$ref": "#/components/schemas/objs_scopes" + "$ref": "#/components/schemas/ScopesObj" }, "channel": { - "$ref": "#/components/schemas/objs_scopes" + "$ref": "#/components/schemas/ScopesObj" }, "group": { - "$ref": "#/components/schemas/objs_scopes" + "$ref": "#/components/schemas/ScopesObj" }, "im": { - "$ref": "#/components/schemas/objs_scopes" + "$ref": "#/components/schemas/ScopesObj" }, "mpim": { - "$ref": "#/components/schemas/objs_scopes" + "$ref": "#/components/schemas/ScopesObj" }, "team": { - "$ref": "#/components/schemas/objs_scopes" + "$ref": "#/components/schemas/ScopesObj" }, "user": { - "$ref": "#/components/schemas/objs_scopes" + "$ref": "#/components/schemas/ScopesObj" } }, "type": "object" @@ -7368,7 +7368,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -7421,7 +7421,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -7467,7 +7467,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -7537,7 +7537,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -7565,7 +7565,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -7645,7 +7645,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -7704,7 +7704,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -7774,7 +7774,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "revoked": { "type": "boolean" @@ -7834,7 +7834,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -7896,19 +7896,19 @@ "additionalProperties": false, "properties": { "bot_id": { - "$ref": "#/components/schemas/defs_bot_id" + "$ref": "#/components/schemas/BotIdDef" }, "is_enterprise_install": { "type": "boolean" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "team": { "type": "string" }, "team_id": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "url": { "type": "string" @@ -7917,7 +7917,7 @@ "type": "string" }, "user_id": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" } }, "required": [ @@ -7978,7 +7978,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -8033,7 +8033,7 @@ "additionalProperties": false, "properties": { "app_id": { - "$ref": "#/components/schemas/defs_app_id" + "$ref": "#/components/schemas/AppIdDef" }, "deleted": { "type": "boolean" @@ -8062,7 +8062,7 @@ "type": "object" }, "id": { - "$ref": "#/components/schemas/defs_bot_id" + "$ref": "#/components/schemas/BotIdDef" }, "name": { "type": "string" @@ -8071,7 +8071,7 @@ "type": "integer" }, "user_id": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" } }, "required": [ @@ -8085,7 +8085,7 @@ "type": "object" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -8155,7 +8155,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -8265,7 +8265,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -8293,7 +8293,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -8367,7 +8367,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -8395,7 +8395,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -8446,7 +8446,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -8474,7 +8474,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -8561,7 +8561,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -8589,7 +8589,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -8665,7 +8665,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -8693,7 +8693,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -8775,7 +8775,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -8803,7 +8803,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -8877,13 +8877,13 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "ts": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" } }, "required": [ @@ -8945,7 +8945,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -9025,7 +9025,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -9085,7 +9085,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -9138,10 +9138,10 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "permalink": { "format": "uri", @@ -9206,7 +9206,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -9297,13 +9297,13 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "ts": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" } }, "required": [ @@ -9366,7 +9366,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -9482,10 +9482,10 @@ "additionalProperties": false, "properties": { "message_ts": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -9549,7 +9549,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -9676,16 +9676,16 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "message": { - "$ref": "#/components/schemas/objs_message" + "$ref": "#/components/schemas/MessageObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "ts": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" } }, "required": [ @@ -9758,7 +9758,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -9870,19 +9870,19 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "message": { "additionalProperties": false, "properties": { "bot_id": { - "$ref": "#/components/schemas/defs_bot_id" + "$ref": "#/components/schemas/BotIdDef" }, "bot_profile": { - "$ref": "#/components/schemas/objs_bot_profile" + "$ref": "#/components/schemas/BotProfileObj" }, "team": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "text": { "type": "string" @@ -9891,7 +9891,7 @@ "type": "string" }, "user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "username": { "type": "string" @@ -9907,7 +9907,7 @@ "type": "object" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "post_at": { "pattern": "^\\d{10}$", @@ -10008,7 +10008,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -10062,7 +10062,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "response_metadata": { "additionalProperties": false, @@ -10081,7 +10081,7 @@ "additionalProperties": false, "properties": { "channel_id": { - "$ref": "#/components/schemas/defs_channel_id" + "$ref": "#/components/schemas/ChannelIdDef" }, "date_created": { "pattern": "^\\d{10}$", @@ -10179,7 +10179,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -10313,7 +10313,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -10373,7 +10373,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -10496,7 +10496,7 @@ "type": "object" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "text": { "type": "string" @@ -10575,7 +10575,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -10643,7 +10643,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -10709,7 +10709,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -10788,7 +10788,7 @@ "type": "boolean" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -10846,7 +10846,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -10923,10 +10923,10 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/objs_conversation" + "$ref": "#/components/schemas/ConversationObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -11033,7 +11033,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -11110,14 +11110,14 @@ }, "messages": { "items": { - "$ref": "#/components/schemas/objs_message" + "$ref": "#/components/schemas/MessageObj" }, "minItems": 1, "type": "array", "uniqueItems": true }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "pin_count": { "type": "integer" @@ -11201,7 +11201,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -11309,10 +11309,10 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/objs_conversation" + "$ref": "#/components/schemas/ConversationObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -11409,7 +11409,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -11512,10 +11512,10 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/objs_conversation" + "$ref": "#/components/schemas/ConversationObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -11664,10 +11664,10 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" } }, "required": [ @@ -11685,7 +11685,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -11757,10 +11757,10 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/objs_conversation" + "$ref": "#/components/schemas/ConversationObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "response_metadata": { "properties": { @@ -11879,7 +11879,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -11953,7 +11953,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -12016,7 +12016,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -12095,7 +12095,7 @@ "type": "boolean" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -12160,7 +12160,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -12219,13 +12219,13 @@ "properties": { "channels": { "items": { - "$ref": "#/components/schemas/objs_conversation" + "$ref": "#/components/schemas/ConversationObj" }, "type": "array", "uniqueItems": true }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "response_metadata": { "additionalProperties": false, @@ -12363,7 +12363,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -12474,7 +12474,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -12533,7 +12533,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -12592,14 +12592,14 @@ "properties": { "members": { "items": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "minItems": 1, "type": "array", "uniqueItems": true }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "response_metadata": { "additionalProperties": false, @@ -12676,7 +12676,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -12786,7 +12786,7 @@ "items": { "anyOf": [ { - "$ref": "#/components/schemas/objs_conversation" + "$ref": "#/components/schemas/ConversationObj" }, { "additionalProperties": false, @@ -12795,7 +12795,7 @@ "type": "string" }, "id": { - "$ref": "#/components/schemas/defs_dm_id" + "$ref": "#/components/schemas/DmIdDef" }, "is_im": { "type": "boolean" @@ -12804,10 +12804,10 @@ "type": "boolean" }, "last_read": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "latest": { - "$ref": "#/components/schemas/objs_message" + "$ref": "#/components/schemas/MessageObj" }, "unread_count": { "type": "number" @@ -12816,7 +12816,7 @@ "type": "number" }, "user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" } }, "required": [ @@ -12831,7 +12831,7 @@ "type": "boolean" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -12895,7 +12895,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -12969,10 +12969,10 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/objs_conversation" + "$ref": "#/components/schemas/ConversationObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -13078,7 +13078,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -13146,17 +13146,17 @@ "additionalProperties": false, "properties": { "last_read": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "latest_reply": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "reply_count": { "type": "integer" }, "reply_users": { "items": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "type": "array", "uniqueItems": true @@ -13165,22 +13165,22 @@ "type": "integer" }, "source_team": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "subscribed": { "type": "boolean" }, "team": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "text": { "type": "string" }, "thread_ts": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "ts": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "type": { "type": "string" @@ -13189,13 +13189,13 @@ "type": "integer" }, "user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "user_profile": { - "$ref": "#/components/schemas/objs_user_profile_short" + "$ref": "#/components/schemas/UserProfileShortObj" }, "user_team": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" } }, "required": [ @@ -13216,34 +13216,34 @@ "type": "boolean" }, "parent_user_id": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "source_team": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "team": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "text": { "type": "string" }, "thread_ts": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "ts": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "type": { "type": "string" }, "user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "user_profile": { - "$ref": "#/components/schemas/objs_user_profile_short" + "$ref": "#/components/schemas/UserProfileShortObj" }, "user_team": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" } }, "required": [ @@ -13262,7 +13262,7 @@ "type": "array" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -13361,7 +13361,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -13496,10 +13496,10 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/objs_conversation" + "$ref": "#/components/schemas/ConversationObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -13561,7 +13561,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -13638,10 +13638,10 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/objs_conversation" + "$ref": "#/components/schemas/ConversationObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -13703,7 +13703,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -13776,7 +13776,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -13839,7 +13839,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "provided": { "type": "string" @@ -13897,7 +13897,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -13961,7 +13961,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -14033,7 +14033,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -14090,7 +14090,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -14151,7 +14151,7 @@ "type": "integer" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "snooze_enabled": { "type": "boolean" @@ -14216,7 +14216,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -14277,7 +14277,7 @@ "type": "integer" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "snooze_enabled": { "type": "boolean" @@ -14345,7 +14345,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -14431,7 +14431,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "snooze_enabled": { "type": "boolean" @@ -14502,7 +14502,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -14554,7 +14554,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -14594,7 +14594,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -14655,7 +14655,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -14683,7 +14683,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -14754,7 +14754,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -14807,7 +14807,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -14874,7 +14874,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -14929,7 +14929,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -14981,25 +14981,25 @@ "additionalProperties": false, "properties": { "comments": { - "$ref": "#/components/schemas/objs_comments" + "$ref": "#/components/schemas/CommentsObj" }, "content_html": { "nullable": true }, "editor": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "file": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "paging": { - "$ref": "#/components/schemas/objs_paging" + "$ref": "#/components/schemas/PagingObj" }, "response_metadata": { - "$ref": "#/components/schemas/objs_response_metadata" + "$ref": "#/components/schemas/ResponseMetadataObj" } }, "required": [ @@ -15122,7 +15122,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -15215,17 +15215,17 @@ "properties": { "files": { "items": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "minItems": 0, "type": "array", "uniqueItems": true }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "paging": { - "$ref": "#/components/schemas/objs_paging" + "$ref": "#/components/schemas/PagingObj" } }, "required": [ @@ -15374,7 +15374,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -15530,7 +15530,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -15558,7 +15558,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -15610,7 +15610,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -15638,7 +15638,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -15708,7 +15708,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -15736,7 +15736,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -15853,7 +15853,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -15881,7 +15881,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -15933,7 +15933,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -15961,7 +15961,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -16082,7 +16082,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -16110,7 +16110,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -16176,10 +16176,10 @@ "additionalProperties": false, "properties": { "file": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -16238,7 +16238,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -16305,10 +16305,10 @@ "additionalProperties": false, "properties": { "file": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -16368,7 +16368,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -16467,10 +16467,10 @@ "additionalProperties": false, "properties": { "file": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -16584,7 +16584,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -16647,10 +16647,10 @@ "type": "array" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "team_id": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "user_id_map": { "additionalProperties": true, @@ -16726,7 +16726,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -16805,7 +16805,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -16837,7 +16837,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -16930,7 +16930,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -16977,7 +16977,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -17071,7 +17071,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -17118,7 +17118,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -17227,7 +17227,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -17287,7 +17287,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -17350,10 +17350,10 @@ "type": "integer" }, "created_by": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "file": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "type": { "enum": [ @@ -17369,16 +17369,16 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "created": { "type": "integer" }, "created_by": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "message": { - "$ref": "#/components/schemas/objs_message" + "$ref": "#/components/schemas/MessageObj" }, "type": { "enum": [ @@ -17396,7 +17396,7 @@ "uniqueItems": true }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -17412,7 +17412,7 @@ "type": "integer" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -17504,7 +17504,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -17590,7 +17590,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -17649,7 +17649,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -17730,7 +17730,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -17789,7 +17789,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -17844,13 +17844,13 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "message": { - "$ref": "#/components/schemas/objs_message" + "$ref": "#/components/schemas/MessageObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "type": { "enum": [ @@ -17870,10 +17870,10 @@ "additionalProperties": false, "properties": { "file": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "type": { "enum": [ @@ -17892,13 +17892,13 @@ "additionalProperties": false, "properties": { "comment": { - "$ref": "#/components/schemas/objs_comment" + "$ref": "#/components/schemas/CommentObj" }, "file": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "type": { "enum": [ @@ -17990,7 +17990,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -18091,10 +18091,10 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "message": { - "$ref": "#/components/schemas/objs_message" + "$ref": "#/components/schemas/MessageObj" }, "type": { "enum": [ @@ -18114,7 +18114,7 @@ "additionalProperties": false, "properties": { "file": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "type": { "enum": [ @@ -18133,10 +18133,10 @@ "additionalProperties": false, "properties": { "comment": { - "$ref": "#/components/schemas/objs_comment" + "$ref": "#/components/schemas/CommentObj" }, "file": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "type": { "enum": [ @@ -18158,13 +18158,13 @@ "type": "array" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "paging": { - "$ref": "#/components/schemas/objs_paging" + "$ref": "#/components/schemas/PagingObj" }, "response_metadata": { - "$ref": "#/components/schemas/objs_response_metadata" + "$ref": "#/components/schemas/ResponseMetadataObj" } }, "required": [ @@ -18307,7 +18307,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -18442,7 +18442,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -18502,7 +18502,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -18582,10 +18582,10 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "reminder": { - "$ref": "#/components/schemas/objs_reminder" + "$ref": "#/components/schemas/ReminderObj" } }, "required": [ @@ -18648,7 +18648,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -18715,7 +18715,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -18774,7 +18774,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -18841,7 +18841,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -18898,7 +18898,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -18950,10 +18950,10 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "reminder": { - "$ref": "#/components/schemas/objs_reminder" + "$ref": "#/components/schemas/ReminderObj" } }, "required": [ @@ -19011,7 +19011,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -19073,11 +19073,11 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "reminders": { "items": { - "$ref": "#/components/schemas/objs_reminder" + "$ref": "#/components/schemas/ReminderObj" }, "type": "array" } @@ -19136,7 +19136,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -19188,13 +19188,13 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "self": { "additionalProperties": false, "properties": { "id": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "name": { "type": "string" @@ -19213,7 +19213,7 @@ "type": "string" }, "id": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "name": { "type": "string" @@ -19295,7 +19295,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -19365,7 +19365,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -19455,7 +19455,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -19583,7 +19583,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -19645,7 +19645,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -19704,13 +19704,13 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "date_create": { "type": "integer" }, "message": { - "$ref": "#/components/schemas/objs_message" + "$ref": "#/components/schemas/MessageObj" }, "type": { "enum": [ @@ -19734,7 +19734,7 @@ "type": "integer" }, "file": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "type": { "enum": [ @@ -19754,13 +19754,13 @@ "additionalProperties": false, "properties": { "comment": { - "$ref": "#/components/schemas/objs_comment" + "$ref": "#/components/schemas/CommentObj" }, "date_create": { "type": "integer" }, "file": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "type": { "enum": [ @@ -19781,7 +19781,7 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "date_create": { "type": "integer" @@ -19804,7 +19804,7 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/defs_dm_id" + "$ref": "#/components/schemas/DmIdDef" }, "date_create": { "type": "integer" @@ -19827,7 +19827,7 @@ "additionalProperties": false, "properties": { "channel": { - "$ref": "#/components/schemas/defs_group_id" + "$ref": "#/components/schemas/GroupIdDef" }, "date_create": { "type": "integer" @@ -19852,10 +19852,10 @@ "type": "array" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "paging": { - "$ref": "#/components/schemas/objs_paging" + "$ref": "#/components/schemas/PagingObj" } }, "required": [ @@ -19912,7 +19912,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -20023,7 +20023,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -20085,7 +20085,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -20169,7 +20169,7 @@ "type": "string" }, "user_id": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "username": { "type": "string" @@ -20194,10 +20194,10 @@ "uniqueItems": true }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "paging": { - "$ref": "#/components/schemas/objs_paging" + "$ref": "#/components/schemas/PagingObj" } }, "required": [ @@ -20289,7 +20289,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -20365,7 +20365,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -20404,7 +20404,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -20465,10 +20465,10 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "team": { - "$ref": "#/components/schemas/objs_team" + "$ref": "#/components/schemas/TeamObj" } }, "required": [ @@ -20540,7 +20540,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -20606,10 +20606,10 @@ "additionalProperties": false, "properties": { "admin_app_id": { - "$ref": "#/components/schemas/defs_app_id" + "$ref": "#/components/schemas/AppIdDef" }, "app_id": { - "$ref": "#/components/schemas/defs_app_id" + "$ref": "#/components/schemas/AppIdDef" }, "app_type": { "type": "string" @@ -20618,7 +20618,7 @@ "type": "string" }, "channel": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "date": { "type": "string" @@ -20633,7 +20633,7 @@ "type": "string" }, "user_id": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "user_name": { "type": "string" @@ -20655,10 +20655,10 @@ "uniqueItems": true }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "paging": { - "$ref": "#/components/schemas/objs_paging" + "$ref": "#/components/schemas/PagingObj" } }, "required": [ @@ -20716,7 +20716,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -20817,14 +20817,14 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "profile": { "additionalProperties": false, "properties": { "fields": { "items": { - "$ref": "#/components/schemas/objs_team_profile_field" + "$ref": "#/components/schemas/TeamProfileFieldObj" }, "type": "array", "uniqueItems": true @@ -20953,7 +20953,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -21049,10 +21049,10 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "usergroup": { - "$ref": "#/components/schemas/objs_subteam" + "$ref": "#/components/schemas/SubteamObj" } }, "required": [ @@ -21111,7 +21111,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -21185,10 +21185,10 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "usergroup": { - "$ref": "#/components/schemas/objs_subteam" + "$ref": "#/components/schemas/SubteamObj" } }, "required": [ @@ -21247,7 +21247,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -21321,10 +21321,10 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "usergroup": { - "$ref": "#/components/schemas/objs_subteam" + "$ref": "#/components/schemas/SubteamObj" } }, "required": [ @@ -21384,7 +21384,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -21436,11 +21436,11 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "usergroups": { "items": { - "$ref": "#/components/schemas/objs_subteam" + "$ref": "#/components/schemas/SubteamObj" }, "type": "array" } @@ -21567,7 +21567,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -21683,10 +21683,10 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "usergroup": { - "$ref": "#/components/schemas/objs_subteam" + "$ref": "#/components/schemas/SubteamObj" } }, "required": [ @@ -21772,7 +21772,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -21825,11 +21825,11 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "users": { "items": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "type": "array" } @@ -21895,7 +21895,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -21994,10 +21994,10 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "usergroup": { - "$ref": "#/components/schemas/objs_subteam" + "$ref": "#/components/schemas/SubteamObj" } }, "required": [ @@ -22083,7 +22083,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -22136,13 +22136,13 @@ "properties": { "channels": { "items": { - "$ref": "#/components/schemas/objs_conversation" + "$ref": "#/components/schemas/ConversationObj" }, "type": "array", "uniqueItems": true }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "response_metadata": { "additionalProperties": false, @@ -22281,7 +22281,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -22397,7 +22397,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -22453,7 +22453,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -22517,7 +22517,7 @@ "type": "boolean" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "online": { "type": "boolean" @@ -22558,7 +22558,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -22623,13 +22623,13 @@ "description": "Schema for 'identity.basic' scope", "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "team": { "additionalProperties": false, "properties": { "id": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" } }, "required": [ @@ -22641,7 +22641,7 @@ "additionalProperties": false, "properties": { "id": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "name": { "type": "string" @@ -22666,13 +22666,13 @@ "description": "Schema for 'identity.basic,identity.email' scopes", "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "team": { "additionalProperties": false, "properties": { "id": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" } }, "required": [ @@ -22688,7 +22688,7 @@ "type": "string" }, "id": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "name": { "type": "string" @@ -22714,13 +22714,13 @@ "description": "Schema for 'identity.basic,identity.avatar' scopes", "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "team": { "additionalProperties": false, "properties": { "id": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" } }, "required": [ @@ -22732,7 +22732,7 @@ "additionalProperties": false, "properties": { "id": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "image_192": { "format": "url", @@ -22787,7 +22787,7 @@ "description": "Schema for 'identity.basic,identity.team' scopes", "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "team": { "additionalProperties": false, @@ -22796,7 +22796,7 @@ "type": "string" }, "id": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "image_102": { "format": "url", @@ -22852,7 +22852,7 @@ "additionalProperties": false, "properties": { "id": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "name": { "type": "string" @@ -22931,7 +22931,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -22983,10 +22983,10 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "user": { - "$ref": "#/components/schemas/objs_user" + "$ref": "#/components/schemas/UserObj" } }, "required": [ @@ -23077,7 +23077,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -23151,17 +23151,17 @@ }, "members": { "items": { - "$ref": "#/components/schemas/objs_user" + "$ref": "#/components/schemas/UserObj" }, "minItems": 1, "type": "array", "uniqueItems": true }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "response_metadata": { - "$ref": "#/components/schemas/objs_response_metadata" + "$ref": "#/components/schemas/ResponseMetadataObj" } }, "required": [ @@ -23301,7 +23301,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -23379,10 +23379,10 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "user": { - "$ref": "#/components/schemas/objs_user" + "$ref": "#/components/schemas/UserObj" } }, "required": [ @@ -23475,7 +23475,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -23539,10 +23539,10 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "profile": { - "$ref": "#/components/schemas/objs_user_profile" + "$ref": "#/components/schemas/UserProfileObj" } }, "required": [ @@ -23619,7 +23619,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -23721,10 +23721,10 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "profile": { - "$ref": "#/components/schemas/objs_user_profile" + "$ref": "#/components/schemas/UserProfileObj" }, "username": { "type": "string" @@ -23809,7 +23809,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -23861,7 +23861,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -23916,7 +23916,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -24003,7 +24003,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" }, "profile": { "additionalProperties": false, @@ -24125,7 +24125,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" }, "time_ident": { "description": "possibly DEV/QA only", @@ -24200,7 +24200,7 @@ "additionalProperties": false, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -24256,7 +24256,7 @@ "type": "string" }, "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -24308,7 +24308,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -24377,7 +24377,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -24453,7 +24453,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -24512,7 +24512,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -24596,7 +24596,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -24671,7 +24671,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -24747,7 +24747,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -24823,7 +24823,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -24908,7 +24908,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -24936,7 +24936,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -25006,7 +25006,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -25034,7 +25034,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -25105,7 +25105,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_true" + "$ref": "#/components/schemas/OkTrueDef" } }, "required": [ @@ -25133,7 +25133,7 @@ "additionalProperties": true, "properties": { "ok": { - "$ref": "#/components/schemas/defs_ok_false" + "$ref": "#/components/schemas/OkFalseDef" } }, "required": [ @@ -25211,30 +25211,6 @@ } }, "components": { - "requestBodies": { - "admin_inviteRequests_approve": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "properties": { - "invite_request_id": { - "description": "ID of the request to invite.", - "type": "string" - }, - "team_id": { - "description": "ID for the workspace where the invite request was made.", - "type": "string" - } - }, - "required": [ - "invite_request_id" - ], - "type": "object" - } - } - } - } - }, "schemas": { "blocks": { "description": "This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.", @@ -25253,128 +25229,128 @@ "title": "Block Kit blocks", "type": "array" }, - "defs_app_id": { + "AppIdDef": { "pattern": "^A[A-Z0-9]{1,}$", "title": "App ID", "type": "string" }, - "defs_bot_id": { + "BotIdDef": { "pattern": "^B[A-Z0-9]{8,}$", "title": "Bot User ID", "type": "string" }, - "defs_channel": { + "ChannelDef": { "pattern": "^[CGD][A-Z0-9]{8,}$", "title": "Channel-like conversation ID", "type": "string" }, - "defs_channel_id": { + "ChannelIdDef": { "pattern": "^[C][A-Z0-9]{2,}$", "title": "Channel ID", "type": "string" }, - "defs_channel_name": { + "ChannelNameDef": { "title": "Name of a channel", "type": "string" }, - "defs_comment_id": { + "CommentIdDef": { "pattern": "^Fc[A-Z0-9]{8,}$", "title": "File Comment ID", "type": "string" }, - "defs_dm_id": { + "DmIdDef": { "pattern": "^[D][A-Z0-9]{8,}$", "title": "Direct Message Channel ID", "type": "string" }, - "defs_enterprise_id": { + "EnterpriseIdDef": { "pattern": "^[E][A-Z0-9]{8,}$", "title": "Enterprise ID", "type": "string" }, - "defs_enterprise_name": { + "EnterpriseNameDef": { "title": "Name of the enterprise org", "type": "string" }, - "defs_enterprise_user_id": { + "EnterpriseUserIdDef": { "pattern": "^[WU][A-Z0-9]{8,}$", "title": "Enterprise User ID", "type": "string" }, - "defs_file_id": { + "FileIdDef": { "pattern": "^[F][A-Z0-9]{8,}$", "title": "File ID", "type": "string" }, - "defs_group_id": { + "GroupIdDef": { "pattern": "^[G][A-Z0-9]{8,}$", "title": "Private Channel ID", "type": "string" }, - "defs_ok_false": { + "OkFalseDef": { "enum": [ false ], "title": "default failure response", "type": "boolean" }, - "defs_ok_true": { + "OkTrueDef": { "enum": [ true ], "title": "default success response", "type": "boolean" }, - "defs_optional_app_id": { + "OptionalAppIdDef": { "pattern": "^(A[A-Z0-9]{1,})?$", "title": "App ID or empty string", "type": "string" }, - "defs_pinned_info": { + "PinnedInfoDef": { "additionalProperties": false, "title": "Info for a pinned item", "type": "object" }, - "defs_reminder_id": { + "ReminderIdDef": { "pattern": "^Rm[A-Z0-9]{8,}$", "title": "Reminder ID", "type": "string" }, - "defs_subteam_id": { + "SubteamIdDef": { "pattern": "^S[A-Z0-9]{2,}$", "title": "Subteam ID", "type": "string" }, - "defs_team": { + "TeamDef": { "pattern": "^[T][A-Z0-9]{2,}$", "title": "Team ID", "type": "string" }, - "defs_topic_purpose_creator": { + "TopicPurposeCreatorDef": { "pattern": "^[UW][A-Z0-9]{8,}$|^$", "title": "User ID or empty string, used for topic and purpose creation", "type": "string" }, - "defs_ts": { + "TsDef": { "pattern": "^\\d{10}\\.\\d{6}$", "title": "Timestamp in format 0123456789.012345", "type": "string" }, - "defs_user_id": { + "UserIdDef": { "pattern": "^[UW][A-Z0-9]{2,}$", "title": "User ID", "type": "string" }, - "defs_workspace_id": { + "WorkspaceIdDef": { "pattern": "^[TE][A-Z0-9]{8,}$", "title": "Team or Enterprise ID", "type": "string" }, - "objs_bot_profile": { + "BotProfileObj": { "additionalProperties": false, "properties": { "app_id": { - "$ref": "#/components/schemas/defs_app_id" + "$ref": "#/components/schemas/AppIdDef" }, "deleted": { "type": "boolean" @@ -25403,13 +25379,13 @@ "type": "object" }, "id": { - "$ref": "#/components/schemas/defs_bot_id" + "$ref": "#/components/schemas/BotIdDef" }, "name": { "type": "string" }, "team_id": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "updated": { "type": "integer" @@ -25427,20 +25403,20 @@ "title": "Bot Profile Object", "type": "object" }, - "objs_channel": { + "ChannelObj": { "additionalProperties": false, "properties": { "accepted_user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "created": { "type": "integer" }, "creator": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "id": { - "$ref": "#/components/schemas/defs_channel_id" + "$ref": "#/components/schemas/ChannelIdDef" }, "is_archived": { "type": "boolean" @@ -25485,13 +25461,13 @@ "type": "boolean" }, "last_read": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "latest": { "items": { "anyOf": [ { - "$ref": "#/components/schemas/objs_message" + "$ref": "#/components/schemas/MessageObj" }, { "nullable": true @@ -25501,7 +25477,7 @@ }, "members": { "items": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "minItems": 0, "type": "array", @@ -25518,7 +25494,7 @@ }, "pending_shared": { "items": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "minItems": 0, "type": "array", @@ -25526,7 +25502,7 @@ }, "previous_names": { "items": { - "$ref": "#/components/schemas/defs_channel_name" + "$ref": "#/components/schemas/ChannelNameDef" }, "minItems": 0, "type": "array", @@ -25539,7 +25515,7 @@ "additionalProperties": false, "properties": { "creator": { - "$ref": "#/components/schemas/defs_topic_purpose_creator" + "$ref": "#/components/schemas/TopicPurposeCreatorDef" }, "last_set": { "type": "integer" @@ -25559,7 +25535,7 @@ "additionalProperties": false, "properties": { "creator": { - "$ref": "#/components/schemas/defs_topic_purpose_creator" + "$ref": "#/components/schemas/TopicPurposeCreatorDef" }, "last_set": { "type": "integer" @@ -25604,7 +25580,7 @@ "title": "Channel Object", "type": "object" }, - "objs_comment": { + "CommentObj": { "additionalProperties": false, "properties": { "comment": { @@ -25614,7 +25590,7 @@ "type": "integer" }, "id": { - "$ref": "#/components/schemas/defs_comment_id" + "$ref": "#/components/schemas/CommentIdDef" }, "is_intro": { "type": "boolean" @@ -25626,17 +25602,17 @@ "type": "integer" }, "pinned_info": { - "$ref": "#/components/schemas/defs_pinned_info" + "$ref": "#/components/schemas/PinnedInfoDef" }, "pinned_to": { "items": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "type": "array" }, "reactions": { "items": { - "$ref": "#/components/schemas/objs_reaction" + "$ref": "#/components/schemas/ReactionObj" }, "type": "array" }, @@ -25644,7 +25620,7 @@ "type": "integer" }, "user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" } }, "required": [ @@ -25658,36 +25634,36 @@ "title": "File Comment Object", "type": "object" }, - "objs_comments": { + "CommentsObj": { "items": {}, "title": "file comments object", "type": "array" }, - "objs_conversation": { + "ConversationObj": { "items": { "anyOf": [ { "additionalProperties": false, "properties": { "accepted_user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "connected_team_ids": { "items": { - "$ref": "#/components/schemas/defs_workspace_id" + "$ref": "#/components/schemas/WorkspaceIdDef" }, "minItems": 0, "type": "array", "uniqueItems": true }, "conversation_host_id": { - "$ref": "#/components/schemas/defs_workspace_id" + "$ref": "#/components/schemas/WorkspaceIdDef" }, "created": { "type": "integer" }, "creator": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "display_counts": { "additionalProperties": false, @@ -25706,17 +25682,17 @@ "type": "object" }, "enterprise_id": { - "$ref": "#/components/schemas/defs_enterprise_id" + "$ref": "#/components/schemas/EnterpriseIdDef" }, "has_pins": { "type": "boolean" }, "id": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "internal_team_ids": { "items": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "minItems": 0, "type": "array", @@ -25792,13 +25768,13 @@ "type": "boolean" }, "last_read": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "latest": { "items": { "anyOf": [ { - "$ref": "#/components/schemas/objs_message" + "$ref": "#/components/schemas/MessageObj" }, { "nullable": true @@ -25808,7 +25784,7 @@ }, "members": { "items": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "minItems": 0, "type": "array", @@ -25827,7 +25803,7 @@ "items": { "anyOf": [ { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, { "nullable": true @@ -25837,7 +25813,7 @@ }, "pending_connected_team_ids": { "items": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "minItems": 0, "type": "array", @@ -25845,7 +25821,7 @@ }, "pending_shared": { "items": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "minItems": 0, "type": "array", @@ -25856,7 +25832,7 @@ }, "previous_names": { "items": { - "$ref": "#/components/schemas/defs_channel_name" + "$ref": "#/components/schemas/ChannelNameDef" }, "minItems": 0, "type": "array", @@ -25869,7 +25845,7 @@ "additionalProperties": false, "properties": { "creator": { - "$ref": "#/components/schemas/defs_topic_purpose_creator" + "$ref": "#/components/schemas/TopicPurposeCreatorDef" }, "last_set": { "type": "integer" @@ -25887,7 +25863,7 @@ }, "shared_team_ids": { "items": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "minItems": 0, "type": "array", @@ -25898,16 +25874,16 @@ "additionalProperties": false, "properties": { "accepted_user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "is_active": { "type": "boolean" }, "team": { - "$ref": "#/components/schemas/objs_team" + "$ref": "#/components/schemas/TeamObj" }, "user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" } }, "required": [ @@ -25928,7 +25904,7 @@ "additionalProperties": false, "properties": { "creator": { - "$ref": "#/components/schemas/defs_topic_purpose_creator" + "$ref": "#/components/schemas/TopicPurposeCreatorDef" }, "last_set": { "type": "integer" @@ -25958,7 +25934,7 @@ "type": "string" }, "user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "version": { "type": "integer" @@ -25989,24 +25965,24 @@ "additionalProperties": false, "properties": { "accepted_user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "connected_team_ids": { "items": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "minItems": 0, "type": "array", "uniqueItems": true }, "conversation_host_id": { - "$ref": "#/components/schemas/defs_workspace_id" + "$ref": "#/components/schemas/WorkspaceIdDef" }, "created": { "type": "integer" }, "creator": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "display_counts": { "additionalProperties": false, @@ -26025,11 +26001,11 @@ "type": "object" }, "id": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "internal_team_ids": { "items": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "minItems": 0, "type": "array", @@ -26096,13 +26072,13 @@ "type": "boolean" }, "last_read": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "latest": { "items": { "anyOf": [ { - "$ref": "#/components/schemas/objs_message" + "$ref": "#/components/schemas/MessageObj" }, { "nullable": true @@ -26112,7 +26088,7 @@ }, "members": { "items": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "minItems": 0, "type": "array", @@ -26131,7 +26107,7 @@ "items": { "anyOf": [ { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, { "nullable": true @@ -26141,7 +26117,7 @@ }, "pending_connected_team_ids": { "items": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "minItems": 0, "type": "array", @@ -26149,7 +26125,7 @@ }, "pending_shared": { "items": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "minItems": 0, "type": "array", @@ -26160,7 +26136,7 @@ }, "previous_names": { "items": { - "$ref": "#/components/schemas/defs_channel_name" + "$ref": "#/components/schemas/ChannelNameDef" }, "minItems": 0, "type": "array", @@ -26173,7 +26149,7 @@ "additionalProperties": false, "properties": { "creator": { - "$ref": "#/components/schemas/defs_topic_purpose_creator" + "$ref": "#/components/schemas/TopicPurposeCreatorDef" }, "last_set": { "type": "integer" @@ -26191,7 +26167,7 @@ }, "shared_team_ids": { "items": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "minItems": 0, "type": "array", @@ -26202,16 +26178,16 @@ "additionalProperties": false, "properties": { "accepted_user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "is_active": { "type": "boolean" }, "team": { - "$ref": "#/components/schemas/objs_team" + "$ref": "#/components/schemas/TeamObj" }, "user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" } }, "required": [ @@ -26232,7 +26208,7 @@ "additionalProperties": false, "properties": { "creator": { - "$ref": "#/components/schemas/defs_topic_purpose_creator" + "$ref": "#/components/schemas/TopicPurposeCreatorDef" }, "last_set": { "type": "integer" @@ -26259,7 +26235,7 @@ "type": "integer" }, "user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "version": { "type": "integer" @@ -26296,7 +26272,7 @@ "type": "boolean" }, "id": { - "$ref": "#/components/schemas/defs_dm_id" + "$ref": "#/components/schemas/DmIdDef" }, "is_archived": { "type": "boolean" @@ -26326,13 +26302,13 @@ "type": "boolean" }, "last_read": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "latest": { "items": { "anyOf": [ { - "$ref": "#/components/schemas/objs_message" + "$ref": "#/components/schemas/MessageObj" }, { "nullable": true @@ -26344,7 +26320,7 @@ "items": { "anyOf": [ { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, { "nullable": true @@ -26366,7 +26342,7 @@ "type": "integer" }, "id": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "is_active": { "type": "boolean" @@ -26375,7 +26351,7 @@ "type": "string" }, "team": { - "$ref": "#/components/schemas/objs_team" + "$ref": "#/components/schemas/TeamObj" } }, "required": [ @@ -26398,7 +26374,7 @@ "type": "integer" }, "user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "version": { "type": "integer" @@ -26418,17 +26394,17 @@ ] } }, - "objs_enterprise_user": { + "EnterpriseUserObj": { "additionalProperties": false, "properties": { "enterprise_id": { - "$ref": "#/components/schemas/defs_enterprise_id" + "$ref": "#/components/schemas/EnterpriseIdDef" }, "enterprise_name": { - "$ref": "#/components/schemas/defs_enterprise_name" + "$ref": "#/components/schemas/EnterpriseNameDef" }, "id": { - "$ref": "#/components/schemas/defs_enterprise_user_id" + "$ref": "#/components/schemas/EnterpriseUserIdDef" }, "is_admin": { "type": "boolean" @@ -26438,7 +26414,7 @@ }, "teams": { "items": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "type": "array", "uniqueItems": true @@ -26454,7 +26430,7 @@ ], "type": "object" }, - "objs_external_org_migrations": { + "ExternalOrgMigrationsObj": { "properties": { "current": { "items": { @@ -26485,12 +26461,12 @@ "title": "External Org Migrations", "type": "object" }, - "objs_file": { + "FileObj": { "additionalProperties": false, "properties": { "channels": { "items": { - "$ref": "#/components/schemas/defs_channel_id" + "$ref": "#/components/schemas/ChannelIdDef" }, "type": "array", "uniqueItems": true @@ -26511,7 +26487,7 @@ "type": "boolean" }, "editor": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "external_id": { "type": "string" @@ -26528,7 +26504,7 @@ }, "groups": { "items": { - "$ref": "#/components/schemas/defs_group_id" + "$ref": "#/components/schemas/GroupIdDef" }, "type": "array", "uniqueItems": true @@ -26537,14 +26513,14 @@ "type": "boolean" }, "id": { - "$ref": "#/components/schemas/defs_file_id" + "$ref": "#/components/schemas/FileIdDef" }, "image_exif_rotation": { "type": "integer" }, "ims": { "items": { - "$ref": "#/components/schemas/defs_dm_id" + "$ref": "#/components/schemas/DmIdDef" }, "type": "array", "uniqueItems": true @@ -26562,7 +26538,7 @@ "type": "boolean" }, "last_editor": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "mimetype": { "type": "string" @@ -26594,11 +26570,11 @@ "type": "string" }, "pinned_info": { - "$ref": "#/components/schemas/defs_pinned_info" + "$ref": "#/components/schemas/PinnedInfoDef" }, "pinned_to": { "items": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "type": "array" }, @@ -26613,7 +26589,7 @@ }, "reactions": { "items": { - "$ref": "#/components/schemas/objs_reaction" + "$ref": "#/components/schemas/ReactionObj" }, "type": "array" }, @@ -26633,7 +26609,7 @@ "type": "integer" }, "source_team": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "state": { "type": "string" @@ -26734,7 +26710,7 @@ "type": "string" }, "user_team": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "username": { "type": "string" @@ -26743,7 +26719,7 @@ "title": "file object", "type": "object" }, - "objs_icon": { + "IconObj": { "properties": { "image_102": { "type": "string" @@ -26772,7 +26748,7 @@ }, "type": "object" }, - "objs_message": { + "MessageObj": { "additionalProperties": false, "properties": { "attachments": { @@ -26814,7 +26790,7 @@ "items": { "anyOf": [ { - "$ref": "#/components/schemas/defs_bot_id" + "$ref": "#/components/schemas/BotIdDef" }, { "nullable": true, @@ -26824,23 +26800,23 @@ } }, "bot_profile": { - "$ref": "#/components/schemas/objs_bot_profile" + "$ref": "#/components/schemas/BotProfileObj" }, "client_msg_id": { "type": "string" }, "comment": { - "$ref": "#/components/schemas/objs_comment" + "$ref": "#/components/schemas/CommentObj" }, "display_as_bot": { "type": "boolean" }, "file": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "files": { "items": { - "$ref": "#/components/schemas/objs_file" + "$ref": "#/components/schemas/FileObj" }, "minItems": 1, "type": "array", @@ -26860,7 +26836,7 @@ "type": "object" }, "inviter": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "is_delayed_message": { "type": "boolean" @@ -26872,10 +26848,10 @@ "type": "boolean" }, "last_read": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "latest_reply": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "name": { "type": "string" @@ -26884,7 +26860,7 @@ "type": "string" }, "parent_user_id": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "permalink": { "format": "uri", @@ -26892,7 +26868,7 @@ }, "pinned_to": { "items": { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, "type": "array" }, @@ -26901,7 +26877,7 @@ }, "reactions": { "items": { - "$ref": "#/components/schemas/objs_reaction" + "$ref": "#/components/schemas/ReactionObj" }, "type": "array" }, @@ -26910,7 +26886,7 @@ }, "reply_users": { "items": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "minItems": 1, "type": "array", @@ -26920,7 +26896,7 @@ "type": "integer" }, "source_team": { - "$ref": "#/components/schemas/defs_workspace_id" + "$ref": "#/components/schemas/WorkspaceIdDef" }, "subscribed": { "type": "boolean" @@ -26929,19 +26905,19 @@ "type": "string" }, "team": { - "$ref": "#/components/schemas/defs_workspace_id" + "$ref": "#/components/schemas/WorkspaceIdDef" }, "text": { "type": "string" }, "thread_ts": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "topic": { "type": "string" }, "ts": { - "$ref": "#/components/schemas/defs_ts" + "$ref": "#/components/schemas/TsDef" }, "type": { "type": "string" @@ -26953,13 +26929,13 @@ "type": "boolean" }, "user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "user_profile": { - "$ref": "#/components/schemas/objs_user_profile_short" + "$ref": "#/components/schemas/UserProfileShortObj" }, "user_team": { - "$ref": "#/components/schemas/defs_workspace_id" + "$ref": "#/components/schemas/WorkspaceIdDef" }, "username": { "type": "string" @@ -26973,7 +26949,7 @@ "title": "Message object", "type": "object" }, - "objs_paging": { + "PagingObj": { "additionalProperties": false, "properties": { "count": { @@ -27002,7 +26978,7 @@ "title": "paging object", "type": "object" }, - "objs_primary_owner": { + "PrimaryOwnerObj": { "properties": { "email": { "type": "string" @@ -27017,7 +26993,7 @@ ], "type": "object" }, - "objs_reaction": { + "ReactionObj": { "additionalProperties": true, "properties": { "count": { @@ -27028,7 +27004,7 @@ }, "users": { "items": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "type": "array" } @@ -27041,17 +27017,17 @@ "title": "Reaction object", "type": "object" }, - "objs_reminder": { + "ReminderObj": { "additionalProperties": false, "properties": { "complete_ts": { "type": "integer" }, "creator": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "id": { - "$ref": "#/components/schemas/defs_reminder_id" + "$ref": "#/components/schemas/ReminderIdDef" }, "recurring": { "type": "boolean" @@ -27063,7 +27039,7 @@ "type": "integer" }, "user": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" } }, "required": [ @@ -27075,7 +27051,7 @@ ], "type": "object" }, - "objs_resources": { + "ResourcesObj": { "additionalProperties": false, "properties": { "excluded_ids": { @@ -27083,10 +27059,10 @@ "items": { "anyOf": [ { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" } ] } @@ -27098,10 +27074,10 @@ "items": { "anyOf": [ { - "$ref": "#/components/schemas/defs_channel" + "$ref": "#/components/schemas/ChannelDef" }, { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" } ] } @@ -27118,7 +27094,7 @@ "title": "resources in info from apps.permissions.info", "type": "object" }, - "objs_response_metadata": { + "ResponseMetadataObj": { "items": { "anyOf": [ { @@ -27193,7 +27169,7 @@ ] } }, - "objs_scopes": { + "ScopesObj": { "items": { "title": "Named OAuth scopes", "type": "string", @@ -27205,7 +27181,7 @@ }, "type": "array" }, - "objs_subteam": { + "SubteamObj": { "additionalProperties": false, "properties": { "auto_provision": { @@ -27231,7 +27207,7 @@ "type": "integer" }, "created_by": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "date_create": { "type": "integer" @@ -27249,7 +27225,7 @@ "nullable": true }, { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" } ] } @@ -27264,7 +27240,7 @@ "type": "string" }, "id": { - "$ref": "#/components/schemas/defs_subteam_id" + "$ref": "#/components/schemas/SubteamIdDef" }, "is_external": { "type": "boolean" @@ -27283,13 +27259,13 @@ "properties": { "channels": { "items": { - "$ref": "#/components/schemas/defs_channel_id" + "$ref": "#/components/schemas/ChannelIdDef" }, "type": "array" }, "groups": { "items": { - "$ref": "#/components/schemas/defs_group_id" + "$ref": "#/components/schemas/GroupIdDef" }, "type": "array" } @@ -27301,17 +27277,17 @@ "type": "object" }, "team_id": { - "$ref": "#/components/schemas/defs_team" + "$ref": "#/components/schemas/TeamDef" }, "updated_by": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "user_count": { "type": "integer" }, "users": { "items": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "type": "array" } @@ -27339,7 +27315,7 @@ "title": "Subteam/Usergroup Object", "type": "object" }, - "objs_team": { + "TeamObj": { "additionalProperties": false, "properties": { "archived": { @@ -27381,22 +27357,22 @@ "type": "string" }, "enterprise_id": { - "$ref": "#/components/schemas/defs_enterprise_id" + "$ref": "#/components/schemas/EnterpriseIdDef" }, "enterprise_name": { - "$ref": "#/components/schemas/defs_enterprise_name" + "$ref": "#/components/schemas/EnterpriseNameDef" }, "external_org_migrations": { - "$ref": "#/components/schemas/objs_external_org_migrations" + "$ref": "#/components/schemas/ExternalOrgMigrationsObj" }, "has_compliance_export": { "type": "boolean" }, "icon": { - "$ref": "#/components/schemas/objs_icon" + "$ref": "#/components/schemas/IconObj" }, "id": { - "$ref": "#/components/schemas/defs_workspace_id" + "$ref": "#/components/schemas/WorkspaceIdDef" }, "is_assigned": { "type": "boolean" @@ -27442,7 +27418,7 @@ "type": "string" }, "primary_owner": { - "$ref": "#/components/schemas/objs_primary_owner" + "$ref": "#/components/schemas/PrimaryOwnerObj" }, "sso_provider": { "properties": { @@ -27469,7 +27445,7 @@ "title": "Team Object", "type": "object" }, - "objs_team_profile_field": { + "TeamProfileFieldObj": { "additionalProperties": false, "properties": { "field_name": { @@ -27496,7 +27472,7 @@ "nullable": true }, { - "$ref": "#/components/schemas/objs_team_profile_field_option" + "$ref": "#/components/schemas/TeamProfileFieldOptionObj" } ] } @@ -27532,7 +27508,7 @@ ], "type": "object" }, - "objs_team_profile_field_option": { + "TeamProfileFieldOptionObj": { "additionalProperties": false, "properties": { "is_custom": { @@ -27554,7 +27530,7 @@ }, "type": "object" }, - "objs_user": { + "UserObj": { "items": { "anyOf": [ { @@ -27569,13 +27545,13 @@ "type": "boolean" }, "enterprise_user": { - "$ref": "#/components/schemas/objs_enterprise_user" + "$ref": "#/components/schemas/EnterpriseUserObj" }, "has_2fa": { "type": "boolean" }, "id": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "is_admin": { "type": "boolean" @@ -27620,23 +27596,23 @@ "type": "string" }, "profile": { - "$ref": "#/components/schemas/objs_user_profile" + "$ref": "#/components/schemas/UserProfileObj" }, "real_name": { "type": "string" }, "team": { - "$ref": "#/components/schemas/defs_workspace_id" + "$ref": "#/components/schemas/WorkspaceIdDef" }, "team_id": { - "$ref": "#/components/schemas/defs_workspace_id" + "$ref": "#/components/schemas/WorkspaceIdDef" }, "team_profile": { "additionalProperties": false, "properties": { "fields": { "items": { - "$ref": "#/components/schemas/objs_team_profile_field" + "$ref": "#/components/schemas/TeamProfileFieldObj" }, "minItems": 1, "type": "array", @@ -27696,13 +27672,13 @@ "type": "boolean" }, "enterprise_user": { - "$ref": "#/components/schemas/objs_enterprise_user" + "$ref": "#/components/schemas/EnterpriseUserObj" }, "has_2fa": { "type": "boolean" }, "id": { - "$ref": "#/components/schemas/defs_user_id" + "$ref": "#/components/schemas/UserIdDef" }, "is_admin": { "type": "boolean" @@ -27744,20 +27720,20 @@ "type": "string" }, "profile": { - "$ref": "#/components/schemas/objs_user_profile" + "$ref": "#/components/schemas/UserProfileObj" }, "real_name": { "type": "string" }, "team_id": { - "$ref": "#/components/schemas/defs_workspace_id" + "$ref": "#/components/schemas/WorkspaceIdDef" }, "team_profile": { "additionalProperties": false, "properties": { "fields": { "items": { - "$ref": "#/components/schemas/objs_team_profile_field" + "$ref": "#/components/schemas/TeamProfileFieldObj" }, "minItems": 1, "type": "array", @@ -27771,7 +27747,7 @@ }, "teams": { "items": { - "$ref": "#/components/schemas/defs_workspace_id" + "$ref": "#/components/schemas/WorkspaceIdDef" }, "minItems": 1, "type": "array", @@ -27815,20 +27791,20 @@ ] } }, - "objs_user_profile": { + "UserProfileObj": { "additionalProperties": false, "properties": { "always_active": { "type": "boolean" }, "api_app_id": { - "$ref": "#/components/schemas/defs_optional_app_id" + "$ref": "#/components/schemas/OptionalAppIdDef" }, "avatar_hash": { "type": "string" }, "bot_id": { - "$ref": "#/components/schemas/defs_bot_id" + "$ref": "#/components/schemas/BotIdDef" }, "display_name": { "type": "string" @@ -27975,7 +27951,7 @@ "type": "string" }, "team": { - "$ref": "#/components/schemas/defs_workspace_id" + "$ref": "#/components/schemas/WorkspaceIdDef" }, "title": { "type": "string" @@ -28007,7 +27983,7 @@ "title": "User profile object", "type": "object" }, - "objs_user_profile_short": { + "UserProfileShortObj": { "additionalProperties": false, "properties": { "avatar_hash": { @@ -28043,7 +28019,7 @@ "type": "string" }, "team": { - "$ref": "#/components/schemas/defs_workspace_id" + "$ref": "#/components/schemas/WorkspaceIdDef" } }, "required": [ @@ -28060,6 +28036,30 @@ "type": "object" } }, + "requestBodies": { + "admin_inviteRequests_approve": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "invite_request_id": { + "description": "ID of the request to invite.", + "type": "string" + }, + "team_id": { + "description": "ID for the workspace where the invite request was made.", + "type": "string" + } + }, + "required": [ + "invite_request_id" + ], + "type": "object" + } + } + } + } + }, "securitySchemes": { "slackAuth": { "flows": { diff --git a/docs/spec/sanitations.bal b/docs/spec/sanitations.bal index bfed0d5..9f06dc5 100644 --- a/docs/spec/sanitations.bal +++ b/docs/spec/sanitations.bal @@ -19,6 +19,7 @@ import ballerina/lang.regexp; type Specification record { map paths; + Components components; }; type Path record { @@ -56,6 +57,10 @@ type ResponseSchema record { string schemaType?; }; +type Components record { + map schemas; +}; + const SPEC_PATH = "openapi.json"; const CONTENT_TYPE_JSON = "application/json"; final regexp:RegExp MALFORMED_TITLE_REGEX = re `\w+[\.\s]\w+.*`; @@ -63,8 +68,10 @@ final regexp:RegExp MALFORMED_TITLE_REGEX = re `\w+[\.\s]\w+.*`; public function main() returns error? { json openAPISpec = check io:fileReadJson(SPEC_PATH); Specification spec = check openAPISpec.cloneWithType(Specification); - Specification sanitisedSpec = check sanitizeResponseSchemaNames(spec); - check io:fileWriteJson(SPEC_PATH, sanitisedSpec.toJson()); + + spec = check sanitizeResponseSchemaNames(spec); + string sanitizedSpecString = sanitizeSchemaNames(spec); + check io:fileWriteString(SPEC_PATH, sanitizedSpecString); } function sanitizeResponseSchemaNames(Specification spec) returns Specification|error { @@ -106,3 +113,49 @@ function sanitizeResponseSchemaNames(Specification spec) returns Specification|e return spec; } + +function sanitizeSchemaNames(Specification spec) returns string { + + map updatedSchemas = {}; + map updatedNames = {}; + + foreach [string, json] [schemaName, schema] in spec.components.schemas.entries() { + if schemaName.includes("_") { + string newName = getSanitizedSchemaName(schemaName); + if updatedSchemas.hasKey(newName) { + io:println("Error: Duplicate sanitized schema name found: " + newName + " for schema: " + schemaName); + } + updatedNames[schemaName] = newName; + updatedSchemas[newName] = schema; + } else { + updatedSchemas[schemaName] = schema; + } + } + spec.components.schemas = updatedSchemas; + + string updatedSpec = spec.toJsonString(); + foreach [string, string] [oldName, newName] in updatedNames.entries() { + regexp:RegExp oldRegex = re `#/components/schemas/${oldName}"`; + regexp:Replacement replacement = string `#/components/schemas/${newName}"`; + updatedSpec = oldRegex.replaceAll(updatedSpec, replacement); + } + + return updatedSpec; +} + +function getSanitizedSchemaName(string schemaName) returns string { + string[] nameParts = re `_`.split(schemaName); + if nameParts[0] == "defs" { + string _ = nameParts.remove(0); + nameParts.push("Def"); + } + + if nameParts[0] == "objs" { + string _ = nameParts.remove(0); + nameParts.push("Obj"); + } + + string[] capitalizedNameParts = from string namePart in nameParts + select namePart[0].toUpperAscii() + namePart.substring(1, namePart.length()); + return string:'join("", ...capitalizedNameParts); +} From 89c2ab1e834f632c103b882fa9d63e2afced7773 Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Thu, 11 Jul 2024 23:14:42 +0530 Subject: [PATCH 07/12] Update examples --- .../automated-summary-report/Ballerina.toml | 1 + examples/automated-summary-report/main.bal | 16 ++++---- examples/automated-summary-report/types.bal | 37 ------------------ .../survey-feedback-analysis/Ballerina.toml | 1 + examples/survey-feedback-analysis/main.bal | 20 ++++------ examples/survey-feedback-analysis/types.bal | 39 ------------------- 6 files changed, 16 insertions(+), 98 deletions(-) delete mode 100644 examples/automated-summary-report/types.bal delete mode 100644 examples/survey-feedback-analysis/types.bal diff --git a/examples/automated-summary-report/Ballerina.toml b/examples/automated-summary-report/Ballerina.toml index 4e83f33..9fdd606 100644 --- a/examples/automated-summary-report/Ballerina.toml +++ b/examples/automated-summary-report/Ballerina.toml @@ -1,3 +1,4 @@ +[package] org = "wso2" name = "automated_summary_report" version = "0.1.0" diff --git a/examples/automated-summary-report/main.bal b/examples/automated-summary-report/main.bal index 16b2869..3b35e0d 100644 --- a/examples/automated-summary-report/main.bal +++ b/examples/automated-summary-report/main.bal @@ -14,8 +14,8 @@ // specific language governing permissions and limitations // under the License. -import ballerina/io; import ballerina/http; +import ballerina/io; import ballerina/log; import ballerinax/slack; @@ -30,21 +30,19 @@ final slack:Client slack = check new Client({ public function main() returns error? { // Fetch the list of channels. - json channelResponse = check slack->/conversations\.list(); - Channels channels = check channelResponse.cloneWithType(); + slack:ConversationsListResponse channelResponse = check slack->/conversations\.list(); // Array to store the latest text messages from each channel. string[] latestText; // Iterate through each channel to get the latest message. - foreach ChannelType channel in channels.channels { + foreach slack:ConversationObj channel in channelResponse.channels { // Fetch the conversation history for the current channel. - json historyResponse = check slack->/conversations\.history({channel: channel.id}); - History history = check historyResponse.cloneWithType(); + slack:ConversationsHistoryResponse historyResponse = check slack->/conversations\.history({channel: channel.toString()}); // Get the latest text message from the conversation history. - TextType[] texts = history.texts; - latestText.push(texts[0].text); + slack:MessageObj[] messages = historyResponse.messages; + latestText.push(messages[0].text); } // Construct the stand-up report message. @@ -54,7 +52,7 @@ public function main() returns error? { }`; // Post the stand-up report message to the "general" channel. - json|error postMessageResult = slack->/chat\.postMessage.post({channel: "general", text: textMessage}); + slack:ChatPostMessageResponse|error postMessageResult = slack->/chat\.postMessage.post({channel: "general", text: textMessage}); if postMessageResult is error { log:printError("Failed to post message to Slack", postMessageResult); diff --git a/examples/automated-summary-report/types.bal b/examples/automated-summary-report/types.bal deleted file mode 100644 index 1d9679c..0000000 --- a/examples/automated-summary-report/types.bal +++ /dev/null @@ -1,37 +0,0 @@ -// Copyright (c) 2024 WSO2 LLC. (http://www.wso2.org). -// -// WSO2 LLC. licenses this file to you under the Apache License, -// Version 2.0 (the "License"); you may not use this file except -// in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -# Holds slack channel information. -type ChannelType record { - string id; -}; - -# Holds response struture of the channels list. -type Channels record {| - boolean ok; - ChannelType[] channels; -|}; - -# Holds information of each text -type TextType record { - string text; -}; - -# Holds the response structure of the conversation history. -type History record { - boolean ok; - TextType[] texts; -}; diff --git a/examples/survey-feedback-analysis/Ballerina.toml b/examples/survey-feedback-analysis/Ballerina.toml index ab37f21..58bc46d 100644 --- a/examples/survey-feedback-analysis/Ballerina.toml +++ b/examples/survey-feedback-analysis/Ballerina.toml @@ -1,3 +1,4 @@ +[package] org = "wso2" name = "survey_feedback_analysis" version = "0.1.0" diff --git a/examples/survey-feedback-analysis/main.bal b/examples/survey-feedback-analysis/main.bal index 1804765..32b97d6 100644 --- a/examples/survey-feedback-analysis/main.bal +++ b/examples/survey-feedback-analysis/main.bal @@ -32,42 +32,36 @@ final slack:Client slack = check new ({ public function main() returns error? { // Create a new channel for the survey - json|error createChannelResponse = slack->/conversations\.create.post({name: CHANNEL_NAME}); + slack:ConversationsCreateResponse|error createChannelResponse = slack->/conversations\.create.post({name: CHANNEL_NAME}); if createChannelResponse is error { log:printError("Error creating the survey conversation: " + createChannelResponse.message()); return; } // Post a message to the conversation created and get the timestamp of the message - json|error sendMsgResponse = slack->/chat\.postMessage.post({channel: CHANNEL_NAME, text: SURVEY_REQUEST_MSG}); + slack:ChatPostMessageResponse|error sendMsgResponse = slack->/chat\.postMessage.post({channel: CHANNEL_NAME, text: SURVEY_REQUEST_MSG}); if sendMsgResponse is error { log:printError(sendMsgResponse.message()); return; } - string messageTimestamp = check sendMsgResponse.message.ts; + string messageTimestamp = sendMsgResponse.message.ts; // Check for replies to the survey message - json|error repliesResponse = slack->/conversations\.replies({channel: CHANNEL_NAME, ts: messageTimestamp}); + slack:ConversationsRepliesResponse|error repliesResponse = slack->/conversations\.replies({channel: CHANNEL_NAME, ts: messageTimestamp}); if repliesResponse is error { log:printError(repliesResponse.message()); return; } - RepliesResponse|error replies = repliesResponse.cloneWithType(); - if replies is error { - log:printError(replies.message()); - return; - } - // Get the messages from the replies - MessagesItem[] messages = replies.messages; + var messages = repliesResponse.messages; // Print the survey responses io:println("Replies to the survey message:"); io:println("-----------------------------"); int counter = 1; - foreach MessagesItem message in messages { - io:println(string `Reply ${counter}: ${message.text}`); + foreach var message in messages { + io:println(string `Reply ${counter}: ${message.toString()}`); counter += 1; } } diff --git a/examples/survey-feedback-analysis/types.bal b/examples/survey-feedback-analysis/types.bal deleted file mode 100644 index 228b268..0000000 --- a/examples/survey-feedback-analysis/types.bal +++ /dev/null @@ -1,39 +0,0 @@ -// Copyright (c) 2024 WSO2 LLC. (http://www.wso2.org). -// -// WSO2 LLC. licenses this file to you under the Apache License, -// Version 2.0 (the "License"); you may not use this file except -// in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, -// software distributed under the License is distributed on an -// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// KIND, either express or implied. See the License for the -// specific language governing permissions and limitations -// under the License. - -type MessagesItem record { - string text; - string thread_ts; - string ts; - string 'type; - string user; - string parent_user_id?; - string last_read?; - int reply_count?; - boolean subscribed?; - int unread_count?; -}; - -type Response_metadata record { - string next_cursor; -}; - -type RepliesResponse record { - boolean has_more; - MessagesItem[] messages; - boolean ok; - Response_metadata response_metadata; -}; From 45b5847ca007acbdfb6fd0d714a43f23d014f609 Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Thu, 11 Jul 2024 23:16:53 +0530 Subject: [PATCH 08/12] Update docs --- README.md | 2 +- ballerina/Module.md | 2 +- ballerina/Package.md | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 338ae56..ebd8208 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ Now, utilize the available connector operations. #### Send a Text Message to General Channel ```ballerina -json postMessageResponse = check slack->/chat\.postMessage.post({channel: "general", text: "hello"}); +slack:ChatPostMessageResponse postMessageResponse = check slack->/chat\.postMessage.post({channel: "general", text: "hello"}); ``` ### Step 4: Run the Ballerina application diff --git a/ballerina/Module.md b/ballerina/Module.md index fa956d3..d888601 100644 --- a/ballerina/Module.md +++ b/ballerina/Module.md @@ -74,7 +74,7 @@ Now, utilize the available connector operations. #### Send a Text Message to General Channel ```ballerina -json postMessageResponse = check slack->/chat\.postMessage.post({channel: "general", text: "hello"}); +slack:ChatPostMessageResponse postMessageResponse = check slack->/chat\.postMessage.post({channel: "general", text: "hello"}); ``` ### Step 4: Run the Ballerina application diff --git a/ballerina/Package.md b/ballerina/Package.md index fa956d3..4311e3f 100644 --- a/ballerina/Package.md +++ b/ballerina/Package.md @@ -10,7 +10,7 @@ Sign-In Page -### Step 2: Create a new Slack application +### Step 2: Create a new Slack application 1. Navigate to your apps in [Slack API](https://api.slack.com/) and create a new Slack app. @@ -22,7 +22,7 @@ 3. Click on the "Create App" button. -### Step 3: Add scopes to the token +### Step 3: Add scopes to the token 1. Once the application is created, go to the "Add Features and Functionality" section and click on "Permissions" to set the token scopes. @@ -74,7 +74,7 @@ Now, utilize the available connector operations. #### Send a Text Message to General Channel ```ballerina -json postMessageResponse = check slack->/chat\.postMessage.post({channel: "general", text: "hello"}); +slack:ChatPostMessageResponse postMessageResponse = check slack->/chat\.postMessage.post({channel: "general", text: "hello"}); ``` ### Step 4: Run the Ballerina application From 33c224b45b779d5833bffd087b9ca9bd6c4549a4 Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Thu, 11 Jul 2024 23:20:36 +0530 Subject: [PATCH 09/12] Fix sanitations.md entry --- docs/spec/sanitations.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/spec/sanitations.md b/docs/spec/sanitations.md index aa25a53..83987a4 100644 --- a/docs/spec/sanitations.md +++ b/docs/spec/sanitations.md @@ -28,8 +28,8 @@ These changes are done in order to improve the overall usability, and to address * users.deletePhoto * users.setPhoto -2. Sanitized the inline response schema titles by removing the whitespaces and special characters and, converting them to pascal case. - * This was done using the `sanitations.bal` script. +2. Sanitized the inline and component schema names by removing the whitespaces, special characters and, converting them to pascal case. + * This was done using the `sanitations.bal` script under the `docs/spec` directory. ## OpenAPI cli command From aa2c3ac62a3cf036ab663134f2d945776b75d059 Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Thu, 11 Jul 2024 23:38:44 +0530 Subject: [PATCH 10/12] Update gradle build with sanitation script validation --- build.gradle | 1 + docs/spec/build.gradle | 42 ++++++++++++++++++++++++++++++++++++++++++ settings.gradle | 3 ++- 3 files changed, 45 insertions(+), 1 deletion(-) create mode 100644 docs/spec/build.gradle diff --git a/build.gradle b/build.gradle index 65c0b8c..33d272a 100644 --- a/build.gradle +++ b/build.gradle @@ -61,6 +61,7 @@ allprojects { def moduleVersion = project.version.replace("-SNAPSHOT", "") task build { + dependsOn(':slack-sanitation:build') dependsOn(':slack-ballerina:build') } diff --git a/docs/spec/build.gradle b/docs/spec/build.gradle new file mode 100644 index 0000000..ba25d7a --- /dev/null +++ b/docs/spec/build.gradle @@ -0,0 +1,42 @@ +/* + * Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org) All Rights Reserved. + * + * WSO2 LLC. licenses this file to you under the Apache License, + * Version 2.0 (the "License"); you may not use this file except + * in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import org.apache.tools.ant.taskdefs.condition.Os + +def files = ["sanitations.bal"]; + +task build { + doLast { + try { + files.each { file -> + println("Building ${file} ...") + exec { + workingDir project.projectDir + if (Os.isFamily(Os.FAMILY_WINDOWS)) { + commandLine 'sh', "/c", "bal build ${file} && exit %%ERRORLEVEL%%" + } else { + commandLine 'sh', "-c", "bal build ${file}" + } + } + } + } catch (Exception e) { + println("Sanitation Script Build failed: " + e.message) + throw e + } + } +} diff --git a/settings.gradle b/settings.gradle index 44c878c..aaabe00 100644 --- a/settings.gradle +++ b/settings.gradle @@ -32,10 +32,11 @@ plugins { rootProject.name = 'module-ballerinax-slack' +include ':slack-sanitation' include ':slack-ballerina' project(':slack-ballerina').projectDir = file("ballerina") - +project(':slack-sanitation').projectDir = file("docs/spec") gradleEnterprise { buildScan { termsOfServiceUrl = 'https://gradle.com/terms-of-service' From 7b7b6eaaada4eb82af475fe80bd99fca998e31a1 Mon Sep 17 00:00:00 2001 From: Nipuna Ransinghe Date: Fri, 12 Jul 2024 08:52:24 +0530 Subject: [PATCH 11/12] Apply suggestions from code review Co-authored-by: Azeem Muzammil <33729295+AzeemMuzammil@users.noreply.github.com> --- docs/spec/build.gradle | 2 +- docs/spec/sanitations.bal | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/spec/build.gradle b/docs/spec/build.gradle index ba25d7a..63d6fd9 100644 --- a/docs/spec/build.gradle +++ b/docs/spec/build.gradle @@ -1,5 +1,5 @@ /* - * Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org) All Rights Reserved. + * Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org). * * WSO2 LLC. licenses this file to you under the Apache License, * Version 2.0 (the "License"); you may not use this file except diff --git a/docs/spec/sanitations.bal b/docs/spec/sanitations.bal index 9f06dc5..18701dc 100644 --- a/docs/spec/sanitations.bal +++ b/docs/spec/sanitations.bal @@ -115,7 +115,6 @@ function sanitizeResponseSchemaNames(Specification spec) returns Specification|e } function sanitizeSchemaNames(Specification spec) returns string { - map updatedSchemas = {}; map updatedNames = {}; From 484cc04708e1d473ba55cb9e630776bb8aa7db9f Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Fri, 12 Jul 2024 10:38:12 +0530 Subject: [PATCH 12/12] Address more review suggestions --- docs/spec/sanitations.bal | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/spec/sanitations.bal b/docs/spec/sanitations.bal index 9f06dc5..6fe987f 100644 --- a/docs/spec/sanitations.bal +++ b/docs/spec/sanitations.bal @@ -16,6 +16,7 @@ import ballerina/io; import ballerina/lang.regexp; +import ballerina/mime; type Specification record { map paths; @@ -62,7 +63,6 @@ type Components record { }; const SPEC_PATH = "openapi.json"; -const CONTENT_TYPE_JSON = "application/json"; final regexp:RegExp MALFORMED_TITLE_REGEX = re `\w+[\.\s]\w+.*`; public function main() returns error? { @@ -89,7 +89,7 @@ function sanitizeResponseSchemaNames(Specification spec) returns Specification|e } foreach [string, ResponseCode] [_, item] in responses.entries() { map content = item.content ?: {}; - ResponseHeader app = content[CONTENT_TYPE_JSON] ?: {}; + ResponseHeader app = content[mime:APPLICATION_JSON] ?: {}; ResponseSchema schema = app.schema ?: {}; string? title = schema.title; if title !is string {