Support `format: uuid`

Open liambutler-lawrence opened this issue 1 year ago • 1 comments

Motivation

Our API spec heavily uses UUID-typed fields, which are represented in our OpenAPI doc using format: uuid as described in the JSONSchema spec.

However, swift-openapi-generator currently ignores that part of the OpenAPI doc and generates them all as Swift.String, meaning we have to manually call UUID.uuidString and UUID(uuidString:) (and implement required error handling on the latter).

Proposed solution

Make the generator respect format: uuid and define such fields using the Swift UUID type.

Alternatives considered

No response

Additional information

No response

Dec 19 '24 21:12 liambutler-lawrence

Thanks for filing this @liambutler-lawrence.

This is a duplicate of #375, which is a more general ask for generating more typed values.

There's an open PR, #627, that specifically adds support for UUID, but that's currently blocked on working out a backwards compatibility story (see https://github.com/apple/swift-openapi-generator/pull/627#issuecomment-2518138710).

Dec 20 '24 08:12 simonjbeaumont