OpenApiDocumentTransformerContext.GetOrCreateSchemaAsync Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Dient zum Abrufen oder Erstellen eines OpenApiSchema für den angegebenen Typs.
public System.Threading.Tasks.Task<Microsoft.OpenApi.OpenApiSchema> GetOrCreateSchemaAsync(Type type, Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription? parameterDescription = default, System.Threading.CancellationToken cancellationToken = default);member this.GetOrCreateSchemaAsync : Type * Microsoft.AspNetCore.Mvc.ApiExplorer.ApiParameterDescription * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.OpenApi.OpenApiSchema>Public Function GetOrCreateSchemaAsync (type As Type, Optional parameterDescription As ApiParameterDescription = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of OpenApiSchema)Parameter
- type
- Type
Der Typ, für den das Schema erstellt wird.
- parameterDescription
- ApiParameterDescription
Eine optionale Parameterbeschreibung zum Erweitern des Schemas.
- cancellationToken
- CancellationToken
Ein Abbruchtoken zum Abbrechen des Vorgangs.
Gibt zurück
Eine Aufgabe, die den asynchronen Vorgang mit einem Wert vom Typ OpenApiSchemadarstellt.
Hinweise
Das zurückgegebene Schema wird um alle IOpenApiSchemaTransformerElemente erweitert, die im Dokument registriert sind. Wenn parameterDescription kein Nullwert ist, wird das Schema auch mit den ApiParameterDescription Informationen erweitert, z. B. Standardwerte und Validierungsmetadaten.