Add the requestBody for the post endpoints

Question

Add the requestBody for the post endpoints

Opened this issue a year ago · 12 comments

caduvieira commented a year ago

The post endpoints in the API doc doesn't have a requestBody example or specification. Would be nice to have it.

If added to the openapi.yaml should be enough
https://learn.openapis.org/specification/parameters.html

Answer 1 · 2024-12-28T15:49:16.000Z

Great spot! I'm not at my laptop at the moment, but I'll get this fixed when I'm back.

Answer 2 · 2025-01-03T16:36:12.000Z

I had a quick look at this earlier and it's caused by us switching to spatie/laravel-data. Scribe is no longer able to read a FormRequest so is unable to derive the request body.

We'll need to write a custom Scribe strategy to pull the data from Laravel Data, pretty gnarly.

Answer 3 · 2025-01-03T16:37:29.000Z

Actually, pinging @joelbutcher (refactored Cachet into laravel-data and @olivernybroe (experience writing Scribe strategies).

Answer 4 · 2025-01-03T21:19:55.000Z

@jbrooksuk I'm working on a Scribe strategy specifically for Laravel Data for work. I'm hoping to publish this soon. If you assign this to me, I'll make sure to create a PR once this is done. 👍

Answer 5 · 2025-01-03T22:00:59.000Z

Hah, no way @joelbutcher! I'll make the PR in Cachet itself that installs, configures and generates the Scribe docs.

Answer 6 · 2025-01-05T18:27:38.000Z

@jbrooksuk https://github.com/joelbutcher/scribe-laravel-data-plugin

Answer 7 · 2025-01-05T20:09:59.000Z

@joelbutcher I've tested this out (cachethq/cachet#4449) but it's not generating everything. A good example is the POST components endpoint. Only the name field is generated.

Answer 8 · 2025-01-06T09:44:11.000Z

@jbrooksuk That's odd, by the looks of it, Laravel Data itself isn't returning any rules for the properties with default values. Might have to dig a bit deeper into laravel-data as to why this is occurring. An alternative is to scrap using PHP attributes and define a static rules method on each request (similar to Laravel Form requests):

public static function rules(ValidationContext $context): array
{
    return [
        //...
    ];
}

Answer 9 · 2025-01-06T09:46:29.000Z

@jbrooksuk I'll send in a PR today that uses the rules method to explicitly define the validation rules, rather than having Laravel Data infer from types and attributes

Answer 10 · 2025-01-06T09:52:56.000Z

Amazing, thanks @joelbutcher!

Answer 11 · 2025-01-06T10:10:33.000Z

@jbrooksuk at one point we had float as a validation rule for creating and updating a metric, but I'm now running into this error:

Method Illuminate\Validation\Validator::validateFloat does not exist.

Is there an alternative rule we can use? I was thinking decimal?

Answer 12 · 2025-01-06T10:13:16.000Z

Yeah, decimal should be fine.