116 lines
4.2 KiB
C#
116 lines
4.2 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.Edm;
|
|
using Microsoft.OpenApi.OData.Generator;
|
|
using Microsoft.OpenApi.OData.Vocabulary.Capabilities;
|
|
|
|
namespace Microsoft.OpenApi.OData.Operation
|
|
{
|
|
/// <summary>
|
|
/// Update an Entity
|
|
/// 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 entity.
|
|
/// </summary>
|
|
internal class EntityPatchOperationHandler : EntitySetOperationHandler
|
|
{
|
|
/// <inheritdoc/>
|
|
public override OperationType OperationType => OperationType.Patch;
|
|
|
|
/// <inheritdoc/>
|
|
protected override void SetBasicInfo(OpenApiOperation operation)
|
|
{
|
|
// Summary
|
|
operation.Summary = "Update entity in " + EntitySet.Name;
|
|
|
|
// OperationId
|
|
if (Context.Settings.EnableOperationId)
|
|
{
|
|
string typeName = EntitySet.EntityType().Name;
|
|
operation.OperationId = EntitySet.Name + "." + typeName + ".Update" + Utils.UpperFirstChar(typeName);
|
|
}
|
|
|
|
base.SetBasicInfo(operation);
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
protected override void SetRequestBody(OpenApiOperation operation)
|
|
{
|
|
operation.RequestBody = new OpenApiRequestBody
|
|
{
|
|
Required = true,
|
|
Description = "New property values",
|
|
Content = new Dictionary<string, OpenApiMediaType>
|
|
{
|
|
{
|
|
Constants.ApplicationJsonMediaType, new OpenApiMediaType
|
|
{
|
|
Schema = new OpenApiSchema
|
|
{
|
|
Reference = new OpenApiReference
|
|
{
|
|
Type = ReferenceType.Schema,
|
|
Id = EntitySet.EntityType().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)
|
|
{
|
|
UpdateRestrictionsType update = Context.Model.GetRecord<UpdateRestrictionsType>(EntitySet, CapabilitiesConstants.UpdateRestrictions);
|
|
if (update == null || update.Permission == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
// the Permission should be collection, however current ODL supports the single permission.
|
|
// Will update after ODL change.
|
|
operation.Security = Context.CreateSecurityRequirements(new[] { update.Permission.Scheme }).ToList();
|
|
}
|
|
|
|
protected override void AppendCustomParameters(OpenApiOperation operation)
|
|
{
|
|
UpdateRestrictionsType update = Context.Model.GetRecord<UpdateRestrictionsType>(EntitySet, CapabilitiesConstants.UpdateRestrictions);
|
|
if (update == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (update.CustomHeaders != null)
|
|
{
|
|
AppendCustomParameters(operation.Parameters, update.CustomHeaders, ParameterLocation.Header);
|
|
}
|
|
|
|
if (update.CustomQueryOptions != null)
|
|
{
|
|
AppendCustomParameters(operation.Parameters, update.CustomQueryOptions, ParameterLocation.Query);
|
|
}
|
|
}
|
|
}
|
|
}
|