Skip to content

Commit 4ce5044

Browse files
committed
just some docs
1 parent 8eed8a7 commit 4ce5044

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

components/server/src/scm/scm-service.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ export class ScmService {
3737
) {}
3838

3939
/**
40+
* `getToken` allows clients to retrieve SCM tokens based on the specified host.
4041
*
4142
* @param userId subject and current user.
4243
* @param query specifies the `host` of the auth provider to search for a token.
@@ -66,7 +67,14 @@ export class ScmService {
6667
}
6768

6869
/**
69-
* `guessTokenScopes` requires the same permissions as `getToken`.
70+
* `guessTokenScopes` allows clients to retrieve scopes that would be necessary for a specified
71+
* git operation on a specified repository.
72+
*
73+
* This method requires the same permissions as `getToken`. If no token is found, this will
74+
* return the default scopes for the provider of the specified host.
75+
*
76+
* @throws 404/NOT_FOUND if the user is not found.
77+
* @throws 404/NOT_FOUND if the provider is not found.
7078
*/
7179
public async guessTokenScopes(
7280
userId: string,

0 commit comments

Comments
 (0)