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 <[email protected]> * Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx Co-authored-by: Larry Gregory <[email protected]> * Update x-pack/plugins/security/public/plugin.tsx Co-authored-by: Larry Gregory <[email protected]> * Update x-pack/plugins/security/public/plugin.tsx Co-authored-by: Larry Gregory <[email protected]> * remove unneccessary readonly prefix * Update all api docs Co-authored-by: Larry Gregory <[email protected]>
elastic · Jun 8, 2021 · 8aa370b · 8aa370b
1 parent bdafd27
commit 8aa370b
Show file tree

Hide file tree

Showing 31 changed files with 1,309 additions and 1,245 deletions.
diff --git a/api_docs/cases.json b/api_docs/cases.json
@@ -347,17 +347,13 @@
             "label": "security",
             "description": [],
             "signature": [
-              "{ authc: ",
-              "AuthenticationServiceSetup",
-              "; sessionTimeout: ",
-              "SessionTimeout",
-              "; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ",
-              "SecurityLicenseFeatures",
-              "; features$: ",
-              "Observable",
-              "<",
-              "SecurityLicenseFeatures",
-              ">; }>; __legacyCompat: { logoutUrl: string; tenant: string; }; }"
+              {
+                "pluginId": "security",
+                "scope": "public",
+                "docId": "kibSecurityPluginApi",
+                "section": "def-public.SecurityPluginSetup",
+                "text": "SecurityPluginSetup"
+              }
             ],
             "source": {
               "path": "x-pack/plugins/cases/public/types.ts",
@@ -456,17 +452,15 @@
             "section": "def-public.StartPlugins",
             "text": "StartPlugins"
           },
-          " & { security: { authc: ",
-          "AuthenticationServiceSetup",
-          "; sessionTimeout: ",
-          "SessionTimeout",
-          "; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ",
-          "SecurityLicenseFeatures",
-          "; features$: ",
-          "Observable",
-          "<",
-          "SecurityLicenseFeatures",
-          ">; }>; __legacyCompat: { logoutUrl: string; tenant: string; }; }; }"
+          " & { security: ",
+          {
+            "pluginId": "security",
+            "scope": "public",
+            "docId": "kibSecurityPluginApi",
+            "section": "def-public.SecurityPluginSetup",
+            "text": "SecurityPluginSetup"
+          },
+          "; }"
         ],
         "source": {
           "path": "x-pack/plugins/cases/public/types.ts",