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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
from ninja import NinjaAPI
api = NinjaAPI()
@api.get("/operation1", operation_id="my_id")
def operation_1(request):
"""
This will be in description
"""
return {"docstrings": True}
@api.get("/operation2", description="description from argument", deprecated=True)
def operation2(request):
return {"description": True, "deprecated": True}
@api.get("/operation3", summary="Summary from argument", description="description arg")
def operation3(request):
"This one also has docstring description"
return {"summary": True, "description": "multiple"}
@api.get("/operation4", tags=["tag1", "tag2"])
def operation4(request):
return {"tags": True}
@api.get(
"/operation5",
openapi_extra={
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": ["email"],
"type": "object",
"properties": {
"name": {"type": "string"},
"phone": {"type": "number"},
"email": {"type": "string"},
},
}
}
},
"required": True,
},
},
)
def operation5(request):
return {"openapi_extra": True}
@api.get("/not-included", include_in_schema=False)
def not_included(request):
return True
schema = api.get_openapi_schema()
def test_schema():
op1 = schema["paths"]["/api/operation1"]["get"]
op2 = schema["paths"]["/api/operation2"]["get"]
op3 = schema["paths"]["/api/operation3"]["get"]
op4 = schema["paths"]["/api/operation4"]["get"]
op5 = schema["paths"]["/api/operation5"]["get"]
assert op1["operationId"] == "my_id"
assert op2["operationId"] == "test_openapi_params_operation2"
assert op3["operationId"] == "test_openapi_params_operation3"
assert op4["operationId"] == "test_openapi_params_operation4"
assert op5["operationId"] == "test_openapi_params_operation5"
assert op1["summary"] == "Operation 1"
assert op2["summary"] == "Operation2"
assert op3["summary"] == "Summary from argument"
assert op4["summary"] == "Operation4"
assert op5["summary"] == "Operation5"
assert op1["description"] == "This will be in description"
assert op2["description"] == "description from argument"
assert op2["deprecated"] is True
assert op3["description"] == "description arg"
assert op4["tags"] == ["tag1", "tag2"]
assert op5["requestBody"] == {
"content": {
"application/json": {
"schema": {
"required": ["email"],
"type": "object",
"properties": {
"name": {"type": "string"},
"phone": {"type": "number"},
"email": {"type": "string"},
},
}
}
},
"required": True,
}
def test_not_included():
assert list(schema["paths"].keys()) == [
"/api/operation1",
"/api/operation2",
"/api/operation3",
"/api/operation4",
"/api/operation5",
]
# checking that "/not-included" is not there
|
