Swagger PHP: как объявить свойство для использования определения схемы?

ответ моего приложения выглядит так:

{
  "status": "success",
  "data": {
      "status": "ready"
   },
  "request_id": "string"
}

Я попытался определить ответ в Swagger

 *           @SWGResponse (
 *              response=200,
 *              description="Success response",
 *              @SWGSchema (
 *                  @SWGProperty(
 *                      property="status",
 *                      type="string",
 *                      default="success"
 *                  ),
 *                  @SWGProperty(
 *                      property="data",
 *                      @SWGSchema(
 *                          ref="#/definitions/Service/models/Status"
 *                      )
 *                  ),
 *                  @SWGProperty(
 *                      property="request_id",
 *                      type="string"
 *                  ),
 *              )
 *          ),

но он не использует определение схемы для статуса, так что мой ответ на самом деле выглядит так:

{
  "status": "success",
  "data": {},
  "request_id": "string"
}

как определить свойство данных для использования определения схемы? Или это можно сделать по-другому?

9
php schema swagger

1 ответов

как забавно может быть тот факт, что люди иногда находят ответ сразу после публикации вопроса.

ответ:

*           @SWG\Response (
 *              response=200,
 *              description="Success response",
 *              @SWG\Schema (
 *                  @SWG\Property(
 *                      property="status",
 *                      type="string",
 *                      default="success"
 *                  ),
 *                  @SWG\Property(
 *                      property="data",
 *                      ref="#/definitions/Service/models/Status"
 *                  ),
 *                  @SWG\Property(
 *                      property="request_id",
 *                      type="string"
 *                  ),
 *              )
 *          ),
10