Merge pull request #308 from neuroglia-io/swagger-fix

Removed most non-essential external schemas (introducedby ODATA) from the OpenAPI documentation file

Author: JBBianchi

src/apis/management/Synapse.Apis.Management.Http/Extensions/ISynapseApplicationBuilderExtensions.cs

@@ -25,6 +25,7 @@
 using Neuroglia;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;
+using Synapse.Apis.Management.Http.Services;
 using Synapse.Application.Configuration;
 using Synapse.Application.Services;
 using Synapse.Integration.Serialization.Converters;
@@ -33,7 +34,7 @@ namespace Synapse.Apis.Management.Http
 {
 
     /// <summary>
-    /// Defines extensions for <see cref="ISynapseApplicationBuilder"/>s
+    /// Defines extensions for <see cref="ISynapseApplicationBuilder"/>s 
     /// </summary>
     public static class ISynapseApplicationBuilderExtensions
     {
@@ -73,6 +74,9 @@ public static ISynapseApplicationBuilder UseHttpManagementApi(this ISynapseAppli
                 .AddApplicationPart(typeof(MetadataController).Assembly);
             synapse.Services.AddSwaggerGen(builder =>
             {
+                builder.OperationFilter<IgnoreODataQueryOptionOperationFilter>();
+                builder.SchemaFilter<IgnorExternalSchemaFilter>();
+                builder.DocumentFilter<IgnorExternalSchemaFilter>();
                 builder.CustomOperationIds(o =>
                 {
                     if (!string.IsNullOrWhiteSpace(o.RelativePath) && o.RelativePath.StartsWith("odata")) return o.RelativePath;

src/apis/management/Synapse.Apis.Management.Http/Services/IgnorExternalSchemaFilter.cs

@@ -0,0 +1,57 @@
+/*
+ * Copyright © 2022-Present The Synapse Authors
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace Synapse.Apis.Management.Http.Services
+{
+    /// <summary>
+    /// Represents the object used to filter schemas described by the generated OpenAPI documentation
+    /// </summary>
+    public class IgnorExternalSchemaFilter
+        : ISchemaFilter, IDocumentFilter
+    {
+
+        /// <summary>
+        /// Gets a <see cref="List{T}"/> containing all the schemas to include in the generated OpenAPI documentation
+        /// </summary>
+        internal protected static readonly List<string> IncludedSchemas = new();
+
+        /// <inheritdoc/>
+        public void Apply(OpenApiSchema schema, SchemaFilterContext context)
+        {
+            if (context.Type.Namespace!.StartsWith("Neuroglia") 
+                || context.Type.Namespace!.StartsWith("Synapse") 
+                || context.Type.Namespace.StartsWith("ServerlessWorkflow")
+                || context.Type.Namespace == "System")
+                IncludedSchemas.Add(context.Type.Name);
+        }
+
+        /// <inheritdoc/>
+        public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
+        {
+            foreach(var schema in swaggerDoc.Components.Schemas.ToList())
+            {
+                if (IncludedSchemas.Contains(schema.Key)) continue;
+                swaggerDoc.Components.Schemas.Remove(schema.Key);
+            }
+        }
+
+    }
+
+}

src/apis/management/Synapse.Apis.Management.Http/Services/IgnoreODataQueryOptionOperationFilter.cs

@@ -0,0 +1,46 @@
+/*
+ * Copyright © 2022-Present The Synapse Authors
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace Synapse.Apis.Management.Http.Services
+{
+
+    /// <summary>
+    /// Represents the <see cref="IOperationFilter"/> used to ignore <see cref="ODataQueryOptions"/> parameters
+    /// </summary>
+    public class IgnoreODataQueryOptionOperationFilter
+        : IOperationFilter
+    {
+
+        /// <inheritdoc/>
+        public virtual void Apply(OpenApiOperation operation, OperationFilterContext context)
+        {
+            context.ApiDescription.ParameterDescriptions
+                .Where(param => param.ParameterDescriptor.ParameterType.IsGenericType && param.ParameterDescriptor.ParameterType.GetGenericTypeDefinition() == typeof(ODataQueryOptions<>))
+                .ToList()
+                .ForEach(param =>
+                {
+                    var parameter = operation.Parameters.SingleOrDefault(p => p.Name == param.Name);
+                    if (parameter != null) operation.Parameters.Remove(parameter);
+                });
+        }
+
+    }
+
+}

src/dashboard/Synapse.Dashboard/Pages/Workflows/View/View.razor

@@ -77,6 +77,14 @@
                                 ValueProvider="source => source.Key"
                                 PropertyPath="@PropertyPath.Parse(nameof(V1WorkflowInstance.Key))" />
                                 <Column T="V1WorkflowInstance"
+                                Name="ActivationType"
+                                ValueProvider="source => source.ActivationType"
+                                PropertyPath="@PropertyPath.Parse(nameof(V1WorkflowInstance.ActivationType))">
+                                    <CellTemplate Context="context">
+                                        <span class="badge rounded-pill bg-secondary">@(EnumHelper.Stringify((V1WorkflowInstanceActivationType)context.Value))</span>
+                                    </CellTemplate>
+                                </Column>
+                                <Column T="V1WorkflowInstance"
                                 Name="Status"
                                 ValueProvider="source => source.Status"
                                 PropertyPath="@PropertyPath.Parse(nameof(V1WorkflowInstance.Status))">
@@ -314,9 +322,9 @@ else
         await this.workflowToolbar.OnShowWorkflowInputModal(serializedInput);
     }
 
-    protected string GetCssClassFor(V1WorkflowInstanceStatus workflowInstanceStatus)
+    protected string GetCssClassFor(V1WorkflowInstanceStatus status)
     {
-        return workflowInstanceStatus switch
+        return status switch
         {
             V1WorkflowInstanceStatus.Pending => "bg-secondary",
             V1WorkflowInstanceStatus.Scheduling => "border-primary",