Scribe sends integers as strings in JSON?

[alexweb]

Hi everyone.
Looks like scribe doesn't work properly with integer type when sending JSON?
My annotations look like this (see id type):

    /**
     * @group Coupon
     *
     * Update Coupon
     * @authenticated
     * @bodyParam data object required
     * @bodyParam data.id int required Example: 1
     * @bodyParam data.name string required Example: COUPONNAME
     * @bodyParam data.percentage int required Example: 30
     * @bodyParam data.permanent bool required Example: true
     * @bodyParam data.startDate string optional Example: 2023-01-05T14:48:00.000Z
     * @bodyParam data.endDate string optional Example: 2023-10-05T14:48:00.000Z
     * @throws Error422Exception|Throwable
     */

Resulting request:

{
  "id": "1",
  "name": "COUPONNAME",
  "percentage": "30",
  "permanent": true,
  "startDate": "2023-01-05T14:48:00.000Z",
  "endDate": "2023-10-05T14:48:00.000Z"
}

Looks like Scribe still wraps integers into quotes?

Or is there any option to change this behaviour? I would like it to send integer as integer instead (see id and percentage):

{
  "id": 1,
  "name": "COUPONNAME",
  "percentage": 30,
  "permanent": true,
  "startDate": "2023-01-05T14:48:00.000Z",
  "endDate": "2023-10-05T14:48:00.000Z"
}

[shalvah]

It's probably because when you're reading a text input in HTML, every value is a string (and Scribe doesn't do any conversion). The fix would probably be to render a number input for number types (rather than a text input). See

scribe/resources/views/components/field-details.blade.php

Line 25 in b0d2bbe

@if($type === 'boolean')

— we currently render booleans specially, but not numbers. PR welcome.

[alexweb]

Thanks for the reply. Will need to fix this

[shalvah]

Okay, I'm wrong. We do set it.

scribe/resources/views/components/field-details.blade.php

Lines 19 to 23 in 195c897

	$inputType = match($baseType) {
	'number', 'integer' => 'number',
	'file' => 'file',
	default => 'text',
	};

I think it's the HTML/JS. IIRC, reading an input value in JS always gives you a string, even if the input type is number.

[mselmanyildirim]

Do we have a workaround to send booleans from Scribe UI?
Similar to reported above, when I generate the document via Laravel's validation as follows:

and select the parameter via Scribe API UI:

I get the following error:

When I try to debug with the following:

I get this result, saying it is not boolean, but rather string:

What I finally did as a workaround is adding the type as Enum in the codeblock as the following:

And Scribe UI becomes like:

It still gets sent as string, but at least Laravel validates it to be a boolean. It is not very handsome comparing to radio switch though 😉

[shalvah]

IIRC, reading an input value in JS always gives you a string

PRs appreciated

[ptelevich]

@shalvah got it, #830

[shalvah]

fixed in 4.35.0