domaindrivendev/Swashbuckle.AspNetCore

Please annotate SchemaRepository.TryLookupByType

Ouverte

#3 659 ouverte le 15 nov. 2025

Voir sur GitHubGuide contributeur
 (3 commentaires) (2 réactions) (0 personne assignée)C# (1 341 forks)batch import
good first issuehelp-wanted

Métriques du dépôt

Stars
 (5 497 étoiles)
Métriques de merge PR
 (Merge moyen 3j 14h) (45 PRs mergées en 30 j)

Description

I was reviewing some code and noticed a hidden bug: null could be returned, but there was no compiler warning. This is because TryLookupByType lacks the [NotNullWhen(true)] annotation, which is used, for example, in IPAddress.TryParse.

It would be helpful if SchemaRepository.TryLookupByType were annotated for nullability, similar to my workaround below:

#nullable enable
public static bool TryLookupByTypeSafe(this SchemaRepository schemaRepository,
    Type type, [NotNullWhen(true)] out OpenApiSchemaReference? referenceSchema)
{
    bool result = schemaRepository.TryLookupByType(type,
        out OpenApiSchemaReference? obliviousReferenceSchema);
    referenceSchema = result ? obliviousReferenceSchema : null;
    return result;
}
#nullable restore

And then the hidden bug becomes a compiler warning:

Guide contributeur

Direction de recherche
Ajoutez l'attribut [NotNullWhen(true)] au paramètre de sortie de la méthode TryLookupByType.
Stack technique
csharp
Domaine
backend
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C#Nullable Reference Types
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85