JSONスキーマ：対話型および非対話型検証
draft-fge-json-schema-validation-00

概要

JSONスキーマ（application/schema+json）にはいくつかの目的があり、その1つはインスタンス検証です。検証プロセスは対話型または非対話型です。たとえば、アプリケーションはJSONスキーマを使用して、ユーザー入力チェックに加えて、対話型のコンテンツ生成を可能にするユーザーインターフェイスを構築したり、さまざまなソースから取得したデータを検証したりできます。この仕様では、検証を目的としたスキーマキーワードについて説明します。

このメモのステータス

このインターネットドラフトは、BCP 78およびBCP 79の規定に完全に準拠して提出されています。

インターネットドラフトは、インターネットエンジニアリングタスクフォース（IETF）の作業文書です。他のグループもインターネットドラフトとして作業文書を配布する場合があることに注意してください。現在のインターネットドラフトのリストはhttp://datatracker.ietf.org/drafts/current/にあります。

インターネットドラフトは、最大6か月間有効なドラフト文書であり、いつでも他の文書によって更新、置換、または廃止される可能性があります。インターネットドラフトを参照資料として使用したり、「進行中の作業」として以外の方法で引用したりすることは不適切です。

このインターネットドラフトは、2017年8月26日に期限切れになります。

著作権表示

Copyright (c) 2013 IETF Trust and the persons identified as the document authors. All rights reserved.

この文書は、BCP 78およびこの文書の発行日に有効なIETF文書に関するIETFトラストの法的規定（http://trustee.ietf.org/license-info）の対象となります。これらの文書は、この文書に関するあなたの権利と制限について説明しているため、注意深く確認してください。この文書から抽出されたコードコンポーネントには、トラストの法的規定のセクション4.eに記載されているSimplified BSD Licenseのテキストを含める必要があり、Simplified BSD Licenseに記載されているように保証なしで提供されます。

目次

• 1. はじめに
• 2. 表記規則と用語
• 3. 相互運用性に関する考慮事項
• 3.1. 文字列インスタンスの検証
• 3.2. 数値インスタンスの検証
• 3.3. 正規表現
• 4. 一般的な検証に関する考慮事項
• 4.1. キーワードとインスタンスのプリミティブ型
• 4.2. 相互依存キーワード
• 4.3. 不足しているキーワードのデフォルト値
• 4.4. コンテナインスタンスの検証
• 5. インスタンスタイプ別に分類された検証キーワード
• 5.1. 数値インスタンス（数値と整数）の検証キーワード
• 5.1.1. multipleOf
• 5.1.2. maximumとexclusiveMaximum
• 5.1.3. minimumとexclusiveMinimum
• 5.2. 文字列の検証キーワード
• 5.2.1. maxLength
• 5.2.2. minLength
• 5.2.3. pattern
• 5.3. 配列の検証キーワード
• 5.3.1. additionalItemsとitems
• 5.3.2. maxItems
• 5.3.3. minItems
• 5.3.4. uniqueItems
• 5.4. オブジェクトの検証キーワード
• 5.4.1. maxProperties
• 5.4.2. minProperties
• 5.4.3. required
• 5.4.4. additionalProperties、properties、patternProperties
• 5.4.5. dependencies
• 5.5. あらゆるインスタンスタイプの検証キーワード
• 5.5.1. enum
• 5.5.2. type
• 5.5.3. allOf
• 5.5.4. anyOf
• 5.5.5. oneOf
• 5.5.6. not
• 5.5.7. definitions
• 6. メタデータキーワード
• 6.1. 「title」と「description」
• 6.1.1. 有効な値
• 6.1.2. 目的
• 6.2. 「default」
• 6.2.1. 有効な値
• 6.2.2. 目的
• 7. 「format」によるセマンティック検証
• 7.1. 前書き
• 7.2. 実装要件
• 7.3. 定義済み属性
• 7.3.1. date-time
• 7.3.2. email
• 7.3.3. hostname
• 7.3.4. ipv4
• 7.3.5. ipv6
• 7.3.6. uri
• 8. 子スキーマを計算するための参照アルゴリズム
• 8.1. 前書き
• 8.2. 配列要素
• 8.2.1. 特性の定義
• 8.2.2. 暗黙のキーワードとデフォルト値
• 8.2.3. 計算
• 8.3. オブジェクトメンバー
• 8.3.1. 特性の定義
• 8.3.2. 暗黙のキーワード
• 8.3.3. 計算
• 9. セキュリティに関する考慮事項
• 10. IANAに関する考慮事項
• 11. 参考文献
• 11.1. 規範的な参考文献
• 11.2. 参考情報
• 付録A. 変更履歴
• 著者のアドレス

