RestApiServer.cs

// Copyright (c) Microsoft. All rights reserved.

using System.Collections.Generic;
using System.Collections.ObjectModel;

namespace Microsoft.SemanticKernel.Plugins.OpenApi;

/// <summary>
/// REST API server.
/// </summary>
public sealed class RestApiServer
{
    /// <summary>
    /// Description of the server.
    /// </summary>
    public string? Description { get; }

    /// <summary>
    /// A URL to the target host. This URL supports Server Variables and MAY be relative,
    /// to indicate that the host location is relative to the location where the OpenAPI document is being served.
    /// Variable substitutions will be made when a variable is named in {brackets}.
    /// </summary>
#pragma warning disable CA1056 // URI-like properties should not be strings
    public string? Url { get; }
#pragma warning restore CA1056 // URI-like properties should not be strings

    /// <summary>
    /// A map between a variable name and its value. The value is used for substitution in the server's URL template.
    /// </summary>
    public IDictionary<string, RestApiServerVariable> Variables { get; private set; }

    /// <summary>
    /// Construct a new <see cref="RestApiServer"/> object.
    /// </summary>
    /// <param name="url">URL to the target host</param>
    /// <param name="variables">Substitution variables for the server's URL template</param>
    /// <param name="description">Description of the server</param>
#pragma warning disable CA1054 // URI-like parameters should not be strings
    internal RestApiServer(string? url = null, IDictionary<string, RestApiServerVariable>? variables = null, string? description = null)
#pragma warning restore CA1054 // URI-like parameters should not be strings
    {
        this.Url = string.IsNullOrEmpty(url) ? null : url;
        this.Variables = variables ?? new Dictionary<string, RestApiServerVariable>();
        this.Description = description;
    }

    /// <summary>
    /// Makes the current instance unmodifiable.
    /// </summary>
    internal void Freeze()
    {
        this.Variables = new ReadOnlyDictionary<string, RestApiServerVariable>(this.Variables);
        foreach (var variable in this.Variables.Values)
        {
            variable.Freeze();
        }
    }
}