@azure-tools/typespec-providerhub-controller 0.27.0

package/templates/providerhub/modelCopy.sq

@@ -0,0 +1,98 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated />
+
+using System;
+using System.ComponentModel;
+using System.Runtime.Serialization;
+using Newtonsoft.Json;
+using Microsoft.TypeSpec.ProviderHub.Controller;
+
+namespace Microsoft.{{serviceName}}.Service.Models
+{
+    /// <summary>
+    /// Helper for merging canonical {{name}} models as part of a PUT or PATCH operation
+    /// </summary>
+    public partial class {{name}}CopyHelper
+    {
+        /// <summary>
+        /// Extensibility point: perform actions before data is copied
+        /// </summary>
+        /// <param name="source">The source {{name}}</param>
+        /// <param name="target">The target {{name}}</param>
+        partial void OnBeginCopyForPatch({{name}} source, {{name}} target);
+
+        /// <summary>
+        /// Extensibility point: perform actions after data is copied
+        /// </summary>
+        /// <param name="source">The source {{name}}</param>
+        /// <param name="target">The target {{name}}</param>
+        partial void OnEndCopyForPatch({{name}} source, {{name}} target);
+
+        /// <summary>
+        /// Copy the properties of a source {{name}} to a target {{name}}, using PATCH semantics
+        /// </summary>
+        /// <param name="source">The source {{name}}</param>
+        /// <param name="target">The target {{name}}</param>
+        public void CopyForPatch({{name}} source, {{name}} target)
+        {
+{{#if (or isVersioned hasVersionedAncestor)}}
+            var version = source.VersionInfo;
+{{/if}}
+            var serialization = source.SerializationInfo;
+            OnBeginCopyForPatch(source, target);
+{{#with this  as | model |}}
+{{#each properties}}
+{{#if (or model.isVersioned model.hasVersionedAncestor)}}
+            if (version.IsContractProperty(nameof(source.{{name}})) && serialization.IsSerializedProperty(nameof(source.{{name}})))
+                target.{{name}} = source.{{name}};
+{{else}}
+            if (serialization.IsSerializedProperty(nameof(source.{{name}})))
+                target.{{name}} = source.{{name}};
+{{/if}}
+{{/each}}
+{{/with}}
+            OnEndCopyForPatch(source, target);
+        }
+
+        /// <summary>
+        /// Extensibility point: perform actions before data is copied
+        /// </summary>
+        /// <param name="source">The source {{name}}</param>
+        /// <param name="target">The target {{name}}</param>
+        partial void OnBeginCopyForPut({{name}} source, {{name}} target);
+
+        /// <summary>
+        /// Extensibility point: perform actions after data is copied
+        /// </summary>
+        /// <param name="source">The source {{name}}</param>
+        /// <param name="target">The target {{name}}</param>
+        partial void OnEndCopyForPut({{name}} source, {{name}} target);
+
+        /// <summary>
+        /// Copy the properties of a source {{name}} to a target {{name}}, using PUT semantics
+        /// </summary>
+        /// <param name="source">The source {{name}}</param>
+        /// <param name="target">The target {{name}}</param>
+        public void CopyForPut({{name}} source, {{name}} target)
+        {
+{{#if (or isVersioned hasVersionedAncestor)}}
+            var version = source.VersionInfo;
+{{/if}}
+            var serialization = source.SerializationInfo;
+            OnBeginCopyForPut(source, target);
+{{#with this  as | model |}}
+{{#each properties}}
+{{#if (or ../isVersioned ../hasVersionedAncestor)}}
+            if (version.IsContractProperty(nameof(source.{{name}})))
+                target.{{name}} = source.{{name}};
+{{else}}
+            target.{{name}} = source.{{name}};
+{{/if}}
+{{/each}}
+{{/with}}
+            OnEndCopyForPut(source, target);
+        }
+    }
+}

package/templates/providerhub/modelCopyExtension.sq

@@ -0,0 +1,39 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated />
+
+using System;
+using System.ComponentModel;
+using System.Runtime.Serialization;
+using Newtonsoft.Json;
+using Microsoft.TypeSpec.ProviderHub.Controller;
+
+namespace Microsoft.{{serviceName}}.Service.Models
+{
+    /// <summary>
+    /// Extensions for easy PUT and PATCH copying of a resource
+    /// </summary>
+    public static class {{name}}Extensions
+    {
+        /// <summary>
+        /// Copy the properties of this {{name}} to another {{name}}
+        /// </summary>
+        /// <param name="source">The source {{name}}</param>
+        /// <param name="target">The target {{name}}</param>
+        /// <param name="copySettings">The kind of copy you would like to perform (using PUT or PATCH semantics)</param>
+        public static void CopyTo(this {{name}} source, {{name}} target, CopySettings copySettings = CopySettings.UsePutSemantics)
+        {
+            var helper = new {{name}}CopyHelper();
+            switch (copySettings)
+            {
+                case CopySettings.UsePatchSemantics:
+                    helper.CopyForPatch(source, target);
+                    break;
+                case CopySettings.UsePutSemantics:
+                    helper.CopyForPut(source, target);
+                    break;
+            }
+        }
+    }
+}

package/templates/providerhub/modelVersionComposite.sq

@@ -0,0 +1,69 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated />
+
+using System;
+using System.ComponentModel;
+using System.Runtime.Serialization;
+using Newtonsoft.Json;
+using Microsoft.TypeSpec.ProviderHub.Controller;
+
+namespace Microsoft.{{serviceName}}.Service.Models
+{
+    /// <summary>
+    /// The version information for a {{name}}.
+    /// </summary>
+    public partial class {{name}}VersionInfo : ResourceVersionInfo
+    {
+        /// <summary>
+        /// Create versioning info for a {{name}}
+        /// </summary>
+        /// <param name="wrapped">The version info of the ancestor versioned class</param>
+        public {{name}}VersionInfo({{name}} instance, ResourceVersionInfo wrapped)
+        {
+            OnBeforeInitialize(instance, wrapped);
+            ContractProperties = new ResourceContractProperties(Type, VersionComparer, wrapped?.ContractProperties, GetBaseModelVersion);
+            OnAfterInitialize(instance, wrapped);
+        }
+
+        /// <summary>
+        /// Extensibility point - perform operations on the version info before it is initialized
+        /// </summary>
+        /// <param name="instance">The {{name}} being tracked</param>
+        /// <param name="wrappedVersionInfo">Since an ancestor class is also versioned, the version info for that class</param>
+        partial void OnBeforeInitialize({{name}} instance, ResourceVersionInfo wrappedVersionInfo);
+
+        /// <summary>
+        /// Extensibility point - perform operations on the version info after it is initialized
+        /// </summary>
+        /// <param name="instance">The {{name}} being tracked</param>
+        /// <param name="wrappedVersionInfo">Since an ancestor class is also versioned, the version info for that class</param>
+        partial void OnAfterInitialize({{name}} instance, ResourceVersionInfo wrappedVersionInfo);
+
+        /// <summary>
+        /// The version comparer for this type.
+        /// </summary>
+        public override VersionComparer VersionComparer => VersionedSerializer.Instance.ServiceVersionComparer;
+
+        /// <summary>
+        /// The target type for this version info
+        /// </summary>
+        public override Type Type => typeof({{name}});
+
+        /// <summary>
+        /// The chain of resource contract properties that determine version info
+        /// </summary>
+        public override ResourceContractProperties ContractProperties { get; } 
+
+        /// <summary>
+        /// The last deserialized version of the tracked resource
+        /// </summary>
+        public override string LastDeserializedVersion { get; set; }
+
+        string GetBaseModelVersion(Type type, string version)
+        {
+            return VersionedSerializer.Instance.GetModelVersion(type, version);
+        }
+    }
+}

package/templates/providerhub/modelVersionStandard.sq

@@ -0,0 +1,62 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated />
+
+using System;
+using System.ComponentModel;
+using System.Runtime.Serialization;
+using Newtonsoft.Json;
+using Microsoft.TypeSpec.ProviderHub.Controller;
+
+namespace Microsoft.{{serviceName}}.Service.Models
+{
+    /// <summary>
+    /// The version information for a {{name}}.
+    /// </summary>
+    public partial class {{name}}VersionInfo : ResourceVersionInfo
+    {
+        /// <summary>
+        /// Create versioning info for a {{name}}
+        /// </summary>
+        /// <param name="instance">The tracked object</param>
+        public {{name}}VersionInfo({{name}} instance)
+        {
+            OnBeforeInitialize(instance);
+            ContractProperties = new ResourceContractProperties(Type, VersionComparer);
+            OnAfterInitialize(instance);
+        }
+
+        /// <summary>
+        /// Extensibility point - perform operations on the version info before it is initialized
+        /// </summary>
+        /// <param name="instance">The {{name}} being tracked</param>
+        partial void OnBeforeInitialize({{name}} instance);
+
+        /// <summary>
+        /// Extensibility point - perform operations on the version info after it is initialized
+        /// </summary>
+        /// <param name="instance">The {{name}} being tracked</param>
+        partial void OnAfterInitialize({{name}} instance);
+
+        /// <summary>
+        /// The version comparer for this type.
+        /// </summary>
+        public override VersionComparer VersionComparer => VersionedSerializer.Instance.ServiceVersionComparer;
+
+        /// <summary>
+        /// The last deserialized version of the tracked resource
+        /// </summary>
+        public override string LastDeserializedVersion { get; set; }
+
+        /// <summary>
+        /// The target type for this version info
+        /// </summary>
+        public override Type Type => typeof({{name}});
+
+        /// <summary>
+        /// The chain of resource contract properties that determine version info
+        /// </summary>
+        public override ResourceContractProperties ContractProperties { get; } 
+    }
+}

package/templates/providerhub/openEnum.sq

@@ -0,0 +1,34 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated />
+using Newtonsoft.Json;
+using Microsoft.TypeSpec.ProviderHub.Controller;
+
+namespace {{nameSpace}}.Service.Models
+{
+{{#if description}}
+    /// <summary>
+    {{> renderComment content=description}}
+    /// </summary>
+{{/if}}
+    [JsonConverter(typeof(EnumJsonConverter<{{name}}>))]
+    public struct {{name}}
+    {
+        public static readonly {{name}} {{#each values as |value valueIndex|}}{{value.name}} = "{{#if value.value}}{{value.value}}{{else}}{{value.name}}{{/if}}"{{#if @last}};{{else}},{{/if}} {{/each}}
+
+        private readonly string _value;
+
+        public {{name}}(string value) =>
+            _value = value;
+
+        public override string ToString() =>
+            _value;
+
+        public static implicit operator string({{name}} obj) =>
+            obj.ToString();
+
+        public static implicit operator {{name}}(string str) =>
+            new {{name}}(str);
+    }
+}

package/templates/providerhub/resourceController.sq

@@ -0,0 +1,20 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated />
+
+using Microsoft.Extensions.Logging;
+
+namespace {{nameSpace}}.Service.Controllers
+{
+    /// <summary>
+    /// Controller for user RP operations on the {{name}} resource.
+    /// </summary>
+    public partial class {{name}}Controller : {{name}}ControllerBase
+    {
+        public {{name}}Controller(ILogger<{{name}}Controller> logger)
+            : base(logger)
+        {
+        }
+    }
+}

package/templates/providerhub/resourceControllerBase.Logger.sq

@@ -0,0 +1,48 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated />
+
+{{#with this as |res|}}
+using System;
+using Microsoft.Extensions.Logging;
+
+namespace {{nameSpace}}.Service.Controllers
+{
+    public abstract partial class {{res.name}}ControllerBase
+    {
+        private static Action<ILogger, Exception> _logRequestNull;
+{{#each operations as |operation operationIndex|}}
+        private static Action<ILogger, Exception> _logValidate{{getOperationAction operation}};
+        private static Action<ILogger, Exception> _logBegin{{getOperationAction operation}};
+{{#if (ne (getOperationAction operation) "Read")}}
+        private static Action<ILogger, Exception> _logEnd{{getOperationAction operation}};
+{{/if}}
+{{/each}}
+
+        private static void InitializeLogger()
+        {
+            _logRequestNull = LoggerMessage.Define(
+                LogLevel.Error,
+                new EventId(1, "RequestIsNull"),
+                "Request is null");
+{{#each operations as |operation operationIndex|}}
+            _logValidate{{getOperationAction operation}} = LoggerMessage.Define(
+                LogLevel.Information,
+                new EventId({{increment operationIndex}}1, "ValidateOperation"),
+                "Validate{{getOperationAction operation}}Async()");
+            _logBegin{{getOperationAction operation}} = LoggerMessage.Define(
+                LogLevel.Information,
+                new EventId({{increment operationIndex}}2, "BeginOperation"),
+                "Begin{{getOperationAction operation}}Async()");
+{{#if (ne (getOperationAction operation) "Read")}}
+            _logEnd{{getOperationAction operation}} = LoggerMessage.Define(
+                LogLevel.Information,
+                new EventId({{increment operationIndex}}3, "EndOperation"),
+                "End{{getOperationAction operation}}Async()");
+{{/if}}
+{{/each}}
+        }
+    }
+}
+{{/with}}

package/templates/providerhub/resourceControllerBase.sq

@@ -0,0 +1,154 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated />
+
+{{#with this as |res|}}
+using System;
+using System.Net;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.TypeSpec.ProviderHub;
+using Microsoft.TypeSpec.ProviderHub.Controller;
+using Microsoft.Extensions.Logging;
+using {{nameSpace}}.Service.Models;
+
+namespace {{nameSpace}}.Service.Controllers
+{
+    /// <summary>
+    /// Controller for user RP operations on the {{res.name}} resource.
+    /// </summary>
+    [ApiController]
+    public abstract partial class {{res.name}}ControllerBase : ControllerBase
+    {
+        protected readonly ILogger<{{res.name}}ControllerBase> _logger;
+
+        static {{res.name}}ControllerBase()
+        {
+            InitializeLogger();
+        }
+
+        protected {{res.name}}ControllerBase(ILogger<{{res.name}}ControllerBase> logger)
+        {
+            _logger = logger;
+        }
+
+{{#each operations as |operation operationIndex|}}
+{{#if (getOperationAction operation)}}
+{{#if (notCustomOp operation)}}
+        /// <summary>
+        /// Validate the request to {{getOperationAction operation}} the {{res.name}} resource.
+        /// </summary>
+{{#each operation.parameters as |parameter index |}}
+        /// <param name="{{parameter.name}}">
+        {{> renderComment content=parameter.description}}
+        /// </param>
+{{/each}}
+        /// <returns> A ValidationResponse indicating the validity of the {{getOperationAction operation}} request.</returns>
+        [HttpPost]
+        [Route({{res.serviceName}}ServiceRoutes.{{res.name}}Validate{{getOperationAction operation}})]
+        [ProducesResponseType((int)HttpStatusCode.OK, Type = typeof(ValidationResponse))]
+        public async Task<IActionResult> Validate{{getOperationAction operation}}Async({{decl operation}})
+        {
+            _logValidate{{getOperationAction operation}}(_logger, null);
+
+{{#if (isDefined operation.requestParameter)}}
+            var modelValidation = ValidationHelpers.ValidateModel({{operation.requestParameter.name}});
+            if (modelValidation.IsValid)
+            {
+                modelValidation = await OnValidate{{getOperationAction operation}}({{call operation}});
+            }
+{{else}}
+            var modelValidation = await OnValidate{{getOperationAction operation}}({{call operation}});
+{{/if}}
+            return Ok(modelValidation);
+        }
+
+        protected virtual Task<ValidationResponse> OnValidate{{getOperationAction operation}}({{decl operation}})
+        {
+            return Task.FromResult(ValidationResponse.Valid);
+        }
+{{#unless @first}}
+
+{{/unless}}
+{{#if (ne (getOperationAction operation) "Read")}}
+        /// <summary>
+        /// Called after the end of the request to {{getOperationAction operation}} the {{res.name}} resource.
+        /// </summary>
+{{#each operation.parameters as |parameter index|}}
+        /// <param name="{{parameter.name}}">
+        {{> renderComment content=parameter.description}}
+        /// </param>
+{{/each}}
+        [HttpPost]
+        [Route({{res.serviceName}}ServiceRoutes.{{res.name}}End{{getOperationAction operation}})]
+        [ProducesResponseType((int)HttpStatusCode.OK, Type = typeof(void))]
+        public async Task<IActionResult> End{{getOperationAction operation}}Async({{decl operation}})
+        {
+            _logEnd{{getOperationAction operation}}(_logger, null);
+
+            await OnEnd{{getOperationAction operation}}({{call operation}});
+            return Ok();
+        }
+
+        protected virtual Task OnEnd{{getOperationAction operation}}({{decl operation}})
+        {
+            return Task.CompletedTask;
+        }
+{{/if}}
+{{/if}}
+
+        /// <summary>
+        /// {{getOperationAction operation}} the {{res.name}} resource.
+        /// </summary>
+{{#each operation.parameters as |parameter index|}}
+        /// <param name="{{parameter.name}}">
+        {{> renderComment content=parameter.description}}
+        /// </param>
+{{/each}}
+        /// <returns> The {{res.name}} resource.</returns>
+        [Http{{#if (eqi operation.verb "GET")}}Post{{else}}{{initialCaps operation.verb}}{{/if}}]
+        [Route({{res.serviceName}}ServiceRoutes.{{res.name}}{{#if (eqi operation.verb "GET")}}BeginRead{{else}}Item{{/if}}{{#unless (notCustomOp operation)}}{{operation.name}}{{/unless}})]
+        [ProducesResponseType((int)HttpStatusCode.OK, Type = typeof({{operation.returnType}}))]
+{{#if (or (eq (getOperationAction operation) "Create") (eq (getOperationAction operation) "Patch"))}}
+        [ProducesResponseType((int)HttpStatusCode.Created, Type = typeof({{operation.returnType}}))]
+{{/if}}
+{{#if (eqi operation.verb "POST")}}
+        [ProducesResponseType((int)HttpStatusCode.Accepted, Type = typeof({{operation.returnType}}))]
+{{/if}}
+{{#if (eqi operation.verb "DELETE")}}
+        [ProducesResponseType((int)HttpStatusCode.NoContent, Type = typeof({{operation.returnType}}))]
+{{/if}}
+        public async Task<IActionResult> Begin{{getOperationAction operation}}Async({{decl operation}})
+        {
+            _logBegin{{getOperationAction operation}}(_logger, null);
+
+{{#if operation.requestParameter}}
+            {{operation.requestParameter.name}} = {{operation.requestParameter.name}} ?? throw new ArgumentNullException(nameof({{operation.requestParameter.name}}));
+{{/if}}
+            if (Request is null)
+            {
+                _logRequestNull(_logger, null);
+                return BadRequest("Request is null");
+            }
+
+            var result = await On{{getOperationAction operation}}Async({{call operation }});
+            return result;
+        }
+
+        protected virtual Task<IActionResult> On{{getOperationAction operation}}Async({{decl operation}})
+        {
+{{#if (eqi operation.verb "PATCH")}}
+            return Task.FromResult<IActionResult>(Ok({{ bodyParamName operation }}));
+{{else}}
+            return Task.FromResult<IActionResult>(Ok());
+{{/if}}
+        }
+{{/if}}
+{{#unless @last}}
+
+{{/unless}}
+{{/each}}
+    }
+}
+{{/with}}

package/templates/providerhub/resourceProviderRegistration.sq

@@ -0,0 +1,11 @@
+{
+  "properties": {
+    "providerType": "Hidden",
+    "management": {
+      "incidentRoutingService": "{{serviceName}} Resource Provider",
+      "incidentRoutingTeam": "{{serviceName}} Triage",
+      "incidentContactEmail": "helpme@{{serviceName}}.com"
+    },
+    "enableTenantLinkedNotification": false
+  }
+}

package/templates/providerhub/resourceRegistration.sq

@@ -0,0 +1,27 @@
+{
+  "properties": {
+    "routingType": "Default",
+    "regionality": "Regional",
+    "management": {
+      "incidentRoutingService": "ICM ServiceName",
+      "incidentRoutingTeam": "ICM TeamName",
+      "incidentContactEmail": "incidentContactEmail@domain.com"
+    },
+    "endpoints": [
+      {
+        "apiVersions": ["{{join apiVersion "\", \""}}"],
+        "locations": ["West US"],
+        "extensions": [
+          {
+            "endpointUri": "http://host.docker.internal:6020/",
+            "extensionCategories": [
+{{#each extensions as | value valueIndex|}}
+              "{{value}}"{{#unless @last}},{{/unless}}
+{{/each}}
+            ]
+          }
+        ]
+      }
+    ]
+  }
+}

package/templates/providerhub/serviceRoutingConstants.sq

@@ -0,0 +1,38 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated />
+
+namespace {{nameSpace}}.Service.Controllers
+{
+    public static class {{serviceName}}ServiceRoutes
+    {
+{{#if includeOperationController}}
+        public const string ListOperations = "providers/{{nameSpace}}/operations";
+{{/if}}
+{{#each resources as |resource index |}}
+        public const string {{resource.name}}Item = "{{resource.itemPath}}";
+{{#each resource.operations as | operation opIndex |}}
+{{#if (eqi operation.verb "PUT")}}
+        public const string {{resource.name}}ValidateCreate = "{{resource.itemPath}}/resourceCreationValidate";
+        public const string {{resource.name}}EndCreate = "{{resource.itemPath}}/resourceCreationCompleted";
+{{/if}}
+{{#if (eqi operation.verb "GET")}}
+        public const string {{resource.name}}ValidateRead = "{{resource.itemPath}}/resourceReadValidate";
+        public const string {{resource.name}}BeginRead = "{{resource.itemPath}}/resourceReadBegin";
+{{/if}}
+{{#if (eqi operation.verb "PATCH")}}
+        public const string {{resource.name}}ValidatePatch = "{{resource.itemPath}}/resourcePatchValidate";
+        public const string {{resource.name}}EndPatch = "{{resource.itemPath}}/resourcePatchCompleted";
+{{/if}}
+{{#if (eqi operation.verb "DELETE")}}
+        public const string {{resource.name}}ValidateDelete = "{{resource.itemPath}}/resourceDeletionValidate";
+        public const string {{resource.name}}EndDelete = "{{resource.itemPath}}/resourceDeletionCompleted";
+{{/if}}
+{{#if (eqi operation.verb "POST")}}
+        public const string {{resource.name}}Item{{operation.name}} = "{{resource.itemPath}}/{{operation.subPath}}";
+{{/if}}
+{{/each}}
+{{/each}}
+    }
+}

package/templates/providerhub/single/OperationControllerBase.sq

@@ -0,0 +1,52 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated />
+
+using System;
+using System.Net;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.TypeSpec.ProviderHub.Controller;
+using Microsoft.Extensions.Logging;
+
+using {{nameSpace}}.Service.Models;
+
+namespace {{nameSpace}}.Service.Controllers
+{
+    public abstract class OperationControllerBase : Controller
+    {
+        private static readonly Action<ILogger, Exception> _logListOperations;
+
+        protected readonly ILogger<OperationControllerBase> _logger;
+
+        static OperationControllerBase()
+        {
+            _logListOperations = LoggerMessage.Define(
+                LogLevel.Information,
+                new EventId(1, "ListOperations"),
+                "ListOperationsAsync()");
+        }
+
+        protected OperationControllerBase(ILogger<OperationControllerBase> logger) =>
+            _logger = logger;
+
+        /// <summary>
+        /// List all operations provided by {{nameSpace}}.
+        /// </summary>
+        /// <returns> The list of {{nameSpace}} operations.</returns>
+        [HttpGet]
+        [Route({{serviceName}}ServiceRoutes.ListOperations)]
+        [ProducesResponseType((int)HttpStatusCode.OK, Type = typeof(OperationListResult))]
+        public async Task<IActionResult> ListOperationsAsync()
+        {
+            _logListOperations(_logger, null);
+
+            var list = await OnOperationListAsync(Request);
+            return Ok(list);
+        }
+
+        protected abstract Task<OperationListResult> OnOperationListAsync(HttpRequest request);
+    }
+}