docs(Activity): add documentation for buttons

discordjs · Apr 10, 2021 · 6e9c820 · 6e9c820
1 parent ab8b289
commit 6e9c820
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/deno/payloads/v8/gateway.ts b/deno/payloads/v8/gateway.ts
@@ -201,6 +201,9 @@ export interface GatewayActivity {
 	 * See https://en.wikipedia.org/wiki/Bit_field
 	 */
 	flags?: ActivityFlags;
+	/**
+	 * The custom buttons shown in the Rich Presence (max 2)
+	 */
 	buttons?: string[] | GatewayActivityButton[];
 }
 
@@ -298,6 +301,12 @@ export enum ActivityFlags {
 }
 
 export interface GatewayActivityButton {
+	/**
+	 * The text shown on the button (1-32 characters)
+	 */
 	label: string;
+	/**
+	 * The url opened when clicking the button (1-512 characters)
+	 */
 	url: string;
 }
diff --git a/deno/rest/v8/oauth2.ts b/deno/rest/v8/oauth2.ts
@@ -57,7 +57,6 @@ export interface RESTPostOAuth2AccessTokenURLEncodedData {
 	grant_type: 'authorization_code';
 	code: string;
 	redirect_uri?: string;
-	scope: string;
 }
 
 /**
@@ -80,7 +79,7 @@ export interface RESTPostOAuth2RefreshTokenURLEncodedData {
 	grant_type: 'refresh_token';
 	refresh_token: string;
 	redirect_uri?: string;
-	scope: string;
+	scope?: string;
 }
 
 export type RESTPostOAuth2RefreshTokenResult = RESTPostOAuth2AccessTokenResult;

diff --git a/payloads/v8/gateway.ts b/payloads/v8/gateway.ts
@@ -201,6 +201,9 @@ export interface GatewayActivity {
 	 * See https://en.wikipedia.org/wiki/Bit_field
 	 */
 	flags?: ActivityFlags;
+	/**
+	 * The custom buttons shown in the Rich Presence (max 2)
+	 */
 	buttons?: string[] | GatewayActivityButton[];
 }
 
@@ -298,6 +301,12 @@ export const enum ActivityFlags {
 }
 
 export interface GatewayActivityButton {
+	/**
+	 * The text shown on the button (1-32 characters)
+	 */
 	label: string;
+	/**
+	 * The url opened when clicking the button (1-512 characters)
+	 */
 	url: string;
 }