Fix broken API explorer

SteeltoeOSS · Jul 13, 2023 · 74b269f · 74b269f
1 parent 9e3c666
commit 74b269f
Show file tree

Hide file tree

Showing 11 changed files with 193 additions and 81 deletions.
diff --git a/api-all.json b/api-all.json
@@ -34,7 +34,7 @@
     "disableDefaultFilter": false,
     "filter": "api-filter.yml",
     "properties": {
-      "TargetFramework": "net6.0"
+      "TargetFramework": "net5.0"
     },
     "version": "3.all"
   },

diff --git a/api-filter.yml b/api-filter.yml
@@ -1,4 +1,12 @@
 apiRules:
+# Excluding types in global namespace, originating from Management/.../DotNetHeapDump
+- exclude:
+    uidRegex: ^$
+    type: Namespace
+# Excluding types in Graphs namespace, originating from Management/.../DotNetHeapDump
+- exclude:
+    uidRegex: ^Graphs
+    type: Namespace
 - exclude:
     uidRegex: ^OpenCensus\.*
     type: Namespace

diff --git a/api-v2.json b/api-v2.json
@@ -95,25 +95,6 @@
       },
       "version": "2.x"
     },
-  {
-    "src": [
-      {
-        "files": [
-          "**/*.csproj"
-        ],
-        "exclude": [ "**/bin/**", "**/obj/**" ],
-        "src": "sources/v2/src/Integration/src"
-      }
-    ],
-    "dest": "api/browser/v2/integration",
-    "disableGitFeatures": false,
-    "disableDefaultFilter": false,
-    "filter": "api-filter.yml",
-    "properties": {
-      "TargetFramework": "netcoreapp3.1"
-    },
-    "version": "2.x"
-  },
     {
       "src": [
         {
@@ -170,25 +151,6 @@
         "TargetFramework": "netcoreapp3.1"
       },
       "version": "2.x"
-  },
-  {
-    "src": [
-      {
-        "files": [
-          "**/*.csproj"
-        ],
-        "exclude": [ "**/bin/**", "**/obj/**" ],
-        "src": "sources/v2/src/Stream/src"
-      }
-    ],
-    "dest": "api/browser/v2/stream",
-    "disableGitFeatures": false,
-    "disableDefaultFilter": false,
-    "filter": "api-filter.yml",
-    "properties": {
-      "TargetFramework": "netcoreapp3.1"
-    },
-    "version": "2.x"
     }
   ]
 }
