apispec/tests/test_array_requestbody.py at 71d9b70d02c121d702233f09ab7cc805ac83319b · marshmallow-code/apispec · 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
from marshmallow import Schema, fields

from apispec import APISpec
from apispec.ext.marshmallow import MarshmallowPlugin


class UUIDListSchema(Schema):
    uuids = fields.List(fields.UUID(), data_key=None)


def _build_schema(list_as_array: bool):
    plugin = MarshmallowPlugin(list_as_array=list_as_array)
    spec = APISpec(
        title="Test",
        version="1.0.0",
        openapi_version="3.0.2",
        plugins=[plugin],
    )
    spec.path(
        path="/list",
        operations={
            "post": {
                "requestBody": {
                    "content": {"application/json": {"schema": UUIDListSchema()}}
                },
                "responses": {"200": {}},
            }
        },
    )
    schema = spec.to_dict()["paths"]["/list"]["post"]["requestBody"]["content"][
        "application/json"
    ]["schema"]

    if "$ref" in schema:
        ref_name = schema["$ref"].split("/")[-1]
        schema = spec.to_dict()["components"]["schemas"][ref_name]

    return schema


def test_default_is_object():
    schema = _build_schema(list_as_array=False)
    assert schema["type"] == "object"


def test_list_as_array_flag():
    schema = _build_schema(list_as_array=True)
    assert schema["type"] == "array"
    assert "items" in schema