using `@Examples()` on a model about tsed

[Romakita]

Solution

class QueryParamModel {
  @Property()
  path: string;

  @Property()
  condition: string;

  @Property()
  value: string;
}

@Path("/query")
class QueryModelCtrl {
  @OperationPath("GET", "/")
  async get(
    @QueryParams()
    @Examples({
      example1: {
        description: "description1",
        value: {
          path: "path1",
          condition: "condition1"
        }
      },
      example2: {
        description: "description1",
        value: {
          path: "path2",
          condition: "condition2"
        }
      }
    })
    q: QueryParamModel
  ) {}
}

Generates:

{
  "paths": {
    "/query": {
      "get": {
        "operationId": "queryModelCtrlGet",
        "parameters": [
          {
            "in": "query",
            "name": "path",
            "required": false,
            "examples": {
              "example1": {
                "description": "description1",
                "value": "path1"
              },
              "example2": {
                "description": "description1",
                "value": "path2"
              }
            },
            "schema": {
              "type": "string"
            }
          },
          {
            "examples": {
              "example1": {
                "description": "description1",
                "value": "condition1"
              },
              "example2": {
                "description": "description1",
                "value": "condition2"
              }
            },
            "in": "query",
            "name": "condition",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "value",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        },
        "tags": [
          "QueryModelCtrl"
        ]
      }
    }
  },
  "tags": [
    {
      "name": "QueryModelCtrl"
    }
  ]
}

[github-actions]

🎉 Are you happy?

If you appreciated the support, know that it is free and is carried out on personal time ;)

A support, even a little bit makes a difference for me and continues to bring you answers!

[Romakita]

🎉 This issue has been resolved in version 7.66.0 🎉

The release is available on:

• v7.66.0
• GitHub release

Your semantic-release bot 📦🚀