Add more context for how to make a custom SCM Auth provider work

Signed-off-by: Brian Phillips <28457+brianphillips@users.noreply.github.com>
2023-05-01 23:34:05 -05:00
parent d1797f0e91
commit ffeb1c3784
1 changed files with 22 additions and 1 deletions
@@ -348,7 +348,28 @@ const gheAuthApiRef: ApiRef<OAuthApi & ProfileInfoApi & SessionApi> =
  });
 ```

-The new ref is then used to add a new provider to the ApiFactory:
+This new API ref will only work if you define an API factory for it. For example:
+
+```ts
+createApiFactory({
+  api: gheAuthApiRef,
+  deps: {
+    discoveryApi: discoveryApiRef,
+    oauthRequestApi: oauthRequestApiRef,
+    configApi: configApiRef,
+  },
+  factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
+    GithubAuth.create({
+      configApi,
+      discoveryApi,
+      oauthRequestApi,
+      defaultScopes: ['read:user'],
+      environment: configApi.getOptionalString('auth.environment'),
+    }),
+});
+```
+
+The new API ref is then used to add a new provider to the ApiFactory:

 ```ts
 createApiFactory({