Skip to content

Commit

Permalink
just some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexTugarev committed Nov 22, 2023
1 parent 8eed8a7 commit 4ce5044
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion components/server/src/scm/scm-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ export class ScmService {
) {}

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

/**
* `guessTokenScopes` requires the same permissions as `getToken`.
* `guessTokenScopes` allows clients to retrieve scopes that would be necessary for a specified
* git operation on a specified repository.
*
* This method requires the same permissions as `getToken`. If no token is found, this will
* return the default scopes for the provider of the specified host.
*
* @throws 404/NOT_FOUND if the user is not found.
* @throws 404/NOT_FOUND if the provider is not found.
*/
public async guessTokenScopes(
userId: string,
Expand Down

0 comments on commit 4ce5044

Please sign in to comment.