Open API 3.0.1 readOnly Annotation

Question

I am having a few problems with the Open API 3.0.1 java annotations to define a property as readOnly for a specific method. During a POST operation the API expects a NewAccount model. Here is a truncated representation of the model;

{
    "user": {
        "id": "...",
        ...
    },
    "account": {
        "id": "...",
        ...
    }
}

What I need is to define the user.id and account.id as readOnly in this operation. All my docs are generated from code via annotations and this is what I have so far;

    @POST
    @Path("/access/accounts")
    @Consumes("application/json")
    @Operation(
            summary = "Create a new account.",
            description = "Create a new account."
    )
    @Tags({@Tag(name = "account")})
    @RequestBody(
            description = "New accounts required models.",
            required = true,
            content = @Content(
                    schema = @Schema(
                            implementation = NewAccount.class
                    )
            )
    )
    @ApiResponses({
            @ApiResponse(
                    responseCode = "201",
                    description = "The new account.",
                    content = @Content(
                            schema = @Schema(
                                    implementation = Account.class
                            )
                    )
            )
    })

Answer 1

You need to add the @Schema(accessMode = Schema.AccessMode.READ_ONLY) annotation to the id property. This will mark the id property as readOnly: true in the generated OpenAPI definition.

Example from here:

import io.swagger.v3.oas.annotations.media.Schema;

public class ReadOnlyFields {
    @Schema(accessMode = Schema.AccessMode.READ_ONLY)
    public Long id;
}