Using ref Property about openapi-php-attributes HOT 5 CLOSED

Hi !

RefProperty is only used for responses. I had something in mind like:

#[Property(["field1.subfield1" => "string", "field1.subfield2" => "int])]

But now I'm thinking of automatically generating the RequestBody ref directly from the Request object (in your case CalculationRequest). Basically this means you would declare your schema in your request file and in your controller, just the POST and Response.

Maybe this would include implementing an interface to "find" the request body or just any class inheriting symphony's Request object.

What do you think ?

Obviously I'm open to PRs but if needed I can do it

from openapi-php-attributes.

The variant with the Request object looks very interesting. But in general, this will not solve my problem, it would be great to explicitly specify child schemas. In my example, it would look something like this:

#[
    Schema(name: CalculationRequest::class),
    Property(PropertyType::STRING, "service"),
    Property(PropertyType::REF, "shippingAddress"),
    PropertyRef(Address::class),
    Property(PropertyType::REF, "deliveryAddress"),
    PropertyRef(Address::class),
]
class CalculationRequest extends JsonRequest implements ValidateRequestInterface
{
    private string $service;
    private Address $shippingAddress;
    private Address $deliveryAddress;
}

#[
    Schema(name: Address::class),
    Property(PropertyType::STRING, "region"),
    Property(PropertyType::STRING, "city"),
    Property(PropertyType::STRING, "address"),
    Property(PropertyType::STRING, "fullAddress"),
    Property(PropertyType::BOOLEAN, "isTerminal"),
]
class Address
{
    public string $region;
    public string $city;
    public string $address;
    public string $fullAddress;
    public bool $isTerminal;
}

How do you think?

I think I can implement this in a separate PR.

from openapi-php-attributes.

That looks good !

Maybe the syntax should be like the Response attribute where you can put a reference in the attributes.

You could then have:

#[
    Schema,
    Property(name: "shippingAddress", ref: Address::class)
]
class CalculationRequest {
}

Though, this could just be a shortcut ...

from openapi-php-attributes.

Published in version 1.2 and 1.3

from openapi-php-attributes.

Thank you @uderline 🙏

from openapi-php-attributes.