Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore/linting #1997

Merged
merged 9 commits into from
Dec 19, 2024
Merged

chore/linting #1997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4f55597
chore: exposes unused property so consumers can read the information
baywet Dec 19, 2024
b00b557
chore: aligns parameter names with base definition
baywet Dec 19, 2024
f9f7766
chore: aligns parameter names
baywet Dec 19, 2024
a72c5c2
chore: linting
baywet Dec 19, 2024
b9ef21d
chore: removes conflicting overload
baywet Dec 19, 2024
84e83f4
chore: reduces loops
baywet Dec 19, 2024
4f28b65
fix: extensions collection initialization
baywet Dec 19, 2024
778184f
fix: restores default constructor for ISerializable implementation
baywet Dec 19, 2024
e86df13
chore: makes regex internal
baywet Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi.Hidi/StatsVisitor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public override void Visit(OpenApiOperation operation)

public int LinkCount { get; set; }

public override void Visit(OpenApiLink operation)
public override void Visit(OpenApiLink link)
{
LinkCount++;
}
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi.Workbench/StatsVisitor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public override void Visit(OpenApiOperation operation)

public int LinkCount { get; set; }

public override void Visit(OpenApiLink operation)
public override void Visit(OpenApiLink link)
{
LinkCount++;
}
Expand Down
11 changes: 5 additions & 6 deletions src/Microsoft.OpenApi/Models/OpenApiExtensibleDictionary.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,23 @@ public abstract class OpenApiExtensibleDictionary<T> : Dictionary<string, T>,
/// <summary>
/// Parameterless constructor
/// </summary>
protected OpenApiExtensibleDictionary() { }

protected OpenApiExtensibleDictionary():this(null) { }
/// <summary>
/// Initializes a copy of <see cref="OpenApiExtensibleDictionary{T}"/> class.
/// </summary>
/// <param name="dictionary">The generic dictionary.</param>
/// <param name="extensions">The dictionary of <see cref="IOpenApiExtension"/>.</param>
protected OpenApiExtensibleDictionary(
Dictionary<string, T> dictionary = null,
IDictionary<string, IOpenApiExtension> extensions = null) : base(dictionary)
Dictionary<string, T> dictionary,
IDictionary<string, IOpenApiExtension> extensions = null) : base(dictionary is null ? [] : dictionary)
{
Extensions = extensions != null ? new Dictionary<string, IOpenApiExtension>(extensions) : null;
Extensions = extensions != null ? new Dictionary<string, IOpenApiExtension>(extensions) : [];
}

/// <summary>
/// This object MAY be extended with Specification Extensions.
/// </summary>
public IDictionary<string, IOpenApiExtension> Extensions { get; set; } = new Dictionary<string, IOpenApiExtension>();
public IDictionary<string, IOpenApiExtension> Extensions { get; set; }


/// <summary>
Expand Down
7 changes: 5 additions & 2 deletions src/Microsoft.OpenApi/Services/OpenApiReferenceError.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ namespace Microsoft.OpenApi.Services
/// </summary>
public class OpenApiReferenceError : OpenApiError
{
private OpenApiReference _reference;
/// <summary>
/// The reference that caused the error.
/// </summary>
public readonly OpenApiReference Reference;
/// <summary>
/// Initializes the <see cref="OpenApiError"/> class using the message and pointer from the given exception.
/// </summary>
Expand All @@ -26,7 +29,7 @@ public OpenApiReferenceError(OpenApiException exception) : base(exception.Pointe
/// <param name="message"></param>
public OpenApiReferenceError(OpenApiReference reference, string message) : base("", message)
{
_reference = reference;
Reference = reference;
}
}
}
259 changes: 74 additions & 185 deletions src/Microsoft.OpenApi/Validations/OpenApiValidator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,219 +67,108 @@ public void AddWarning(OpenApiValidatorWarning warning)
_warnings.Add(warning);
}

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

/// <summary>
/// Execute validation rules against an <see cref="OpenApiInfo"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiInfo item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiInfo info) => Validate(info);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiContact"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiContact item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiContact contact) => Validate(contact);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiComponents"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiComponents item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiComponents components) => Validate(components);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiHeader"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiHeader item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiHeader header) => Validate(header);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiResponse"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiResponse item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiResponse response) => Validate(response);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiMediaType"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiMediaType item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiMediaType mediaType) => Validate(mediaType);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiResponses"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiResponses item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiResponses response) => Validate(response);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiExternalDocs"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiExternalDocs item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiExternalDocs externalDocs) => Validate(externalDocs);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiLicense"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiLicense item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiLicense license) => Validate(license);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiOAuthFlow"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiOAuthFlow item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiOAuthFlow openApiOAuthFlow) => Validate(openApiOAuthFlow);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiTag"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiTag item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiTag tag) => Validate(tag);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiParameter"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiParameter item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiParameter parameter) => Validate(parameter);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiSchema"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiSchema item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiSchema schema) => Validate(schema);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiServer"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiServer item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiServer server) => Validate(server);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiEncoding"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiEncoding item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiEncoding encoding) => Validate(encoding);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiCallback"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiCallback item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiCallback callback) => Validate(callback);

/// <summary>
/// Execute validation rules against an <see cref="IOpenApiExtensible"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(IOpenApiExtensible item) => Validate(item);
/// <inheritdoc/>
public override void Visit(IOpenApiExtensible openApiExtensible) => Validate(openApiExtensible);

/// <summary>
/// Execute validation rules against an <see cref="IOpenApiExtension"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(IOpenApiExtension item) => Validate(item, item.GetType());
/// <inheritdoc/>
public override void Visit(IOpenApiExtension openApiExtension) => Validate(openApiExtension, openApiExtension.GetType());

