OpenApiExtensionRules.cs

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

using System;
using System.Linq;

namespace Microsoft.OpenApi
{
    /// <summary>
    /// The validation rules for <see cref="IOpenApiExtensible"/>.
    /// </summary>
    [OpenApiRule]
    public static class OpenApiExtensibleRules
    {
        /// <summary>
        /// Extension name MUST start with "x-".
        /// </summary>
        public static ValidationRule<IOpenApiExtensible> ExtensionNameMustStartWithXDash =>
            new(nameof(ExtensionNameMustStartWithXDash),
                (context, item) =>
                {
                    if (item.Extensions is not null)
                    {
                        context.Enter("extensions");
                        foreach (var extensible in item.Extensions.Keys.Where(static x => !x.StartsWith(OpenApiConstants.ExtensionFieldNamePrefix, StringComparison.OrdinalIgnoreCase)))
                        {
                            context.CreateError(nameof(ExtensionNameMustStartWithXDash),
                                string.Format(SRResource.Validation_ExtensionNameMustBeginWithXDash, extensible, context.PathString));
                        }
                        context.Exit();
                    }
                });
    }
}