1. はじめに

JSONスキーマを使用すると、特定のJSONドキュメント（インスタンス）が特定の数の基準を満たすことを要求できます。これらの基準は、この仕様で説明されている一連のキーワードによって具体化されます。さらに、対話型インスタンス生成を支援するための一連のキーワードが定義されています。これらについても、この仕様で説明します。

この仕様では、JSONスキーマコアスペックで定義されている用語を使用します。読者はこの仕様のコピーを持っていることをお勧めします。

2. 表記規則と用語

この文書のキーワード「MUST」、「MUST NOT」、「REQUIRED」、「SHALL」、「SHALL NOT」、「SHOULD」、「SHOULD NOT」、「RECOMMENDED」、「MAY」、および「OPTIONAL」は、RFC 2119 [RFC2119]に記載されているとおりに解釈されます。

この仕様では、配列とオブジェクトの両方のインスタンスを指すために「コンテナインスタンス」という用語を使用します。配列要素またはオブジェクトメンバー値を指すために「子インスタンス」という用語を使用します。

この仕様では、オブジェクトのメンバー名のセットを指すために「プロパティセット」という用語を使用します。たとえば、JSONオブジェクト{ "a": 1, "b": 2 }のプロパティセットは[ "a", "b" ]です。

配列値の要素は、コアスペックで定義されているように、この配列の2つの要素が等しくない場合、一意であると言われます。

3. 相互運用性に関する考慮事項

3.1. 文字列インスタンスの検証

ヌル文字（\x00）はJSON文字列で有効であることに注意してください。検証するインスタンスには、基盤となるプログラミング言語がそのようなデータを処理できるかどうかに関係なく、この文字を含む文字列値が含まれている場合があります。

3.2. 数値インスタンスの検証

JSONの仕様では、数値のスケールまたは精度の境界を定義していません。JSONスキーマもそのような境界を定義していません。これは、JSONスキーマによって処理される数値インスタンスが、基盤となるプログラミング言語がそのようなデータを処理できるかどうかに関係なく、任意に大きく、かつ/または任意に大きな小数部を持つことができることを意味します。

3.3. 正規表現

2つの検証キーワード「pattern」と「patternProperties」は、制約を表現するために正規表現を使用します。これらの正規表現は、ECMA 262 [ecma262]正規表現の方言に従って有効であるべきです（SHOULD）。

さらに、正規表現の構成要素のサポートには大きなばらつきがあるため、スキーマの作成者は、次の正規表現トークンに限定する必要があります（SHOULD）。

• JSON仕様 [RFC4627]で定義されている個々のUnicode文字。
• 単純文字クラス（[abc]）、範囲文字クラス（[a-z]）。
• 補完文字クラス（[^abc]、[^a-z]）。
• 単純な量指定子： "+"（1つ以上）、"*"（0以上）、"?"（0または1）、およびそれらの遅延バージョン（"+?"、"*?"、"??"）。
• 範囲量指定子： "{x}"（ちょうどx個）、"{x,y}"（少なくともx個、最大y個）、{x,}（x個以上）、およびそれらの遅延バージョン。
• 入力の先頭（ "^"）と入力の末尾（ "$"）のアンカー。
• 単純なグループ化（ "..."）と選択（ "|"）。

最後に、実装では、正規表現が先頭にも末尾にもアンカーされていないと見なしてはなりません（MUST NOT）。これは、たとえば、「es」が「expression」と一致することを意味します。

4. 一般的検証に関する考慮事項

4.1. キーワードとインスタンスプリミティブ型

一部の検証キーワードは、1つ以上のプリミティブ型にのみ適用されます。インスタンスのプリミティブ型が特定のキーワードで検証できない場合、このキーワードとインスタンスの検証は成功する必要があります（SHOULD）。

この仕様では、キーワードを検証するプリミティブ型（または型）に従って、キーワードを異なるセクションにグループ化します。一部のキーワードはすべてのインスタンスタイプを検証することに注意してください。

4.2. 相互依存キーワード

