Skip to content

Commit 28b226e

Browse files
baywetbaywet
authored
Merge pull request #1997 from microsoft/chore/linting
chore/linting
2 parents 8bf3fbe + e86df13 commit 28b226e

File tree

8 files changed

+130
-241
lines changed

8 files changed

+130
-241
lines changed

‎src/Microsoft.OpenApi.Hidi/StatsVisitor.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public override void Visit(OpenApiOperation operation)
6161

6262
public int LinkCount { get; set; }
6363

64-
public override void Visit(OpenApiLink operation)
64+
public override void Visit(OpenApiLink link)
6565
{
6666
LinkCount++;
6767
}

‎src/Microsoft.OpenApi.Workbench/StatsVisitor.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public override void Visit(OpenApiOperation operation)
6161

6262
public int LinkCount { get; set; }
6363

64-
public override void Visit(OpenApiLink operation)
64+
public override void Visit(OpenApiLink link)
6565
{
6666
LinkCount++;
6767
}

‎src/Microsoft.OpenApi/Models/OpenApiExtensibleDictionary.cs‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,23 @@ public abstract class OpenApiExtensibleDictionary<T> : Dictionary<string, T>,
2020
/// <summary>
2121
/// Parameterless constructor
2222
/// </summary>
23-
protected OpenApiExtensibleDictionary() { }
24-
23+
protected OpenApiExtensibleDictionary():this(null) { }
2524
/// <summary>
2625
/// Initializes a copy of <see cref="OpenApiExtensibleDictionary{T}"/> class.
2726
/// </summary>
2827
/// <param name="dictionary">The generic dictionary.</param>
2928
/// <param name="extensions">The dictionary of <see cref="IOpenApiExtension"/>.</param>
3029
protected OpenApiExtensibleDictionary(
31-
Dictionary<string, T> dictionary = null,
32-
IDictionary<string, IOpenApiExtension> extensions = null) : base(dictionary)
30+
Dictionary<string, T> dictionary,
31+
IDictionary<string, IOpenApiExtension> extensions = null) : base(dictionary is null ? [] : dictionary)
3332
{
34-
Extensions = extensions != null ? new Dictionary<string, IOpenApiExtension>(extensions) : null;
33+
Extensions = extensions != null ? new Dictionary<string, IOpenApiExtension>(extensions) : [];
3534
}
3635

3736
/// <summary>
3837
/// This object MAY be extended with Specification Extensions.
3938
/// </summary>
40-
public IDictionary<string, IOpenApiExtension> Extensions { get; set; } = new Dictionary<string, IOpenApiExtension>();
39+
public IDictionary<string, IOpenApiExtension> Extensions { get; set; }
4140

4241

4342
/// <summary>

‎src/Microsoft.OpenApi/Services/OpenApiReferenceError.cs‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ namespace Microsoft.OpenApi.Services
1111
/// </summary>
1212
public class OpenApiReferenceError : OpenApiError
1313
{
14-
private OpenApiReference _reference;
14+
/// <summary>
15+
/// The reference that caused the error.
16+
/// </summary>
17+
public readonly OpenApiReference Reference;
1518
/// <summary>
1619
/// Initializes the <see cref="OpenApiError"/> class using the message and pointer from the given exception.
1720
/// </summary>
@@ -26,7 +29,7 @@ public OpenApiReferenceError(OpenApiException exception) : base(exception.Pointe
2629
/// <param name="message"></param>
2730
public OpenApiReferenceError(OpenApiReference reference, string message) : base("", message)
2831
{
29-
_reference = reference;
32+
Reference = reference;
3033
}
3134
}
3235
}

‎src/Microsoft.OpenApi/Validations/OpenApiValidator.cs‎

Lines changed: 74 additions & 185 deletions
Original file line numberDiff line numberDiff line change
@@ -67,219 +67,108 @@ public void AddWarning(OpenApiValidatorWarning warning)
6767
_warnings.Add(warning);
6868
}
6969

