Swagger annotations with linked property array

Question

I'm new to PHP Swagger and using the Laravel package L5-Swagger to create documentation for my API. Now I'm trying to let one model contain an array of the other model, an Order can have several OrderItems.

Unfortuantly I cannot get the linking to work. See attached screen shot.

What am I doing wrong?

This is my Order model:

/**
 * @SWG\Definition(
 *   required={"order_id","order_items"},
 *   type="object",
 *   @SWG\Xml(name="Order")
 * )
 */
class Order
{
    /**
     * @SWG\Property(example="O-789456123")
     * @var string
     */
    public $order_id;

    /**
     * @SWG\Property(type="array", items="$ref:OrderItem")
     * @var array
     */
    public $order_items = [];
}

This is my OrderItem model:

/**
 * @SWG\Definition(
 *   required={"sku","quantity", "price_including_tax"},
 *   type="object",
 *   @SWG\Xml(name="OrderItem")
 * )
 */
class OrderItem
{
    /**
     * @SWG\Property(example="SKU-123")
     * @var string
     */
    public $sku;

    /**
     * @SWG\Property(example=2)
     * @var integer
     */
    public $quantity;

    /**
     * @SWG\Property(example=199.75)
     * @var float
     */
    public $price_including_tax;
}

Bob Fanger · Accepted Answer · 2018-02-18 20:27:51Z

2

I think items="$ref:OrderItem" should be @SWG\Items(ref="#/definitions/OrderItem")

Ps. Checking the intermediate format (the swagger.json) can provide insight into what going wrong.

answered Feb 18, 2018 at 20:27

Bob Fanger

30k7 gold badges68 silver badges83 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Robban Over a year ago

Worked like a charm! Thank you very much!

Collectives™ on Stack Overflow

Swagger annotations with linked property array

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related