インスタンスを検証するために、一部のキーワードは他のキーワードの有無の影響を受けます。この場合、これらのキーワードはすべて同じセクションにグループ化されます。

4.3. 不足しているキーワードのデフォルト値

一部のキーワードは、存在しない場合、実装によってデフォルト値を持つと見なされる場合があります（MAY）。この場合、デフォルト値が記載されます。

4.4. コンテナインスタンスの検証

コンテナインスタンス（配列またはオブジェクト）を検証できるキーワードは、インスタンス自体のみを検証し、子（配列アイテムまたはオブジェクトプロパティ）は検証しません。ただし、これらのキーワードの一部には、子がどのスキーマに対して有効である必要があるかを計算するために必要な情報が含まれています。子のインスタンスの関連スキーマを計算するアルゴリズムは、別のセクションで説明します。

配列要素は1つのスキーマに対してのみ検証する必要があるのに対し、オブジェクトメンバー値は複数のスキーマに対して検証する必要がある場合があることに注意してください。

5. インスタンスタイプ別に分類された検証キーワード

5.1. 数値インスタンス（数値と整数）の検証キーワード

5.1.1. multipleOf

5.1.1.1. 有効な値

"multipleOf"の値はJSON数値である必要があります（MUST）。この数値は0より厳密に大きい必要があります（MUST）。

5.1.1.2. 検証が成功するための条件

数値インスタンスは、インスタンスをこのキーワードの値で除算した結果が整数の場合、「multipleOf」に対して有効です。

5.1.2. maximumとexclusiveMaximum

5.1.2.1. 有効な値

"maximum"の値はJSON数値である必要があります（MUST）。 "exclusiveMaximum"の値はブール値である必要があります（MUST）。

「exclusiveMaximum」が存在する場合、「maximum」も存在しなければなりません（MUST）。

5.1.2.2. 検証が成功するための条件

検証の成功は、「exclusiveMaximum」の有無とその値に依存します。

• 「exclusiveMaximum」が存在しない場合、またはブール値がfalseの場合、インスタンスの値が「maximum」の値以下であれば、インスタンスは有効です。
• 「exclusiveMaximum」のブール値がtrueの場合、インスタンスの値が「maximum」の値よりも厳密に小さい場合、インスタンスは有効です。

5.1.2.3. デフォルト値

「exclusiveMaximum」が存在しない場合、ブール値がfalseで存在するとみなすことができます。

5.1.3. minimumとexclusiveMinimum

5.1.3.1. 有効な値

「minimum」の値はJSON数値でなければなりません（MUST）。「exclusiveMinimum」の値はブール値でなければなりません（MUST）。

「exclusiveMinimum」が存在する場合、「minimum」も存在しなければなりません（MUST）。

5.1.3.2. 検証が成功するための条件

検証の成功は、「exclusiveMinimum」の有無とその値に依存します。

• 「exclusiveMinimum」が存在しない場合、またはブール値がfalseの場合、インスタンスの値が「minimum」の値以上であれば、インスタンスは有効です。
• 「exclusiveMinimum」が存在し、ブール値がtrueの場合、インスタンスの値が「minimum」の値よりも厳密に大きい場合、インスタンスは有効です。

5.1.3.3. デフォルト値

「exclusiveMinimum」が存在しない場合、ブール値がfalseで存在するとみなすことができます。

5.2. 文字列の検証キーワード

5.2.1. maxLength

5.2.1.1. 有効な値

このキーワードの値は整数でなければなりません（MUST）。この整数は0以上でなければなりません（MUST）。

5.2.1.2. 検証が成功するための条件

文字列インスタンスの長さがこのキーワードの値以下であれば、このキーワードに対して有効です。

文字列インスタンスの長さは、RFC 4627 [RFC4627]で定義されている文字数として定義されます。

5.2.2. minLength

5.2.2.1. 有効な値

このキーワードの値は整数でなければなりません（MUST）。この整数は0以上でなければなりません（MUST）。

5.2.2.2. 検証が成功するための条件

文字列インスタンスの長さがこのキーワードの値以上であれば、このキーワードに対して有効です。

文字列インスタンスの長さは、RFC 4627 [RFC4627]で定義されている文字数として定義されます。

5.2.2.3. デフォルト値

「minLength」が存在しない場合、整数値0で存在するとみなすことができます。

5.2.3. pattern

