OpenApiDocumentTransformerContext.GetOrCreateSchemaAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
指定した型の OpenApiSchema を取得または作成します。 ドキュメントに登録されている IOpenApiSchemaTransformerでスキーマを拡張します。
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型の値を持つ非同期操作を表すタスク。