windmill-api 1.497.2__py3-none-any.whl → 1.498.0__py3-none-any.whl

windmill_api/api/openapi/download_openapi_spec.py

@@ -0,0 +1,166 @@
+from http import HTTPStatus
+from io import BytesIO
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.download_openapi_spec_json_body import DownloadOpenapiSpecJsonBody
+from ...types import File, Response
+
+
+def _get_kwargs(
+    workspace: str,
+    *,
+    json_body: DownloadOpenapiSpecJsonBody,
+) -> Dict[str, Any]:
+    pass
+
+    json_json_body = json_body.to_dict()
+
+    return {
+        "method": "post",
+        "url": "/w/{workspace}/openapi/download".format(
+            workspace=workspace,
+        ),
+        "json": json_json_body,
+    }
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[File]:
+    if response.status_code == HTTPStatus.OK:
+        response_200 = File(payload=BytesIO(response.content))
+
+        return response_200
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[File]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    workspace: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    json_body: DownloadOpenapiSpecJsonBody,
+) -> Response[File]:
+    """Download the OpenAPI v3.1 spec as a file
+
+    Args:
+        workspace (str):
+        json_body (DownloadOpenapiSpecJsonBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[File]
+    """
+
+    kwargs = _get_kwargs(
+        workspace=workspace,
+        json_body=json_body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    workspace: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    json_body: DownloadOpenapiSpecJsonBody,
+) -> Optional[File]:
+    """Download the OpenAPI v3.1 spec as a file
+
+    Args:
+        workspace (str):
+        json_body (DownloadOpenapiSpecJsonBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        File
+    """
+
+    return sync_detailed(
+        workspace=workspace,
+        client=client,
+        json_body=json_body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    workspace: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    json_body: DownloadOpenapiSpecJsonBody,
+) -> Response[File]:
+    """Download the OpenAPI v3.1 spec as a file
+
+    Args:
+        workspace (str):
+        json_body (DownloadOpenapiSpecJsonBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[File]
+    """
+
+    kwargs = _get_kwargs(
+        workspace=workspace,
+        json_body=json_body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    workspace: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    json_body: DownloadOpenapiSpecJsonBody,
+) -> Optional[File]:
+    """Download the OpenAPI v3.1 spec as a file
+
+    Args:
+        workspace (str):
+        json_body (DownloadOpenapiSpecJsonBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        File
+    """
+
+    return (
+        await asyncio_detailed(
+            workspace=workspace,
+            client=client,
+            json_body=json_body,
+        )
+    ).parsed

windmill_api/api/openapi/generate_openapi_spec.py

@@ -0,0 +1,105 @@
+from http import HTTPStatus
+from typing import Any, Dict, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.generate_openapi_spec_json_body import GenerateOpenapiSpecJsonBody
+from ...types import Response
+
+
+def _get_kwargs(
+    workspace: str,
+    *,
+    json_body: GenerateOpenapiSpecJsonBody,
+) -> Dict[str, Any]:
+    pass
+
+    json_json_body = json_body.to_dict()
+
+    return {
+        "method": "post",
+        "url": "/w/{workspace}/openapi/generate".format(
+            workspace=workspace,
+        ),
+        "json": json_json_body,
+    }
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Any]:
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    workspace: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    json_body: GenerateOpenapiSpecJsonBody,
+) -> Response[Any]:
+    """generate openapi spec from http routes/webhook
+
+    Args:
+        workspace (str):
+        json_body (GenerateOpenapiSpecJsonBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        workspace=workspace,
+        json_body=json_body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    workspace: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+    json_body: GenerateOpenapiSpecJsonBody,
+) -> Response[Any]:
+    """generate openapi spec from http routes/webhook
+
+    Args:
+        workspace (str):
+        json_body (GenerateOpenapiSpecJsonBody):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        workspace=workspace,
+        json_body=json_body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)

windmill_api/models/create_http_trigger_json_body.py

@@ -27,6 +27,8 @@ class CreateHttpTriggerJsonBody:
         authentication_method (CreateHttpTriggerJsonBodyAuthenticationMethod):
         is_static_website (bool):
         workspaced_route (Union[Unset, bool]):
+        summary (Union[Unset, str]):
+        description (Union[Unset, str]):
         static_asset_config (Union[Unset, CreateHttpTriggerJsonBodyStaticAssetConfig]):
         authentication_resource_path (Union[Unset, str]):
         wrap_body (Union[Unset, bool]):
