domaindrivendev/Swashbuckle.AspNetCore

Please annotate SchemaRepository.TryLookupByType

Offen

#3.659 geöffnet am 15.11.2025

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)C# (1.341 Forks)batch import
good first issuehelp-wanted

Repository-Metriken

Stars
 (5.497 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 3T 14h) (45 gemergte PRs in 30 T)

Beschreibung

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:

Contributor Guide

Research-Richtung
Fügen Sie das Attribut [NotNullWhen(true)] zum Ausgabeparameter der Methode TryLookupByType hinzu.
Tech Stack
csharp
Domain
backend
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#Nullable Reference Types
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85