5.2.3.1. 有効な値

このキーワードの値は文字列でなければなりません（MUST）。この文字列は、ECMA 262正規表現の規則に従って、有効な正規表現である必要があります（SHOULD）。

5.2.3.2. 検証が成功するための条件

正規表現がインスタンスに正常に一致する場合、文字列インスタンスは有効とみなされます。正規表現は暗黙的にアンカーされていないことを思い出してください。

5.3. 配列の検証キーワード

5.3.1. additionalItemsとitems

5.3.1.1. 有効な値

「additionalItems」の値は、ブール値またはオブジェクトのいずれかでなければなりません（MUST）。オブジェクトの場合、このオブジェクトは有効なJSONスキーマでなければなりません（MUST）。

「items」の値は、オブジェクトまたは配列のいずれかでなければなりません（MUST）。オブジェクトの場合、このオブジェクトは有効なJSONスキーマでなければなりません（MUST）。配列の場合、この配列の項目はオブジェクトでなければならず（MUST）、これらの各オブジェクトは有効なJSONスキーマでなければなりません（MUST）。

5.3.1.2. 検証が成功するための条件

これらの2つのキーワードに関する配列インスタンスの検証の成功は、次のように決定されます。

• 「items」が存在しない場合、またはその値がオブジェクトの場合、インスタンスの検証は「additionalItems」の値に関係なく常に成功します。
• 「additionalItems」の値がブール値trueまたはオブジェクトの場合、インスタンスの検証は常に成功します。
• 「additionalItems」の値がブール値falseで、「items」の値が配列の場合、インスタンスのサイズが「items」のサイズ以下の場合、インスタンスは有効です。

5.3.1.3. 例

次の例は、「additionalItems」のブール値がfalseで、「items」が配列の場合を扱います。これは、インスタンスが検証に失敗する可能性のある唯一の状況であるためです。

これはスキーマの例です。

{
    "items": [ {}, {}, {} ],
    "additionalItems": false
}

                            

このスキーマでは、次のインスタンスは有効です。

• []（空の配列）
• [ [ 1, 2, 3, 4 ], [ 5, 6, 7, 8 ] ],
• [ 1, 2, 3 ];

次のインスタンスは無効です。

• [ 1, 2, 3, 4 ],
• [ null, { "a": "b" }, true, 31.000002020013 ]

5.3.1.4. デフォルト値

いずれかのキーワードが存在しない場合、空のスキーマが存在するとみなすことができます。

5.3.2. maxItems

5.3.2.1. 有効な値

このキーワードの値は整数でなければなりません（MUST）。この整数は0以上でなければなりません（MUST）。

5.3.2.2. 検証が成功するための条件

配列インスタンスのサイズがこのキーワードの値以下であれば、「maxItems」に対して有効です。

5.3.3. minItems

5.3.3.1. 有効な値

このキーワードの値は整数でなければなりません（MUST）。この整数は0以上でなければなりません（MUST）。

5.3.3.2. 検証が成功するための条件

配列インスタンスのサイズがこのキーワードの値以上であれば、「minItems」に対して有効です。

5.3.3.3. デフォルト値

このキーワードが存在しない場合、値0で存在するとみなすことができます。

5.3.4. uniqueItems

5.3.4.1. 有効な値

このキーワードの値はブール値でなければなりません（MUST）。

5.3.4.2. 検証が成功するための条件

このキーワードのブール値がfalseの場合、インスタンスの検証は成功します。ブール値がtrueの場合、すべての要素が一意である場合、インスタンスの検証は成功します。

5.3.4.3. デフォルト値

存在しない場合、このキーワードはブール値falseで存在するとみなすことができます。

5.4. オブジェクトの検証キーワード

5.4.1. maxProperties

5.4.1.1. 有効な値

このキーワードの値は整数でなければなりません（MUST）。この整数は0以上でなければなりません（MUST）。

5.4.1.2. 検証が成功するための条件

オブジェクトインスタンスのプロパティ数がこのキーワードの値以下であれば、「maxProperties」に対して有効です。

5.4.2. minProperties

5.4.2.1. 有効な値

このキーワードの値は整数でなければなりません（MUST）。この整数は0以上でなければなりません（MUST）。

5.4.2.2. 検証が成功するための条件

オブジェクトインスタンスのプロパティ数がこのキーワードの値以上であれば、「minProperties」に対して有効です。

