-
Notifications
You must be signed in to change notification settings - Fork 63
/
EdmOperationOperationHandler.cs
296 lines (256 loc) · 11 KB
/
EdmOperationOperationHandler.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
// ------------------------------------------------------------
// 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.Any;
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;
using Microsoft.OpenApi.OData.Vocabulary.Core;
namespace Microsoft.OpenApi.OData.Operation
{
/// <summary>
/// Base class for operation of <see cref="IEdmOperation"/>.
/// </summary>
internal abstract class EdmOperationOperationHandler : OperationHandler
{
/// <summary>
/// Gets the navigation source.
/// </summary>
protected IEdmNavigationSource NavigationSource { get; private set; }
/// <summary>
/// Gets the Edm operation.
/// </summary>
protected IEdmOperation EdmOperation { get; private set; }
/// <summary>
/// Gets the OData operation segment.
/// </summary>
protected ODataOperationSegment OperationSegment { get; private set; }
/// <summary>
/// Gets a value indicating whether the path has type cast segment or not.
/// </summary>
protected bool HasTypeCast { get; private set; }
/// <inheritdoc/>
protected override void Initialize(ODataContext context, ODataPath path)
{
// It's bound operation, the first segment must be the navigaiton source.
ODataNavigationSourceSegment navigationSourceSegment = path.FirstSegment as ODataNavigationSourceSegment;
NavigationSource = navigationSourceSegment.NavigationSource;
OperationSegment = path.LastSegment as ODataOperationSegment;
EdmOperation = OperationSegment.Operation;
HasTypeCast = path.Segments.Any(s => s is ODataTypeCastSegment);
base.Initialize(context, path);
}
/// <inheritdoc/>
protected override void SetBasicInfo(OpenApiOperation operation)
{
// Summary
operation.Summary = "Invoke " + (EdmOperation.IsAction() ? "action " : "function ") + EdmOperation.Name;
// Description
operation.Description = Context.Model.GetDescriptionAnnotation(EdmOperation);
// OperationId
if (Context.Settings.EnableOperationId)
{
// When the key segment is available,
// its EntityType name will be used
// in the operationId to avoid potential
// duplicates in entity vs entityset functions/actions
List<string> identifiers = new();
foreach (ODataSegment segment in Path.Segments)
{
if (segment is not ODataKeySegment)
{
identifiers.Add(segment.Identifier);
}
else
{
identifiers.Add(segment.EntityType.Name);
}
}
string operationId = string.Join(".", identifiers);
if (EdmOperation.IsAction())
{
operation.OperationId = operationId;
}
else
{
if (Path.LastSegment is ODataOperationSegment operationSegment &&
Context.Model.IsOperationOverload(operationSegment.Operation))
{
operation.OperationId = operationId + "-" + Path.LastSegment.GetPathHash(Context.Settings);
}
else
{
operation.OperationId = operationId;
}
}
}
base.SetBasicInfo(operation);
}
/// <inheritdoc/>
protected override void SetTags(OpenApiOperation operation)
{
string value = EdmOperation.IsAction() ? "Actions" : "Functions";
OpenApiTag tag = new OpenApiTag
{
Name = NavigationSource.Name + "." + value,
};
tag.Extensions.Add(Constants.xMsTocType, new OpenApiString("container"));
operation.Tags.Add(tag);
Context.AppendTag(tag);
base.SetTags(operation);
}
/// <inheritdoc/>
protected override void SetParameters(OpenApiOperation operation)
{
base.SetParameters(operation);
if (EdmOperation.IsFunction())
{
IEdmFunction function = (IEdmFunction)EdmOperation;
if (OperationSegment.ParameterMappings != null)
{
IList<OpenApiParameter> parameters = Context.CreateParameters(function, OperationSegment.ParameterMappings);
foreach (var parameter in parameters)
{
operation.Parameters.AppendParameter(parameter);
}
}
else
{
IDictionary<string, string> mappings = ParameterMappings[OperationSegment];
IList<OpenApiParameter> parameters = Context.CreateParameters(function, mappings);
if (operation.Parameters == null)
{
operation.Parameters = parameters;
}
else
{
foreach (var parameter in parameters)
{
operation.Parameters.AppendParameter(parameter);
}
}
}
AppendSystemQueryOptions(function, operation);
}
}
/// <inheritdoc/>
protected override void SetResponses(OpenApiOperation operation)
{
operation.Responses = Context.CreateResponses(EdmOperation);
base.SetResponses(operation);
}
/// <inheritdoc/>
protected override void SetSecurity(OpenApiOperation operation)
{
OperationRestrictionsType restriction = Context.Model.GetRecord<OperationRestrictionsType>(EdmOperation, CapabilitiesConstants.OperationRestrictions);
if (restriction == null || restriction.Permissions == null)
{
return;
}
operation.Security = Context.CreateSecurityRequirements(restriction.Permissions).ToList();
}
/// <inheritdoc/>
protected override void AppendCustomParameters(OpenApiOperation operation)
{
OperationRestrictionsType restriction = Context.Model.GetRecord<OperationRestrictionsType>(EdmOperation, CapabilitiesConstants.OperationRestrictions);
if (restriction == null)
{
return;
}
if (restriction.CustomHeaders != null)
{
AppendCustomParameters(operation, restriction.CustomHeaders, ParameterLocation.Header);
}
if (restriction.CustomQueryOptions != null)
{
AppendCustomParameters(operation, restriction.CustomQueryOptions, ParameterLocation.Query);
}
}
private void AppendSystemQueryOptions(IEdmFunction function, OpenApiOperation operation)
{
if (function.ReturnType.IsCollection())
{
// $top
if (Context.CreateTop(function) is OpenApiParameter topParameter)
{
operation.Parameters.AppendParameter(topParameter);
}
// $skip
if (Context.CreateSkip(function) is OpenApiParameter skipParameter)
{
operation.Parameters.AppendParameter(skipParameter);
}
// $search
if (Context.CreateSearch(function) is OpenApiParameter searchParameter)
{
operation.Parameters.AppendParameter(searchParameter);
}
// $filter
if (Context.CreateFilter(function) is OpenApiParameter filterParameter)
{
operation.Parameters.AppendParameter(filterParameter);
}
// $count
if (Context.CreateCount(function) is OpenApiParameter countParameter)
{
operation.Parameters.AppendParameter(countParameter);
}
if (function.ReturnType?.Definition?.AsElementType() is IEdmEntityType entityType)
{
// $select
if (Context.CreateSelect(function, entityType) is OpenApiParameter selectParameter)
{
operation.Parameters.AppendParameter(selectParameter);
}
// $orderby
if (Context.CreateOrderBy(function, entityType) is OpenApiParameter orderbyParameter)
{
operation.Parameters.AppendParameter(orderbyParameter);
}
}
}
}
/// <inheritdoc/>
protected override void SetCustomLinkRelType()
{
if (Context.Settings.CustomHttpMethodLinkRelMapping != null && EdmOperation != null)
{
LinkRelKey key = EdmOperation.IsAction() ? LinkRelKey.Action : LinkRelKey.Function;
Context.Settings.CustomHttpMethodLinkRelMapping.TryGetValue(key, out string linkRelValue);
CustomLinkRel = linkRelValue;
}
}
/// <inheritdoc/>
protected override void SetExternalDocs(OpenApiOperation operation)
{
if (Context.Settings.ShowExternalDocs && Context.Model.GetLinkRecord(EdmOperation, CustomLinkRel) is Link externalDocs)
{
operation.ExternalDocs = new OpenApiExternalDocs()
{
Description = CoreConstants.ExternalDocsDescription,
Url = externalDocs.Href
};
}
}
// <inheritdoc/>
protected override void SetExtensions(OpenApiOperation operation)
{
if (Context.Settings.EnablePagination && EdmOperation.ReturnType?.TypeKind() == EdmTypeKind.Collection)
{
OpenApiObject extension = new OpenApiObject
{
{ "nextLinkName", new OpenApiString("@odata.nextLink")},
{ "operationName", new OpenApiString(Context.Settings.PageableOperationName)}
};
operation.Extensions.Add(Constants.xMsPageable, extension);
}
base.SetExtensions(operation);
}
}
}