Enhance risk API documentation and error handling
Some checks failed
AOC Guard CI / aoc-guard (push) Has been cancelled
AOC Guard CI / aoc-verify (push) Has been cancelled
Concelier Attestation Tests / attestation-tests (push) Has been cancelled
Docs CI / lint-and-preview (push) Has been cancelled

- Updated API documentation for risk endpoints to include optional caching headers and error catalog references.
- Added a new error catalog JSON file to standardize error responses.
- Improved explainability documentation with sample outputs for console and CLI.
- Added SHA256 checksums for new sample files related to explainability.
- Refined AocGuard tests to utilize a helper method for generating test JSON, improving readability and maintainability.
- Updated runbook references to ensure consistency in sprint documentation.
- Introduced stub implementations for MongoDB storage interfaces and options, laying groundwork for future development.
- Disabled analytics in Angular CLI configuration for privacy considerations.
This commit is contained in:
StellaOps Bot
2025-12-06 00:47:29 +02:00
parent 582a88e8f8
commit 6c1177a6ce
19 changed files with 1403 additions and 1319 deletions

View File

@@ -0,0 +1,11 @@
namespace StellaOps.Concelier.Storage.Mongo.Documents;
/// <summary>
/// Stub record for document storage. (Placeholder for full implementation)
/// </summary>
public sealed record DocumentRecord
{
public string Id { get; init; } = string.Empty;
public string TenantId { get; init; } = string.Empty;
public string Source { get; init; } = string.Empty;
}

View File

@@ -0,0 +1,8 @@
namespace StellaOps.Concelier.Storage.Mongo;
/// <summary>
/// Stub interface for document storage. (Placeholder for full implementation)
/// </summary>
public interface IDocumentStore
{
}

View File

@@ -0,0 +1,8 @@
namespace StellaOps.Concelier.Storage.Mongo;
/// <summary>
/// Stub interface for source state repository. (Placeholder for full implementation)
/// </summary>
public interface ISourceStateRepository
{
}

View File

@@ -0,0 +1,10 @@
namespace StellaOps.Concelier.Storage.Mongo;
/// <summary>
/// Stub options for MongoDB storage. (Placeholder for full implementation)
/// </summary>
public sealed class MongoStorageOptions
{
public string ConnectionString { get; set; } = string.Empty;
public string DatabaseName { get; set; } = string.Empty;
}

View File

@@ -0,0 +1,12 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<LangVersion>preview</LangVersion>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<ProjectReference Include="../StellaOps.Concelier.RawModels/StellaOps.Concelier.RawModels.csproj" />
<ProjectReference Include="../StellaOps.Concelier.Models/StellaOps.Concelier.Models.csproj" />
</ItemGroup>
</Project>