5.4.2.3. デフォルト値

このキーワードが存在しない場合、値0で存在するとみなすことができます。

5.4.3. required

5.4.3.1. 有効な値

このキーワードの値は配列でなければなりません（MUST）。この配列には少なくとも1つの要素がなければなりません（MUST）。この配列の要素は文字列でなければならず（MUST）、一意でなければなりません（MUST）。

5.4.3.2. 検証が成功するための条件

オブジェクトインスタンスのプロパティセットに、このキーワードの配列値のすべての要素が含まれている場合、このキーワードに対して有効です。

5.4.4. additionalProperties、properties、およびpatternProperties

5.4.4.1. 有効な値

「additionalProperties」の値は、ブール値またはオブジェクトでなければなりません（MUST）。オブジェクトの場合、有効なJSONスキーマでもなければなりません（MUST）。

「properties」の値はオブジェクトでなければなりません（MUST）。このオブジェクトの各値はオブジェクトでなければならず（MUST）、各オブジェクトは有効なJSONスキーマでなければなりません（MUST）。

「patternProperties」の値はオブジェクトでなければなりません（MUST）。このオブジェクトの各プロパティ名は、ECMA 262正規表現の規則に従って、有効な正規表現である必要があります（SHOULD）。このオブジェクトの各プロパティ値はオブジェクトでなければならず（MUST）、各オブジェクトは有効なJSONスキーマでなければなりません（MUST）。

5.4.4.2. 検証が成功するための条件

これらの3つのキーワードに対するオブジェクトインスタンスの検証の成功は、「additionalProperties」の値に依存します。

• 値がブール値trueまたはスキーマの場合、検証は成功します。
• 値がブール値falseの場合、検証の成功を判断するアルゴリズムを以下に示します。

5.4.4.3. デフォルト値

「properties」または「patternProperties」が存在しない場合、値として空のオブジェクトが存在するとみなすことができます。

「additionalProperties」が存在しない場合、値として空のスキーマが存在するとみなすことができます。

5.4.4.4. 「additionalProperties」のブール値がfalseの場合

この場合、インスタンスの検証は「properties」と「patternProperties」のプロパティセットに依存します。このセクションでは、「patternProperties」のプロパティ名を便宜上正規表現と呼びます。

最初のステップは、次のセットを収集することです。

s

検証するインスタンスのプロパティセット。

p

「properties」からのプロパティセット。

pp

「patternProperties」からのプロパティセット。

これらの3つのセットを収集したら、プロセスは次のとおりです。

• 「s」から「p」のすべての要素を削除します（存在する場合）。
• 「pp」の各正規表現について、この正規表現に一致する「s」のすべての要素を削除します。

これらの2つのステップの後、セット「s」が空の場合、インスタンスの検証は成功します。

5.4.4.5. 例

このスキーマは例として使用されます。

{
    "properties": {
        "p1": {}
    },
    "patternProperties": {
        "p": {},
        "[0-9]": {}
    },
    "additionalProperties": false
}

                            

これは検証するインスタンスです。

{
    "p1": true,
    "p2": null,
    "a32&o": "foobar",
    "": [],
    "fiddle": 42,
    "apple": "pie"
}

                            

3つのプロパティセットは次のとおりです。

s

[ "p1", "p2", "a32&o", "", "fiddle", "apple" ]

p

[ "p1" ]

pp

[ "p", "[0-9]" ]

アルゴリズムの2つのステップを適用する

• 最初のステップの後、「p1」は「s」から削除されます。
• 2番目のステップの後、「p2」（「p」と一致）、「a32&o」（「[0-9]」と一致）、および「apple」（「p」と一致）は「s」から削除されます。

セット「s」にはまだ2つの要素 "" と "fiddle" が含まれています。したがって、検証は失敗します。

5.4.5. dependencies

5.4.5.1. 有効な値

このキーワードの値はオブジェクトでなければなりません（MUST）。このオブジェクトの各値は、オブジェクトまたは配列のいずれかでなければなりません（MUST）。

値がオブジェクトの場合、有効なJSONスキーマでなければなりません（MUST）。これはスキーマ依存関係と呼ばれます。

値が配列の場合、少なくとも1つの要素がなければなりません（MUST）。各要素は文字列でなければならず（MUST）、配列内の要素は一意でなければなりません（MUST）。これはプロパティ依存関係と呼ばれます。

