View Source

Class OperationIdHandler

Inheritance
System.Object
Namespace: Umbraco.Cms.Api.Common.OpenApi
Assembly: Umbraco.Cms.Api.Common.dll
Syntax
public class OperationIdHandler : IOperationIdHandler

Constructors

View Source

OperationIdHandler(IOptions<ApiVersioningOptions>)

Declaration
public OperationIdHandler(IOptions<ApiVersioningOptions> apiVersioningOptions)
Parameters
Type Name Description
Microsoft.Extensions.Options.IOptions<ApiVersioningOptions> apiVersioningOptions

Methods

View Source

CanHandle(ApiDescription)

Declaration
public bool CanHandle(ApiDescription apiDescription)
Parameters
Type Name Description
Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription apiDescription
Returns
Type Description
System.Boolean
View Source

CanHandle(ApiDescription, ControllerActionDescriptor)

Declaration
protected virtual bool CanHandle(ApiDescription apiDescription, ControllerActionDescriptor controllerActionDescriptor)
Parameters
Type Name Description
Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription apiDescription
Microsoft.AspNetCore.Mvc.Controllers.ControllerActionDescriptor controllerActionDescriptor
Returns
Type Description
System.Boolean
View Source

Handle(ApiDescription)

Declaration
public virtual string Handle(ApiDescription apiDescription)
Parameters
Type Name Description
Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription apiDescription
Returns
Type Description
System.String
View Source

UmbracoOperationId(ApiDescription)

Generates a unique operation identifier for a given API following Umbraco's operation id naming conventions.

Declaration
protected string UmbracoOperationId(ApiDescription apiDescription)
Parameters
Type Name Description
Microsoft.AspNetCore.Mvc.ApiExplorer.ApiDescription apiDescription
Returns
Type Description
System.String