[CAMEL-16986] camel-openapi-java - Add support for description and example in @Schema annotation

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 3.11.2
• Fix Version/s: 3.12.0
• Component/s: camel-openapi-java

Environment

Maven dependencies:

• camel-openapi-java-starter:3.11.2
• camel-openapi-java:3.11.2
• swagger-core: 2.1.10

• Estimated Complexity: Unknown
• Assignee: Unassigned
• Reporter: Thorsten Roemer
• Created: 20/Sep/21 08:40
• Updated: 20/Sep/21 14:38
• Resolved: 20/Sep/21 14:38

Description

When using the @Schema annotation for OpenAPI documentation, the "description" and "example" parameters are apparently ignored because the generated JSON file does not contain any of these elements.

E.g.:

@io.swagger.v3.oas.annotations.media.Schema(description = "The transaction id", example = "id-123")
String id;

Current generated JSON:

[...]
"components" : {
  "schemas" : {
    "Example" : {
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string"
        },
[...]

Expected generated JSON:

[...]
"components" : {
  "schemas" : {
    "Example" : {
      "type" : "object",
      "properties" : {
        "id" : {
            "description" : "The transaction id",
            "type" : "string",
            "example" : "id-123"
          },
[...]

Issue Links

• links to: GitHub Pull Request #6117