From eee82313d064ff0e54e48b742fbdef752fc4c3ae Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Thu, 27 Jun 2024 20:32:13 +0530 Subject: [PATCH 1/3] Add descriptions to the common parameter names used in the spec --- docs/spec/openapi.json | 436 ++++++++++++++++++++-------------------- docs/spec/sanitation.md | 11 +- 2 files changed, 228 insertions(+), 219 deletions(-) diff --git a/docs/spec/openapi.json b/docs/spec/openapi.json index fed6c8f..2eb936d 100644 --- a/docs/spec/openapi.json +++ b/docs/spec/openapi.json @@ -930,7 +930,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -1011,7 +1011,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -1022,7 +1022,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -1088,7 +1088,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -1099,7 +1099,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -1170,7 +1170,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -1181,7 +1181,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -1265,7 +1265,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -1276,7 +1276,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -1336,7 +1336,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -1347,7 +1347,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -1409,7 +1409,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -1490,7 +1490,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -1571,7 +1571,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -1628,7 +1628,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -1698,7 +1698,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -1757,7 +1757,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -1817,7 +1817,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -1896,7 +1896,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -1963,7 +1963,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -1974,7 +1974,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -2045,7 +2045,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -2056,7 +2056,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -2121,7 +2121,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -2132,7 +2132,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -2216,7 +2216,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -2227,7 +2227,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -2302,7 +2302,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -2313,7 +2313,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -2395,7 +2395,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -2406,7 +2406,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -2490,7 +2490,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -2539,7 +2539,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -2590,7 +2590,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -2652,7 +2652,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -2663,7 +2663,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -2685,7 +2685,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -2736,7 +2736,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -2747,7 +2747,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -2841,7 +2841,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -2852,7 +2852,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -2914,7 +2914,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -2925,7 +2925,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -2976,7 +2976,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -2987,7 +2987,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -3044,7 +3044,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -3055,7 +3055,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -3123,7 +3123,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -3134,7 +3134,7 @@ { "name": "webhook_token", "in": "path", - "description": "", + "description": "Webhook Token", "required": true, "style": "simple", "schema": { @@ -3201,7 +3201,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -3212,7 +3212,7 @@ { "name": "webhook_token", "in": "path", - "description": "", + "description": "Webhook Token", "required": true, "style": "simple", "schema": { @@ -3273,7 +3273,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -3284,7 +3284,7 @@ { "name": "webhook_token", "in": "path", - "description": "", + "description": "Webhook Token", "required": true, "style": "simple", "schema": { @@ -3426,7 +3426,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -3544,7 +3544,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -3626,7 +3626,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -3686,7 +3686,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -3794,7 +3794,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -3873,7 +3873,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -3970,7 +3970,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -4032,7 +4032,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -4120,7 +4120,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -4177,7 +4177,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -4245,7 +4245,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -4256,7 +4256,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -4267,7 +4267,7 @@ { "name": "role_id", "in": "path", - "description": "", + "description": "Role ID", "required": true, "style": "simple", "schema": { @@ -4316,7 +4316,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -4327,7 +4327,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -4338,7 +4338,7 @@ { "name": "role_id", "in": "path", - "description": "", + "description": "Role ID", "required": true, "style": "simple", "schema": { @@ -4389,7 +4389,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -4440,7 +4440,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -4511,7 +4511,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -4578,7 +4578,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -4752,7 +4752,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -4820,7 +4820,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -4891,7 +4891,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -4956,7 +4956,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -5040,7 +5040,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -5115,7 +5115,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -5197,7 +5197,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -5371,7 +5371,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -5382,7 +5382,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -5447,7 +5447,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -5458,7 +5458,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -5507,7 +5507,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -5518,7 +5518,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -5569,7 +5569,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -5664,7 +5664,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -5735,7 +5735,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -5797,7 +5797,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -5808,7 +5808,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -5886,7 +5886,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -5897,7 +5897,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -5948,7 +5948,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -6016,7 +6016,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -6027,7 +6027,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -6082,7 +6082,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -6093,7 +6093,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -6142,7 +6142,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -6153,7 +6153,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -6293,7 +6293,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -6399,7 +6399,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -6570,7 +6570,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -6643,7 +6643,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -6711,7 +6711,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -6784,7 +6784,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -6874,7 +6874,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -6949,7 +6949,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -7011,7 +7011,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -7022,7 +7022,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -7071,7 +7071,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -7082,7 +7082,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -7133,7 +7133,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -7195,7 +7195,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -7206,7 +7206,7 @@ { "name": "webhook_token", "in": "path", - "description": "", + "description": "Webhook Token", "required": true, "style": "simple", "schema": { @@ -7217,7 +7217,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -7284,7 +7284,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -7295,7 +7295,7 @@ { "name": "webhook_token", "in": "path", - "description": "", + "description": "Webhook Token", "required": true, "style": "simple", "schema": { @@ -7306,7 +7306,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -7367,7 +7367,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -7378,7 +7378,7 @@ { "name": "webhook_token", "in": "path", - "description": "", + "description": "Webhook Token", "required": true, "style": "simple", "schema": { @@ -7389,7 +7389,7 @@ { "name": "message_id", "in": "path", - "description": "", + "description": "Message ID", "required": true, "style": "simple", "schema": { @@ -7531,7 +7531,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -7542,7 +7542,7 @@ { "name": "webhook_token", "in": "path", - "description": "", + "description": "Webhook Token", "required": true, "style": "simple", "schema": { @@ -7626,7 +7626,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -7637,7 +7637,7 @@ { "name": "webhook_token", "in": "path", - "description": "", + "description": "Webhook Token", "required": true, "style": "simple", "schema": { @@ -7891,7 +7891,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -7953,7 +7953,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8039,7 +8039,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8099,7 +8099,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8198,7 +8198,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8281,7 +8281,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8369,7 +8369,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8424,7 +8424,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8492,7 +8492,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8503,7 +8503,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -8565,7 +8565,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8627,7 +8627,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8702,7 +8702,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8760,7 +8760,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8815,7 +8815,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8883,7 +8883,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -8940,7 +8940,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9065,7 +9065,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9131,7 +9131,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9197,7 +9197,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9263,7 +9263,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9342,7 +9342,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9402,7 +9402,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9470,7 +9470,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9536,7 +9536,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9596,7 +9596,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9675,7 +9675,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9743,7 +9743,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9802,7 +9802,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9896,7 +9896,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -9971,7 +9971,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10047,7 +10047,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10113,7 +10113,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10179,7 +10179,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10190,7 +10190,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -10245,7 +10245,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10256,7 +10256,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -10327,7 +10327,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10338,7 +10338,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -10387,7 +10387,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10398,7 +10398,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -10471,7 +10471,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10557,7 +10557,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10614,7 +10614,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10689,7 +10689,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10751,7 +10751,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10817,7 +10817,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10877,7 +10877,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -10956,7 +10956,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11016,7 +11016,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11084,7 +11084,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11139,7 +11139,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11207,7 +11207,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11218,7 +11218,7 @@ { "name": "role_id", "in": "path", - "description": "", + "description": "Role ID", "required": true, "style": "simple", "schema": { @@ -11267,7 +11267,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11278,7 +11278,7 @@ { "name": "role_id", "in": "path", - "description": "", + "description": "Role ID", "required": true, "style": "simple", "schema": { @@ -11346,7 +11346,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11405,7 +11405,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11471,7 +11471,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11547,7 +11547,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11643,7 +11643,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11711,7 +11711,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11722,7 +11722,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -11777,7 +11777,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11788,7 +11788,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -11848,7 +11848,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -11859,7 +11859,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { @@ -11910,7 +11910,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -12007,7 +12007,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -12075,7 +12075,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -12130,7 +12130,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -12179,7 +12179,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -12247,7 +12247,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -12302,7 +12302,7 @@ { "name": "application_id", "in": "path", - "description": "", + "description": "Application ID", "required": true, "style": "simple", "schema": { @@ -12370,7 +12370,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -12381,7 +12381,7 @@ { "name": "webhook_token", "in": "path", - "description": "", + "description": "Webhook Token", "required": true, "style": "simple", "schema": { @@ -12447,7 +12447,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -12458,7 +12458,7 @@ { "name": "webhook_token", "in": "path", - "description": "", + "description": "Webhook Token", "required": true, "style": "simple", "schema": { @@ -12558,7 +12558,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -12569,7 +12569,7 @@ { "name": "webhook_token", "in": "path", - "description": "", + "description": "Webhook Token", "required": true, "style": "simple", "schema": { @@ -12619,7 +12619,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -12630,7 +12630,7 @@ { "name": "webhook_token", "in": "path", - "description": "", + "description": "Webhook Token", "required": true, "style": "simple", "schema": { @@ -12773,7 +12773,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -12838,7 +12838,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -12887,7 +12887,7 @@ { "name": "webhook_id", "in": "path", - "description": "", + "description": "Webhook ID", "required": true, "style": "simple", "schema": { @@ -12965,7 +12965,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -13033,7 +13033,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -13101,7 +13101,7 @@ { "name": "channel_id", "in": "path", - "description": "", + "description": "Channel ID", "required": true, "style": "simple", "schema": { @@ -13346,7 +13346,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -13411,7 +13411,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -13460,7 +13460,7 @@ { "name": "guild_id", "in": "path", - "description": "", + "description": "Guild ID", "required": true, "style": "simple", "schema": { @@ -13528,7 +13528,7 @@ { "name": "user_id", "in": "path", - "description": "", + "description": "User ID", "required": true, "style": "simple", "schema": { diff --git a/docs/spec/sanitation.md b/docs/spec/sanitation.md index 4be86b0..f84204d 100644 --- a/docs/spec/sanitation.md +++ b/docs/spec/sanitation.md @@ -17,7 +17,16 @@ These changes are done in order to improve the overall usability, and as workaro 2. Renamed the `config.auth` variable into `httpClientConfig.auth`. This is done as a workaround for this issue. [Authorization issues in the generated client](https://github.com/ballerina-platform/ballerina-library/issues/6655) - +3. Added descriptions to the following parameter names throughout the specification: + + * `guild_id` + * `application_id` + * `channel_id` + * `message_id` + * `webhook_id` + * `webhook_token` + * `role_id` + ## OpenAPI cli command The following command was used to generate the Ballerina client from the OpenAPI specification. The command should be executed from the repository root directory. From f48a3476685f5210d730fb93bed24900847ca9fe Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Thu, 27 Jun 2024 20:36:07 +0530 Subject: [PATCH 2/3] Regenerate client with the new sanitations --- ballerina/client.bal | 370 +++++++++++++++++++++---------------------- 1 file changed, 185 insertions(+), 185 deletions(-) diff --git a/ballerina/client.bal b/ballerina/client.bal index 0bd4b66..156bd5d 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -65,7 +65,7 @@ public isolated client class Client { # delete_application_command # - # + application_id - + # + application_id - Application ID # + command_id - # + headers - Headers to be sent with the request # + return - 204 response for delete_application_command @@ -81,7 +81,7 @@ public isolated client class Client { # delete_entitlement # - # + application_id - + # + application_id - Application ID # + entitlement_id - # + headers - Headers to be sent with the request # + return - 204 response for delete_entitlement @@ -97,8 +97,8 @@ public isolated client class Client { # delete_guild_application_command # - # + application_id - - # + guild_id - + # + application_id - Application ID + # + guild_id - Guild ID # + command_id - # + headers - Headers to be sent with the request # + return - 204 response for delete_guild_application_command @@ -114,7 +114,7 @@ public isolated client class Client { # delete_channel # - # + channel_id - + # + channel_id - Channel ID # + headers - Headers to be sent with the request # + return - 200 response for delete_channel resource isolated function delete channels/[string channel_id](map headers = {}) returns inline_response_200_6|error { @@ -129,8 +129,8 @@ public isolated client class Client { # delete_message # - # + channel_id - - # + message_id - + # + channel_id - Channel ID + # + message_id - Message ID # + headers - Headers to be sent with the request # + return - 204 response for delete_message resource isolated function delete channels/[string channel_id]/messages/[string message_id](map headers = {}) returns http:Response|error { @@ -145,8 +145,8 @@ public isolated client class Client { # delete_all_message_reactions # - # + channel_id - - # + message_id - + # + channel_id - Channel ID + # + message_id - Message ID # + headers - Headers to be sent with the request # + return - 204 response for delete_all_message_reactions resource isolated function delete channels/[string channel_id]/messages/[string message_id]/reactions(map headers = {}) returns http:Response|error { @@ -161,8 +161,8 @@ public isolated client class Client { # delete_all_message_reactions_by_emoji # - # + channel_id - - # + message_id - + # + channel_id - Channel ID + # + message_id - Message ID # + emoji_name - # + headers - Headers to be sent with the request # + return - 204 response for delete_all_message_reactions_by_emoji @@ -178,10 +178,10 @@ public isolated client class Client { # delete_user_message_reaction # - # + channel_id - - # + message_id - + # + channel_id - Channel ID + # + message_id - Message ID # + emoji_name - - # + user_id - + # + user_id - User ID # + headers - Headers to be sent with the request # + return - 204 response for delete_user_message_reaction resource isolated function delete channels/[string channel_id]/messages/[string message_id]/reactions/[string emoji_name]/[string user_id](map headers = {}) returns http:Response|error { @@ -206,7 +206,7 @@ public isolated client class Client { # delete_channel_permission_overwrite # - # + channel_id - + # + channel_id - Channel ID # + overwrite_id - # + headers - Headers to be sent with the request # + return - 204 response for delete_channel_permission_overwrite @@ -222,8 +222,8 @@ public isolated client class Client { # unpin_message # - # + channel_id - - # + message_id - + # + channel_id - Channel ID + # + message_id - Message ID # + headers - Headers to be sent with the request # + return - 204 response for unpin_message resource isolated function delete channels/[string channel_id]/pins/[string message_id](map headers = {}) returns http:Response|error { @@ -238,8 +238,8 @@ public isolated client class Client { # delete_group_dm_user # - # + channel_id - - # + user_id - + # + channel_id - Channel ID + # + user_id - User ID # + headers - Headers to be sent with the request # + return - 204 response for delete_group_dm_user resource isolated function delete channels/[string channel_id]/recipients/[string user_id](map headers = {}) returns http:Response|error { @@ -254,8 +254,8 @@ public isolated client class Client { # delete_thread_member # - # + channel_id - - # + user_id - + # + channel_id - Channel ID + # + user_id - User ID # + headers - Headers to be sent with the request # + return - 204 response for delete_thread_member resource isolated function delete channels/[string channel_id]/thread\-members/[string user_id](map headers = {}) returns http:Response|error { @@ -280,7 +280,7 @@ public isolated client class Client { # delete_guild # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 204 response for delete_guild resource isolated function delete guilds/[string guild_id](map headers = {}) returns http:Response|error { @@ -295,7 +295,7 @@ public isolated client class Client { # delete_auto_moderation_rule # - # + guild_id - + # + guild_id - Guild ID # + rule_id - # + headers - Headers to be sent with the request # + return - 204 response for delete_auto_moderation_rule @@ -311,8 +311,8 @@ public isolated client class Client { # unban_user_from_guild # - # + guild_id - - # + user_id - + # + guild_id - Guild ID + # + user_id - User ID # + headers - Headers to be sent with the request # + return - 204 response for unban_user_from_guild resource isolated function delete guilds/[string guild_id]/bans/[string user_id](map headers = {}) returns http:Response|error { @@ -327,7 +327,7 @@ public isolated client class Client { # delete_guild_emoji # - # + guild_id - + # + guild_id - Guild ID # + emoji_id - # + headers - Headers to be sent with the request # + return - 204 response for delete_guild_emoji @@ -343,7 +343,7 @@ public isolated client class Client { # delete_guild_integration # - # + guild_id - + # + guild_id - Guild ID # + integration_id - # + headers - Headers to be sent with the request # + return - 204 response for delete_guild_integration @@ -359,8 +359,8 @@ public isolated client class Client { # delete_guild_member # - # + guild_id - - # + user_id - + # + guild_id - Guild ID + # + user_id - User ID # + headers - Headers to be sent with the request # + return - 204 response for delete_guild_member resource isolated function delete guilds/[string guild_id]/members/[string user_id](map headers = {}) returns http:Response|error { @@ -375,9 +375,9 @@ public isolated client class Client { # delete_guild_member_role # - # + guild_id - - # + user_id - - # + role_id - + # + guild_id - Guild ID + # + user_id - User ID + # + role_id - Role ID # + headers - Headers to be sent with the request # + return - 204 response for delete_guild_member_role resource isolated function delete guilds/[string guild_id]/members/[string user_id]/roles/[string role_id](map headers = {}) returns http:Response|error { @@ -392,8 +392,8 @@ public isolated client class Client { # delete_guild_role # - # + guild_id - - # + role_id - + # + guild_id - Guild ID + # + role_id - Role ID # + headers - Headers to be sent with the request # + return - 204 response for delete_guild_role resource isolated function delete guilds/[string guild_id]/roles/[string role_id](map headers = {}) returns http:Response|error { @@ -408,7 +408,7 @@ public isolated client class Client { # delete_guild_scheduled_event # - # + guild_id - + # + guild_id - Guild ID # + guild_scheduled_event_id - # + headers - Headers to be sent with the request # + return - 204 response for delete_guild_scheduled_event @@ -424,7 +424,7 @@ public isolated client class Client { # delete_guild_sticker # - # + guild_id - + # + guild_id - Guild ID # + sticker_id - # + headers - Headers to be sent with the request # + return - 204 response for delete_guild_sticker @@ -440,7 +440,7 @@ public isolated client class Client { # delete_guild_template # - # + guild_id - + # + guild_id - Guild ID # + code - # + headers - Headers to be sent with the request # + return - 200 response for delete_guild_template @@ -481,7 +481,7 @@ public isolated client class Client { # leave_guild # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 204 response for leave_guild resource isolated function delete users/\@me/guilds/[string guild_id](map headers = {}) returns http:Response|error { @@ -496,7 +496,7 @@ public isolated client class Client { # delete_webhook # - # + webhook_id - + # + webhook_id - Webhook ID # + headers - Headers to be sent with the request # + return - 204 response for delete_webhook resource isolated function delete webhooks/[string webhook_id](map headers = {}) returns http:Response|error { @@ -511,8 +511,8 @@ public isolated client class Client { # delete_webhook_by_token # - # + webhook_id - - # + webhook_token - + # + webhook_id - Webhook ID + # + webhook_token - Webhook Token # + headers - Headers to be sent with the request # + return - 204 response for delete_webhook_by_token resource isolated function delete webhooks/[string webhook_id]/[string webhook_token](map headers = {}) returns http:Response|error { @@ -527,9 +527,9 @@ public isolated client class Client { # delete_webhook_message # - # + webhook_id - - # + webhook_token - - # + message_id - + # + webhook_id - Webhook ID + # + webhook_token - Webhook Token + # + message_id - Message ID # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 204 response for delete_webhook_message @@ -557,7 +557,7 @@ public isolated client class Client { # get_application # - # + application_id - + # + application_id - Application ID # + headers - Headers to be sent with the request # + return - 200 response for get_application resource isolated function get applications/[string application_id](map headers = {}) returns PrivateApplicationResponse|error { @@ -572,7 +572,7 @@ public isolated client class Client { # list_application_commands # - # + application_id - + # + application_id - Application ID # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 200 response for list_application_commands @@ -589,7 +589,7 @@ public isolated client class Client { # get_application_command # - # + application_id - + # + application_id - Application ID # + command_id - # + headers - Headers to be sent with the request # + return - 200 response for get_application_command @@ -605,7 +605,7 @@ public isolated client class Client { # get_entitlements # - # + application_id - + # + application_id - Application ID # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 200 response for get_entitlements @@ -623,7 +623,7 @@ public isolated client class Client { # get_entitlement # - # + application_id - + # + application_id - Application ID # + entitlement_id - # + headers - Headers to be sent with the request # + return - 200 response for get_entitlement @@ -639,8 +639,8 @@ public isolated client class Client { # list_guild_application_commands # - # + application_id - - # + guild_id - + # + application_id - Application ID + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 200 response for list_guild_application_commands @@ -657,8 +657,8 @@ public isolated client class Client { # get_guild_application_command # - # + application_id - - # + guild_id - + # + application_id - Application ID + # + guild_id - Guild ID # + command_id - # + headers - Headers to be sent with the request # + return - 200 response for get_guild_application_command @@ -674,8 +674,8 @@ public isolated client class Client { # get_guild_application_command_permissions # - # + application_id - - # + guild_id - + # + application_id - Application ID + # + guild_id - Guild ID # + command_id - # + headers - Headers to be sent with the request # + return - 200 response for get_guild_application_command_permissions @@ -691,8 +691,8 @@ public isolated client class Client { # list_guild_application_command_permissions # - # + application_id - - # + guild_id - + # + application_id - Application ID + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for list_guild_application_command_permissions resource isolated function get applications/[string application_id]/guilds/[string guild_id]/commands/permissions(map headers = {}) returns CommandPermissionsResponse[]|error { @@ -707,7 +707,7 @@ public isolated client class Client { # get_application_role_connections_metadata # - # + application_id - + # + application_id - Application ID # + headers - Headers to be sent with the request # + return - 200 response for get_application_role_connections_metadata resource isolated function get applications/[string application_id]/role\-connections/metadata(map headers = {}) returns ApplicationRoleConnectionsMetadataItemResponse[]|error { @@ -732,7 +732,7 @@ public isolated client class Client { # get_channel # - # + channel_id - + # + channel_id - Channel ID # + headers - Headers to be sent with the request # + return - 200 response for get_channel resource isolated function get channels/[string channel_id](map headers = {}) returns inline_response_200_6|error { @@ -747,7 +747,7 @@ public isolated client class Client { # list_channel_invites # - # + channel_id - + # + channel_id - Channel ID # + headers - Headers to be sent with the request # + return - 200 response for list_channel_invites resource isolated function get channels/[string channel_id]/invites(map headers = {}) returns anydata[]|error { @@ -762,7 +762,7 @@ public isolated client class Client { # list_messages # - # + channel_id - + # + channel_id - Channel ID # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 200 response for list_messages @@ -779,8 +779,8 @@ public isolated client class Client { # get_message # - # + channel_id - - # + message_id - + # + channel_id - Channel ID + # + message_id - Message ID # + headers - Headers to be sent with the request # + return - 200 response for get_message resource isolated function get channels/[string channel_id]/messages/[string message_id](map headers = {}) returns MessageResponse|error { @@ -795,8 +795,8 @@ public isolated client class Client { # list_message_reactions_by_emoji # - # + channel_id - - # + message_id - + # + channel_id - Channel ID + # + message_id - Message ID # + emoji_name - # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request @@ -814,7 +814,7 @@ public isolated client class Client { # list_pinned_messages # - # + channel_id - + # + channel_id - Channel ID # + headers - Headers to be sent with the request # + return - 200 response for list_pinned_messages resource isolated function get channels/[string channel_id]/pins(map headers = {}) returns MessageResponse[]|error { @@ -840,8 +840,8 @@ public isolated client class Client { # get_thread_member # - # + channel_id - - # + user_id - + # + channel_id - Channel ID + # + user_id - User ID # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 200 response for get_thread_member @@ -891,7 +891,7 @@ public isolated client class Client { # list_channel_webhooks # - # + channel_id - + # + channel_id - Channel ID # + headers - Headers to be sent with the request # + return - 200 response for list_channel_webhooks resource isolated function get channels/[string channel_id]/webhooks(map headers = {}) returns anydata[]|error { @@ -934,7 +934,7 @@ public isolated client class Client { # get_guild # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 200 response for get_guild @@ -962,7 +962,7 @@ public isolated client class Client { # list_auto_moderation_rules # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for list_auto_moderation_rules resource isolated function get guilds/[string guild_id]/auto\-moderation/rules(map headers = {}) returns anydata[]|error { @@ -977,7 +977,7 @@ public isolated client class Client { # get_auto_moderation_rule # - # + guild_id - + # + guild_id - Guild ID # + rule_id - # + headers - Headers to be sent with the request # + return - 200 response for get_auto_moderation_rule @@ -993,7 +993,7 @@ public isolated client class Client { # list_guild_bans # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 200 response for list_guild_bans @@ -1010,8 +1010,8 @@ public isolated client class Client { # get_guild_ban # - # + guild_id - - # + user_id - + # + guild_id - Guild ID + # + user_id - User ID # + headers - Headers to be sent with the request # + return - 200 response for get_guild_ban resource isolated function get guilds/[string guild_id]/bans/[string user_id](map headers = {}) returns GuildBanResponse|error { @@ -1026,7 +1026,7 @@ public isolated client class Client { # list_guild_channels # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for list_guild_channels resource isolated function get guilds/[string guild_id]/channels(map headers = {}) returns anydata[]|error { @@ -1041,7 +1041,7 @@ public isolated client class Client { # list_guild_emojis # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for list_guild_emojis resource isolated function get guilds/[string guild_id]/emojis(map headers = {}) returns EmojiResponse[]|error { @@ -1056,7 +1056,7 @@ public isolated client class Client { # get_guild_emoji # - # + guild_id - + # + guild_id - Guild ID # + emoji_id - # + headers - Headers to be sent with the request # + return - 200 response for get_guild_emoji @@ -1072,7 +1072,7 @@ public isolated client class Client { # list_guild_integrations # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for list_guild_integrations resource isolated function get guilds/[string guild_id]/integrations(map headers = {}) returns anydata[]|error { @@ -1087,7 +1087,7 @@ public isolated client class Client { # list_guild_invites # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for list_guild_invites resource isolated function get guilds/[string guild_id]/invites(map headers = {}) returns anydata[]|error { @@ -1102,7 +1102,7 @@ public isolated client class Client { # list_guild_members # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 200 response for list_guild_members @@ -1119,8 +1119,8 @@ public isolated client class Client { # get_guild_member # - # + guild_id - - # + user_id - + # + guild_id - Guild ID + # + user_id - User ID # + headers - Headers to be sent with the request # + return - 200 response for get_guild_member resource isolated function get guilds/[string guild_id]/members/[string user_id](map headers = {}) returns GuildMemberResponse|error { @@ -1135,7 +1135,7 @@ public isolated client class Client { # search_guild_members # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 200 response for search_guild_members @@ -1162,7 +1162,7 @@ public isolated client class Client { # get_guilds_onboarding # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for get_guilds_onboarding resource isolated function get guilds/[string guild_id]/onboarding(map headers = {}) returns UserGuildOnboardingResponse|error { @@ -1177,7 +1177,7 @@ public isolated client class Client { # get_guild_preview # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for get_guild_preview resource isolated function get guilds/[string guild_id]/preview(map headers = {}) returns GuildPreviewResponse|error { @@ -1192,7 +1192,7 @@ public isolated client class Client { # preview_prune_guild # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 200 response for preview_prune_guild @@ -1210,7 +1210,7 @@ public isolated client class Client { # list_guild_voice_regions # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for list_guild_voice_regions resource isolated function get guilds/[string guild_id]/regions(map headers = {}) returns VoiceRegionResponse[]|error { @@ -1225,7 +1225,7 @@ public isolated client class Client { # list_guild_roles # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for list_guild_roles resource isolated function get guilds/[string guild_id]/roles(map headers = {}) returns GuildRoleResponse[]|error { @@ -1251,7 +1251,7 @@ public isolated client class Client { # get_guild_scheduled_event # - # + guild_id - + # + guild_id - Guild ID # + guild_scheduled_event_id - # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request @@ -1269,7 +1269,7 @@ public isolated client class Client { # list_guild_scheduled_event_users # - # + guild_id - + # + guild_id - Guild ID # + guild_scheduled_event_id - # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request @@ -1287,7 +1287,7 @@ public isolated client class Client { # list_guild_stickers # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for list_guild_stickers resource isolated function get guilds/[string guild_id]/stickers(map headers = {}) returns GuildStickerResponse[]|error { @@ -1302,7 +1302,7 @@ public isolated client class Client { # get_guild_sticker # - # + guild_id - + # + guild_id - Guild ID # + sticker_id - # + headers - Headers to be sent with the request # + return - 200 response for get_guild_sticker @@ -1318,7 +1318,7 @@ public isolated client class Client { # list_guild_templates # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for list_guild_templates resource isolated function get guilds/[string guild_id]/templates(map headers = {}) returns GuildTemplateResponse[]|error { @@ -1333,7 +1333,7 @@ public isolated client class Client { # get_active_guild_threads # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for get_active_guild_threads resource isolated function get guilds/[string guild_id]/threads/active(map headers = {}) returns ThreadsResponse|error { @@ -1358,7 +1358,7 @@ public isolated client class Client { # get_guild_webhooks # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for get_guild_webhooks resource isolated function get guilds/[string guild_id]/webhooks(map headers = {}) returns anydata[]|error { @@ -1383,7 +1383,7 @@ public isolated client class Client { # get_guild_widget_settings # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for get_guild_widget_settings resource isolated function get guilds/[string guild_id]/widget(map headers = {}) returns WidgetSettingsResponse|error { @@ -1521,7 +1521,7 @@ public isolated client class Client { # get_user # - # + user_id - + # + user_id - User ID # + headers - Headers to be sent with the request # + return - 200 response for get_user resource isolated function get users/[string user_id](map headers = {}) returns UserResponse|error { @@ -1581,7 +1581,7 @@ public isolated client class Client { # get_my_guild_member # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 200 response for get_my_guild_member resource isolated function get users/\@me/guilds/[string guild_id]/member(map headers = {}) returns PrivateGuildMemberResponse|error { @@ -1605,7 +1605,7 @@ public isolated client class Client { # get_webhook # - # + webhook_id - + # + webhook_id - Webhook ID # + headers - Headers to be sent with the request # + return - 200 response for get_webhook resource isolated function get webhooks/[string webhook_id](map headers = {}) returns inline_response_200_4|error { @@ -1620,8 +1620,8 @@ public isolated client class Client { # get_webhook_by_token # - # + webhook_id - - # + webhook_token - + # + webhook_id - Webhook ID + # + webhook_token - Webhook Token # + headers - Headers to be sent with the request # + return - 200 response for get_webhook_by_token resource isolated function get webhooks/[string webhook_id]/[string webhook_token](map headers = {}) returns inline_response_200_4|error { @@ -1636,9 +1636,9 @@ public isolated client class Client { # get_webhook_message # - # + webhook_id - - # + webhook_token - - # + message_id - + # + webhook_id - Webhook ID + # + webhook_token - Webhook Token + # + message_id - Message ID # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 200 response for get_webhook_message @@ -1666,7 +1666,7 @@ public isolated client class Client { # update_application # - # + application_id - + # + application_id - Application ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for update_application @@ -1685,7 +1685,7 @@ public isolated client class Client { # update_application_command # - # + application_id - + # + application_id - Application ID # + command_id - # + headers - Headers to be sent with the request # + payload - @@ -1705,8 +1705,8 @@ public isolated client class Client { # update_guild_application_command # - # + application_id - - # + guild_id - + # + application_id - Application ID + # + guild_id - Guild ID # + command_id - # + headers - Headers to be sent with the request # + payload - @@ -1739,7 +1739,7 @@ public isolated client class Client { # update_channel # - # + channel_id - + # + channel_id - Channel ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for update_channel @@ -1758,8 +1758,8 @@ public isolated client class Client { # update_message # - # + channel_id - - # + message_id - + # + channel_id - Channel ID + # + message_id - Message ID # + headers - Headers to be sent with the request # + return - 200 response for update_message resource isolated function patch channels/[string channel_id]/messages/[string message_id](Update_messageHeaders headers, messages_message_id_body payload) returns MessageResponse|error { @@ -1777,7 +1777,7 @@ public isolated client class Client { # update_guild # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for update_guild @@ -1796,7 +1796,7 @@ public isolated client class Client { # update_auto_moderation_rule # - # + guild_id - + # + guild_id - Guild ID # + rule_id - # + headers - Headers to be sent with the request # + payload - @@ -1816,7 +1816,7 @@ public isolated client class Client { # bulk_update_guild_channels # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 204 response for bulk_update_guild_channels @@ -1835,7 +1835,7 @@ public isolated client class Client { # update_guild_emoji # - # + guild_id - + # + guild_id - Guild ID # + emoji_id - # + headers - Headers to be sent with the request # + payload - @@ -1855,8 +1855,8 @@ public isolated client class Client { # update_guild_member # - # + guild_id - - # + user_id - + # + guild_id - Guild ID + # + user_id - User ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for update_guild_member @@ -1888,7 +1888,7 @@ public isolated client class Client { # bulk_update_guild_roles # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for bulk_update_guild_roles @@ -1907,8 +1907,8 @@ public isolated client class Client { # update_guild_role # - # + guild_id - - # + role_id - + # + guild_id - Guild ID + # + role_id - Role ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for update_guild_role @@ -1927,8 +1927,8 @@ public isolated client class Client { # update_voice_state # - # + guild_id - - # + user_id - + # + guild_id - Guild ID + # + user_id - User ID # + headers - Headers to be sent with the request # + payload - # + return - 204 response for update_voice_state @@ -1947,7 +1947,7 @@ public isolated client class Client { # update_guild_sticker # - # + guild_id - + # + guild_id - Guild ID # + sticker_id - # + headers - Headers to be sent with the request # + payload - @@ -1967,7 +1967,7 @@ public isolated client class Client { # update_guild_template # - # + guild_id - + # + guild_id - Guild ID # + code - # + headers - Headers to be sent with the request # + payload - @@ -1987,8 +1987,8 @@ public isolated client class Client { # update_voice_state # - # + guild_id - - # + user_id - + # + guild_id - Guild ID + # + user_id - User ID # + headers - Headers to be sent with the request # + payload - # + return - 204 response for update_voice_state @@ -2033,7 +2033,7 @@ public isolated client class Client { # update_guild_widget_settings # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for update_guild_widget_settings @@ -2078,7 +2078,7 @@ public isolated client class Client { # update_webhook # - # + webhook_id - + # + webhook_id - Webhook ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for update_webhook @@ -2097,8 +2097,8 @@ public isolated client class Client { # update_webhook_by_token # - # + webhook_id - - # + webhook_token - + # + webhook_id - Webhook ID + # + webhook_token - Webhook Token # + headers - Headers to be sent with the request # + payload - # + return - 200 response for update_webhook_by_token @@ -2117,9 +2117,9 @@ public isolated client class Client { # update_webhook_message # - # + webhook_id - - # + webhook_token - - # + message_id - + # + webhook_id - Webhook ID + # + webhook_token - Webhook Token + # + message_id - Message ID # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 200 response for update_webhook_message @@ -2153,7 +2153,7 @@ public isolated client class Client { # create_application_command # - # + application_id - + # + application_id - Application ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for create_application_command @@ -2172,7 +2172,7 @@ public isolated client class Client { # create_entitlement # - # + application_id - + # + application_id - Application ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for create_entitlement @@ -2191,7 +2191,7 @@ public isolated client class Client { # consume_entitlement # - # + application_id - + # + application_id - Application ID # + entitlement_id - # + headers - Headers to be sent with the request # + return - 204 response for consume_entitlement @@ -2208,8 +2208,8 @@ public isolated client class Client { # create_guild_application_command # - # + application_id - - # + guild_id - + # + application_id - Application ID + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for create_guild_application_command @@ -2228,7 +2228,7 @@ public isolated client class Client { # follow_channel # - # + channel_id - + # + channel_id - Channel ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for follow_channel @@ -2247,7 +2247,7 @@ public isolated client class Client { # create_channel_invite # - # + channel_id - + # + channel_id - Channel ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for create_channel_invite @@ -2266,7 +2266,7 @@ public isolated client class Client { # create_message # - # + channel_id - + # + channel_id - Channel ID # + headers - Headers to be sent with the request # + return - 200 response for create_message resource isolated function post channels/[string channel_id]/messages(Create_messageHeaders headers, channel_id_messages_body payload) returns MessageResponse|error { @@ -2284,8 +2284,8 @@ public isolated client class Client { # crosspost_message # - # + channel_id - - # + message_id - + # + channel_id - Channel ID + # + message_id - Message ID # + headers - Headers to be sent with the request # + return - 200 response for crosspost_message resource isolated function post channels/[string channel_id]/messages/[string message_id]/crosspost(map headers = {}) returns MessageResponse|error { @@ -2301,8 +2301,8 @@ public isolated client class Client { # create_thread_from_message # - # + channel_id - - # + message_id - + # + channel_id - Channel ID + # + message_id - Message ID # + headers - Headers to be sent with the request # + payload - # + return - 201 response for create_thread_from_message @@ -2334,7 +2334,7 @@ public isolated client class Client { # create_thread # - # + channel_id - + # + channel_id - Channel ID # + headers - Headers to be sent with the request # + payload - # + return - 201 response for create_thread @@ -2353,7 +2353,7 @@ public isolated client class Client { # trigger_typing_indicator # - # + channel_id - + # + channel_id - Channel ID # + headers - Headers to be sent with the request # + return - 200 response for trigger_typing_indicator resource isolated function post channels/[string channel_id]/typing(map headers = {}) returns record {}|error { @@ -2369,7 +2369,7 @@ public isolated client class Client { # create_webhook # - # + channel_id - + # + channel_id - Channel ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for create_webhook @@ -2406,7 +2406,7 @@ public isolated client class Client { # create_auto_moderation_rule # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for create_auto_moderation_rule @@ -2438,7 +2438,7 @@ public isolated client class Client { # create_guild_channel # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 201 response for create_guild_channel @@ -2457,7 +2457,7 @@ public isolated client class Client { # create_guild_emoji # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 201 response for create_guild_emoji @@ -2476,7 +2476,7 @@ public isolated client class Client { # set_guild_mfa_level # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for set_guild_mfa_level @@ -2495,7 +2495,7 @@ public isolated client class Client { # prune_guild # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for prune_guild @@ -2514,7 +2514,7 @@ public isolated client class Client { # create_guild_role # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for create_guild_role @@ -2546,7 +2546,7 @@ public isolated client class Client { # create_guild_sticker # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + return - 201 response for create_guild_sticker resource isolated function post guilds/[string guild_id]/stickers(guild_id_stickers_body payload, map headers = {}) returns GuildStickerResponse|error { @@ -2564,7 +2564,7 @@ public isolated client class Client { # create_guild_template # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for create_guild_template @@ -2653,8 +2653,8 @@ public isolated client class Client { # execute_webhook # - # + webhook_id - - # + webhook_token - + # + webhook_id - Webhook ID + # + webhook_token - Webhook Token # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + payload - @@ -2675,8 +2675,8 @@ public isolated client class Client { # execute_github_compatible_webhook # - # + webhook_id - - # + webhook_token - + # + webhook_id - Webhook ID + # + webhook_token - Webhook Token # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + payload - @@ -2697,8 +2697,8 @@ public isolated client class Client { # execute_slack_compatible_webhook # - # + webhook_id - - # + webhook_token - + # + webhook_id - Webhook ID + # + webhook_token - Webhook Token # + headers - Headers to be sent with the request # + queries - Queries to be sent with the request # + return - 200 response for execute_slack_compatible_webhook @@ -2718,7 +2718,7 @@ public isolated client class Client { # bulk_set_application_commands # - # + application_id - + # + application_id - Application ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for bulk_set_application_commands @@ -2737,8 +2737,8 @@ public isolated client class Client { # bulk_set_guild_application_commands # - # + application_id - - # + guild_id - + # + application_id - Application ID + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for bulk_set_guild_application_commands @@ -2757,8 +2757,8 @@ public isolated client class Client { # set_guild_application_command_permissions # - # + application_id - - # + guild_id - + # + application_id - Application ID + # + guild_id - Guild ID # + command_id - # + headers - Headers to be sent with the request # + payload - @@ -2778,7 +2778,7 @@ public isolated client class Client { # update_application_role_connections_metadata # - # + application_id - + # + application_id - Application ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for update_application_role_connections_metadata @@ -2808,7 +2808,7 @@ public isolated client class Client { # set_channel_permission_overwrite # - # + channel_id - + # + channel_id - Channel ID # + overwrite_id - # + headers - Headers to be sent with the request # + payload - @@ -2828,8 +2828,8 @@ public isolated client class Client { # pin_message # - # + channel_id - - # + message_id - + # + channel_id - Channel ID + # + message_id - Message ID # + headers - Headers to be sent with the request # + return - 204 response for pin_message resource isolated function put channels/[string channel_id]/pins/[string message_id](map headers = {}) returns http:Response|error { @@ -2845,8 +2845,8 @@ public isolated client class Client { # add_group_dm_user # - # + channel_id - - # + user_id - + # + channel_id - Channel ID + # + user_id - User ID # + headers - Headers to be sent with the request # + payload - # + return - 201 response for add_group_dm_user @@ -2865,8 +2865,8 @@ public isolated client class Client { # add_thread_member # - # + channel_id - - # + user_id - + # + channel_id - Channel ID + # + user_id - User ID # + headers - Headers to be sent with the request # + return - 204 response for add_thread_member resource isolated function put channels/[string channel_id]/thread\-members/[string user_id](map headers = {}) returns http:Response|error { @@ -2893,8 +2893,8 @@ public isolated client class Client { # ban_user_from_guild # - # + guild_id - - # + user_id - + # + guild_id - Guild ID + # + user_id - User ID # + headers - Headers to be sent with the request # + payload - # + return - 204 response for ban_user_from_guild @@ -2913,8 +2913,8 @@ public isolated client class Client { # add_guild_member # - # + guild_id - - # + user_id - + # + guild_id - Guild ID + # + user_id - User ID # + headers - Headers to be sent with the request # + payload - # + return - 201 response for add_guild_member @@ -2933,9 +2933,9 @@ public isolated client class Client { # add_guild_member_role # - # + guild_id - - # + user_id - - # + role_id - + # + guild_id - Guild ID + # + user_id - User ID + # + role_id - Role ID # + headers - Headers to be sent with the request # + return - 204 response for add_guild_member_role resource isolated function put guilds/[string guild_id]/members/[string user_id]/roles/[string role_id](map headers = {}) returns http:Response|error { @@ -2951,7 +2951,7 @@ public isolated client class Client { # put_guilds_onboarding # - # + guild_id - + # + guild_id - Guild ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for put_guilds_onboarding @@ -2970,7 +2970,7 @@ public isolated client class Client { # sync_guild_template # - # + guild_id - + # + guild_id - Guild ID # + code - # + headers - Headers to be sent with the request # + return - 200 response for sync_guild_template From 699d3d8ff055ce5905c604196cc139c8e946f5ca Mon Sep 17 00:00:00 2001 From: Nipuna Ranasinghe Date: Thu, 27 Jun 2024 20:40:10 +0530 Subject: [PATCH 3/3] Add documentation for command ID --- ballerina/client.bal | 16 ++++++++-------- docs/spec/openapi.json | 16 ++++++++-------- docs/spec/sanitation.md | 1 + 3 files changed, 17 insertions(+), 16 deletions(-) diff --git a/ballerina/client.bal b/ballerina/client.bal index 156bd5d..ccedee5 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -66,7 +66,7 @@ public isolated client class Client { # delete_application_command # # + application_id - Application ID - # + command_id - + # + command_id - Command ID # + headers - Headers to be sent with the request # + return - 204 response for delete_application_command resource isolated function delete applications/[string application_id]/commands/[string command_id](map headers = {}) returns http:Response|error { @@ -99,7 +99,7 @@ public isolated client class Client { # # + application_id - Application ID # + guild_id - Guild ID - # + command_id - + # + command_id - Command ID # + headers - Headers to be sent with the request # + return - 204 response for delete_guild_application_command resource isolated function delete applications/[string application_id]/guilds/[string guild_id]/commands/[string command_id](map headers = {}) returns http:Response|error { @@ -590,7 +590,7 @@ public isolated client class Client { # get_application_command # # + application_id - Application ID - # + command_id - + # + command_id - Command ID # + headers - Headers to be sent with the request # + return - 200 response for get_application_command resource isolated function get applications/[string application_id]/commands/[string command_id](map headers = {}) returns ApplicationCommandResponse|error { @@ -659,7 +659,7 @@ public isolated client class Client { # # + application_id - Application ID # + guild_id - Guild ID - # + command_id - + # + command_id - Command ID # + headers - Headers to be sent with the request # + return - 200 response for get_guild_application_command resource isolated function get applications/[string application_id]/guilds/[string guild_id]/commands/[string command_id](map headers = {}) returns ApplicationCommandResponse|error { @@ -676,7 +676,7 @@ public isolated client class Client { # # + application_id - Application ID # + guild_id - Guild ID - # + command_id - + # + command_id - Command ID # + headers - Headers to be sent with the request # + return - 200 response for get_guild_application_command_permissions resource isolated function get applications/[string application_id]/guilds/[string guild_id]/commands/[string command_id]/permissions(map headers = {}) returns CommandPermissionsResponse|error { @@ -1686,7 +1686,7 @@ public isolated client class Client { # update_application_command # # + application_id - Application ID - # + command_id - + # + command_id - Command ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for update_application_command @@ -1707,7 +1707,7 @@ public isolated client class Client { # # + application_id - Application ID # + guild_id - Guild ID - # + command_id - + # + command_id - Command ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for update_guild_application_command @@ -2759,7 +2759,7 @@ public isolated client class Client { # # + application_id - Application ID # + guild_id - Guild ID - # + command_id - + # + command_id - Command ID # + headers - Headers to be sent with the request # + payload - # + return - 200 response for set_guild_application_command_permissions diff --git a/docs/spec/openapi.json b/docs/spec/openapi.json index 2eb936d..645ee21 100644 --- a/docs/spec/openapi.json +++ b/docs/spec/openapi.json @@ -1110,7 +1110,7 @@ { "name": "command_id", "in": "path", - "description": "", + "description": "Command ID", "required": true, "style": "simple", "schema": { @@ -1192,7 +1192,7 @@ { "name": "command_id", "in": "path", - "description": "", + "description": "Command ID", "required": true, "style": "simple", "schema": { @@ -1985,7 +1985,7 @@ { "name": "command_id", "in": "path", - "description": "", + "description": "Command ID", "required": true, "style": "simple", "schema": { @@ -2067,7 +2067,7 @@ { "name": "command_id", "in": "path", - "description": "", + "description": "Command ID", "required": true, "style": "simple", "schema": { @@ -2143,7 +2143,7 @@ { "name": "command_id", "in": "path", - "description": "", + "description": "Command ID", "required": true, "style": "simple", "schema": { @@ -4831,7 +4831,7 @@ { "name": "command_id", "in": "path", - "description": "", + "description": "Command ID", "required": true, "style": "simple", "schema": { @@ -4902,7 +4902,7 @@ { "name": "command_id", "in": "path", - "description": "", + "description": "Command ID", "required": true, "style": "simple", "schema": { @@ -4967,7 +4967,7 @@ { "name": "command_id", "in": "path", - "description": "", + "description": "Command ID", "required": true, "style": "simple", "schema": { diff --git a/docs/spec/sanitation.md b/docs/spec/sanitation.md index f84204d..58ac1e7 100644 --- a/docs/spec/sanitation.md +++ b/docs/spec/sanitation.md @@ -26,6 +26,7 @@ These changes are done in order to improve the overall usability, and as workaro * `webhook_id` * `webhook_token` * `role_id` + * `command_id` ## OpenAPI cli command