From 7d8a603cf6eb427af81a5986ff8846f9e4e9c052 Mon Sep 17 00:00:00 2001
From: Sebastian <sebastian@squidex.io>
Date: Wed, 11 Mar 2020 17:13:02 +0100
Subject: [PATCH] Fix the API docs.

---
 .../Controllers/Apps/AppPatternsController.cs |  4 ++--
 .../Controllers/Apps/AppRolesController.cs    |  2 +-
 .../Controllers/History/HistoryController.cs  |  2 +-
 .../Api/Controllers/Ping/PingController.cs    |  2 +-
 .../Api/Controllers/Rules/RulesController.cs  |  4 ++--
 .../Schemas/SchemaFieldsController.cs         | 16 ++++++++--------
 .../Areas/Api/Views/Shared/Docs.cshtml        | 19 +++++++++++++++++--
 7 files changed, 32 insertions(+), 17 deletions(-)

diff --git a/backend/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs b/backend/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs
index da58aade8..2102836c8 100644
--- a/backend/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs
+++ b/backend/src/Squidex/Areas/Api/Controllers/Apps/AppPatternsController.cs
@@ -82,7 +82,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
         }
 
         /// <summary>
-        /// Update an existing app pattern.
+        /// Update an app pattern.
         /// </summary>
         /// <param name="app">The name of the app.</param>
         /// <param name="id">The id of the pattern to be updated.</param>
@@ -107,7 +107,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
         }
 
         /// <summary>
-        /// Delete an existing app pattern.
+        /// Delete an app pattern.
         /// </summary>
         /// <param name="app">The name of the app.</param>
         /// <param name="id">The id of the pattern to be deleted.</param>
diff --git a/backend/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs b/backend/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs
index 8a3aef0ba..a40cee38e 100644
--- a/backend/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs
+++ b/backend/src/Squidex/Areas/Api/Controllers/Apps/AppRolesController.cs
@@ -107,7 +107,7 @@ namespace Squidex.Areas.Api.Controllers.Apps
         }
 
         /// <summary>
-        /// Update an existing app role.
+        /// Update an app role.
         /// </summary>
         /// <param name="app">The name of the app.</param>
         /// <param name="name">The name of the role to be updated.</param>
diff --git a/backend/src/Squidex/Areas/Api/Controllers/History/HistoryController.cs b/backend/src/Squidex/Areas/Api/Controllers/History/HistoryController.cs
index d50a2def7..dda051f83 100644
--- a/backend/src/Squidex/Areas/Api/Controllers/History/HistoryController.cs
+++ b/backend/src/Squidex/Areas/Api/Controllers/History/HistoryController.cs
@@ -31,7 +31,7 @@ namespace Squidex.Areas.Api.Controllers.History
         }
 
         /// <summary>
-        /// Get the events from the history.
+        /// Get historical events.
         /// </summary>
         /// <param name="app">The name of the app.</param>
         /// <param name="channel">The name of the channel.</param>
diff --git a/backend/src/Squidex/Areas/Api/Controllers/Ping/PingController.cs b/backend/src/Squidex/Areas/Api/Controllers/Ping/PingController.cs
index fd6c294b6..6771038f2 100644
--- a/backend/src/Squidex/Areas/Api/Controllers/Ping/PingController.cs
+++ b/backend/src/Squidex/Areas/Api/Controllers/Ping/PingController.cs
@@ -27,7 +27,7 @@ namespace Squidex.Areas.Api.Controllers.Ping
         }
 
         /// <summary>
-        /// Get general info status of the API.
+        /// Get API information.
         /// </summary>
         /// <returns>
         /// 200 => Infos returned.
diff --git a/backend/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs b/backend/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs
index 5e81463ca..a03cc0f82 100644
--- a/backend/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs
+++ b/backend/src/Squidex/Areas/Api/Controllers/Rules/RulesController.cs
@@ -46,7 +46,7 @@ namespace Squidex.Areas.Api.Controllers.Rules
         }
 
         /// <summary>
-        /// Get the supported rule actions.
+        /// Get supported rule actions.
         /// </summary>
         /// <returns>
         /// 200 => Rule actions returned.
