Missing Documentation for Create Execution from Workflow endpoint - no using Inputs info

[japerry911]

Description

I think there is missing documentation on the create execution from Workflow endpoint. It's not showing that you can add inputs as a form data body - checked the network tab when Triggered Kestra Workflow in UI and found how to do inputs. I am happy to add this to API docs, but I couldn't find where that it is at.

Documentation URL here

Here's image showing current docs for corresponding endpoint:

Here's image showing inputs as request body option in network tab -

[japerry911]

For what it's worth this works 🚀 didn't notice it was the multipart content type

    def create_execution_from_flow_id(
        self,
        namespace: str,
        flow_id: str,
        inputs: dict[str, Any] | None = None,
    ) -> dict[str, Any]:
        url = (
            f"{self.base_url}/api/v1/{self.tenant}/executions/{namespace}/{flow_id}"
            "?wait=false"
        )

        # Convert inputs to form-data fields
        files = {}
        if inputs:
            for key, value in inputs.items():
                files[key] = (None, str(value))

        response = requests.post(
            url,
            headers={
                "Authorization": f"Bearer {self.api_key}",
            },
            files=files,
        )

        return response.json()

[anna-geller]

@Skraye can you help with that to just briefly note technically how this should be handled? we can then find the right place to document it with @aj-emerich

[Skraye]

The above swagger is generate from an openApi spec file and this file is generated from our annotation in the code.
It seems there is already a description : https://github.com/kestra-io/kestra/blob/develop/webserver/src/main/java/io/kestra/webserver/controllers/api/ExecutionController.java#L619
But when looking at the openApi file, its missing, so we need to dig in the library that generate the openApi file

Short term solution: precise it in the method description (see a bit above the line I sent)

[aj-emerich]

@Skraye It's unclear to me which next action to take to document.

[Skraye]

Well you can not do much, its all technical stuff