openapi-schema-test-suite/test-schema.json at master · python-openapi/openapi-schema-test-suite · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://python-openapi.github.io/openapi-schema-test-suite/test-schema",
    "description": "A schema for files contained within this suite",

    "type": "array",
    "minItems": 1,
    "items": {
        "description": "An individual test case, containing multiple tests of a single schema's behavior",

        "type": "object",
        "required": ["description", "schema", "tests"],
        "properties": {
            "description": {
                "description": "The test case description",
                "type": "string"
            },
            "comment": {
                "description": "Any additional comments about the test case",
                "type": "string"
            },
            "schema": {
                "description": "A valid OpenAPI Schema Object for the corresponding version directory the file sits within."
            },
            "tests": {
                "description": "A set of related tests all using the same schema",
                "type": "array",
                "items": { "$ref": "#/$defs/test" },
                "minItems": 1
            }
        },
        "additionalProperties": false
    },

    "$defs": {
        "test": {
            "description": "A single test",

            "type": "object",
            "required": ["description", "data", "valid"],
            "properties": {
                "description": {
                    "description": "The test description, briefly explaining which behavior it exercises",
                    "type": "string"
                },
                "comment": {
                    "description": "Any additional comments about the test",
                    "type": "string"
                },
                "data": {
                    "description": "The instance which should be validated against the schema in 'schema'."
                },
                "valid": {
                    "description": "Whether the validation process of this instance should consider the instance valid or not",
                    "type": "boolean"
                }
            },
            "additionalProperties": false
        }
    }
}