5.4.5.2. 検証が成功するための条件

5.4.5.2.1. スキーマ依存関係

スキーマ依存関係のすべての（名前、スキーマ）ペアについて、インスタンスにこの名前のプロパティがある場合、スキーマに対しても正常に検証する必要があります。

プロパティ名に関連付けられた値ではなく、インスタンス自体が正常に検証する必要があることに注意してください。

5.4.5.2.2. プロパティ依存関係

プロパティ依存関係の各（名前、プロパティセット）ペアについて、インスタンスにこの名前のプロパティがある場合、プロパティセットと同じ名前のプロパティも必要です。

5.5. あらゆるインスタンスタイプの検証キーワード

5.5.1. enum

5.5.1.1. 有効な値

このキーワードの値は配列でなければなりません（MUST）。この配列には少なくとも1つの要素がなければなりません（MUST）。配列内の要素は一意でなければなりません（MUST）。

配列内の要素は、nullを含む任意のタイプにすることができます。

5.5.1.2. 検証が成功するための条件

インスタンスの値がこのキーワードの配列値のいずれかの要素と等しい場合、インスタンスはこのキーワードに対して正常に検証されます。

5.5.2. type（型）

5.5.2.1. 有効な値

このキーワードの値は、文字列または配列でなければなりません（MUST）。配列の場合、配列の要素は文字列でなければならず（MUST）、一意でなければなりません（MUST）。

文字列値は、コア仕様で定義されている7つのプリミティブ型のいずれかでなければなりません（MUST）。

5.5.2.2. 検証成功の条件

インスタンスのプリミティブ型が、キーワードで定義されている型のいずれかである場合、インスタンスは正常に一致とみなされます。注記：「number」には「integer」が含まれます。

5.5.3. allOf（すべて）

5.5.3.1. 有効な値

このキーワードの値は配列でなければなりません（MUST）。この配列には少なくとも1つの要素がなければなりません（MUST）。

配列の要素はオブジェクトでなければなりません（MUST）。各オブジェクトは有効なJSONスキーマでなければなりません（MUST）。

5.5.3.2. 検証成功の条件

インスタンスがこのキーワードの値で定義されたすべてのスキーマに対して正常に検証された場合、インスタンスはこのキーワードに対して正常に検証されます。

5.5.4. anyOf（いずれか）

5.5.4.1. 有効な値

このキーワードの値は配列でなければなりません（MUST）。この配列には少なくとも1つの要素がなければなりません（MUST）。

配列の要素はオブジェクトでなければなりません（MUST）。各オブジェクトは有効なJSONスキーマでなければなりません（MUST）。

5.5.4.2. 検証成功の条件

インスタンスがこのキーワードの値で定義された少なくとも1つのスキーマに対して正常に検証された場合、インスタンスはこのキーワードに対して正常に検証されます。

5.5.5. oneOf（1つだけ）

5.5.5.1. 有効な値

このキーワードの値は配列でなければなりません（MUST）。この配列には少なくとも1つの要素がなければなりません（MUST）。

配列の要素はオブジェクトでなければなりません（MUST）。各オブジェクトは有効なJSONスキーマでなければなりません（MUST）。

5.5.5.2. 検証成功の条件

インスタンスがこのキーワードの値で定義されたちょうど1つのスキーマに対して正常に検証された場合、インスタンスはこのキーワードに対して正常に検証されます。

5.5.6. not（否定）

5.5.6.1. 有効な値

このキーワードの値はオブジェクトでなければなりません（MUST）。このオブジェクトは有効なJSONスキーマでなければなりません（MUST）。

5.5.6.2. 検証成功の条件

このキーワードで定義されたスキーマに対して検証が失敗した場合、インスタンスはこのキーワードに対して有効です。

5.5.7. definitions（定義）

5.5.7.1. 有効な値

このキーワードの値はオブジェクトでなければなりません（MUST）。このオブジェクトの各メンバー値は、有効なJSONスキーマでなければなりません（MUST）。

5.5.7.2. 検証成功の条件

このキーワードは、検証自体には直接関与しません。スキーマ作成者がJSONスキーマをより一般的なスキーマにインライン化するための標準化された場所を提供することが役割です。