@@ -42,6 +44,8 @@ class CreateHttpTriggerJsonBody:
     authentication_method: CreateHttpTriggerJsonBodyAuthenticationMethod
     is_static_website: bool
     workspaced_route: Union[Unset, bool] = UNSET
+    summary: Union[Unset, str] = UNSET
+    description: Union[Unset, str] = UNSET
     static_asset_config: Union[Unset, "CreateHttpTriggerJsonBodyStaticAssetConfig"] = UNSET
     authentication_resource_path: Union[Unset, str] = UNSET
     wrap_body: Union[Unset, bool] = UNSET
@@ -60,6 +64,8 @@ class CreateHttpTriggerJsonBody:
 
         is_static_website = self.is_static_website
         workspaced_route = self.workspaced_route
+        summary = self.summary
+        description = self.description
         static_asset_config: Union[Unset, Dict[str, Any]] = UNSET
         if not isinstance(self.static_asset_config, Unset):
             static_asset_config = self.static_asset_config.to_dict()
@@ -84,6 +90,10 @@ class CreateHttpTriggerJsonBody:
         )
         if workspaced_route is not UNSET:
             field_dict["workspaced_route"] = workspaced_route
+        if summary is not UNSET:
+            field_dict["summary"] = summary
+        if description is not UNSET:
+            field_dict["description"] = description
         if static_asset_config is not UNSET:
             field_dict["static_asset_config"] = static_asset_config
         if authentication_resource_path is not UNSET:
@@ -120,6 +130,10 @@ class CreateHttpTriggerJsonBody:
 
         workspaced_route = d.pop("workspaced_route", UNSET)
 
+        summary = d.pop("summary", UNSET)
+
+        description = d.pop("description", UNSET)
+
         _static_asset_config = d.pop("static_asset_config", UNSET)
         static_asset_config: Union[Unset, CreateHttpTriggerJsonBodyStaticAssetConfig]
         if isinstance(_static_asset_config, Unset):
@@ -143,6 +157,8 @@ class CreateHttpTriggerJsonBody:
             authentication_method=authentication_method,
             is_static_website=is_static_website,
             workspaced_route=workspaced_route,
+            summary=summary,
+            description=description,
             static_asset_config=static_asset_config,
             authentication_resource_path=authentication_resource_path,
             wrap_body=wrap_body,

windmill_api/models/create_http_triggers_json_body_item.py

@@ -31,6 +31,8 @@ class CreateHttpTriggersJsonBodyItem:
         authentication_method (CreateHttpTriggersJsonBodyItemAuthenticationMethod):
         is_static_website (bool):
         workspaced_route (Union[Unset, bool]):
+        summary (Union[Unset, str]):
+        description (Union[Unset, str]):
         static_asset_config (Union[Unset, CreateHttpTriggersJsonBodyItemStaticAssetConfig]):
         authentication_resource_path (Union[Unset, str]):
         wrap_body (Union[Unset, bool]):
@@ -46,6 +48,8 @@ class CreateHttpTriggersJsonBodyItem:
     authentication_method: CreateHttpTriggersJsonBodyItemAuthenticationMethod
     is_static_website: bool
     workspaced_route: Union[Unset, bool] = UNSET
+    summary: Union[Unset, str] = UNSET
+    description: Union[Unset, str] = UNSET
     static_asset_config: Union[Unset, "CreateHttpTriggersJsonBodyItemStaticAssetConfig"] = UNSET
     authentication_resource_path: Union[Unset, str] = UNSET
     wrap_body: Union[Unset, bool] = UNSET
@@ -64,6 +68,8 @@ class CreateHttpTriggersJsonBodyItem:
 
         is_static_website = self.is_static_website
         workspaced_route = self.workspaced_route
+        summary = self.summary
+        description = self.description
         static_asset_config: Union[Unset, Dict[str, Any]] = UNSET
         if not isinstance(self.static_asset_config, Unset):
             static_asset_config = self.static_asset_config.to_dict()
@@ -88,6 +94,10 @@ class CreateHttpTriggersJsonBodyItem:
         )
         if workspaced_route is not UNSET:
             field_dict["workspaced_route"] = workspaced_route
