How do I setup a POST /resources/{id}/subresource endpoint?

I’ve got the following entities / relationships…

class Service {

}

class Shortlist {

    /**
     * @var Collection<Service>
     *
     * @ORM\ManyToMany(targetEntity="AppBundle\Entity\Service")
     * @ApiSubresource()
     */
    private $services;

}

I want to setup an endpoint where I can add an (existing) services to an (existing) shortlist. My thoughts where that I would be able to setup the POST /resources/{id}/subresource endpoint to do this, with the body something like…

{
   "@id": "/services/{id}",
}

How can I do this in a way that will automatically be included in the API swagger docs?

I’ve tried adding the following to the Shortlist class…

/**
 * @ApiResource(
 *     ...
 *     subresourceOperations={
 *         "shortlist_post_service"={"method"="POST", "route_name"="api_shortlist_post_service"}
 *     },
 *     ...
 * )
 */
class Shortlist {
}

… and setup the action…

<?php
declare(strict_types=1);

namespace AppBundle\Action\Shortlist;

use AppBundle\Entity\Service;
use AppBundle\Entity\Shortlist;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;

class PostServiceAction
{

    /**
     * Retrieves your own User
     *
     * @Route(
     *     name="api_shortlist_post_service",
     *     path="/shortlists/{id}/services.{_format}",
     *     defaults={"_format"=null, "_api_resource_class"=Shortlist::class, "_api_collection_operation_name"="post"}
     * )
     * @Method("POST")
     *
     * @param Service $data
     *
     * @return Service
     */
    public function __invoke(Service $data)
    {
        // ...
    }

}

… but this didn’t add the route to the Swagger docs.

Any help or advise on this (or a better way of performing this action) is much appreciated. Perhaps just pointers on how to add custom Swagger doc details?

[algorun77]

Hello, After almost 4 years, this feature is really missing to the project. Being able to control subresources from the parent resource would be way simpler than having to specify the parent id in the request. Aka :

POST /parents/{id}/subresources
{
    "some": "field",
    "anotherValue": 42
}

IMO is way better and simpler to handle than

POST /subresources
{
    "some": "field",
    "anotherValue": 42,
    "parent": "/parents/{id}"
}

I’m really looking to see this in the near future!

[soyuka]

you can’t for now subresources are not writable atm 😃.

All you can do is to add a custom route like the above. Too enable it it swagger try to link the ApiResource with your custom route!