OpenApiDocumentTransformerContext.GetOrCreateSchemaAsync Metodo
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Ottiene o crea un oggetto OpenApiSchema per il tipo specificato.
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)Parametri
- type
- Type
Tipo per il quale viene creato lo schema.
- parameterDescription
- ApiParameterDescription
Descrizione del parametro facoltativa per aumentare lo schema.
- cancellationToken
- CancellationToken
Token di annullamento per annullare l'operazione.
Valori restituiti
Attività che rappresenta l'operazione asincrona, con un valore di tipo OpenApiSchema.
Commenti
Lo schema restituito viene aumentato con qualsiasi IOpenApiSchemaTransformerelemento registrato nel documento. Se parameterDescription non è Null, lo schema verrà aumentato anche con le ApiParameterDescription informazioni, ad esempio i valori predefiniti e i metadati di convalida.