OperationUpdateContract interface
API 操作の更新コントラクトの詳細。
プロパティ
description | 操作の説明。 HTML 書式設定タグを含めることができます。 |
display |
操作名。 |
method | 有効な HTTP 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、これらに限定されません。 |
policies | 操作ポリシー |
request | 要求の詳細を含むエンティティ。 |
responses | 操作応答の配列。 |
template |
URL テンプレート パラメーターのコレクション。 |
url |
この操作のターゲット リソースを識別する相対 URL テンプレート。 パラメーターを含めることができます。 例: /customers/{cid}/orders/{oid}/?date={date} |
プロパティの詳細
description
操作の説明。 HTML 書式設定タグを含めることができます。
description?: string
プロパティ値
string
displayName
操作名。
displayName?: string
プロパティ値
string
method
有効な HTTP 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、これらに限定されません。
method?: string
プロパティ値
string
policies
操作ポリシー
policies?: string
プロパティ値
string
request
responses
templateParameters
urlTemplate
この操作のターゲット リソースを識別する相対 URL テンプレート。 パラメーターを含めることができます。 例: /customers/{cid}/orders/{oid}/?date={date}
urlTemplate?: string
プロパティ値
string