70-
/// <summary>
71-
/// Execute validation rules against an <see cref="OpenApiDocument"/>
72-
/// </summary>
73-
/// <param name="item">The object to be validated</param>
74-
public override void Visit(OpenApiDocument item) => Validate(item);
70+
/// <inheritdoc/>
71+
public override void Visit(OpenApiDocument doc) => Validate(doc);
7572

76-
/// <summary>
77-
/// Execute validation rules against an <see cref="OpenApiInfo"/>
78-
/// </summary>
79-
/// <param name="item">The object to be validated</param>
80-
public override void Visit(OpenApiInfo item) => Validate(item);
73+
/// <inheritdoc/>
74+
public override void Visit(OpenApiInfo info) => Validate(info);
8175

82-
/// <summary>
83-
/// Execute validation rules against an <see cref="OpenApiContact"/>
84-
/// </summary>
85-
/// <param name="item">The object to be validated</param>
86-
public override void Visit(OpenApiContact item) => Validate(item);
76+
/// <inheritdoc/>
77+
public override void Visit(OpenApiContact contact) => Validate(contact);
8778

88-
/// <summary>
89-
/// Execute validation rules against an <see cref="OpenApiComponents"/>
90-
/// </summary>
91-
/// <param name="item">The object to be validated</param>
92-
public override void Visit(OpenApiComponents item) => Validate(item);
79+
/// <inheritdoc/>
80+
public override void Visit(OpenApiComponents components) => Validate(components);
9381

94-
/// <summary>
95-
/// Execute validation rules against an <see cref="OpenApiHeader"/>
96-
/// </summary>
97-
/// <param name="item">The object to be validated</param>
98-
public override void Visit(OpenApiHeader item) => Validate(item);
82+
/// <inheritdoc/>
83+
public override void Visit(OpenApiHeader header) => Validate(header);
9984

100-
/// <summary>
101-
/// Execute validation rules against an <see cref="OpenApiResponse"/>
102-
/// </summary>
103-
/// <param name="item">The object to be validated</param>
104-
public override void Visit(OpenApiResponse item) => Validate(item);
85+
/// <inheritdoc/>
86+
public override void Visit(OpenApiResponse response) => Validate(response);
10587

106-
/// <summary>
107-
/// Execute validation rules against an <see cref="OpenApiMediaType"/>
108-
/// </summary>
109-
/// <param name="item">The object to be validated</param>
110-
public override void Visit(OpenApiMediaType item) => Validate(item);
88+
/// <inheritdoc/>
89+
public override void Visit(OpenApiMediaType mediaType) => Validate(mediaType);
11190

112-
/// <summary>
113-
/// Execute validation rules against an <see cref="OpenApiResponses"/>
114-
/// </summary>
115-
/// <param name="item">The object to be validated</param>
116-
public override void Visit(OpenApiResponses item) => Validate(item);
91+
/// <inheritdoc/>
92+
public override void Visit(OpenApiResponses response) => Validate(response);
11793

118-
/// <summary>
119-
/// Execute validation rules against an <see cref="OpenApiExternalDocs"/>
120-
/// </summary>
121-
/// <param name="item">The object to be validated</param>
122-
public override void Visit(OpenApiExternalDocs item) => Validate(item);
94+
/// <inheritdoc/>
95+
public override void Visit(OpenApiExternalDocs externalDocs) => Validate(externalDocs);
12396

124-
/// <summary>
125-
/// Execute validation rules against an <see cref="OpenApiLicense"/>
126-
/// </summary>
127-
/// <param name="item">The object to be validated</param>
128-
public override void Visit(OpenApiLicense item) => Validate(item);
97+
/// <inheritdoc/>
98+
public override void Visit(OpenApiLicense license) => Validate(license);
12999

130-
/// <summary>
131-
/// Execute validation rules against an <see cref="OpenApiOAuthFlow"/>
132-
/// </summary>
133-
/// <param name="item">The object to be validated</param>
134-
public override void Visit(OpenApiOAuthFlow item) => Validate(item);
100+
/// <inheritdoc/>
101+
public override void Visit(OpenApiOAuthFlow openApiOAuthFlow) => Validate(openApiOAuthFlow);
135102

