Generate {} instead of object in OpenAPI spec

[Hes-Siemelink]

Hello all

I am generating the OpenAPI spec from java.ws.rs with the gradle plugin.

I have a container object that has an accessor method getValue() that returns Object. This value can be an Integer, Boolean, List, etc. The OpenAPI spec generates object for this. But when generating the client bindings in Python, it would be more useful to have this as {}, so the response JSON can be parsed correctly in the case of Integer or Boolean.

Is there a way to generate the correct return type? For example by adding an annotation to the Java method.

Thanks!

[MikeEdgar]

Hi @Hes-Siemelink , this should work as you expect when #1347 is merged and released. I hope/expect it should be in the next version.

[Hes-Siemelink]

My ReleaseApi class defines the variables endpoint:

    @GET
    @Path("/{releaseId:.*Release[^/]*}/variables")
    @PublicApiMember
    List<Variable> getVariables(@PathParam("releaseId") String releaseId);

Variable is defined as follows:

public class Variable {

    private Object value;

    public Object getValue() {
        return value;
    }

   // more stuff
}

The OpenAPI bit is

  /api/v1/releases/{releaseId}/variables:
    get:
      operationId: ReleaseApi_getVariables
      parameters:
      - name: releaseId
        in: path
        required: true
        schema:
          pattern: ".*Release[^/]*"
          type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Variable'

And the schema definition of Variable is:

    Variable:
      type: object
      properties:
        value:
          type: object        # <== This should be {}

      // More stuff

[MikeEdgar]

I see what you mean. I'll take a look, but maybe there's a bug that is preventing value from being a $ref. Do you see a schema for AnyType ?

[Hes-Siemelink]

No schema entry for AnyType.

And no endpoints return Object directly, it is all through return types.

[MikeEdgar]

Darn... configProperties doesn't seem to be loaded for the Gradle plugin. We'll need a fix for that.

[Hes-Siemelink]

Oh dear. It does complain (blow up) when I specify a file that doesn't exist.

[Hes-Siemelink]

Cool, thanks!