documentation

bnmnetp · bnmnetp · commit 57c4774854aa · 2022-11-27T18:03:04.000-08:00
diff --git a/bookserver/internal/utils.py b/bookserver/internal/utils.py
@@ -48,7 +48,7 @@ def canonicalize_tz(tstring: str) -> str:
 def make_json_response(
     status: int = status.HTTP_200_OK, detail: Any = None
 ) -> JSONResponse:
-    # Omit the detail if it's none.
+    # content is a required parameter for a JSONResponse
     return JSONResponse(
         status_code=status, content=jsonable_encoder({"detail": detail})
     )

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ def canonicalize_tz(tstring: str) -> str:`
`48`	`48`	`def make_json_response(`
`49`	`49`	`status: int = status.HTTP_200_OK, detail: Any = None`
`50`	`50`	`) -> JSONResponse:`
`51`		`- # Omit the detail if it's none.`
	`51`	`+ # content is a required parameter for a JSONResponse`
`52`	`52`	`return JSONResponse(`
`53`	`53`	`status_code=status, content=jsonable_encoder({"detail": detail})`
`54`	`54`	`)`