{
    "type": "array",
    "items": { "$ref": "#/definitions/positiveInteger" },
    "definitions": {
        "positiveInteger": {
            "type": "integer",
            "minimum": 0,
            "exclusiveMinimum": true
        }
    }
}

                                

例として、正の整数の配列を記述するスキーマを以下に示します。ここで、正の整数の制約は「definitions」内のサブスキーマです。

6. メタデータキーワード

6.1. "title"（タイトル）と "description"（説明）

6.1.1. 有効な値

これらのキーワードの値はどちらも文字列でなければなりません（MUST）。

6.1.2. 目的

これらのキーワードはどちらも、ユーザーインターフェースを、そのユーザーインターフェースによって生成されるデータに関する情報で装飾するために使用できます。タイトルはできれば短く、説明は、このスキーマで記述されるインスタンスの目的について説明を提供します。

これらのキーワードはどちらも、ルートスキーマおよび任意のサブスキーマで使用できます（MAY）。

6.2. "default"（デフォルト）

6.2.1. 有効な値

このキーワードの値に制限はありません。

6.2.2. 目的

このキーワードは、特定のスキーマに関連付けられたデフォルトのJSON値を提供するために使用できます。デフォルト値は、関連付けられたスキーマに対して有効であることが推奨されます（RECOMMENDED）。

このキーワードは、ルートスキーマおよび任意のサブスキーマで使用できます（MAY）。

7. "format"によるセマンティック検証

7.1. 前書き

構造的検証だけでは、インスタンスがアプリケーションのすべての要件を満たしていることを検証するには不十分な場合があります。「format」キーワードは、RFCまたは他の外部仕様であれ、信頼できるリソースによって正確に記述されている値の固定サブセットに対して、相互運用可能なセマンティック検証を可能にするために定義されています。

このキーワードの値は、フォーマット属性と呼ばれます。文字列でなければなりません（MUST）。フォーマット属性は、一般に、特定のインスタンスタイプのセットのみを検証できます。検証対象のインスタンスの型がこのセットにない場合、このフォーマット属性とインスタンスの検証は成功する必要があります（SHOULD）。

7.2. 実装要件

実装は「format」キーワードをサポートしてもよい（MAY）。サポートする場合、

• 以下に定義された属性の検証を実装する必要があります（SHOULD）。
• このキーワードの検証を無効にするオプションを提供する必要があります（SHOULD）。

実装はカスタムフォーマット属性を追加してもよい（MAY）。当事者間の合意がない限り、スキーマ作成者は、ピア実装がこのキーワードおよび/またはカスタムフォーマット属性をサポートすることを期待してはなりません（SHALL NOT）。

7.3. 定義済み属性

7.3.1. date-time（日付時刻）

7.3.1.1. 適用性

この属性は文字列インスタンスに適用されます。

7.3.1.2. 検証

文字列インスタンスがRFC 3339、セクション5.6 [RFC3339]で定義されている有効な日付表現である場合、この属性に対して有効です。

7.3.2. email（電子メール）

7.3.2.1. 適用性

この属性は文字列インスタンスに適用されます。

7.3.2.2. 検証

文字列インスタンスがRFC 5322、セクション3.4.1 [RFC5322]で定義されている有効なインターネット電子メールアドレスである場合、この属性に対して有効です。

7.3.3. hostname（ホスト名）

7.3.3.1. 適用性

この属性は文字列インスタンスに適用されます。

7.3.3.2. 検証

文字列インスタンスがRFC 1034、セクション3.1 [RFC1034]で定義されているインターネットホスト名の有効な表現である場合、この属性に対して有効です。

7.3.4. ipv4

7.3.4.1. 適用性

この属性は文字列インスタンスに適用されます。

7.3.4.2. 検証

文字列インスタンスがRFC 2673、セクション3.2 [RFC2673]で定義されている「ドット区切り」ABNF構文に従ってIPv4アドレスの有効な表現である場合、この属性に対して有効です。

7.3.5. ipv6

7.3.5.1. 適用性

この属性は文字列インスタンスに適用されます。

7.3.5.2. 検証

文字列インスタンスがRFC 2373、セクション2.2 [RFC2373]で定義されているIPv6アドレスの有効な表現である場合、この属性に対して有効です。

7.3.6. uri

7.3.6.1. 適用性

この属性は文字列インスタンスに適用されます。

7.3.6.2. 検証

文字列インスタンスが[RFC3986]に従って有効なURIである場合、この属性に対して有効です。

