Translating `OpenApiSpex.schema` does not work

[s-lukashenka-micoworks]

I am trying to use gettext in the schemas modules to translate various OpenApiSpex.schema() stuff, and it does not seem to be working. Please, advise how to apply translations to API specs.

[zorbash]

Can you provide an example of the code alongside expected / actual behaviour and any errors you might be seeing?

[s-lukashenka-micoworks]

Here is what I have in a schemas.ex file:

  defmodule BatchResponse do
    use Gettext, backend: MyAppWeb.Gettext

    require OpenApiSpex

    OpenApiSpex.schema(
      %{
        title: gettext("api-spec.batch.response-title"),
        description: gettext("api-spec.batch.response-description"),
        type: :object,
        properties: %{
          id: %Schema{
            type: :string,
            description: gettext("api-spec.batch.response-id"),
            format: :uuid
          },
          is_enabled: %Schema{
            type: :boolean,
            description: gettext("api-spec.batch.response-is-enabled")
          },
          updated_at: %Schema{
            type: :string,
            description: gettext("api-spec.batch.response-updated-at"),
            format: :"date-time"
          },
          created_at: %Schema{
            type: :string,
            description: gettext("api-spec.batch.response-created-at"),
            format: :"date-time"
          },
        },
        example: %{
          "uid" => "96c36c45-b95c-4ab1-8bb1-6e6e1283c950",
          "updated_at" => "2025-02-19T01:16:36Z",
          "created_at" => "2025-02-19T01:16:36Z",
          "is_enabled" => false
        },
      },
    )
  end

My api spec is defined like this:

  def spec do
    %OpenApi{
      servers: [Server.from_endpoint(Endpoint)],
      info: %Info{
        title: to_string(Application.spec(:my_app, :description)),
        version: to_string(Application.spec(:my_app, :vsn))
      },
      # Populate the paths from a phoenix router
      paths: Paths.from_router(Router),
      components: %Components{
        securitySchemes: %{
          "OAuth2ClientCredentials" => %SecurityScheme{
            type: "oauth2",
            description: "OAuth2 Client Credentials Grant",
            flows: %{
              "clientCredentials" => %{
                tokenUrl: ~p"/oauth/token",
                scopes: %{
                  "batches:read" => "Read access to batches",
                }
              }
            }
          }
        }
      }
    }
    # Discover request/response schemas from path specs
    |> OpenApiSpex.resolve_schema_modules()
  end

And then in each controller I have specs defined not in the macro way, but how it is laid out here: https://hexdocs.pm/open_api_spex/3.4.0/readme.html.

gettext has an effect on the specs defined at the controller level but does not work for the stuff defined in schemas.ex.

What would be the recommended approach to translating specs in the first place?