共通項目

OpenAPI 2.0 と 3.0 に共通するセキュリティ設定、パラメーター、レスポンス、スキーマ、参照に関する文書です。

文書一覧

文書 パス
DELETEの成功レスポンスが未定義(OpenAPI 3.0) openAPI/general/success_response_code_undefined_delete_operation
GETの成功レスポンスが未定義(OpenAPI 3.0) openAPI/general/success_response_code_undefined_get_operation
HEADの成功レスポンスが未定義(OpenAPI 3.0) openAPI/general/success_response_code_undefined_head_operation
プロパティが定義されていないオブジェクトスキーマ openAPI/general/json_object_schema_without_properties
型制約のないオブジェクトスキーマ openAPI/general/json_object_schema_without_type
PATCHの成功レスポンスが未定義(OpenAPI 3.0) openAPI/general/success_response_code_undefined_patch_operation
POSTの成功レスポンスが未定義(OpenAPI 3.0) openAPI/general/success_response_code_undefined_post_operation
PUTの成功レスポンスが未定義(OpenAPI 3.0) openAPI/general/success_response_code_undefined_put_operation
空のSchema Object openAPI/general/schema_object_empty
参照オブジェクトの追加プロパティの確認 openAPI/general/json_ref_alongside_properties
OpenAPIの連絡先URLの確認 openAPI/general/invalid_contact_url
OpenAPIの連絡先メールアドレスの確認 openAPI/general/invalid_contact_email
既定値が型と一致しない(OpenAPI 3.0) openAPI/general/default_invalid
enumと追加のスキーマ制約の確認 openAPI/general/object_using_enum_with_keyword
例の値がスキーマの型と一致しない(OpenAPI 3.0) openAPI/general/example_not_compliant_with_schema_type
Acceptヘッダーパラメーター定義の確認 openAPI/general/header_parameter_named_as_accept
Authorizationヘッダーパラメーター定義の確認 openAPI/general/header_parameter_named_as_authorization
Content-Typeヘッダーパラメーター定義の確認 openAPI/general/header_parameter_named_as_content_type
OpenAPIのライセンスURLの確認 openAPI/general/invalid_license_url
スキーマの最小値が最大値を超えている openAPI/general/property_defining_maximum_not_greater_than_minimum
操作の外部文書URLの確認 openAPI/general/invalid_operation_external_documentation_url
必須プロパティーのスキーマ定義の確認 openAPI/general/properties_missing_required_property
レスポンスヘッダーの定義とHTTP上の意味の確認 openAPI/general/header_response_name_is_invalid
スキーマの外部文書URLの確認 openAPI/general/invalid_schema_external_documentation_url
タグの外部ドキュメントURLの確認 openAPI/general/invalid_tag_external_documentation_url
パス変数に対応する path パラメーターがない openAPI/general/template_path_parameter_with_no_corresponding_path_parameter
パステンプレートに対応しないパスパラメーター openAPI/general/path_parameter_with_no_corresponding_template_path
曖昧なパス定義 openAPI/general/path_ambiguous
文字列パターンが未定義(OpenAPI 3.0) openAPI/general/pattern_undefined
文字列の最大長が未定義(OpenAPI 3.0) openAPI/general/maximum_length_undefined
文字列パターンの許容範囲が広すぎる(OpenAPI 3.0) openAPI/general/string_schema_with_broad_pattern
discriminator の値の型とマッピングの確認 openAPI/general/schema_discriminator_property_not_string
配列の要素数の上限の未定義 openAPI/general/array_without_maximum_number_items
配列要素の定義が未指定 openAPI/general/items_undefined
配列要素の型が未定義(OpenAPI 3.0) openAPI/general/array_items_has_no_type
本文のないレスポンスに本文が定義されている(OpenAPI 3.0) openAPI/general/response_operations_body_schema_incorrect_defined
スキーマの型とitemsの用途の確認 openAPI/general/non_array_schema_with_items
操作ごとのsecurity配列が空 openAPI/general/security_operations_empty_array
OpenAPI paths の公開範囲の確認 openAPI/general/paths_object_empty
OpenAPI レスポンス定義の確認 openAPI/general/responses_object_is_empty
全体のsecurity配列が空 openAPI/general/security_empty_array
操作ごとのsecurityにある空のオブジェクト openAPI/general/security_operations_empty_object_definition
全体のsecurityにある空のオブジェクト openAPI/general/security_empty_object_definition
名前が空のパスプレースホルダー openAPI/general/path_template_empty
操作の正常応答定義の確認 openAPI/general/operation_without_successful_http_status_code
discriminator のプロパティー定義の確認 openAPI/general/schema_discriminator_mismatch_defined_properties
数値形式が未指定(OpenAPI 3.0) openAPI/general/numeric_schema_without_format
数値の最大値が未定義(OpenAPI 3.0) openAPI/general/numeric_schema_without_maximum
数値の最小値が未定義(OpenAPI 3.0) openAPI/general/numeric_schema_without_minimum
応答本文のスキーマの未定義 openAPI/general/response_operations_body_schema_undefined
スキーマ合成での直接自己参照の確認 openAPI/general/schema_object_with_circular_ref
defaultレスポンスが未定義(OpenAPI 3.0) openAPI/general/default_response_undefined_operations
操作別のAPIキー認証の通信保護(OpenAPI 3.0) openAPI/general/api_key_exposed_in_operation_security
OpenAPI パスで公開する操作の確認 openAPI/general/path_without_operation
不正な HTTP レスポンスステータスコード openAPI/general/responses_wrong_http_status_code
未対応の位置での allowEmptyValue の使用 openAPI/general/property_allow_empty_value_improperly_defined
グローバルな外部文書URLの確認 openAPI/general/invalid_global_external_documentation_url
API全体の認証要件がないOpenAPIドキュメント openAPI/general/global_security_field_undefined
認証要件が宣言されていないOpenAPIの操作 openAPI/general/no_global_and_operation_security_defined
全体に適用するAPIキー認証の通信保護(OpenAPI 3.0) openAPI/general/api_key_exposed_in_global_security
必須プロパティーの型定義の確認 openAPI/general/schema_required_property_undefined
operationIdの重複 openAPI/general/operation_id_not_unique
合成スキーマのプロパティー制約の確認 openAPI/general/schema_object_properties_with_duplicated_keys
パラメーターの識別組み合わせと使用箇所の確認 openAPI/general/parameters_name_in_not_unique
ヘッダーパラメーター名の重複の確認 openAPI/general/parameter_objects_headers_dup_name
enum 値とスキーマの型の整合性の確認 openAPI/general/schema_enum_invalid
数値形式が型と一致しない(OpenAPI 3.0) openAPI/general/invalid_format
スキーマの型に適用される制約の確認 openAPI/general/type_has_invalid_keyword
必須プロパティーとデフォルト値の動作の確認 openAPI/general/required_property_default_value
想定されるレスポンスコードが未定義(OpenAPI 3.0) openAPI/general/response_code_missing
必須指定のない discriminator プロパティー openAPI/general/schema_discriminator_not_required
必須指定のないパスパラメーター openAPI/general/path_parameter_not_required

