When generating the documentation, the OpenAPI does not include properties of objects that are nested in arrays. This PR aims at fixing this bug.

openapi: 3.0.3
info:
  title: 'Test'
  version: 1.0.0
paths:
  /api/test:
    get:
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                example:
                  someArray:
                    - anotherObjectKey: objectValue
                properties:
                  someArray:
                    type: array
                    example:
                      anotherObjectKey: objectValue
                    items:
                      type: object

openapi: 3.0.3
info:
  title: 'Test'
  version: 1.0.0
paths:
  /api/test:
    get:
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                example:
                  someArray:
                    - anotherObjectKey: objectValue
                properties:
                  someArray:
                    type: array
                    example:
                      anotherObjectKey: objectValue
                    items:
                      type: object
                      properties:
                        anotherObjectKey:
                          type: string
                          example: objectValue

--- a/before
+++ b/after
@@ -22,3 +22,7 @@ paths:
                       anotherObjectKey: objectValue
                     items:
                       type: object
+                      properties:
+                        anotherObjectKey:
+                          type: string
+                          example: objectValue

hello I want to make the doc for a route who has to send an image

But no matter if I put the image in img/logos/logo. png or in ressources/images/logo. png I have the second screenshot exception

Did I use wrong? I don't see my mistake in the doc

Thx for all

Screenshots and stack traces:

My environment:

• PHP version 8.1.13 : - Framework (Laravel):
• Laravel versions : * v9.46.0
• Scribe versions : * 4.10.1

**My Scribe config : PHP Warning: PHP Startup: gd: Unable to initialize module Module compiled with module API=20190902 PHP compiled with module API=20210902 These options need to match

Warning: PHP Startup: gd: Unable to initialize module Module compiled with module API=20190902 PHP compiled with module API=20210902 These options need to match in Unknown on line 0 title => "Seela API Documentation" base_url => "http://127.0.0.1:8000" try_it_out.base_url => "http://127.0.0.1:8000" auth.enabled => true auth.default => true auth.name => "Authorization" auth.use_value => "[email protected]" logo => "img/logos/logo.png" last_updated => "Last updated: {date:j F Y}"

Hi I have json response from my API containing string like "This field must be {{value}} or less" and looks like this breaks scribe's blade, because I get an error:

"Error PHP 8.2.0. 9.45.1 Undefined constant "value""

Looks like scribe inserts response from API right into blade without escaping double curly brackets {{ ? And laravel then tries to parse {{value}} in blade and can't find such constant? Maybe I can make scribe encode {{ in output from my API?

Thanks

What happened?

1. I ran php artisan scribe:generate
2. And I saw scribe auto generated id urlParam for /class/{class_room}/opening-hours/{opening_hour}

I cannot change id to opening_hour, whenever i add @urlParam opening_hour scribe creates documentation with three url parameters.

Screenshots and stack traces: Route Handler php artisan route:list result: GET|HEAD class/{class_room}/opening-hours/{opening_hour} ..... admin.class.room.opening-hours.show Scribe Result

My environment:

• PHP version (from php -v): 8.1.3
• Framework (Laravel/Lumen): Laravel
• Laravel/Lumen version (from composer show laravel/framework or composer show laravel/lumen-framework): v9.46
• Scribe version (from composer show knuckleswtf/scribe): 4.10.1

My Scribe config (from php artisan scribe:config:diff):

title => "Test"
base_url => "https://www.test.test"
type => "laravel"
laravel.add_routes => false
try_it_out.base_url => "https://www.test.test"
auth.enabled => true
auth.default => true
auth.placeholder => "{YOUR_PERSONAL_AUTH_TOKEN}"
strategies.metadata => removed Knuckles\Scribe\Extracting\Strategies\Metadata\GetFromMetadataAttributes
strategies.urlParameters => removed Knuckles\Scribe\Extracting\Strategies\UrlParameters\GetFromUrlParamAttribute
strategies.queryParameters => removed Knuckles\Scribe\Extracting\Strategies\QueryParameters\GetFromQueryParamAttribute
strategies.headers => removed Knuckles\Scribe\Extracting\Strategies\Headers\GetFromHeaderAttribute
strategies.bodyParameters => removed Knuckles\Scribe\Extracting\Strategies\BodyParameters\GetFromBodyParamAttribute
strategies.responses => removed Knuckles\Scribe\Extracting\Strategies\Responses\UseResponseAttributes
strategies.responseFields => removed Knuckles\Scribe\Extracting\Strategies\ResponseFields\GetFromResponseFieldAttribute

Additional info: I need to be able to disable automatic ID detection or rename it to what i want or whatever it actually is, at least. It should be opening_hour in my route, not id.

• [x] I've read the documentation and I can't find details on how to achieve this.
• [x] I almost know the section Responses by heart

I very much like the option to autogenerate an example response from a given API Resources and Models because it reduces code duplicity. But I would love if scribe would generate ResponseField (with name and type) from the API Resource / the Model (instead of just example responses).

In the following I describe an excerpt of my results so far and how I would like them to be:

• I have
  • a model called Rating,
  • a route GET api/ratings and
  • a Controller Method RatingController::all() where a ResourceCollection (RatingCollection::class) is returned.

<?php
...
/**
 * Class Rating
 * 
 * @property int $id
 * @property Carbon|null $created_at
 * @property Carbon|null $updated_at
 * @property int $score
 * @property int $userID
 * @property int $bikeID
 * 
 * @property Bike $bike
 * @property User $user
 *
 * @package App\Models
 */
class Rating extends BaseModel
{
	protected $table = 'ratings';

	protected $casts = [
		'score' => 'int',
		'userID' => 'int',
		'bikeID' => 'int'
	];

	protected $fillable = [
		'score',
		'userID',
		'bikeID'
	];

	public function bike()
	{
		return $this->belongsTo(Bike::class, 'bikeID');
	}

	public function user()
	{
		return $this->belongsTo(User::class, 'userID');
	}
}

Route::get("ratings", [RatingController::class, 'all'])->name('ratings.get');

/**
 * @group Ratings 
 * API to create or update and read bike ratings
 */
class RatingController extends Controller
{
    /**
     * GET ratings
     * 
     * user sees a list of all ratings for all bikes (since a certain time)
     */
    #[QueryParam('sinceDate', 'date', 'time from which the ratings were submitted', required: false, example: '2023-04-26T12:30:00')]
    #[ResponseFromApiResource(RatingCollection::class, Rating::class)]
    public function all(FormRequests\Rating\GetAllRequest $request)
    {
        $validated = $request->validated();
        $ratings = Rating::where('updated_at', '>=', date("Y-m-d H:i:s", strtotime($validated['sinceDate'])))->get();
        return new JsonResponse(new RatingCollection($ratings), 200, [], 0);
    }
}

I get the following result:

I would love this result (without manually adding ResponseFields):

Hello,

In a FormRequest, access directly to url parameter does not work (null). Here is a code example:

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Support\Facades\Route;

class UserRequest extends FormRequest
{

    public function rules(): array
    {
        $this->user; // null

        $this->route('user'); // null

        Route::current()->parameters()['user']; // not null

    }
}

Only the third one works but i prefer to avoid this.

I ran php artisan scribe:generate