ardalis/Result

ProblemDetails Title

Open

#126 opened on Mar 28, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C# (126 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (1,034 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently, the title of the ProblemDetails Result, is hardcoded. e.g., https://github.com/ardalis/Result/blob/638403856683c736007148ce1b27f2bf3615ab2e/src/Ardalis.Result.AspNetCore/ResultStatusMap.cs#L123

This does not allow internationalization and makes the content pretty generic. However, according to the RFC standard, localization is intended and the message provided in the example is pretty specific. https://www.rfc-editor.org/rfc/rfc7807 First, I thought of having titles in multiple languages in ardalis.result, but now I think the best approach would be to allow the developer using ardalis.result to set the title. Any thoughts?

Contributor guide

Research direction
Investigate the current implementation of ProblemDetails in the Result library, specifically the hardcoded title in ResultStatusMap.cs. Propose a design to allow customization, possibly through a configuration option or by exposing a property.
Tech stack
csharp
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70