REST サービスを呼び出す OpenAPI のサポート

OpenAPI v2 および OpenAPI v3 の仕様ファイルで定義されている REST サービスはサポートされていますが、いくつかの制限が適用されます。

サポート対象外の OpenAPI 仕様

以下の指定はサポートされていません。
  • プロパティー allOf、oneOf、anyOf、および not はサポートされません。
  • ビジネスアプリケーションと外部オートメーションサービスは、プロパティなしで定義されたオブジェクトを含む OpenAPI 定義での REST 操作をサポートしていません。
  • int64 形式の Integer 型はサポートされません。 整数の値がサポートされている整数より大きい場合、問題が発生する。
  • OpenAPI v2 入力ファイルに $ref プロパティーが存在し、そのプロパティーが、#/definitions/name (スキーマの場合)、#/parameters/name (パラメーターの場合)、#/responses/name (応答の場合) 以外の場所に存在するエレメントを参照している場合、その OpenAPI v2 入力ファイルはサポートされません。
  • OpenAPI v3 入力ファイルに $ref プロパティーが存在し、そのプロパティーが #/components/schemas/name (スキーマの場合)、 #/components/parameters/name (パラメーターの場合)、 #/components/responses/name (応答の場合)、 #/components/requestBodies/name (要求本文の場合)、および #/components/securitySchemes/name (セキュリティー・スキームの場合) 以外の場所に存在するエレメントを参照している場合、その OpenAPI v3 入力ファイルはサポートされません。
  • スキーマ・オブジェクト内のプロパティーを参照する $ref プロパティーを持つ OpenAPI v3 入力ファイルは、参照されるプロパティーのタイプがプリミティブ・データ型でない限り、サポートされません。
  • セミコロンが含まれるパスは、URI 内で有効であってもサポートされません。

無視される OpenAPI の仕様とプロパティー

以下の指定が無視されます。
  • HTTP メソッドの GET、HEAD、OPTIONS、および DELETE では、要求本文は無視されます。
  • すべてのデータ型について、プロパティー default は無視されます。
  • パラメーターが String 型の場合、プロパティー maxLength および minLength は無視されます。
  • Integer 型および Decimal 型の場合、プロパティー multipleOf は無視されます。
  • プロパティー allowEmptyValue は無視されます。
  • スキーマ・プロパティ maxProperties、 minProperties、 additionalProperties は無視される。
  • スキーマ配列プロパティ maxItems と minItems は無視される。
  • String 型の場合、email、password、および hostname の形式は無視されます。
  • OpenAPI v2 の入力ファイルでは、Accept、Content-Type、または Authorization という名前のヘッダー・パラメーターは無視されます。
以下の制限が適用されます。
  • ビジネス・オブジェクトの名前の最大長は 64 文字であるため、64 文字より長いデータ型の名前は、アプリケーションで短縮されます。