OpenAPITools / OpenAPITools/openapi-generator

[swift5] Using onProgressReady with AsyncAwait

Open
#12,384 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Description

I can't figure out how we're supposed to use onProgressReady with our generated APIs. Suppose I have a generated OpenAPI call like:

open class func foobarCreate(foobar: Foobar, apiResponseQueue: DispatchQueue = FoobarAPI.apiResponseQueue) async throws -> CreatedFoobar

Where do I inject the onProgressReady callback if I want to know the progress of the task? Is it at all possible?

Do I implement it in my RequestBuilder subclasses somehow? I can't seem to override onProgressReady since it's not open, but rather public, is that a bug?

Any help appreciated, especially working examples :)

openapi-generator version

5.3.1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the generated foobarCreate async entry point and the RequestBuilder subclasses mentioned in the report; inspect how onProgressReady is exposed in the Swift 5 async path. Confirm whether the callback can be supplied, then document a working usage example or capture the limitation using openapi-generator 5.3.1 as the reproduction context.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, swift
Domain
api, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.