[REQ][Qt][C++] Callback support for Qt5

[basyskom-dege]

Is your feature request related to a problem? Please describe.

I would like to add callback support for Qt5. I started to implement it but i came across a problem i could not solve.
As far is I know, the callback URL has to be put in the query and if it requires parameters in the request body, those parameters have to be put in the body. I can retrieve the callback URL but i cant get the parameters for the body in the mustache template. I am using THIS YAML file. I tried to change the AbstractCppCodegen.java to create a new Mustache variable (line 339f.):

  public void preprocessOpenAPI(OpenAPI openAPI) {
        List<Server> serverList = openAPI.getServers();
        Map<String, Callback> callbacks =  openAPI.getComponents().getCallbacks();
        (...)
       this.additionalProperties.put("test", callbacks);
        }

Unfortunatly this will result in an empty map even though the YAML file proviedes callbacks.
Only way I could get the callback is to use {{#callbacks}} inside {{#operations}}. This is where i can get the callback URL but I cant get the parameters, since they are defined in jsonSchma, which is a big string with the whole request body:

jsonSchema='{
  "description" : "subscription payload",
  "content" : {
    "application/json" : {
      "schema" : {
        "properties" : {
          "timestamp" : {
            "type" : "string",
            "format" : "date-time"
          },
          "userData" : {
            "type" : "string"
          }
        }
      }

The parameters from the callbacks are defined in the callbacks section of the YAML file:

      callbacks:
        onData:
          '{$request.query.callbackUrl}/data':
            post:
              requestBody:
                description: subscription payload
                content:
                  application/json:
                    schema:
                      properties:
                        timestamp:
                          type: string
                          format: date-time
                        userData:
                          type: string

Does anyone knows how to get the single parameters from the requestBody field without the big string?

Thanks in advance!

[DavidTurland]

Hi,
Hope there is still life in this issue?
If not, this is for anyone interested...

The Callback object relationship ( See the org.openapitools.codegen package,
especially CodegenCallback)
is accessible within the mustache templates, eg cpp-qt-client/api-body.mustache

This snippet should be enough to give a taster of the mapping:

{{#operations}} 
   {{#operation}}
   // callbacks: list of CodegenCallback
   {{#callbacks}}
       // vendorExtensions: Map<String, Object>
       {{#vendorExtensions}}  
           {{#entrySet}}
              key {{key}}
              object{{value}}
           {{/entrySet}}
       {{/vendorExtensions}}
       // urls: List of CodegenCallback.Url
       {{#urls}}  
            expression: {{expression}}
            // requests: list of CodegenOperation
            {{#requests}}  
                operationId: {{operationId}}
                // bodyParams: list of CodegenParameter
                {{#bodyParams}}  
                    // eg:
                    description: {{description}}
                    //vars: list of CodegenProperty
                    {{#vars}} 
                        dataType: {{dataType}}
                        format  : {{format}}
                        baseName: {{baseName}}
                        {{!toString}}
                        //---------
                    {{/vars}}
                {{/bodyParams}}
            {{/requests}}
            {{#vendorExtensions}}
                {{#entrySet}}
                  key {{!key}}
                  object{{!value}}
                {{/entrySet}}
            {{/vendorExtensions}}
       {{/urls}}
   {{/callbacks}}
    {{/operation}}
{{/operations}}

The above, pasted anywhere in say cpp-qt-client/api-body.mustache,
and run against THIS
with eg:

java -jar openapi-generator-cli.jar generate \
-i https://raw.githubusercontent.com/OAI/OpenAPI-Specification/3.0.1/examples/v3.0/callback-example.yaml \
-g cpp-qt-client

yields:

...
// operations: list of org.openapitools.codegen.CodegenOperation
// callbacks: list of CodegenCallback
   // vendorExtensions: Map<String, Object>
   // urls: List of CodegenCallback.Url
        expression: {$request.query.callbackUrl}/data
        // requests: list of CodegenOperation
            operationId: onDataDataPost
            // bodyParams: list of CodegenParameter
                // eg:
                description: subscription payload
                //vars: list of CodegenProperty
                    dataType: QDateTime
                    format: date-time
                    baseName: timestamp
                    //---------
                    dataType: QString
                    format: 
                    baseName: userData
                    //---------
...

hth?

Regards,

David Turland