/// <summary>
/// Execute validation rules against a list of <see cref="OpenApiExample"/>
/// </summary>
/// <param name="items">The object to be validated</param>
public override void Visit(IList<OpenApiExample> items) => Validate(items, items.GetType());
/// <inheritdoc/>
public override void Visit(IList<OpenApiExample> example) => Validate(example, example.GetType());

/// <summary>
/// Execute validation rules against a <see cref="OpenApiPathItem"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiPathItem item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiPathItem pathItem) => Validate(pathItem);

/// <summary>
/// Execute validation rules against a <see cref="OpenApiServerVariable"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiServerVariable item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiServerVariable serverVariable) => Validate(serverVariable);

/// <summary>
/// Execute validation rules against a <see cref="OpenApiSecurityScheme"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiSecurityScheme item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiSecurityScheme securityScheme) => Validate(securityScheme);

/// <summary>
/// Execute validation rules against a <see cref="OpenApiSecurityRequirement"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiSecurityRequirement item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiSecurityRequirement securityRequirement) => Validate(securityRequirement);

/// <summary>
/// Execute validation rules against a <see cref="OpenApiRequestBody"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiRequestBody item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiRequestBody requestBody) => Validate(requestBody);

/// <summary>
/// Execute validation rules against a <see cref="OpenApiPaths"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiPaths item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiPaths paths) => Validate(paths);

/// <summary>
/// Execute validation rules against a <see cref="OpenApiLink"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiLink item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiLink link) => Validate(link);

/// <summary>
/// Execute validation rules against a <see cref="OpenApiExample"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiExample item) => Validate(item);
/// <inheritdoc/>
public override void Visit(OpenApiExample example) => Validate(example);

/// <summary>
/// Execute validation rules against a <see cref="OpenApiOperation"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiOperation item) => Validate(item);
/// <summary>
/// Execute validation rules against a <see cref="IDictionary{OperationType, OpenApiOperation}"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(IDictionary<OperationType, OpenApiOperation> item) => Validate(item, item.GetType());
/// <summary>
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiHeader}"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(IDictionary<string, OpenApiHeader> item) => Validate(item, item.GetType());
/// <summary>
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiCallback}"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(IDictionary<string, OpenApiCallback> item) => Validate(item, item.GetType());
/// <summary>
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiMediaType}"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(IDictionary<string, OpenApiMediaType> item) => Validate(item, item.GetType());
/// <summary>
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiExample}"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(IDictionary<string, OpenApiExample> item) => Validate(item, item.GetType());
/// <summary>
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiLink}"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(IDictionary<string, OpenApiLink> item) => Validate(item, item.GetType());
/// <summary>
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiServerVariable}"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(IDictionary<string, OpenApiServerVariable> item) => Validate(item, item.GetType());
/// <summary>
/// Execute validation rules against a <see cref="IDictionary{String, OpenApiEncoding}"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(IDictionary<string, OpenApiEncoding> item) => Validate(item, item.GetType());
/// <inheritdoc/>
public override void Visit(OpenApiOperation operation) => Validate(operation);
/// <inheritdoc/>
public override void Visit(IDictionary<OperationType, OpenApiOperation> operations) => Validate(operations, operations.GetType());
/// <inheritdoc/>
public override void Visit(IDictionary<string, OpenApiHeader> headers) => Validate(headers, headers.GetType());
/// <inheritdoc/>
public override void Visit(IDictionary<string, OpenApiCallback> callbacks) => Validate(callbacks, callbacks.GetType());
/// <inheritdoc/>
public override void Visit(IDictionary<string, OpenApiMediaType> content) => Validate(content, content.GetType());
/// <inheritdoc/>
public override void Visit(IDictionary<string, OpenApiExample> examples) => Validate(examples, examples.GetType());
/// <inheritdoc/>
public override void Visit(IDictionary<string, OpenApiLink> links) => Validate(links, links.GetType());
/// <inheritdoc/>
public override void Visit(IDictionary<string, OpenApiServerVariable> serverVariables) => Validate(serverVariables, serverVariables.GetType());
/// <inheritdoc/>
public override void Visit(IDictionary<string, OpenApiEncoding> encodings) => Validate(encodings, encodings.GetType());

private void Validate<T>(T item)
{
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi/Validations/Rules/OpenApiComponentsRules.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public static class OpenApiComponentsRules
/// <summary>
/// The key regex.
/// </summary>
public static Regex KeyRegex = new(@"^[a-zA-Z0-9\.\-_]+$");
internal static readonly Regex KeyRegex = new(@"^[a-zA-Z0-9\.\-_]+$");

/// <summary>
/// All the fixed fields declared above are objects
Expand Down
10 changes: 4 additions & 6 deletions src/Microsoft.OpenApi/Validations/Rules/OpenApiExtensionRules.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Licensed under the MIT license.

using System;
using System.Linq;
using Microsoft.OpenApi.Interfaces;
using Microsoft.OpenApi.Properties;

Expand All @@ -21,13 +22,10 @@ public static class OpenApiExtensibleRules
(context, item) =>
{
context.Enter("extensions");
foreach (var extensible in item.Extensions)
foreach (var extensible in item.Extensions.Keys.Where(static x => !x.StartsWith("x-", StringComparison.OrdinalIgnoreCase)))
{
if (!extensible.Key.StartsWith("x-"))
{
context.CreateError(nameof(ExtensionNameMustStartWithXDash),
String.Format(SRResource.Validation_ExtensionNameMustBeginWithXDash, extensible.Key, context.PathString));
}
context.CreateError(nameof(ExtensionNameMustStartWithXDash),
string.Format(SRResource.Validation_ExtensionNameMustBeginWithXDash, extensible, context.PathString));
}
context.Exit();
});
Expand Down
Loading
Loading