136-
/// <summary>
137-
/// Execute validation rules against an <see cref="OpenApiTag"/>
138-
/// </summary>
139-
/// <param name="item">The object to be validated</param>
140-
public override void Visit(OpenApiTag item) => Validate(item);
103+
/// <inheritdoc/>
104+
public override void Visit(OpenApiTag tag) => Validate(tag);
141105

142-
/// <summary>
143-
/// Execute validation rules against an <see cref="OpenApiParameter"/>
144-
/// </summary>
145-
/// <param name="item">The object to be validated</param>
146-
public override void Visit(OpenApiParameter item) => Validate(item);
106+
/// <inheritdoc/>
107+
public override void Visit(OpenApiParameter parameter) => Validate(parameter);
147108

148-
/// <summary>
149-
/// Execute validation rules against an <see cref="OpenApiSchema"/>
150-
/// </summary>
151-
/// <param name="item">The object to be validated</param>
152-
public override void Visit(OpenApiSchema item) => Validate(item);
109+
/// <inheritdoc/>
110+
public override void Visit(OpenApiSchema schema) => Validate(schema);
153111

154-
/// <summary>
155-
/// Execute validation rules against an <see cref="OpenApiServer"/>
156-
/// </summary>
157-
/// <param name="item">The object to be validated</param>
158-
public override void Visit(OpenApiServer item) => Validate(item);
112+
/// <inheritdoc/>
113+
public override void Visit(OpenApiServer server) => Validate(server);
159114

160-
/// <summary>
161-
/// Execute validation rules against an <see cref="OpenApiEncoding"/>
162-
/// </summary>
163-
/// <param name="item">The object to be validated</param>
164-
public override void Visit(OpenApiEncoding item) => Validate(item);
115+
/// <inheritdoc/>
116+
public override void Visit(OpenApiEncoding encoding) => Validate(encoding);
165117

166-
/// <summary>
167-
/// Execute validation rules against an <see cref="OpenApiCallback"/>
168-
/// </summary>
169-
/// <param name="item">The object to be validated</param>
170-
public override void Visit(OpenApiCallback item) => Validate(item);
118+
/// <inheritdoc/>
119+
public override void Visit(OpenApiCallback callback) => Validate(callback);
171120

172-
/// <summary>
173-
/// Execute validation rules against an <see cref="IOpenApiExtensible"/>
174-
/// </summary>
175-
/// <param name="item">The object to be validated</param>
176-
public override void Visit(IOpenApiExtensible item) => Validate(item);
121+
/// <inheritdoc/>
122+
public override void Visit(IOpenApiExtensible openApiExtensible) => Validate(openApiExtensible);
177123

178-
/// <summary>
179-
/// Execute validation rules against an <see cref="IOpenApiExtension"/>
180-
/// </summary>
181-
/// <param name="item">The object to be validated</param>
182-
public override void Visit(IOpenApiExtension item) => Validate(item, item.GetType());
124+
/// <inheritdoc/>
125+
public override void Visit(IOpenApiExtension openApiExtension) => Validate(openApiExtension, openApiExtension.GetType());
183126

184-
/// <summary>
185-
/// Execute validation rules against a list of <see cref="OpenApiExample"/>
186-
/// </summary>
187-
/// <param name="items">The object to be validated</param>
188-
public override void Visit(IList<OpenApiExample> items) => Validate(items, items.GetType());
127+
/// <inheritdoc/>
128+
public override void Visit(IList<OpenApiExample> example) => Validate(example, example.GetType());
189129

190-
/// <summary>
191-
/// Execute validation rules against a <see cref="OpenApiPathItem"/>
192-
/// </summary>
193-
/// <param name="item">The object to be validated</param>
194-
public override void Visit(OpenApiPathItem item) => Validate(item);
130+
/// <inheritdoc/>
131+
public override void Visit(OpenApiPathItem pathItem) => Validate(pathItem);
195132

