Add "/__admin/health" endpoint (#1112)

This commit is contained in:
Stef Heyenrath
2024-06-03 10:59:44 +02:00
committed by GitHub
parent f76ea1d8ec
commit 17f5ab5145
5 changed files with 50 additions and 6 deletions

View File

@@ -24,12 +24,24 @@ public interface IWireMockAdminApi
[Header("Authorization")]
AuthenticationHeaderValue Authorization { get; set; }
/// <summary>
/// Get health status.
/// </summary>
/// <param name="cancellationToken">The optional cancellationToken.</param>
/// <returns>
/// Returns HttpStatusCode <c>200</c> with a value <c>Healthy</c> to indicate that WireMock.Net is healthy.
/// Else it returns HttpStatusCode <c>404</c>.
/// </returns>
[Get("health")]
[AllowAnyStatusCode]
Task<string> GetHealthAsync(CancellationToken cancellationToken = default);
/// <summary>
/// Get the settings.
/// </summary>
/// <returns>SettingsModel</returns>
[Get("settings")]
Task<SettingsModel> GetSettingsAsync();
Task<SettingsModel> GetSettingsAsync(CancellationToken cancellationToken = default);
/// <summary>
/// Update the settings.