Issue Documenting Array of objects

RajviPJain commented 2 weeks ago

Scribe version

4.37

PHP version

8.1

Framework

Laravel

Framework version

9.19

Scribe config

title => "SCRIBE"
type => "laravel"
laravel.add_routes => false
auth.enabled => true
auth.placeholder => "token"
strategies.responses => added [
    'Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls',
    [
        'only' => [
            'GET *',
        ],
    ],
]: removed [
    'Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls',
    [
        'only' => [
            'GET *',
        ],
        'config' => [
            'app.debug' => false,
        ],
    ],
]

What happened?

I have used the following code comments

/**

@bodyParam user object required The user details
@bodyParam user.name string required The user's name
@bodyParam user.age string required The user's age
@bodyParam friend_ids int[] List of the user's friends.
@bodyParam cars object[] List of cars
@bodyParam cars[].year string The year the car was made. Example: 1997
@bodyParam cars[].make string The make of the car. Example: Toyota */

But it is not generating docs as per given output in docs

Given Output

Actual Output

Docs

[X] I've checked the docs, the troubleshooting guide, and existing issues, but I didn't find a solution

shalvah commented 2 weeks ago

I don't think this is a bug. That's just an old screenshot. We don't show the full name anymore (cars[].year), since it's now visually nested under cars.

RajviPJain commented 2 weeks ago

Thank you for the clarification. However, I still believe the previous visual representation was clearer. For example, even if the user names the variable car, the nested variable would appear as car[].year. This format explicitly indicates that car is an array of objects, which enhances understanding for other users.

It would be helpful to revert to the old visual representation. If that's not feasible, I suggest updating the current documentation to align with the example output, as it currently may lead to confusion.

Thank you for considering my feedback!

RajviPJain commented 2 weeks ago

I don't see any option to reopen this issue

@shalvah can you please reopen this issue if possible at your end?

Thanks

shalvah commented 1 week ago

Yeah, the screenshot should be updated. The parameter naming should stay as is.

knuckleswtf / scribe