196-
/// <summary>
197-
/// Execute validation rules against a <see cref="OpenApiServerVariable"/>
198-
/// </summary>
199-
/// <param name="item">The object to be validated</param>
200-
public override void Visit(OpenApiServerVariable item) => Validate(item);
133+
/// <inheritdoc/>
134+
public override void Visit(OpenApiServerVariable serverVariable) => Validate(serverVariable);
201135

202-
/// <summary>
203-
/// Execute validation rules against a <see cref="OpenApiSecurityScheme"/>
204-
/// </summary>
205-
/// <param name="item">The object to be validated</param>
206-
public override void Visit(OpenApiSecurityScheme item) => Validate(item);
136+
/// <inheritdoc/>
137+
public override void Visit(OpenApiSecurityScheme securityScheme) => Validate(securityScheme);
207138

208-
/// <summary>
209-
/// Execute validation rules against a <see cref="OpenApiSecurityRequirement"/>
210-
/// </summary>
211-
/// <param name="item">The object to be validated</param>
212-
public override void Visit(OpenApiSecurityRequirement item) => Validate(item);
139+
/// <inheritdoc/>
140+
public override void Visit(OpenApiSecurityRequirement securityRequirement) => Validate(securityRequirement);
213141

214-
/// <summary>
215-
/// Execute validation rules against a <see cref="OpenApiRequestBody"/>
216-
/// </summary>
217-
/// <param name="item">The object to be validated</param>
218-
public override void Visit(OpenApiRequestBody item) => Validate(item);
142+
/// <inheritdoc/>
143+
public override void Visit(OpenApiRequestBody requestBody) => Validate(requestBody);
219144

220-
/// <summary>
221-
/// Execute validation rules against a <see cref="OpenApiPaths"/>
222-
/// </summary>
223-
/// <param name="item">The object to be validated</param>
224-
public override void Visit(OpenApiPaths item) => Validate(item);
145+
/// <inheritdoc/>
146+
public override void Visit(OpenApiPaths paths) => Validate(paths);
225147

226-
/// <summary>
227-
/// Execute validation rules against a <see cref="OpenApiLink"/>
228-
/// </summary>
229-
/// <param name="item">The object to be validated</param>
230-
public override void Visit(OpenApiLink item) => Validate(item);
148+
/// <inheritdoc/>
149+
public override void Visit(OpenApiLink link) => Validate(link);
231150

232-
/// <summary>
233-
/// Execute validation rules against a <see cref="OpenApiExample"/>
234-
/// </summary>
235-
/// <param name="item">The object to be validated</param>
236-
public override void Visit(OpenApiExample item) => Validate(item);
151+
/// <inheritdoc/>
152+
public override void Visit(OpenApiExample example) => Validate(example);
237153

