RepresentationContract interface
操作要求/応答表現の詳細。
プロパティ
content |
この表現の登録済みコンテンツ タイプまたはカスタム コンテンツ タイプ (application/xml など) を指定します。 |
examples | 表現に対して定義された例。 |
form |
フォーム パラメーターのコレクション。 'contentType' 値が 'application/x-www-form-urlencoded' または 'multipart/form-data' の場合は必須です。 |
schema |
スキーマ識別子。 'contentType' 値が 'application/x-www-form-urlencoded' でも 'multipart/form-data' でもない場合にのみ適用されます。 |
type |
スキーマによって定義された型名。 'contentType' 値が 'application/x-www-form-urlencoded' でも 'multipart/form-data' でもない場合にのみ適用されます。 |
プロパティの詳細
contentType
この表現の登録済みコンテンツ タイプまたはカスタム コンテンツ タイプ (application/xml など) を指定します。
contentType: string
プロパティ値
string
examples
表現に対して定義された例。
examples?: {[propertyName: string]: ParameterExampleContract}
プロパティ値
{[propertyName: string]: ParameterExampleContract}
formParameters
フォーム パラメーターのコレクション。 'contentType' 値が 'application/x-www-form-urlencoded' または 'multipart/form-data' の場合は必須です。
formParameters?: ParameterContract[]
プロパティ値
schemaId
スキーマ識別子。 'contentType' 値が 'application/x-www-form-urlencoded' でも 'multipart/form-data' でもない場合にのみ適用されます。
schemaId?: string
プロパティ値
string
typeName
スキーマによって定義された型名。 'contentType' 値が 'application/x-www-form-urlencoded' でも 'multipart/form-data' でもない場合にのみ適用されます。
typeName?: string
プロパティ値
string