関連ページ72

DELETEの成功レスポンスが未定義(OpenAPI 3.0)

削除リクエストの成功結果がOpenAPIのレスポンス定義にない状態

GETの成功レスポンスが未定義(OpenAPI 3.0)

取得に成功したときのステータスコードが文書にない状態

HEADの成功レスポンスが未定義(OpenAPI 3.0)

本文を返さずメタデータを取得するHEADの成功レスポンスがない状態

プロパティが定義されていないオブジェクトスキーマ

フィールド構成が決まっているオブジェクトは、propertiesで各フィールドを定義します。

型制約のないオブジェクトスキーマ

オブジェクトだけを受け付けるスキーマには、オブジェクト型の制約を指定します。

PATCHの成功レスポンスが未定義(OpenAPI 3.0)

リソースの部分更新に成功したときの結果が文書にない状態

POSTの成功レスポンスが未定義(OpenAPI 3.0)

作成や処理のリクエストが成功したときの結果が文書にない状態

PUTの成功レスポンスが未定義(OpenAPI 3.0)

リソースの作成や置換に成功したときのレスポンスがない状態

空のSchema Object

データ構造を制限する必要がある場合は、空のスキーマに必要な制約を定義します。

参照オブジェクトの追加プロパティの確認

参照と並べたプロパティが、使用する仕様のバージョンで適用されるか確認してください。

OpenAPIの連絡先URLの確認

連絡先リンクが正しいサポートページにつながるか確認してください。

OpenAPIの連絡先メールアドレスの確認

連絡先の表記と実際に受信できるかを確認してください。

既定値が型と一致しない(OpenAPI 3.0)

defaultの値が宣言されたデータ型と一致していない状態

enumと追加のスキーマ制約の確認

