scribe/tests/Fixtures/TestPetApiResource.php

<?php

namespace Knuckles\Scribe\Tests\Fixtures;

use Illuminate\Http\Resources\Json\JsonResource;
use Knuckles\Scribe\Attributes\ResponseField;

class TestPetApiResource extends JsonResource
{
    /**
     * Transform the resource into an array.
     *
     * @param  \Illuminate\Http\Request  $request
     *
     * @return array
     */
    #[ResponseField('id', description: 'The id of the pet.')]
    #[ResponseField('species', 'string', 'The breed')]
    public function toArray($request)
    {
        $result = [
            'id' => $this->id,
            'name' => $this->name,
            'species' => $this->species,
            'owners' => $this->whenLoaded('owners', function () {
                return TestUserApiResource::collection($this->owners);
            }),
            'ownership' => $this->whenPivotLoaded('pet_user', function () {
                return $this->pivot;
            })
        ];

        return $result;
    }
}