@@ -291,7 +291,7 @@ namespace Squidex.Areas.Api.Controllers.Rules
         }
 
         /// <summary>
-        /// Cancels the event and retries.
+        /// Cancels an event.
         /// </summary>
         /// <param name="app">The name of the app.</param>
         /// <param name="id">The event to enqueue.</param>
diff --git a/backend/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs b/backend/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs
index 475ebdb02..e11a0cbd7 100644
--- a/backend/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs
+++ b/backend/src/Squidex/Areas/Api/Controllers/Schemas/SchemaFieldsController.cs
@@ -54,7 +54,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
         }
 
         /// <summary>
-        /// Add a nested schema field.
+        /// Add a nested field.
         /// </summary>
         /// <param name="app">The name of the app.</param>
         /// <param name="name">The name of the schema.</param>
@@ -183,7 +183,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
         }
 
         /// <summary>
-        /// Update a nested schema field.
+        /// Update a nested field.
         /// </summary>
         /// <param name="app">The name of the app.</param>
         /// <param name="name">The name of the schema.</param>
@@ -237,7 +237,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
         }
 
         /// <summary>
-        /// Lock a nested schema field.
+        /// Lock a nested field.
         /// </summary>
         /// <param name="app">The name of the app.</param>
         /// <param name="name">The name of the schema.</param>
@@ -292,7 +292,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
         }
 
         /// <summary>
-        /// Hide a nested schema field.
+        /// Hide a nested field.
         /// </summary>
         /// <param name="app">The name of the app.</param>
         /// <param name="name">The name of the schema.</param>
@@ -347,7 +347,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
         }
 
         /// <summary>
-        /// Show a nested schema field.
+        /// Show a nested field.
         /// </summary>
         /// <param name="app">The name of the app.</param>
         /// <param name="name">The name of the schema.</param>
@@ -402,7 +402,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
         }
 
         /// <summary>
-        /// Enable a nested schema field.
+        /// Enable a nested field.
         /// </summary>
         /// <param name="app">The name of the app.</param>
         /// <param name="name">The name of the schema.</param>
@@ -457,7 +457,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
         }
 
         /// <summary>
-        /// Disable nested a schema field.
+        /// Disable a nested field.
         /// </summary>
         /// <param name="app">The name of the app.</param>
         /// <param name="name">The name of the schema.</param>
@@ -510,7 +510,7 @@ namespace Squidex.Areas.Api.Controllers.Schemas
         }
 
         /// <summary>
-        /// Delete a nested schema field.
+        /// Delete a nested field.
         /// </summary>
         /// <param name="app">The name of the app.</param>
         /// <param name="name">The name of the schema.</param>
diff --git a/backend/src/Squidex/Areas/Api/Views/Shared/Docs.cshtml b/backend/src/Squidex/Areas/Api/Views/Shared/Docs.cshtml
index 01ec2d2b9..d79a549d5 100644
--- a/backend/src/Squidex/Areas/Api/Views/Shared/Docs.cshtml
+++ b/backend/src/Squidex/Areas/Api/Views/Shared/Docs.cshtml
@@ -14,12 +14,26 @@
 
     <style>
         body { margin: 0; padding: 0; }
+
+        .menu-content {
+            position: fixed !important;
+        }
+
+        .api-content {
+            margin-left: 260px;
+        }
+
+        @@media print, screen and (max-width: 50rem) {
+            .api-content {
+                margin-left: 0;
+            }
+        }
     </style>
 </head>
 <body>
     <div id="redoc-container"></div>
 
-    <script src="https://cdn.jsdelivr.net/npm/redoc@2.0.0-rc.22/bundles/redoc.standalone.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/redoc@2.0.0-rc.23/bundles/redoc.standalone.js"></script>
     <script>
         Redoc.init('@Url.Content(Model.Specification)', {
             theme: {
@@ -28,7 +42,8 @@
                         main: '#3f83df'
                     }
                 }
-            }
+            },
+            nativeScrollbars: true
         }, document.getElementById('redoc-container'))
     </script>
 </body>