238-
/// <summary>
239-
/// Execute validation rules against a <see cref="OpenApiOperation"/>
240-
/// </summary>
241-
/// <param name="item">The object to be validated</param>
242-
public override void Visit(OpenApiOperation item) => Validate(item);
243-
/// <summary>
244-
/// Execute validation rules against a <see cref="IDictionary{OperationType, OpenApiOperation}"/>
245-
/// </summary>
246-
/// <param name="item">The object to be validated</param>
247-
public override void Visit(IDictionary<OperationType, OpenApiOperation> item) => Validate(item, item.GetType());
248-
/// <summary>
249-
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiHeader}"/>
250-
/// </summary>
251-
/// <param name="item">The object to be validated</param>
252-
public override void Visit(IDictionary<string, OpenApiHeader> item) => Validate(item, item.GetType());
253-
/// <summary>
254-
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiCallback}"/>
255-
/// </summary>
256-
/// <param name="item">The object to be validated</param>
257-
public override void Visit(IDictionary<string, OpenApiCallback> item) => Validate(item, item.GetType());
258-
/// <summary>
259-
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiMediaType}"/>
260-
/// </summary>
261-
/// <param name="item">The object to be validated</param>
262-
public override void Visit(IDictionary<string, OpenApiMediaType> item) => Validate(item, item.GetType());
263-
/// <summary>
264-
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiExample}"/>
265-
/// </summary>
266-
/// <param name="item">The object to be validated</param>
267-
public override void Visit(IDictionary<string, OpenApiExample> item) => Validate(item, item.GetType());
268-
/// <summary>
269-
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiLink}"/>
270-
/// </summary>
271-
/// <param name="item">The object to be validated</param>
272-
public override void Visit(IDictionary<string, OpenApiLink> item) => Validate(item, item.GetType());
273-
/// <summary>
274-
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiServerVariable}"/>
275-
/// </summary>
276-
/// <param name="item">The object to be validated</param>
277-
public override void Visit(IDictionary<string, OpenApiServerVariable> item) => Validate(item, item.GetType());
278-
/// <summary>
279-
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiEncoding}"/>
280-
/// </summary>
281-
/// <param name="item">The object to be validated</param>
282-
public override void Visit(IDictionary<string, OpenApiEncoding> item) => Validate(item, item.GetType());
154+
/// <inheritdoc/>
155+
public override void Visit(OpenApiOperation operation) => Validate(operation);
156+
/// <inheritdoc/>
157+
public override void Visit(IDictionary<OperationType, OpenApiOperation> operations) => Validate(operations, operations.GetType());
158+
/// <inheritdoc/>
159+
public override void Visit(IDictionary<string, OpenApiHeader> headers) => Validate(headers, headers.GetType());
160+
/// <inheritdoc/>
161+
public override void Visit(IDictionary<string, OpenApiCallback> callbacks) => Validate(callbacks, callbacks.GetType());
162+
/// <inheritdoc/>
163+
public override void Visit(IDictionary<string, OpenApiMediaType> content) => Validate(content, content.GetType());
164+
/// <inheritdoc/>
165+
public override void Visit(IDictionary<string, OpenApiExample> examples) => Validate(examples, examples.GetType());
166+
/// <inheritdoc/>
167+
public override void Visit(IDictionary<string, OpenApiLink> links) => Validate(links, links.GetType());
168+
/// <inheritdoc/>
169+
public override void Visit(IDictionary<string, OpenApiServerVariable> serverVariables) => Validate(serverVariables, serverVariables.GetType());
170+
/// <inheritdoc/>
171+
public override void Visit(IDictionary<string, OpenApiEncoding> encodings) => Validate(encodings, encodings.GetType());
283172

284173
private void Validate<T>(T item)
285174
{

‎src/Microsoft.OpenApi/Validations/Rules/OpenApiComponentsRules.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public static class OpenApiComponentsRules
1717
/// <summary>
1818
/// The key regex.
1919
/// </summary>
20-
public static Regex KeyRegex = new(@"^[a-zA-Z0-9\.\-_]+$");
20+
internal static readonly Regex KeyRegex = new(@"^[a-zA-Z0-9\.\-_]+$");
2121

2222
/// <summary>
2323
/// All the fixed fields declared above are objects

‎src/Microsoft.OpenApi/Validations/Rules/OpenApiExtensionRules.cs‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
// Licensed under the MIT license.
33

44
using System;
5+
using System.Linq;
56
using Microsoft.OpenApi.Interfaces;
67
using Microsoft.OpenApi.Properties;
78

@@ -21,13 +22,10 @@ public static class OpenApiExtensibleRules
2122
(context, item) =>
2223
{
2324
context.Enter("extensions");
24-
foreach (var extensible in item.Extensions)
25+
foreach (var extensible in item.Extensions.Keys.Where(static x => !x.StartsWith("x-", StringComparison.OrdinalIgnoreCase)))
2526
{
26-
if (!extensible.Key.StartsWith("x-"))
27-
{
28-
context.CreateError(nameof(ExtensionNameMustStartWithXDash),
29-
String.Format(SRResource.Validation_ExtensionNameMustBeginWithXDash, extensible.Key, context.PathString));
30-
}
27+
context.CreateError(nameof(ExtensionNameMustStartWithXDash),
28+
string.Format(SRResource.Validation_ExtensionNameMustBeginWithXDash, extensible, context.PathString));
3129
}
3230
context.Exit();
3331
});

0 commit comments

Comments
 (0)