Response Body Object - Change into informational label

[MarJose123]

I have a multiple JSON response with different response structure but the same status code. Is there a way to check the body object response instead of showing "object" as a label?

[romalytvynenko]

Hey @MarJose123

This is a good question. Can you show the code of the controller?

[MarJose123]

here is the code snippet

 /**
     * Update Redeemed Status
     *
     * @param  Request  $request
     * @param  $id
     * @return RedeemResource|JsonResponse
     */
    public function status(Request $request, $id)
    {
        $request->validate([
            'status' => [
                'required',
                'string',
                Rule::enum(RedeemStatusEnum::class),
            ],
        ]);
        $redeem = Redeem::findOrFail($id);
        if ($redeem->status == RedeemStatusEnum::REDEEMED->value) {
            return response()->json([
                'message' => 'Unable to change the status due to it was already completed',
                'success' => false,
            ], HttpResponse::HTTP_FORBIDDEN);
        }

        // refund if cancel / rejected / declined
        if ($request->status == RedeemStatusEnum::CANCELED->value || $redeem->status == RedeemStatusEnum::DECLINED->value) {
            // revert back the product stock
            $redeem->shop->product->increment('stock', 1);

            // refund the user
            auth()->user()->refund($redeem->shop->product);
            $redeem->status = $request->status;
            $redeem->push();

            /**
             * @status 200
             */
            return response()->json([
                'message' => 'Redeem canceled successfully, payment has been refunded.',
                'success' => true,
            ], HttpResponse::HTTP_OK);
        }

        $redeem->status = $request->status;
        $redeem->push();

        return RedeemResource::make($redeem->refresh());
    }

[romalytvynenko]

@MarJose123 gotcha. Would you mind sharing your resulting open api spec as well?

[MarJose123]

@MarJose123 gotcha. Would you mind sharing your resulting open api spec as well?

Here

"patch": {
                "operationId": "redeem.status",
                "summary": "Update Redeemed Status",
                "tags": [
                    "Redeem"
                ],
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application\/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "status": {
                                        "$ref": "#\/components\/schemas\/RedeemStatusEnum"
                                    }
                                },
                                "required": [
                                    "status"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "`RedeemResource`",
                        "content": {
                            "application\/json": {
                                "schema": {
                                    "anyOf": [
                                        {
                                            "type": "object",
                                            "properties": {
                                                "data": {
                                                    "$ref": "#\/components\/schemas\/RedeemResource"
                                                }
                                            },
                                            "required": [
                                                "data"
                                            ]
                                        },
                                        {
                                            "type": "object",
                                            "properties": {
                                                "message": {
                                                    "type": "string",
                                                    "example": "Redeem canceled successfully, payment has been refunded."
                                                },
                                                "success": {
                                                    "type": "boolean"
                                                }
                                            },
                                            "required": [
                                                "message",
                                                "success"
                                            ]
                                        }
                                    ]
                                }
                            }
                        }
                    },
                    "403": {
                        "description": "",
                        "content": {
                            "application\/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "message": {
                                            "type": "string",
                                            "example": "Unable to change the status due to it was already completed"
                                        },
                                        "success": {
                                            "type": "boolean"
                                        }
                                    },
                                    "required": [
                                        "message",
                                        "success"
                                    ]
                                }
                            }
                        }
                    },
                    "422": {
                        "$ref": "#\/components\/responses\/ValidationException"
                    },
                    "401": {
                        "$ref": "#\/components\/responses\/AuthenticationException"
                    }
                }
            },