diff --git a/api-v3.json b/api-v3.json
@@ -1,5 +1,24 @@
 {
   "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "exclude": [ "**/bin/**", "**/obj/**" ],
+          "src": "sources/v3/src/Bootstrap/src"
+        }
+      ],
+      "dest": "api/browser/v3/bootstrap",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "filter": "api-filter.yml",
+      "properties": {
+        "TargetFramework": "net5.0"
+      },
+      "version": "3.x"
+    },
     {
       "src": [
         {

diff --git a/api-v4.json b/api-v4.json
@@ -1,5 +1,24 @@
 {
   "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "exclude": [ "**/bin/**", "**/obj/**" ],
+          "src": "sources/v4/src/Bootstrap/src"
+        }
+      ],
+      "dest": "api/browser/v4/bootstrap",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "filter": "api-filter.yml",
+      "properties": {
+        "TargetFramework": "net6.0"
+      },
+      "version": "4.x"
+    },
     {
       "src": [
         {

diff --git a/api/browser/v2/all/index.md b/api/browser/v2/all/index.md
@@ -13,7 +13,13 @@ uid: api/browser/v2/all/index
 
 Steeltoe's port of [Netflix Hystrix](https://github.com/Netflix/Hystrix) to .NET.
 
-[view](/api/browser/v2/all/Steeltoe.CircuitBreaker.Hystrix.html)
+[view](/api/browser/v2/circuitbreaker/Steeltoe.CircuitBreaker.Hystrix.html)
+
+## Steeltoe Common
+
+Contains several packages that are common to other Steeltoe components.
+
+[view](/api/browser/v2/common/Steeltoe.Common.html)
 
 ## Steeltoe Configuration Providers
 
@@ -37,7 +43,7 @@ Contains packages for interacting with service registries.
 
 Logging extensions that, when used with Steeltoe Management, enable changing the Logging levels for a running application at run-time, without restarting the app.
 
-Currently supporting the Microsoft Console Logger and Serilog.
+Currently supports the Microsoft Console Logger and Serilog.
 
 [view](/api/browser/v2/logging/Steeltoe.Extensions.Logging.html)
 

diff --git a/api/browser/v3/all/index.md b/api/browser/v3/all/index.md
@@ -9,11 +9,23 @@ uid: api/browser/v3/all/index
 
 # Steeltoe Namespaces
 
+## Steeltoe Bootstrap
+
+Extension methods on host-builders that automatically activate Steeltoe features, based on the assemblies used by your app.
+
+[view](/api/browser/v3/bootstrap/Steeltoe.Bootstrap.AutoConfig.html)
+
 ## Steeltoe Circuit Breaker
 
 Steeltoe's port of [Netflix Hystrix](https://github.com/Netflix/Hystrix) to .NET.
 
-[view](/api/browser/v3/all/Steeltoe.CircuitBreaker.html)
+[view](/api/browser/v3/circuitbreaker/Steeltoe.CircuitBreaker.html)
+
+## Steeltoe Common
+
+Contains several packages that are common to other Steeltoe components.
+
+[view](/api/browser/v3/common/Steeltoe.Common.html)
 
 ## Steeltoe Configuration Providers
 
@@ -33,11 +45,17 @@ Contains packages for interacting with service registries.
 
 [view](/api/browser/v3/discovery/Steeltoe.Discovery.html)
 
+## Steeltoe Integration
+
+Contains packages for messaging integrations.
+
+[view](/api/browser/v3/integration/Steeltoe.Integration.html)
+
 ## Steeltoe Logging Extensions
 
 Logging extensions that, when used with Steeltoe Management, enable changing the Logging levels for a running application at run-time, without restarting the app.
 
-Currently supporting the Microsoft Console Logger and Serilog.
+Currently supports the Microsoft Console Logger and Serilog.
 
 [view](/api/browser/v3/logging/Steeltoe.Extensions.Logging.html)
 
@@ -47,8 +65,20 @@ Management tools to help manage and monitor your applications.
 
 [view](/api/browser/v3/management/Steeltoe.Management.html)
 
+## Steeltoe Messaging
+
+Contains messaging support for RabbitMQ.
+
+[view](/api/browser/v3/messaging/Steeltoe.Messaging.html)
+
 ## Steeltoe Security
 
 Authentication and DataProtection libraries which simplify interacting with CredHub and using security services on CloudFoundry.
 
 [view](/api/browser/v3/security/Steeltoe.Security.Authentication.CloudFoundry.html)
+
+## Steeltoe Stream
+
+Contains streaming support for RabbitMQ.
+
+[view](/api/browser/v3/stream/Steeltoe.Stream.Extensions.html)
diff --git a/api/browser/v4/all/index.md b/api/browser/v4/all/index.md
@@ -9,6 +9,18 @@ uid: api/browser/v4/all/index
 
 # Steeltoe Namespaces
 
+## Steeltoe Bootstrap
+
+Extension methods on host-builders that automatically activate Steeltoe features, based on the assemblies used by your app.
+
+[view](/api/browser/v4/bootstrap/Steeltoe.Bootstrap.AutoConfiguration.html)
+
+## Steeltoe Common
+
+Contains several packages that are common to other Steeltoe components.
+
+[view](/api/browser/v4/common/Steeltoe.Common.html)
+
 ## Steeltoe Configuration Providers
 
 [Custom configuration providers](https://docs.microsoft.com/aspnet/core/fundamentals/configuration/#custom-config-providers) for use with Microsoft's [application configuration](https://docs.microsoft.com/aspnet/core/fundamentals/configuration/) for accessing configuration settings for an application.
@@ -27,11 +39,17 @@ Contains packages for interacting with service registries.
 
 [view](/api/browser/v4/discovery/Steeltoe.Discovery.html)
 
+## Steeltoe Integration
+
+Contains packages for messaging integrations.
+
+[view](/api/browser/v4/integration/Steeltoe.Integration.html)
+
 ## Steeltoe Logging Extensions
 
 Logging extensions that, when used with Steeltoe Management, enable changing the Logging levels for a running application at run-time, without restarting the app.
 
-Currently supporting the Microsoft Console Logger and Serilog.
+Currently supports the Microsoft Console Logger and Serilog.
 
 [view](/api/browser/v4/logging/Steeltoe.Logging.html)
 
@@ -41,8 +59,20 @@ Management tools to help manage and monitor your applications.
 
 [view](/api/browser/v4/management/Steeltoe.Management.html)
 
+## Steeltoe Messaging
+
+Contains messaging support for RabbitMQ.
+
+[view](/api/browser/v4/messaging/Steeltoe.Messaging.html)
+
 ## Steeltoe Security
 
-Authentication and DataProtection libraries which simplify interacting with CredHub and using security services on CloudFoundry.
+Authentication and DataProtection libraries using security services on CloudFoundry.
 
 [view](/api/browser/v4/security/Steeltoe.Security.Authentication.CloudFoundry.html)
+
+## Steeltoe Stream
+
+Contains streaming support for RabbitMQ.
+
+[view](/api/browser/v4/stream/Steeltoe.Stream.Extensions.html)
diff --git a/template/steeltoe/partials/toc.tmpl.partial b/template/steeltoe/partials/toc.tmpl.partial
@@ -9,48 +9,66 @@
       <div id="close-sidenav">
         <a class="mobile-toc-showhide" onclick="showMobileToc(); return false;">X</a>
       </div>
-      <div class="dropdown">
+      <div id="version-toggles" class="btn-group btn-group-toggle btn-group-justified" data-toggle="buttons">
-        <button class="btn btn-secondary dropdown-toggle btn-group-justified" type="button" id="dropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="true">
+        <label class="btn btn-secondary versionLabel" onclick="location.href='/api/v4/welcome'">
-          Select Steeltoe version
+          <input type="radio" name="options" id="v4" autocomplete="off"> V4
-        </button>
+        </label>
-
+        <label class="btn btn-secondary versionLabel" onclick="location.href='/api/v3/welcome'">
-        <div class="dropdown-menu" aria-labelledby="dropdownMenuLink">
+          <input type="radio" name="options" id="v3" autocomplete="off"> V3
-          <a class="dropdown-item" href="/api/v2/welcome">Version 2</a>
+        </label>
-          <a class="dropdown-item" href="/api/v3/welcome">Version 3</a>
+        <label class="btn btn-secondary versionLabel" onclick="location.href='/api/v2/welcome'">
-          <a class="dropdown-item" href="/api/v4/welcome">Version 4</a>
+          <input type="radio" name="options" id="v2" autocomplete="off"> V2
-        </div>
+        </label>
+        <label class="btn btn-secondary versionLabel hide" onclick="location.href='/api/browser/v4/all'">
+          <input type="radio" name="optionsApi" id="api-v4" autocomplete="off"> V4
+        </label>
+        <label class="btn btn-secondary versionLabel hide" onclick="location.href='/api/browser/v3/all'">
+          <input type="radio" name="optionsApi" id="api-v3" autocomplete="off"> V3
+        </label>
+        <label class="btn btn-secondary versionLabel hide" onclick="location.href='/api/browser/v2/all'">
+          <input type="radio" name="optionsApi" id="api-v2" autocomplete="off"> V2
+        </label>
       </div>
       <div id="api-navigation" class="hide">
         <div id="api-selection">
-            <select id="api-namespace-v4" class="form-control api-namespace">
+            <select id="api-namespace-v4" class="form-control api-namespace hide">
-              <option value="/api/browser/v4/all/">All Namespaces</option>
+              <option value="/api/browser/v4/all/">All namespaces</option>
+              <option value="/api/browser/v4/bootstrap/Steeltoe.Bootstrap.AutoConfiguration.html">Steeltoe.Bootstrap</option>
+              <option value="/api/browser/v4/common/Steeltoe.Common.html">Steeltoe.Common</option>
               <option value="/api/browser/v4/configuration/Steeltoe.Configuration.html">Steeltoe.Configuration</option>
               <option value="/api/browser/v4/connectors/Steeltoe.Connectors.html">Steeltoe.Connectors</option>
               <option value="/api/browser/v4/discovery/Steeltoe.Discovery.html">Steeltoe.Discovery</option>
+              <option value="/api/browser/v4/integration/Steeltoe.Integration.html">Steeltoe.Integration</option>
               <option value="/api/browser/v4/logging/Steeltoe.Logging.html">Steeltoe.Logging</option>
               <option value="/api/browser/v4/management/Steeltoe.Management.html">Steeltoe.Management</option>
               <option value="/api/browser/v4/messaging/Steeltoe.Messaging.html">Steeltoe.Messaging</option>
               <option value="/api/browser/v4/security/Steeltoe.Security.Authentication.CloudFoundry.html">Steeltoe.Security</option>
+              <option value="/api/browser/v4/stream/Steeltoe.Stream.Extensions.html">Steeltoe.Stream</option>
             </select>
-            <select id="api-namespace-v3" class="form-control api-namespace">
+            <select id="api-namespace-v3" class="form-control api-namespace hide">
-              <option value="/api/browser/v3/all/">All Namespaces</option>
+              <option value="/api/browser/v3/all/">All namespaces</option>
+              <option value="/api/browser/v3/bootstrap/Steeltoe.Bootstrap.AutoConfig.html">Steeltoe.Bootstrap</option>
               <option value="/api/browser/v3/circuitbreaker/Steeltoe.CircuitBreaker.html">Steeltoe.CircuitBreaker</option>
+              <option value="/api/browser/v3/common/Steeltoe.Common.html">Steeltoe.Common</option>
               <option value="/api/browser/v3/configuration/Steeltoe.Extensions.Configuration.html">Steeltoe.Extensions.Configuration</option>
               <option value="/api/browser/v3/connectors/Steeltoe.Connector.html">Steeltoe.Connector</option>
               <option value="/api/browser/v3/discovery/Steeltoe.Discovery.html">Steeltoe.Discovery</option>
+              <option value="/api/browser/v3/integration/Steeltoe.Integration.html">Steeltoe.Integration</option>
               <option value="/api/browser/v3/logging/Steeltoe.Extensions.Logging.html">Steeltoe.Extensions.Logging</option>
               <option value="/api/browser/v3/management/Steeltoe.Management.html">Steeltoe.Management</option>
               <option value="/api/browser/v3/messaging/Steeltoe.Messaging.html">Steeltoe.Messaging</option>
               <option value="/api/browser/v3/security/Steeltoe.Security.Authentication.CloudFoundry.html">Steeltoe.Security</option>
+              <option value="/api/browser/v3/stream/Steeltoe.Stream.Extensions.html">Steeltoe.Stream</option>
             </select>
             <select id="api-namespace-v2" class="form-control api-namespace hide">
-              <option value="/api/browser/v2/all/">All Namespaces</option>
+              <option value="/api/browser/v2/all/">All namespaces</option>
               <option value="/api/browser/v2/circuitbreaker/Steeltoe.CircuitBreaker.Hystrix.html">Steeltoe.CircuitBreaker</option>
+              <option value="/api/browser/v2/common/Steeltoe.Common.html">Steeltoe.Common</option>
               <option value="/api/browser/v2/configuration/Steeltoe.Extensions.Configuration.html">Steeltoe.Extensions.Configuration</option>
               <option value="/api/browser/v2/connectors/Steeltoe.CloudFoundry.Connector.html">Steeltoe.Connector</option>
               <option value="/api/browser/v2/discovery/Steeltoe.Discovery.html">Steeltoe.Discovery</option>
               <option value="/api/browser/v2/logging/Steeltoe.Extensions.Logging.html">Steeltoe.Extensions.Logging</option>
-              <option value="/api/browser/v2/management/management/Steeltoe.Management.Census.Stats.html">Steeltoe.Management</option>
+              <option value="/api/browser/v2/management/Steeltoe.Management.CloudFoundry.html">Steeltoe.Management</option>
               <option value="/api/browser/v2/security/Steeltoe.Security.Authentication.CloudFoundry.html">Steeltoe.Security</option>
             </select>
           </div>

diff --git a/template/steeltoe/styles/main.css b/template/steeltoe/styles/main.css
@@ -434,7 +434,7 @@ ul.breadcrumb > :first-child {
 }
 
 .api-browser .sidetoc {
-	top: 252px;
+	top: 288px;
     z-index: 25;
 }