8. 子スキーマを計算するための参照アルゴリズム

8.1. 前書き

子インスタンスが検証する必要があるスキーマの計算は、以下の要素に影響されます。

• コンテナインスタンスタイプ。
• コンテナインスタンスにおける子インスタンスの定義特性。
• 計算に含まれるキーワードの値。

さらに、計算に含まれる1つ以上のキーワードが定義されていない場合、それらのキーワードはデフォルト値で存在すると見なされることが重要です。デフォルト値については、このセクションで後述します。

8.2. 配列要素

8.2.1. 定義特性

子インスタンスの定義特性は、配列内でのインデックスです。注記: 配列のインデックスは0から始まります。

8.2.2. 含まれるキーワードとデフォルト値。

この計算に含まれる2つのキーワードは、「items」と「additionalItems」です。

いずれかのキーワードが存在しない場合、空のスキーマを値として存在すると見なされます。さらに、「additionalItems」のブール値trueは、空のスキーマと同等と見なされます。

8.2.3. 計算

8.2.3.1. 「items」がスキーマの場合

「items」がスキーマの場合、子インスタンスはそのインデックスおよび「additionalItems」の値に関係なく、このスキーマに対して有効でなければなりません。

8.2.3.2. 「items」が配列の場合

この場合、スキーマはインデックスに依存します。

• インデックスが「items」のサイズ以下の場合、子インスタンスは「items」配列内の対応するスキーマに対して有効でなければなりません。
• そうでない場合、子インスタンスは「additionalItems」で定義されたスキーマに対して有効でなければなりません。

8.3. オブジェクトメンバー

8.3.1. 定義特性

定義特性は、子のプロパティ名です。

8.3.2. 含まれるキーワード

この計算に含まれる3つのキーワードは、「properties」、「patternProperties」、および「additionalProperties」です。

「properties」または「patternProperties」が存在しない場合、空のオブジェクトを値として存在すると見なされます。

「additionalProperties」が存在しない場合、空のスキーマを値として存在すると見なされます。さらに、ブール値trueは、空のスキーマと同等と見なされます。

8.3.3. 計算

8.3.3.1. この計算で使用される名前

以下の計算では、次の名前を使用します。

m

子のプロパティ名。

p

「properties」からのプロパティセット。

pp

「patternProperties」のプロパティセット。このセットの要素は、便宜上、正規表現と呼ばれます。

s

子インスタンスのスキーマのセット。

8.3.3.2. 最初のステップ：「properties」のスキーマ

セット「p」に値「m」が含まれている場合、「properties」内の対応するスキーマが「s」に追加されます。

8.3.3.3. 2番目のステップ：「patternProperties」のスキーマ

「pp」内の各正規表現について、「m」と正常に一致する場合、「patternProperties」内の対応するスキーマが「s」に追加されます。

8.3.3.4. 3番目のステップ：「additionalProperties」

この段階で「s」が空の場合にのみ、「additionalProperties」で定義されたスキーマが「s」に追加されます。

9. セキュリティに関する考慮事項

JSONスキーマ検証には、JSONスキーマコア仕様で定義されているもの以外の追加のセキュリティに関する考慮事項はありません。

10. IANAに関する考慮事項

この仕様は、IANAに影響を与えません。

11. 参考文献

11.1. 規範的参考文献

11.2. 参考情報

付録A. 変更履歴

ドラフト00

• 初期ドラフト。
• ドラフトv3からサルベージ。
• 「required」キーワードの再定義。
• 「extends」、「disallow」の削除。
• 「anyOf」、「allOf」、「oneOf」、「not」、「definitions」、「minProperties」、「maxProperties」の追加。
• 「dependencies」メンバーの値は、単一の文字列にすることはできなくなりました。プロパティ依存配列には少なくとも1つの要素が必要です。
• 「divisibleBy」を「multipleOf」に名前変更。
• 「type」配列はスキーマを持つことができなくなりました。「any」を可能な値として削除します。
• 「format」セクションの改訂。サポートはオプションにします。
• 「format」：属性「phone」、「style」、「color」を削除します。「ip-address」を「ipv4」に名前変更します。すべての属性への参照を追加します。
• 配列/オブジェクトインスタンスのスキーマを計算するアルゴリズムを提供します。
• 相互運用性に関する考慮事項を追加。

著者のアドレス