OpenAPI.NET.OData/src/Microsoft.OpenApi.OData.Reader/Operation/NavigationPropertyPatchOperationHandler.cs

111 lines
4 KiB
C#

// ------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
// ------------------------------------------------------------
using System.Collections.Generic;
using System.Linq;
using Microsoft.OData.Edm;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.OData.Common;
using Microsoft.OpenApi.OData.Generator;
namespace Microsoft.OpenApi.OData.Operation
{
/// <summary>
/// Update a navigation property for a navigation source.
/// The Path Item Object for the entity set contains the keyword patch with an Operation Object as value
/// that describes the capabilities for updating the navigation property for a navigation source.
/// </summary>
internal class NavigationPropertyPatchOperationHandler : NavigationPropertyOperationHandler
{
/// <inheritdoc/>
public override OperationType OperationType => OperationType.Patch;
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Update the navigation property " + NavigationProperty.Name + " in " + NavigationSource.Name;
// OperationId
if (Context.Settings.EnableOperationId)
{
string prefix = "Update";
operation.OperationId = GetOperationId(prefix);
}
base.SetBasicInfo(operation);
}
/// <inheritdoc/>
protected override void SetRequestBody(OpenApiOperation operation)
{
operation.RequestBody = new OpenApiRequestBody
{
Required = true,
Description = "New navigation property values",
Content = new Dictionary<string, OpenApiMediaType>
{
{
Constants.ApplicationJsonMediaType, new OpenApiMediaType
{
Schema = new OpenApiSchema
{
Reference = new OpenApiReference
{
Type = ReferenceType.Schema,
Id = NavigationProperty.ToEntityType().FullName()
}
}
}
}
}
};
base.SetRequestBody(operation);
}
/// <inheritdoc/>
protected override void SetResponses(OpenApiOperation operation)
{
operation.Responses = new OpenApiResponses
{
{ Constants.StatusCode204, Constants.StatusCode204.GetResponse() },
{ Constants.StatusCodeDefault, Constants.StatusCodeDefault.GetResponse() }
};
base.SetResponses(operation);
}
protected override void SetSecurity(OpenApiOperation operation)
{
if (Restriction == null || Restriction.UpdateRestrictions == null)
{
return;
}
operation.Security = Context.CreateSecurityRequirements(Restriction.UpdateRestrictions.Permissions).ToList();
}
protected override void AppendCustomParameters(OpenApiOperation operation)
{
if (Restriction == null || Restriction.UpdateRestrictions == null)
{
return;
}
if (Restriction.UpdateRestrictions.CustomHeaders != null)
{
AppendCustomParameters(operation, Restriction.UpdateRestrictions.CustomHeaders, ParameterLocation.Header);
}
if (Restriction.UpdateRestrictions.CustomQueryOptions != null)
{
AppendCustomParameters(operation, Restriction.UpdateRestrictions.CustomQueryOptions, ParameterLocation.Query);
}
}
}
}