Merge pull request #263 from umbraco/v16/hubspot

V16/hubspot

Author: acoumb

src/Umbraco.Cms.Integrations.Crm.Hubspot/Api/Configuration/BackOfficeSecurityRequirementsOperationFilter.cs

@@ -0,0 +1,9 @@
+using Umbraco.Cms.Api.Management.OpenApi;
+
+namespace Umbraco.Cms.Integrations.Crm.Hubspot.Api.Configuration
+{
+    public class BackOfficeSecurityRequirementsOperationFilter : BackOfficeSecurityRequirementsOperationFilterBase
+    {
+        protected override string ApiName => Constants.ManagementApi.ApiName;
+    }
+}

src/Umbraco.Cms.Integrations.Crm.Hubspot/Api/Configuration/HubspotOperationIdHandler.cs

@@ -0,0 +1,18 @@
+using Asp.Versioning;
+using Microsoft.AspNetCore.Mvc.ApiExplorer;
+using Microsoft.AspNetCore.Mvc.Controllers;
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Api.Common.OpenApi;
+
+namespace Umbraco.Cms.Integrations.Crm.Hubspot.Api.Configuration
+{
+    internal class HubspotOperationIdHandler : OperationIdHandler
+    {
+        public HubspotOperationIdHandler(IOptions<ApiVersioningOptions> apiVersioningOptions) : base(apiVersioningOptions)
+        {
+        }
+
+        protected override bool CanHandle(ApiDescription apiDescription, ControllerActionDescriptor controllerActionDescriptor)
+            => controllerActionDescriptor.ControllerTypeInfo.Namespace?.StartsWith("Umbraco.Cms.Integrations.Crm.Hubspot") is true;
+    }
+}

src/Umbraco.Cms.Integrations.Crm.Hubspot/Api/Management/Controllers/CheckConfigurationController.cs

