Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions Application/EdFi.Ods.Api/Controllers/VersionController.cs
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,12 @@ Dictionary<string, string> GetUrlsByName()
urlsByName["identity"] = $"{rootUrl}/identity/v{ApiVersionConstants.Identity}/";
}

if (_featureManager.IsFeatureEnabled(ApiFeature.OneRoster)
&& !string.IsNullOrEmpty(_apiSettings.OneRosterVersionUrl))
{
urlsByName["oneRoster"] = _apiSettings.OneRosterVersionUrl;
}

return urlsByName;
}
}
Expand Down
4 changes: 3 additions & 1 deletion Application/EdFi.Ods.Common/Configuration/ApiSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public ApiSettings()
public string PathBase { get; set; }

public string OdsContextRouteTemplate { get; set; }

public string OdsCorrelationIdHttpHeaderName { get; set; }

public NotificationSettings Notifications { get; set; } = new();
Expand All @@ -68,6 +68,8 @@ public ApiSettings()

public string DomainsExcludedFromOpenApi { get; set; }

public string OneRosterVersionUrl { get; set; }

public string OdsConnectionStringEncryptionKey
{
get => _odsConnectionStringEncryptionKey;
Expand Down
1 change: 1 addition & 0 deletions Application/EdFi.Ods.Common/Constants/ApiFeature.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ public class ApiFeature : Enumeration<ApiFeature, string>
public static readonly ApiFeature Notifications = new ApiFeature("notifications", "Notifications");
public static readonly ApiFeature SerializedData = new ApiFeature("serializedData", "SerializedData");
public static readonly ApiFeature ResourceLinks = new ApiFeature("resourceLinks", "ResourceLinks");
public static readonly ApiFeature OneRoster = new ApiFeature("oneRoster", "OneRoster");

public ApiFeature(string value, string displayName)
: base(value, displayName) { }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ public class OpenApiMetadataController : ControllerBase
private readonly ILog _logger = LogManager.GetLogger(typeof(OpenApiMetadataController));
private readonly IOpenApiMetadataCacheProvider _openApiMetadataCacheProvider;
private readonly ReverseProxySettings _reverseProxySettings;
private readonly bool _isOneRosterEnabled;
private readonly string _oneRosterVersionUrl;

public OpenApiMetadataController(
IOpenApiMetadataCacheProvider openApiMetadataCacheProvider,
Expand All @@ -49,6 +51,8 @@ public OpenApiMetadataController(
_openApiMetadataCacheProvider = openApiMetadataCacheProvider;
_reverseProxySettings = apiSettings.GetReverseProxySettings();
_isEnabled = featureManager.IsFeatureEnabled(ApiFeature.OpenApiMetadata);
_isOneRosterEnabled = featureManager.IsFeatureEnabled(ApiFeature.OneRoster);
_oneRosterVersionUrl = apiSettings.OneRosterVersionUrl;
}

[HttpGet]
Expand All @@ -67,12 +71,31 @@ public IActionResult Get([FromRoute] OpenApiMetadataSectionRequest request, [Fro
}
}


var content = _openApiMetadataCacheProvider.GetAllSectionDocuments(request.Sdk)
.OrderBy(x => x.Section)
.ThenBy(x => x.Name)
.Select(x => GetSwaggerSectionDetailsForCacheItem(x, version == "2" ? OpenApiSpecVersion.OpenApi2_0 : OpenApiSpecVersion.OpenApi3_0))
.ToList();

if (_isOneRosterEnabled)
{
if (!string.IsNullOrWhiteSpace(_oneRosterVersionUrl))
{
var baseUrl = _oneRosterVersionUrl.TrimEnd('/');
content.Add(new OpenApiMetadataSectionDetails
{
EndpointUri = $"{baseUrl}/{OpenApiMetadataDocumentHelper.Json}",
Name = "OneRoster",
Prefix = "Ed-Fi OneRoster"
});
}
else
{
_logger.Error("OneRoster is enabled, but the OneRosterVersionUrl is not configured.");
}
}

var eTag = HashHelper.GetSha256Hash(JsonConvert.SerializeObject(content))
.ToHexString()
.DoubleQuoted();
Expand Down
Loading