galaxy.webapps.openapi package

Submodules

galaxy.webapps.openapi.utils module

Allows merging overlapping openapi definitions. Taken from https://github.com/tiangolo/fastapi/pull/4727

galaxy.webapps.openapi.utils.get_openapi_security_definitions(flat_dependant: Dependant) → Tuple[Dict[str, Any], List[Dict[str, Any]]]

galaxy.webapps.openapi.utils.get_openapi_operation_parameters(*, all_route_params: Sequence[ModelField], model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str]) → List[Dict[str, Any]]

galaxy.webapps.openapi.utils.get_openapi_operation_request_body(*, body_field: Optional[ModelField], model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str]) → Optional[Dict[str, Any]]

galaxy.webapps.openapi.utils.generate_operation_id(*, route: APIRoute, method: str) → str

galaxy.webapps.openapi.utils.generate_operation_summary(*, route: APIRoute, method: str) → str

galaxy.webapps.openapi.utils.get_openapi_operation_metadata(*, route: APIRoute, method: str, operation_ids: Set[str]) → Dict[str, Any]

galaxy.webapps.openapi.utils.get_openapi_path(*, route: APIRoute, model_name_map: Dict[type, str], operation_ids: Set[str]) → Tuple[Dict[str, Any], Dict[str, Any], Dict[str, Any]]

galaxy.webapps.openapi.utils.get_flat_models_from_routes(routes: Sequence[BaseRoute]) → Set[Union[Type[BaseModel], Type[Enum]]]

galaxy.webapps.openapi.utils.get_openapi(*, title: str, version: str, openapi_version: str = '3.0.3', description: Optional[str] = None, routes: Sequence[BaseRoute], tags: Optional[List[Dict[str, Any]]] = None, servers: Optional[List[Dict[str, Union[Any, str]]]] = None, terms_of_service: Optional[str] = None, contact: Optional[Dict[str, Union[Any, str]]] = None, license_info: Optional[Dict[str, Union[Any, str]]] = None) → Dict[str, Any]

galaxy.webapps.openapi.utils.merge_paths(existing_path: Dict[str, Any], new_path: Dict[str, Any]) → Dict[str, Any]

Merge two openapi path descriptions for the same route, e.g. for response content with different accept-encoding.

galaxy.webapps.openapi.utils.merge_tags(tags_by_id: Dict[str, Optional[List[str]]]) → Optional[List[str]]

galaxy.webapps.openapi.utils.merge_summary(summary_by_id: Dict[str, Optional[str]]) → Optional[str]

galaxy.webapps.openapi.utils.merge_description(desc_by_id: Dict[str, Optional[str]]) → Optional[str]

galaxy.webapps.openapi.utils.merge_operation_id(operation_id_by_id: Dict[str, Optional[str]]) → Optional[str]

galaxy.webapps.openapi.utils.merge_deprecated(deprecated_by_id: Dict[str, Optional[bool]]) → Optional[bool]

galaxy.webapps.openapi.utils.merge_parameters(params_by_id: Dict[str, Optional[List[Dict[str, Any]]]]) → Optional[List[Dict[str, Any]]]

galaxy.webapps.openapi.utils.deep_dict_operation_merge(dict_by_id: Dict[str, Dict[str, Any]]) → Dict[str, Any]