+        if summary is not UNSET:
+            field_dict["summary"] = summary
+        if description is not UNSET:
+            field_dict["description"] = description
         if static_asset_config is not UNSET:
             field_dict["static_asset_config"] = static_asset_config
         if authentication_resource_path is not UNSET:
@@ -124,6 +134,10 @@ class CreateHttpTriggersJsonBodyItem:
 
         workspaced_route = d.pop("workspaced_route", UNSET)
 
+        summary = d.pop("summary", UNSET)
+
+        description = d.pop("description", UNSET)
+
         _static_asset_config = d.pop("static_asset_config", UNSET)
         static_asset_config: Union[Unset, CreateHttpTriggersJsonBodyItemStaticAssetConfig]
         if isinstance(_static_asset_config, Unset):
@@ -147,6 +161,8 @@ class CreateHttpTriggersJsonBodyItem:
             authentication_method=authentication_method,
             is_static_website=is_static_website,
             workspaced_route=workspaced_route,
+            summary=summary,
+            description=description,
             static_asset_config=static_asset_config,
             authentication_resource_path=authentication_resource_path,
             wrap_body=wrap_body,

windmill_api/models/download_openapi_spec_json_body.py

@@ -0,0 +1,150 @@
+from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..models.download_openapi_spec_json_body_openapi_spec_format import DownloadOpenapiSpecJsonBodyOpenapiSpecFormat
+from ..types import UNSET, Unset
+
+if TYPE_CHECKING:
+    from ..models.download_openapi_spec_json_body_http_route_filters_item import (
+        DownloadOpenapiSpecJsonBodyHttpRouteFiltersItem,
+    )
+    from ..models.download_openapi_spec_json_body_info import DownloadOpenapiSpecJsonBodyInfo
+    from ..models.download_openapi_spec_json_body_webhook_filters_item import (
+        DownloadOpenapiSpecJsonBodyWebhookFiltersItem,
+    )
+
+
+T = TypeVar("T", bound="DownloadOpenapiSpecJsonBody")
+
+
+@_attrs_define
+class DownloadOpenapiSpecJsonBody:
+    """
+    Attributes:
+        info (Union[Unset, DownloadOpenapiSpecJsonBodyInfo]):
+        url (Union[Unset, str]):
+        openapi_spec_format (Union[Unset, DownloadOpenapiSpecJsonBodyOpenapiSpecFormat]):
+        http_route_filters (Union[Unset, List['DownloadOpenapiSpecJsonBodyHttpRouteFiltersItem']]):
+        webhook_filters (Union[Unset, List['DownloadOpenapiSpecJsonBodyWebhookFiltersItem']]):
+    """
+
+    info: Union[Unset, "DownloadOpenapiSpecJsonBodyInfo"] = UNSET
+    url: Union[Unset, str] = UNSET
+    openapi_spec_format: Union[Unset, DownloadOpenapiSpecJsonBodyOpenapiSpecFormat] = UNSET
+    http_route_filters: Union[Unset, List["DownloadOpenapiSpecJsonBodyHttpRouteFiltersItem"]] = UNSET
+    webhook_filters: Union[Unset, List["DownloadOpenapiSpecJsonBodyWebhookFiltersItem"]] = UNSET
+    additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        info: Union[Unset, Dict[str, Any]] = UNSET
+        if not isinstance(self.info, Unset):
+            info = self.info.to_dict()
+
+        url = self.url
+        openapi_spec_format: Union[Unset, str] = UNSET
+        if not isinstance(self.openapi_spec_format, Unset):
+            openapi_spec_format = self.openapi_spec_format.value
+
+        http_route_filters: Union[Unset, List[Dict[str, Any]]] = UNSET
+        if not isinstance(self.http_route_filters, Unset):
+            http_route_filters = []
+            for http_route_filters_item_data in self.http_route_filters:
+                http_route_filters_item = http_route_filters_item_data.to_dict()
+
+                http_route_filters.append(http_route_filters_item)
+
+        webhook_filters: Union[Unset, List[Dict[str, Any]]] = UNSET
+        if not isinstance(self.webhook_filters, Unset):
+            webhook_filters = []
+            for webhook_filters_item_data in self.webhook_filters:
+                webhook_filters_item = webhook_filters_item_data.to_dict()
+
+                webhook_filters.append(webhook_filters_item)
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({})
+        if info is not UNSET:
+            field_dict["info"] = info
+        if url is not UNSET:
+            field_dict["url"] = url
+        if openapi_spec_format is not UNSET:
+            field_dict["openapi_spec_format"] = openapi_spec_format
+        if http_route_filters is not UNSET:
+            field_dict["http_route_filters"] = http_route_filters
+        if webhook_filters is not UNSET:
+            field_dict["webhook_filters"] = webhook_filters
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        from ..models.download_openapi_spec_json_body_http_route_filters_item import (
+            DownloadOpenapiSpecJsonBodyHttpRouteFiltersItem,
+        )
+        from ..models.download_openapi_spec_json_body_info import DownloadOpenapiSpecJsonBodyInfo
+        from ..models.download_openapi_spec_json_body_webhook_filters_item import (
+            DownloadOpenapiSpecJsonBodyWebhookFiltersItem,
+        )
+
+        d = src_dict.copy()
+        _info = d.pop("info", UNSET)
+        info: Union[Unset, DownloadOpenapiSpecJsonBodyInfo]
+        if isinstance(_info, Unset):
+            info = UNSET
+        else:
+            info = DownloadOpenapiSpecJsonBodyInfo.from_dict(_info)
+
+        url = d.pop("url", UNSET)
+
+        _openapi_spec_format = d.pop("openapi_spec_format", UNSET)
+        openapi_spec_format: Union[Unset, DownloadOpenapiSpecJsonBodyOpenapiSpecFormat]
+        if isinstance(_openapi_spec_format, Unset):
+            openapi_spec_format = UNSET
+        else:
+            openapi_spec_format = DownloadOpenapiSpecJsonBodyOpenapiSpecFormat(_openapi_spec_format)
+
+        http_route_filters = []
+        _http_route_filters = d.pop("http_route_filters", UNSET)
+        for http_route_filters_item_data in _http_route_filters or []:
+            http_route_filters_item = DownloadOpenapiSpecJsonBodyHttpRouteFiltersItem.from_dict(
+                http_route_filters_item_data
+            )
+
+            http_route_filters.append(http_route_filters_item)
+
+        webhook_filters = []
+        _webhook_filters = d.pop("webhook_filters", UNSET)
+        for webhook_filters_item_data in _webhook_filters or []:
+            webhook_filters_item = DownloadOpenapiSpecJsonBodyWebhookFiltersItem.from_dict(webhook_filters_item_data)
+
+            webhook_filters.append(webhook_filters_item)
+
+        download_openapi_spec_json_body = cls(
+            info=info,
+            url=url,
+            openapi_spec_format=openapi_spec_format,
+            http_route_filters=http_route_filters,
+            webhook_filters=webhook_filters,
+        )
+
+        download_openapi_spec_json_body.additional_properties = d
+        return download_openapi_spec_json_body
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

