Skip to content

Commit

Permalink
Add comments and fix test since removing the unused APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
stacey-gammon committed Jun 7, 2021
1 parent fa30a34 commit 2ce7f03
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
Expand Up @@ -31,12 +31,12 @@ interface StartDeps {

export interface SecurityNavControlServiceStart {
/**
* Returns an Observable of the array of user menu links registered by other plugins
* Returns an Observable of the array of user menu links (the links that show up under the users Avatar in the UI) registered by other plugins
*/
getUserMenuLinks$: () => Observable<UserMenuLink[]>;

/**
* Registers the provided user menu links to be displayed in the user menu in the global nav
* Registers the provided user menu links to be displayed in the user menu (the links that show up under the users Avatar in the UI).
*/
addUserMenuLinks: (newUserMenuLink: UserMenuLink[]) => void;
}
Expand Down
2 changes: 0 additions & 2 deletions x-pack/plugins/security/public/plugin.test.tsx
Expand Up @@ -43,7 +43,6 @@ describe('Security Plugin', () => {
}
)
).toEqual({
__legacyCompat: { logoutUrl: '/some-base-path/logout', tenant: '/some-base-path' },
authc: { getCurrentUser: expect.any(Function), areAPIKeysEnabled: expect.any(Function) },
license: {
isLicenseAvailable: expect.any(Function),
Expand All @@ -52,7 +51,6 @@ describe('Security Plugin', () => {
getFeatures: expect.any(Function),
features$: expect.any(Observable),
},
sessionTimeout: expect.any(SessionTimeout),
});
});

Expand Down
3 changes: 3 additions & 0 deletions x-pack/plugins/security/public/plugin.tsx
Expand Up @@ -176,6 +176,9 @@ export interface SecurityPluginSetup {
}

export interface SecurityPluginStart {
/**
* Exposes the ability to add custom links to the dropdown menu in the top right, where the users Avatar is.
*/
navControlService: SecurityNavControlServiceStart;
/**
* Exposes authentication information about the currently logged in user.
Expand Down

0 comments on commit 2ce7f03

Please sign in to comment.