Coverage for tests / test_custom_schema_fields.py: 100%

1from typing import Annotated 4 ctx1adbc

2 

3from fastapi import FastAPI 4 ctx1adbc

4from fastapi.testclient import TestClient 4 ctx1adbc

5from pydantic import BaseModel, WithJsonSchema 4 ctx1adbc

6 

7app = FastAPI() 4 ctx1adbc

8 

9 

10class Item(BaseModel): 4 ctx1adbc

11 name: str 3 ctx1abc

12 

13 description: Annotated[str | None, WithJsonSchema({"type": ["string", "null"]})] = ( 4 ctx1adbc

14 None 

15 ) 

16 

17 model_config = { 4 ctx1adbc

18 "json_schema_extra": { 

19 "x-something-internal": {"level": 4}, 

20 } 

21 } 

22 

23 

24@app.get("/foo", response_model=Item) 4 ctx1adbc

25def foo(): 4 ctx1adbc

26 return {"name": "Foo item"} 4 ctx1efgh

27 

28 

29client = TestClient(app) 4 ctx1adbc

30 

31 

32item_schema = { 4 ctx1adbc

33 "title": "Item", 

34 "required": ["name"], 

35 "type": "object", 

36 "x-something-internal": { 

37 "level": 4, 

38 }, 

39 "properties": { 

40 "name": { 

41 "title": "Name", 

42 "type": "string", 

43 }, 

44 "description": { 

45 "title": "Description", 

46 "type": ["string", "null"], 

47 }, 

48 }, 

49} 

50 

51 

52def test_custom_response_schema(): 4 ctx1adbc

53 response = client.get("/openapi.json") 4 ctx1ijkl

54 assert response.status_code == 200, response.text 4 ctx1ijkl

55 assert response.json()["components"]["schemas"]["Item"] == item_schema 4 ctx1ijkl

56 

57 

58def test_response(): 4 ctx1adbc

59 # For coverage 

60 response = client.get("/foo") 4 ctx1efgh

61 assert response.status_code == 200, response.text 4 ctx1efgh

62 assert response.json() == {"name": "Foo item", "description": None} 4 ctx1efgh