Как задокументировать обратный вызов с помощью DarkaOnLine / L5-Swagger в Laravel 5.8 - PullRequest
1 голос
/ 05 мая 2020

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

   /**
     * @OA\Post(
     *      path="/myurl-service",
     *      operationId="Id",
     *      tags={"Services"},
     *      summary="Summary",
     *      description="Desc",
     *      security={
     *           {"bearerAuth": {}}
     *       },
     *      @OA\RequestBody(
     *          required=true,
     *          @OA\JsonContent(ref="#/components/schemas/Request")
     *      ),
     *      callbacks={
     *          "Notification": {
     *              "{$request.body#/notification_url}":
     *              @OA\Post(
     *                  @OA\RequestBody(
     *                      required=true
     *                  ),
     *                  @OA\Response(
     *                      response=200,
     *                      description="Successful operation"
     *                  ),
     *              ),
     *          }
     *      }
     *     )
     */

Кто-нибудь задокументировал это и может мне помочь?

Спасибо за аванс.

1 Ответ

0 голосов
/ 14 мая 2020

Использование обозначений JSON работает. Пример:

     *        callbacks={
     *          "Notification"={
     *              "{$requestBody.notification_url}"={
     *                  "post"={
     *                      "requestBody"={
     *                          "required": true,
     *                          "content": {
     *                               "application/json": {
     *                                   "schema": {
     *                                       "$ref": "#/components/schemas/Schema"
     *                                   }
     *                               }
     *                           }
     *                      },
     *                      "responses"={
     *                          "200"={}
     *                      }
     *                  }
     *              }
     *          }
...