OpenApiDocumentTransformerContext.GetOrCreateSchemaAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Возвращает или создает OpenApiSchema объект для указанного типа. Расширяет схему с любыми IOpenApiSchemaTransformerзарегистрированными в документе s. Если parameterDescription значение не равно NULL, схема будет дополнена ApiParameterDescription информацией.
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)Параметры
- type
- Type
Тип, для которого создается схема.
- parameterDescription
- ApiParameterDescription
Необязательное описание параметра для расширения схемы.
- cancellationToken
- CancellationToken
Маркер отмены для отмены операции.
Возвращаемое значение
Задача, представляющая асинхронную операцию с значением типа OpenApiSchema.