Introduce format annotation to control string-types in openapi spec

[jdsalchow]

Add support for string format annotations

Issue

Fixes #3488

Description

This PR introduces a new format annotation that can be used to specify the format of string properties in OpenAPI schemas. This allows for automatic handling of string-based object properties according to the OpenAPI specification's format property, as defined in JSON Schema Validation.

Implementation Details

• Added a format annotation that allows overriding the default format in the schema
• Don't ignoring validation annotations for string types other than string
• Set default StringFormat for various format types:
  • LocalDate -> date
  • Instant | OffsetDateTime | ZonedDateTime -> date-time
  • OffsetTime -> time
  • Period | Duration -> Duration
  • UUID -> UUID

Example Usage

final case class EmailData(
  @format(Email) email: String, 
  received: Option[java.time.LocalDate]
) derives Schema

This generates an OpenAPI schema with the appropriate format annotations:

{
  "email": {
    "type": "string",
    "format": "email"
  },
  "received": {
    "type": ["string", "null"],
    "format": "date"
  }
}

[987Nabil]

I don't think an annotation is the right solution.
Especially not one that lives in this file.

I think right solution is to have a mapping of StandardType to a format.
If this is not precise enough, then we need something in zio schema to make it configurable