fix(CDNRoutes): inconsistency in route and wrong JSDoc (#1033)

Backiscute · web-flow · commit eb7b3d90dd6a · 2024-07-20T12:13:31.000+03:00
diff --git a/deno/rest/v10/mod.ts b/deno/rest/v10/mod.ts
@@ -1015,14 +1015,14 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `/guilds/{guild.id}/icons/{guild.id}.{png|jpeg|webp|gif}`
+	 * - GET `/icons/{guild.id}/{guild.icon}.{png|jpeg|webp|gif}`
 	 *
 	 * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
 	 *
 	 * This route supports the extensions: PNG, JPEG, WebP, GIF
 	 */
 	guildIcon<Format extends GuildIconFormat>(guildId: Snowflake, guildIcon: string, format: Format) {
-		return `icons/${guildId}/${guildIcon}.${format}` as const;
+		return `/icons/${guildId}/${guildIcon}.${format}` as const;
 	},
 
 	/**
@@ -1101,7 +1101,7 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `/guilds/{guild.id}/users/{user.id}/{guild_member.avatar}.{png|jpeg|webp|gif}`
+	 * - GET `/guilds/{guild.id}/users/{user.id}/avatars/{guild_member.avatar}.{png|jpeg|webp|gif}`
 	 *
 	 * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
 	 *
@@ -1221,7 +1221,7 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `team-icons/{team.id}/{team.icon}.{png|jpeg|webp}`
+	 * - GET `/team-icons/{team.id}/{team.icon}.{png|jpeg|webp}`
 	 *
 	 * This route supports the extensions: PNG, JPEG, WebP
 	 */
diff --git a/deno/rest/v9/mod.ts b/deno/rest/v9/mod.ts
@@ -1024,14 +1024,14 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `/guilds/{guild.id}/icons/{guild.id}.{png|jpeg|webp|gif}`
+	 * - GET `/icons/{guild.id}/{guild.icon}.{png|jpeg|webp|gif}`
 	 *
 	 * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
 	 *
 	 * This route supports the extensions: PNG, JPEG, WebP, GIF
 	 */
 	guildIcon<Format extends GuildIconFormat>(guildId: Snowflake, guildIcon: string, format: Format) {
-		return `icons/${guildId}/${guildIcon}.${format}` as const;
+		return `/icons/${guildId}/${guildIcon}.${format}` as const;
 	},
 
 	/**
@@ -1110,7 +1110,7 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `/guilds/{guild.id}/users/{user.id}/{guild_member.avatar}.{png|jpeg|webp|gif}`
+	 * - GET `/guilds/{guild.id}/users/{user.id}/avatars/{guild_member.avatar}.{png|jpeg|webp|gif}`
 	 *
 	 * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
 	 *
@@ -1230,7 +1230,7 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `team-icons/{team.id}/{team.icon}.{png|jpeg|webp}`
+	 * - GET `/team-icons/{team.id}/{team.icon}.{png|jpeg|webp}`
 	 *
 	 * This route supports the extensions: PNG, JPEG, WebP
 	 */
diff --git a/rest/v10/index.ts b/rest/v10/index.ts
@@ -1015,14 +1015,14 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `/guilds/{guild.id}/icons/{guild.id}.{png|jpeg|webp|gif}`
+	 * - GET `/icons/{guild.id}/{guild.icon}.{png|jpeg|webp|gif}`
 	 *
 	 * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
 	 *
 	 * This route supports the extensions: PNG, JPEG, WebP, GIF
 	 */
 	guildIcon<Format extends GuildIconFormat>(guildId: Snowflake, guildIcon: string, format: Format) {
-		return `icons/${guildId}/${guildIcon}.${format}` as const;
+		return `/icons/${guildId}/${guildIcon}.${format}` as const;
 	},
 
 	/**
@@ -1101,7 +1101,7 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `/guilds/{guild.id}/users/{user.id}/{guild_member.avatar}.{png|jpeg|webp|gif}`
+	 * - GET `/guilds/{guild.id}/users/{user.id}/avatars/{guild_member.avatar}.{png|jpeg|webp|gif}`
 	 *
 	 * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
 	 *
@@ -1221,7 +1221,7 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `team-icons/{team.id}/{team.icon}.{png|jpeg|webp}`
+	 * - GET `/team-icons/{team.id}/{team.icon}.{png|jpeg|webp}`
 	 *
 	 * This route supports the extensions: PNG, JPEG, WebP
 	 */
diff --git a/rest/v9/index.ts b/rest/v9/index.ts
@@ -1024,14 +1024,14 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `/guilds/{guild.id}/icons/{guild.id}.{png|jpeg|webp|gif}`
+	 * - GET `/icons/{guild.id}/{guild.icon}.{png|jpeg|webp|gif}`
 	 *
 	 * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
 	 *
 	 * This route supports the extensions: PNG, JPEG, WebP, GIF
 	 */
 	guildIcon<Format extends GuildIconFormat>(guildId: Snowflake, guildIcon: string, format: Format) {
-		return `icons/${guildId}/${guildIcon}.${format}` as const;
+		return `/icons/${guildId}/${guildIcon}.${format}` as const;
 	},
 
 	/**
@@ -1110,7 +1110,7 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `/guilds/{guild.id}/users/{user.id}/{guild_member.avatar}.{png|jpeg|webp|gif}`
+	 * - GET `/guilds/{guild.id}/users/{user.id}/avatars/{guild_member.avatar}.{png|jpeg|webp|gif}`
 	 *
 	 * As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
 	 *
@@ -1230,7 +1230,7 @@ export const CDNRoutes = {
 
 	/**
 	 * Route for:
-	 * - GET `team-icons/{team.id}/{team.icon}.{png|jpeg|webp}`
+	 * - GET `/team-icons/{team.id}/{team.icon}.{png|jpeg|webp}`
 	 *
 	 * This route supports the extensions: PNG, JPEG, WebP
 	 */

Original file line number	Diff line number	Diff line change
`@@ -1015,14 +1015,14 @@ export const CDNRoutes = {`
`1015`	`1015`
`1016`	`1016`	`/**`
`1017`	`1017`	`* Route for:`
`1018`		- * - GET `/guilds/{guild.id}/icons/{guild.id}.{png\|jpeg\|webp\|gif}`
	`1018`	+ * - GET `/icons/{guild.id}/{guild.icon}.{png\|jpeg\|webp\|gif}`
`1019`	`1019`	`*`
`1020`	`1020`	* As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
`1021`	`1021`	`*`
`1022`	`1022`	`* This route supports the extensions: PNG, JPEG, WebP, GIF`
`1023`	`1023`	`*/`
`1024`	`1024`	`guildIcon<Format extends GuildIconFormat>(guildId: Snowflake, guildIcon: string, format: Format) {`
`1025`		- return `icons/${guildId}/${guildIcon}.${format}` as const;
	`1025`	+ return `/icons/${guildId}/${guildIcon}.${format}` as const;
`1026`	`1026`	`},`
`1027`	`1027`
`1028`	`1028`	`/**`
`@@ -1101,7 +1101,7 @@ export const CDNRoutes = {`
`1101`	`1101`
`1102`	`1102`	`/**`
`1103`	`1103`	`* Route for:`
`1104`		- * - GET `/guilds/{guild.id}/users/{user.id}/{guild_member.avatar}.{png\|jpeg\|webp\|gif}`
	`1104`	+ * - GET `/guilds/{guild.id}/users/{user.id}/avatars/{guild_member.avatar}.{png\|jpeg\|webp\|gif}`
`1105`	`1105`	`*`
`1106`	`1106`	* As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
`1107`	`1107`	`*`
`@@ -1221,7 +1221,7 @@ export const CDNRoutes = {`
`1221`	`1221`
`1222`	`1222`	`/**`
`1223`	`1223`	`* Route for:`
`1224`		- * - GET `team-icons/{team.id}/{team.icon}.{png\|jpeg\|webp}`
	`1224`	+ * - GET `/team-icons/{team.id}/{team.icon}.{png\|jpeg\|webp}`
`1225`	`1225`	`*`
`1226`	`1226`	`* This route supports the extensions: PNG, JPEG, WebP`
`1227`	`1227`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -1024,14 +1024,14 @@ export const CDNRoutes = {`
`1024`	`1024`
`1025`	`1025`	`/**`
`1026`	`1026`	`* Route for:`
`1027`		- * - GET `/guilds/{guild.id}/icons/{guild.id}.{png\|jpeg\|webp\|gif}`
	`1027`	+ * - GET `/icons/{guild.id}/{guild.icon}.{png\|jpeg\|webp\|gif}`
`1028`	`1028`	`*`
`1029`	`1029`	* As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
`1030`	`1030`	`*`
`1031`	`1031`	`* This route supports the extensions: PNG, JPEG, WebP, GIF`
`1032`	`1032`	`*/`
`1033`	`1033`	`guildIcon<Format extends GuildIconFormat>(guildId: Snowflake, guildIcon: string, format: Format) {`
`1034`		- return `icons/${guildId}/${guildIcon}.${format}` as const;
	`1034`	+ return `/icons/${guildId}/${guildIcon}.${format}` as const;
`1035`	`1035`	`},`
`1036`	`1036`
`1037`	`1037`	`/**`
`@@ -1110,7 +1110,7 @@ export const CDNRoutes = {`
`1110`	`1110`
`1111`	`1111`	`/**`
`1112`	`1112`	`* Route for:`
`1113`		- * - GET `/guilds/{guild.id}/users/{user.id}/{guild_member.avatar}.{png\|jpeg\|webp\|gif}`
	`1113`	+ * - GET `/guilds/{guild.id}/users/{user.id}/avatars/{guild_member.avatar}.{png\|jpeg\|webp\|gif}`
`1114`	`1114`	`*`
`1115`	`1115`	* As this route supports GIFs, the hash will begin with `a_` if it is available in GIF format
`1116`	`1116`	`*`
`@@ -1230,7 +1230,7 @@ export const CDNRoutes = {`
`1230`	`1230`
`1231`	`1231`	`/**`
`1232`	`1232`	`* Route for:`
`1233`		- * - GET `team-icons/{team.id}/{team.icon}.{png\|jpeg\|webp}`
	`1233`	+ * - GET `/team-icons/{team.id}/{team.icon}.{png\|jpeg\|webp}`
`1234`	`1234`	`*`
`1235`	`1235`	`* This route supports the extensions: PNG, JPEG, WebP`
`1236`	`1236`	`*/`