Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow i18n in Examples documentation #2778

Open
dgt-amexio opened this issue Nov 12, 2024 · 1 comment
Open

Allow i18n in Examples documentation #2778

dgt-amexio opened this issue Nov 12, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@dgt-amexio
Copy link

dgt-amexio commented Nov 12, 2024

Hello,

Context

  • I am using SpringDoc 2.x (2.3 but it seems that feature is not yet implemented on latest version unless if I missed something in codebase and documentation) to provide OpenAPI documentation in a SpringBoot project
  • Till now I have been able to localize various parts of the documentation that is generated, using in-house mechanisms offered by SpringDoc : @Operation.summary, @Operation.description, @APIResponse.description@
  • I am now about to provide explicit examples in @APIResponse and I would like to be examples-related elements to allow i18n
  • From what I read here, it is not yet possible

Describe the solution you'd like

  • Would it be possible to allow i18n in examples documentation ?
  • Fields that would be concerned : @ExampleObject.name, @ExampleObject.description, @ExampleObject.summary,

Could you kinldy indicate whether you have plans for such a feature in a future release of whether I should go for workaround ?

Kind Regards
Denis

@bnasslahsen
Copy link
Contributor

@dgt-amexio,

As you mentioned, this is not yet supported.
Can you add a minimal example with @ExampleObject, that shows on which annotations you need @ExampleObject ?

@bnasslahsen bnasslahsen added the enhancement New feature or request label Dec 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants