1+ // Copyright (c) Microsoft Corporation. All rights reserved.
2+ // Licensed under the MIT license.
3+
4+ using System . Collections . Generic ;
5+ using Microsoft . OpenApi . Models ;
6+
7+ namespace Microsoft . OpenApi . Services
8+ {
9+ /// <summary>
10+ /// Defines behavior for comparing properties of <see cref="OpenApiHeader"/>.
11+ /// </summary>
12+ public class OpenApiHeaderComparer : OpenApiComparerBase < OpenApiHeader >
13+ {
14+ /// <summary>
15+ /// Executes comparision against source and target <see cref="OpenApiHeader"/>.
16+ /// </summary>
17+ /// <param name="sourceHeader">The source.</param>
18+ /// <param name="targetHeader">The target.</param>
19+ /// <param name="comparisonContext">Context under which to compare the source and target.</param>
20+ public override void Compare (
21+ OpenApiHeader sourceHeader ,
22+ OpenApiHeader targetHeader ,
23+ ComparisonContext comparisonContext )
24+ {
25+ if ( sourceHeader == null && targetHeader == null )
26+ {
27+ return ;
28+ }
29+
30+ if ( sourceHeader == null || targetHeader == null )
31+ {
32+ comparisonContext . AddOpenApiDifference (
33+ new OpenApiDifference
34+ {
35+ OpenApiDifferenceOperation = OpenApiDifferenceOperation . Update ,
36+ SourceValue = sourceHeader ,
37+ TargetValue = targetHeader ,
38+ OpenApiComparedElementType = typeof ( OpenApiHeader ) ,
39+ Pointer = comparisonContext . PathString
40+ } ) ;
41+
42+ return ;
43+ }
44+
45+ if ( sourceHeader . Reference != null
46+ && targetHeader . Reference != null
47+ && sourceHeader . Reference . Id != targetHeader . Reference . Id )
48+ {
49+ WalkAndAddOpenApiDifference (
50+ comparisonContext ,
51+ "$ref" ,
52+ new OpenApiDifference
53+ {
54+ OpenApiDifferenceOperation = OpenApiDifferenceOperation . Update ,
55+ SourceValue = sourceHeader . Reference ,
56+ TargetValue = targetHeader . Reference ,
57+ OpenApiComparedElementType = typeof ( OpenApiReference )
58+ } ) ;
59+
60+ return ;
61+ }
62+
63+ if ( sourceHeader . Reference != null )
64+ {
65+ sourceHeader = ( OpenApiHeader ) comparisonContext . SourceDocument . ResolveReference (
66+ targetHeader . Reference ) ;
67+ }
68+
69+ if ( targetHeader . Reference != null )
70+ {
71+ targetHeader = ( OpenApiHeader ) comparisonContext . TargetDocument . ResolveReference (
72+ targetHeader . Reference ) ;
73+ }
74+
75+ WalkAndCompare ( comparisonContext , OpenApiConstants . Description ,
76+ ( ) => Compare ( sourceHeader . Description , targetHeader . Description , comparisonContext ) ) ;
77+
78+ WalkAndCompare ( comparisonContext , OpenApiConstants . Required ,
79+ ( ) => Compare ( sourceHeader . Required , targetHeader . Required , comparisonContext ) ) ;
80+
81+ WalkAndCompare ( comparisonContext , OpenApiConstants . Deprecated ,
82+ ( ) => Compare ( sourceHeader . Deprecated , targetHeader . Deprecated , comparisonContext ) ) ;
83+
84+ WalkAndCompare ( comparisonContext , OpenApiConstants . AllowEmptyValue ,
85+ ( ) => Compare ( sourceHeader . AllowEmptyValue , targetHeader . AllowEmptyValue , comparisonContext ) ) ;
86+
87+ WalkAndCompare ( comparisonContext , OpenApiConstants . Explode ,
88+ ( ) => Compare ( sourceHeader . Explode , targetHeader . Explode , comparisonContext ) ) ;
89+
90+ WalkAndCompare ( comparisonContext , OpenApiConstants . AllowReserved ,
91+ ( ) => Compare ( sourceHeader . AllowReserved , targetHeader . AllowReserved , comparisonContext ) ) ;
92+
93+ WalkAndCompare (
94+ comparisonContext ,
95+ OpenApiConstants . Content ,
96+ ( ) => comparisonContext
97+ . GetComparer < IDictionary < string , OpenApiMediaType > > ( )
98+ . Compare ( sourceHeader . Content , targetHeader . Content , comparisonContext ) ) ;
99+
100+ WalkAndCompare (
101+ comparisonContext ,
102+ OpenApiConstants . Schema ,
103+ ( ) => comparisonContext
104+ . GetComparer < OpenApiSchema > ( )
105+ . Compare ( sourceHeader . Schema , targetHeader . Schema , comparisonContext ) ) ;
106+
107+ // To do compare example
108+ // To do compare examples
109+ // To do compare extensions
110+ }
111+ }
112+ }
0 commit comments