Commit73dbbea

authored and

committed

✨ Allow additional responses to use status ranges and "default" (#435)

1 parent417a3ab commit73dbbeaCopy full SHA for 73dbbea

File tree

+70

-5

lines changed

+70

-5

lines changed

Lines changed: 13 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,15 @@`
`43`	`43`	`},`
`44`	`44`	`}`
`45`	`45`
	`46`	`+status_code_ranges:Dict[str,str]= {`
	`47`	`+"1XX":"Information",`
	`48`	`+"2XX":"Success",`
	`49`	`+"3XX":"Redirection",`
	`50`	`+"4XX":"Client Error",`
	`51`	`+"5XX":"Server Error",`
	`52`	`+"default":"Default Response",`
	`53`	`+}`
	`54`	`+`
`46`	`55`
`47`	`56`	`defget_openapi_params(dependant:Dependant)->List[Field]:`
`48`	`57`	`flat_dependant=get_flat_dependant(dependant,skip_repeats=True)`
`@@ -190,12 +199,14 @@ def get_openapi_path(`
`190`	`199`	`response.setdefault("content", {}).setdefault(`
`191`	`200`	`"application/json", {}`
`192`	`201`	`)["schema"]=response_schema`
`193`		`-status_text=http.client.responses.get(int(additional_status_code))`
	`202`	`+status_text:Optional[str]=status_code_ranges.get(`
	`203`	`+str(additional_status_code).upper()`
	`204`	`+ )orhttp.client.responses.get(int(additional_status_code))`
`194`	`205`	`response.setdefault(`
`195`	`206`	`"description",status_textor"Additional Response"`
`196`	`207`	`)`
`197`	`208`	`operation.setdefault("responses", {})[`
`198`		`-str(additional_status_code)`
	`209`	`+str(additional_status_code).upper()`
`199`	`210`	`]=response`
`200`	`211`	`status_code=str(route.status_code)`
`201`	`212`	`response_schema= {"type":"string"}`

Lines changed: 40 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,40 @@`
	`1`	`+importpytest`
	`2`	`+fromfastapiimportFastAPI`
	`3`	`+fromstarlette.testclientimportTestClient`
	`4`	`+`
	`5`	`+app=FastAPI()`
	`6`	`+`
	`7`	`+`
	`8`	`+@app.get("/a",responses={"hello": {"description":"Not a valid additional response"}})`
	`9`	`+asyncdefa():`
	`10`	`+pass# pragma: no cover`
	`11`	`+`
	`12`	`+`
	`13`	`+openapi_schema= {`
	`14`	`+"openapi":"3.0.2",`
	`15`	`+"info": {"title":"Fast API","version":"0.1.0"},`
	`16`	`+"paths": {`
	`17`	`+"/a": {`
	`18`	`+"get": {`
	`19`	`+"responses": {`
	`20`	`+# this is how one would imagine the openapi schema to be`
	`21`	`+# but since the key is not valid, openapi.utils.get_openapi will raise ValueError`
	`22`	`+"hello": {"description":"Not a valid additional response"},`
	`23`	`+"200": {`
	`24`	`+"description":"Successful Response",`
	`25`	`+"content": {"application/json": {"schema": {}}},`
	`26`	`+ },`
	`27`	`+ },`
	`28`	`+"summary":"A",`
	`29`	`+"operationId":"a_a_get",`
	`30`	`+ }`
	`31`	`+ }`
	`32`	`+ },`
	`33`	`+}`
	`34`	`+`
	`35`	`+client=TestClient(app)`
	`36`	`+`
	`37`	`+`
	`38`	`+deftest_openapi_schema():`
	`39`	`+withpytest.raises(ValueError):`
	`40`	`+client.get("/openapi.json")`

Lines changed: 17 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -10,12 +10,24 @@ async def a():`
`10`	`10`	`return"a"`
`11`	`11`
`12`	`12`
`13`		`-@router.get("/b",responses={502: {"description":"Error 2"}})`
	`13`	`+@router.get(`
	`14`	`+"/b",`
	`15`	`+responses={`
	`16`	`+502: {"description":"Error 2"},`
	`17`	`+"4XX": {"description":"Error with range, upper"},`
	`18`	`+ },`
	`19`	`+)`
`14`	`20`	`asyncdefb():`
`15`	`21`	`return"b"`
`16`	`22`
`17`	`23`
`18`		`-@router.get("/c",responses={501: {"description":"Error 3"}})`
	`24`	`+@router.get(`
	`25`	`+"/c",`
	`26`	`+responses={`
	`27`	`+"400": {"description":"Error with str"},`
	`28`	`+"5xx": {"description":"Error with range, lower"},`
	`29`	`+ },`
	`30`	`+)`
`19`	`31`	`asyncdefc():`
`20`	`32`	`return"c"`
`21`	`33`
`@@ -43,6 +55,7 @@ async def c():`
`43`	`55`	`"get": {`
`44`	`56`	`"responses": {`
`45`	`57`	`"502": {"description":"Error 2"},`
	`58`	`+"4XX": {"description":"Error with range, upper"},`
`46`	`59`	`"200": {`
`47`	`60`	`"description":"Successful Response",`
`48`	`61`	`"content": {"application/json": {"schema": {}}},`
`@@ -55,7 +68,8 @@ async def c():`
`55`	`68`	`"/c": {`
`56`	`69`	`"get": {`
`57`	`70`	`"responses": {`
`58`		`-"501": {"description":"Error 3"},`
	`71`	`+"400": {"description":"Error with str"},`
	`72`	`+"5XX": {"description":"Error with range, lower"},`
`59`	`73`	`"200": {`
`60`	`74`	`"description":"Successful Response",`
`61`	`75`	`"content": {"application/json": {"schema": {}}},`

Comments

(0)