Coverage for /home/airflow/.local/lib/python3.12/site-packages/airflow/api_fastapi/core_api/openapi/exceptions.py: 100%

1# Licensed to the Apache Software Foundation (ASF) under one 

2# or more contributor license agreements. See the NOTICE file 

3# distributed with this work for additional information 

4# regarding copyright ownership. The ASF licenses this file 

5# to you under the Apache License, Version 2.0 (the 

6# "License"); you may not use this file except in compliance 

7# with the License. You may obtain a copy of the License at 

8# 

9# http://www.apache.org/licenses/LICENSE-2.0 

10# 

11# Unless required by applicable law or agreed to in writing, 

12# software distributed under the License is distributed on an 

13# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 

14# KIND, either express or implied. See the License for the 

15# specific language governing permissions and limitations 

16# under the License. 

17 

18from __future__ import annotations 

19 

20from collections.abc import Sequence 

21 

22from airflow.api_fastapi.core_api.base import BaseModel 

23 

24 

25class HTTPExceptionResponse(BaseModel): 

26 """HTTPException Model used for error response.""" 

27 

28 detail: str | dict 

29 

30 

31def create_openapi_http_exception_doc( 

32 responses_status_code: Sequence[int | tuple[int, str]], 

33) -> dict: 

34 """ 

35 Will create additional response example for errors raised by the endpoint. 

36 

37 There is no easy way to introspect the code and automatically see what HTTPException are actually 

38 raised by the endpoint implementation. This piece of documentation needs to be kept 

39 in sync with the endpoint code manually. 

40 

41 Each item can be either a status code or a ``(status_code, description)`` tuple. 

42 Validation error i.e 422 are natively added to the openapi documentation by FastAPI. 

43 """ 

44 openapi_responses: list[tuple[int, dict[str, str | type[HTTPExceptionResponse]]]] = [] 

45 for response_status_code in responses_status_code: 

46 response: dict[str, str | type[HTTPExceptionResponse]] = {"model": HTTPExceptionResponse} 

47 

48 if isinstance(response_status_code, tuple): 

49 status_code, description = response_status_code 

50 response["description"] = description 

51 else: 

52 status_code = response_status_code 

53 

54 openapi_responses.append((status_code, response)) 

55 

56 return { 

57 status_code: response for status_code, response in sorted(openapi_responses, key=lambda item: item[0]) 

58 }