Skip to content

Commit 2ffc3ed

Browse files
committed
docs(rest): add api reference links to interfaces
1 parent 676ae5a commit 2ffc3ed

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

rest/v2/application.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,17 @@ export interface RESTPostAPIApplicationUploadFormDataBody {
4444
file: unknown;
4545
}
4646

47+
/**
48+
* @see https://docs.squarecloud.app/api-reference/endpoint/apps/upload
49+
*/
4750
export interface RESTPostAPIApplicationUploadResultLanguage {
4851
name: ApplicationLanguage;
4952
version: string;
5053
}
5154

55+
/**
56+
* @see https://docs.squarecloud.app/api-reference/endpoint/apps/upload
57+
*/
5258
export interface RESTPostAPIApplicationUploadResult {
5359
id: ApplicationId;
5460
name: string;

rest/v2/deploy.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ export interface RESTPostAPIGithubWebhookJSONBody {
77
access_token: string;
88
}
99

10+
/**
11+
* @see https://docs.squarecloud.app/api-reference/endpoint/apps/deploy/webhooks
12+
*/
1013
export interface RESTPostAPIGithubWebhookResult {
1114
webhook: string;
1215
}

rest/v2/network.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,4 @@ export interface RESTPostAPINetworkCustomDomainJSONBody {
77
custom: string;
88
}
99

10-
/**
11-
* @see https://docs.squarecloud.app/api-reference/endpoint/apps/network/custom
12-
*/
1310
export type RESTPostAPINetworkCustomDomainResultPayload = APIPayloadStatusOnly;

0 commit comments

Comments
 (0)