@@ -8,7 +8,6 @@
 namespace Umbraco.Cms.Integrations.Crm.Hubspot.Api.Management.Controllers
 {
     [ApiVersion("1.0")]
-    [ApiExplorerSettings(GroupName = Constants.ManagementApi.GroupName)]
     public class CheckConfigurationController : HubspotFormsControllerBase
     {
         private readonly HubspotOAuthSettings _oauthSettings;
@@ -20,7 +19,7 @@ public CheckConfigurationController(
             _oauthSettings = oauthSettingsOptions.Value;
         }
 
-        [HttpGet("check-configuration")]
+        [HttpGet("check-configuration", Name = Constants.OperationIdentifiers.CheckConfiguration)]
         [ProducesResponseType(typeof(HubspotFormPickerSettings), StatusCodes.Status200OK)]
         public IActionResult CheckConfiguration()
         {

src/Umbraco.Cms.Integrations.Crm.Hubspot/Api/Management/Controllers/GetAccessTokenController.cs

@@ -10,7 +10,6 @@
 namespace Umbraco.Cms.Integrations.Crm.Hubspot.Api.Management.Controllers
 {
     [ApiVersion("1.0")]
-    [ApiExplorerSettings(GroupName = Constants.ManagementApi.GroupName)]
     public class GetAccessTokenController : HubspotFormsControllerBase
     {
         private readonly IHubspotAuthorizationService _authorizationService;
@@ -21,7 +20,7 @@ public GetAccessTokenController(
             : base(settingsOptions) 
             => _authorizationService = authorizationImplementationFactory(Settings.UseUmbracoAuthorization);
 
-        [HttpPost("access-token")]
+        [HttpPost("access-token", Name = Constants.OperationIdentifiers.GetAccessToken)]
         [ProducesResponseType(typeof(string), StatusCodes.Status200OK)]
         public async Task<IActionResult> GetAccessToken([FromBody] OAuthRequestDto authRequestDto)
         {

src/Umbraco.Cms.Integrations.Crm.Hubspot/Api/Management/Controllers/GetAllController.cs

@@ -12,7 +12,6 @@
 namespace Umbraco.Cms.Integrations.Crm.Hubspot.Api.Management.Controllers
 {
     [ApiVersion("1.0")]
-    [ApiExplorerSettings(GroupName = Constants.ManagementApi.GroupName)]
     public class GetAllController : HubspotFormsControllerBase
     {
         private readonly ILogger<GetAllController> _logger;
@@ -31,7 +30,7 @@ public GetAllController(
             _httpClientFactory = httpClientFactory;
         }
 
-        [HttpGet("get")]
+        [HttpGet("get", Name = Constants.OperationIdentifiers.GetFormsByApiKey)]
         [ProducesResponseType(typeof(ResponseDto), StatusCodes.Status200OK)]
         public async Task<ResponseDto> GetAll()
         {

src/Umbraco.Cms.Integrations.Crm.Hubspot/Api/Management/Controllers/GetAllOAuthController.cs

@@ -31,7 +31,7 @@ public GetAllOAuthController(
             _tokenService = tokenService;
         }
 
-        [HttpGet("oauth/get")]
+        [HttpGet("oauth/get", Name = Constants.OperationIdentifiers.GetFormsOAuth)]
         [ProducesResponseType(typeof(ResponseDto), StatusCodes.Status200OK)]
         public async Task<ResponseDto> GetAllOAuth()
         {

src/Umbraco.Cms.Integrations.Crm.Hubspot/Api/Management/Controllers/GetAuthorizationUrlController.cs

@@ -19,7 +19,7 @@ public GetAuthorizationUrlController(
             AuthorizationImplementationFactory authorizationImplementationFactory) 
             : base(settingsOptions) => _authorizationService = authorizationImplementationFactory(Settings.UseUmbracoAuthorization);
 
-        [HttpGet("authorization-url")]
+        [HttpGet("authorization-url", Name = Constants.OperationIdentifiers.GetAuthorizationUrl)]
         [ProducesResponseType(typeof(string), StatusCodes.Status200OK)]
         public IActionResult GetAuthorizationUrl() => Ok(_authorizationService.GetAuthorizationUrl());
     }

src/Umbraco.Cms.Integrations.Crm.Hubspot/Api/Management/Controllers/HubspotFormsControllerBase.cs

@@ -12,6 +12,7 @@
 namespace Umbraco.Cms.Integrations.Crm.Hubspot.Api.Management.Controllers
 {
     [ApiController]
+    [ApiExplorerSettings(GroupName = Constants.ManagementApi.GroupName)]
     [BackOfficeRoute($"{Constants.ManagementApi.RootPath}/v{{version:apiVersion}}/forms")]
     [Authorize(Policy = AuthorizationPolicies.BackOfficeAccess)]
     [MapToApi(Constants.ManagementApi.ApiName)]

src/Umbraco.Cms.Integrations.Crm.Hubspot/Api/Management/Controllers/RefreshAccessTokenController.cs

@@ -9,7 +9,6 @@
 namespace Umbraco.Cms.Integrations.Crm.Hubspot.Api.Management.Controllers
 {
     [ApiVersion("1.0")]
-    [ApiExplorerSettings(GroupName = Constants.ManagementApi.GroupName)]
     public class RefreshAccessTokenController : HubspotFormsControllerBase
     {
         private readonly IHubspotAuthorizationService _authorizationService;
@@ -19,7 +18,7 @@ public RefreshAccessTokenController(
             AuthorizationImplementationFactory authorizationImplementationFactory) 
             : base(settingsOptions) => _authorizationService = authorizationImplementationFactory(Settings.UseUmbracoAuthorization);
 
-        [HttpPost("refresh")]
+        [HttpPost("refresh", Name = Constants.OperationIdentifiers.RefreshAccessToken)]
         [ProducesResponseType(typeof(string), StatusCodes.Status200OK)]
         public async Task<IActionResult> RefreshAccessToken()
         {

src/Umbraco.Cms.Integrations.Crm.Hubspot/Api/Management/Controllers/RevokeTokenController.cs

@@ -8,7 +8,6 @@
 namespace Umbraco.Cms.Integrations.Crm.Hubspot.Api.Management.Controllers
 {
     [ApiVersion("1.0")]
-    [ApiExplorerSettings(GroupName = Constants.ManagementApi.GroupName)]
     public class RevokeTokenController : HubspotFormsControllerBase
     {
         private readonly ITokenService _tokenService;
@@ -18,7 +17,7 @@ public RevokeTokenController(
             ITokenService tokenService) 
             : base(settingsOptions) => _tokenService = tokenService;
 
-        [HttpPost("revoke")]
+        [HttpPost("revoke", Name = Constants.OperationIdentifiers.RevokeAccessToken)]
         [ProducesResponseType(StatusCodes.Status200OK)]
         public IActionResult RevokeAccessToken()
         {