列挙値とほかの制約を併せて確認し、実際に許可する値を明確にしてください。

例の値がスキーマの型と一致しない(OpenAPI 3.0)

文書の例が関連するスキーマと異なる型を使っている状態

Acceptヘッダーパラメーター定義の確認

レスポンス形式のネゴシエーションと通常の入力を区別してください。

Authorizationヘッダーパラメーター定義の確認

認証要件をセキュリティスキームで表現してください。

Content-Typeヘッダーパラメーター定義の確認

リクエスト本文のメディアタイプを本文の定義に記載してください。

OpenAPIのライセンスURLの確認

ライセンスのリンクが正しい条件文書を指すか確認してください。

スキーマの最小値が最大値を超えている

数値、文字列長、配列要素数の最小値が、対応する最大値を超えないようにしてください。

操作の外部文書URLの確認

操作の詳細ガイドが正しくリンクされているか確認してください。

必須プロパティーのスキーマ定義の確認

必須の存在条件と値の制約を区別し、実際の API 仕様に合わせて定義してください。

レスポンスヘッダーの定義とHTTP上の意味の確認

レスポンス形式と実際のレスポンスヘッダーを分けて記述してください。

スキーマの外部文書URLの確認

データモデルを正しい補足文書に関連付けてください。

タグの外部ドキュメントURLの確認

各タグのリンクが意図した案内資料を指すことを確認してください。

パス変数に対応する path パラメーターがない

同名の必須 path パラメーターをパスまたは操作のレベルに定義してください。

パステンプレートに対応しないパスパラメーター

パスパラメーターを、パステンプレート内の同名のプレースホルダーに対応させてください。

曖昧なパス定義

変数名だけが異なる同じパターンを、別のエンドポイントとして宣言しないでください。

文字列パターンが未定義(OpenAPI 3.0)

形式が決まっている文字列に必要なパターン制約がない状態

文字列の最大長が未定義(OpenAPI 3.0)

長さの制限が必要な文字列にmaxLengthがない状態

文字列パターンの許容範囲が広すぎる(OpenAPI 3.0)

文字列パターンが意図した形式を十分に制限していない状態

discriminator の値の型とマッピングの確認

型の判別に使う値とスキーマの対応を合わせ、文字列変換への依存を確認してください。

配列の要素数の上限の未定義

要素数を制限する必要がある配列では、maxItemsで上限を指定します。

配列要素の定義が未指定

配列スキーマやパラメーターには、仕様のバージョンに合ったitems定義が必要です。

配列要素の型が未定義(OpenAPI 3.0)

特定の型を想定する配列で要素の型を制限していない状態

本文のないレスポンスに本文が定義されている(OpenAPI 3.0)

HEAD、204、304の本文定義がHTTPの規則と矛盾している状態

スキーマの型とitemsの用途の確認

itemsは実際の配列要素に使い、データ型と整合させてください。

操作ごとのsecurity配列が空

操作ごとのsecurity配列が空の場合、全体から継承する認証要件が解除されます。

OpenAPI paths の公開範囲の確認

空の paths が意図した公開範囲に合うか確認し、必要なパスを文書化してください。

OpenAPI レスポンス定義の確認

各操作の responses に実際のレスポンスを一つ以上定義してください。

全体のsecurity配列が空

全体のsecurity配列が空の場合、既定の認証要件はありません。

操作ごとのsecurityにある空のオブジェクト

空の認証要件と無効なsecurityの形式を区別し、意図したポリシーを指定してください。

全体のsecurityにある空のオブジェクト

全体のsecurity配列に空の要件オブジェクトがあると、認証なしのアクセスも選択肢になります。

名前が空のパスプレースホルダー

パスのプレースホルダーに名前を付け、同名の必須パラメーターを定義してください。

操作の正常応答定義の確認

操作が通常の処理で実際に返す結果を明確に記述してください。

discriminator のプロパティー定義の確認

型の判別に使うプロパティー名を、実際のデータとスキーマ定義に合わせてください。

数値形式が未指定(OpenAPI 3.0)

数値の表現方法を示すformatが指定されていない状態

数値の最大値が未定義(OpenAPI 3.0)

上限が必要な数値フィールドにmaximumの制約がない状態

数値の最小値が未定義(OpenAPI 3.0)

下限が必要な数値フィールドにminimumの制約がない状態

応答本文のスキーマの未定義

実際に本文を返すレスポンスのメディアタイプとデータ構造を記述します。