format

Oi, Williams! Tudo bem?

Para representar uma data no formato "YYYY-MM" no Swagger, devemos de fato utilizar o type: string. No entanto, o format deve ser date ou date-time conforme os formatos padrão suportados pelo Swagger (OpenAPI). Infelizmente, o Swagger não possui um formato específico para "YYYY-MM", porém podemos definir o campo assim:

parameters:
  - name: date
    in: query
    required: true
    schema:
      type: string
      pattern: '^\d{4}-(0[1-9]|1[0-2])$'
    example: '2024-07'

Aqui, a propriedade pattern usa uma expressão regular para garantir que a string siga o formato "YYYY-MM". O example fornece um exemplo válido para ajudar na documentação.

Espero ter ajudado!

Um forte abraço e bons estudos!