Skip to content

Commit 8aa370b

Browse files
Stacey Gammonlegrego
andauthored
Improve security plugin return types (#101492)
* Add explicit security types * Remove sessionTimeout, seems unused * add comments * Add comments and fix test since removing the unused APIs * remove unused import * wording cleanup * Export some types that are part of the public API but not exported * more improvements for api docs * update security docs * Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx Co-authored-by: Larry Gregory <lgregorydev@gmail.com> * Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx Co-authored-by: Larry Gregory <lgregorydev@gmail.com> * Update x-pack/plugins/security/public/plugin.tsx Co-authored-by: Larry Gregory <lgregorydev@gmail.com> * Update x-pack/plugins/security/public/plugin.tsx Co-authored-by: Larry Gregory <lgregorydev@gmail.com> * remove unneccessary readonly prefix * Update all api docs Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
1 parent bdafd27 commit 8aa370b

31 files changed

+1309
-1245
lines changed

api_docs/cases.json

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -347,17 +347,13 @@
347347
"label": "security",
348348
"description": [],
349349
"signature": [
350-
"{ authc: ",
351-
"AuthenticationServiceSetup",
352-
"; sessionTimeout: ",
353-
"SessionTimeout",
354-
"; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ",
355-
"SecurityLicenseFeatures",
356-
"; features$: ",
357-
"Observable",
358-
"<",
359-
"SecurityLicenseFeatures",
360-
">; }>; __legacyCompat: { logoutUrl: string; tenant: string; }; }"
350+
{
351+
"pluginId": "security",
352+
"scope": "public",
353+
"docId": "kibSecurityPluginApi",
354+
"section": "def-public.SecurityPluginSetup",
355+
"text": "SecurityPluginSetup"
356+
}
361357
],
362358
"source": {
363359
"path": "x-pack/plugins/cases/public/types.ts",
@@ -456,17 +452,15 @@
456452
"section": "def-public.StartPlugins",
457453
"text": "StartPlugins"
458454
},
459-
" & { security: { authc: ",
460-
"AuthenticationServiceSetup",
461-
"; sessionTimeout: ",
462-
"SessionTimeout",
463-
"; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ",
464-
"SecurityLicenseFeatures",
465-
"; features$: ",
466-
"Observable",
467-
"<",
468-
"SecurityLicenseFeatures",
469-
">; }>; __legacyCompat: { logoutUrl: string; tenant: string; }; }; }"
455+
" & { security: ",
456+
{
457+
"pluginId": "security",
458+
"scope": "public",
459+
"docId": "kibSecurityPluginApi",
460+
"section": "def-public.SecurityPluginSetup",
461+
"text": "SecurityPluginSetup"
462+
},
463+
"; }"
470464
],
471465
"source": {
472466
"path": "x-pack/plugins/cases/public/types.ts",

0 commit comments

Comments
 (0)