OpenApiSchemaTransformerContext.GetOrCreateSchemaAsync Metoda
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Pobiera lub tworzy element OpenApiSchema dla określonego typu. Rozszerza schemat przy użyciu dowolnych IOpenApiSchemaTransformeridentyfikatorów zarejestrowanych w dokumencie. Jeśli parameterDescription nie ma wartości null, schemat zostanie rozszerzony o ApiParameterDescription informacje.
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)
Parametry
- type
- Type
Typ, dla którego tworzony jest schemat.
- parameterDescription
- ApiParameterDescription
Opcjonalny opis parametru w celu rozszerzenia schematu.
- cancellationToken
- CancellationToken
Token anulowania umożliwiający anulowanie operacji.
Zwraca
Zadanie reprezentujące operację asynchroniczną z wartością typu OpenApiSchema.