Any plans for supporting readonly marker ?

[quirell]

Description

Accordint to the specs, properites marked with readonly should not be send as part of a request body

components:
  schemas:
    Common:
      type: object
      required:
        - id
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        createdAt:
          type: string
          format: date-time
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          readOnly: true
    User:
      allOf:
        - $ref: '#/components/schemas/Common'
        - type: object
          required:
            - name
            - surname
          properties:
            name:
              type: string
            surname:
              type: string

but I'm getting bad request.

{
  "error_message": "operation CreateUser: decode request: decode application/json: invalid: id (field required), createdAt (field required), updatedAt (field required)"
}

Do you plan to add support for readonly in a near future ?

References

https://spec.openapis.org/oas/v3.0.3#fixed-fields-19

[ernado]

This will require splitting server and client structures (i.e. different structures for client request and server request in signatures), which we want to avoid.

Probably we can reconsider this on some point, because there is another feature that can lead to this split.

[quirell]

Got it. So for now the only option is to have that split directly in the api definition, is that right?

[quirell]

And to be honest, Ithink you don't need to split the structure between client and server. It would rather require generating different structure for post put and different structure for get etc.
Client and server would both the same schema but depending on the method, or rather the presence of request body in the api definition, you would use Schema and SchemaForUpdate (with readonly properties filtered out)

[ernado]

Oh, you are right.
I'm positive for this feature in this form.

[sonu27]

Any updates on this @ernado ?

[timsofteng]

@ernado It would be super helpful thing.