windmill_api/models/download_openapi_spec_json_body_http_route_filters_item.py

@@ -0,0 +1,72 @@
+from typing import Any, Dict, List, Type, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+T = TypeVar("T", bound="DownloadOpenapiSpecJsonBodyHttpRouteFiltersItem")
+
+
+@_attrs_define
+class DownloadOpenapiSpecJsonBodyHttpRouteFiltersItem:
+    """
+    Attributes:
+        folder_regex (str):
+        path_regex (str):
+        route_path_regex (str):
+    """
+
+    folder_regex: str
+    path_regex: str
+    route_path_regex: str
+    additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> Dict[str, Any]:
+        folder_regex = self.folder_regex
+        path_regex = self.path_regex
+        route_path_regex = self.route_path_regex
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "folder_regex": folder_regex,
+                "path_regex": path_regex,
+                "route_path_regex": route_path_regex,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        d = src_dict.copy()
+        folder_regex = d.pop("folder_regex")
+
+        path_regex = d.pop("path_regex")
+
+        route_path_regex = d.pop("route_path_regex")
+
+        download_openapi_spec_json_body_http_route_filters_item = cls(
+            folder_regex=folder_regex,
+            path_regex=path_regex,
+            route_path_regex=route_path_regex,
+        )
+
+        download_openapi_spec_json_body_http_route_filters_item.additional_properties = d
+        return download_openapi_spec_json_body_http_route_filters_item
+
+    @property
+    def additional_keys(self) -> List[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties