Skip to content

Commit 434d9d5

Browse files
committed
[#522] Document signin/verify success tokens in DemoApi OpenAPI auth template
1 parent b1e8503 commit 434d9d5

1 file changed

Lines changed: 26 additions & 3 deletions

File tree

src/Module/Templates/DemoApi/src/Controllers/OpenApi/OpenApiAuthController.php.tpl

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,18 @@ abstract class OpenApiAuthController extends OpenApiController
4545
* response=200,
4646
* description="Success",
4747
* @OA\JsonContent(
48-
* example={"status": "success"}
48+
* oneOf={
49+
* @OA\Schema(
50+
* example={
51+
* "status": "success",
52+
* "tokens": {
53+
* "access_token": "base64-jwt-token",
54+
* "refresh_token": "refresh-token"
55+
* }
56+
* }
57+
* ),
58+
* @OA\Schema(example={"status": "success", "code": "otp_token"})
59+
* }
4960
* )
5061
* ),
5162
* @OA\Response(response=422, description="Unprocessable Entity"),
@@ -90,7 +101,13 @@ abstract class OpenApiAuthController extends OpenApiController
90101
* response=200,
91102
* description="Success",
92103
* @OA\JsonContent(
93-
* example={"status": "success"}
104+
* example={
105+
* "status": "success",
106+
* "tokens": {
107+
* "access_token": "base64-jwt-token",
108+
* "refresh_token": "refresh-token"
109+
* }
110+
* }
94111
* )
95112
* ),
96113
* @OA\Response(response=401, description="Unauthorized Request"),
@@ -213,7 +230,13 @@ abstract class OpenApiAuthController extends OpenApiController
213230
* response=200,
214231
* description="Success",
215232
* @OA\JsonContent(
216-
* example={"status": "success"}
233+
* example={
234+
* "status": "success",
235+
* "tokens": {
236+
* "access_token": "base64-jwt-token",
237+
* "refresh_token": "refresh-token"
238+
* }
239+
* }
217240
* )
218241
* ),
219242
* @OA\Response(response=422, description="Unprocessable Entity"),

0 commit comments

Comments
 (0)