Uploaded image for project: 'CiviCRM'
  1. CiviCRM
  2. CRM-13986 doctrine rest api
  3. CRM-14330

Add REST-related annotations to generated entities

    Details

    • Type: Sub-task
    • Status: Done/Fixed
    • Priority: Major
    • Resolution: Fixed/Completed
    • Affects Version/s: Unscheduled
    • Fix Version/s: Unscheduled
    • Component/s: Doctrine Integration
    • Labels:
      None
    • Sprint:
      Sprint 2, Sprint 3

      Description

      e.g.

      • @CiviAPI\Entity("WorldRegion")
      • @CiviAPI\Permission()
      • @ORM\Table(name="civicrm_worldregion")
      • @ORM\Entity
      • @Hateoas\Relation("self",
      • href = @Hateoas\Route(
      • "WorldRegion_get",
      • parameters = { "id" = "expr(object.getId())" }

        ,

      • absolute = true,
      • generator = "civi"
      • )
      • )

      (Note: the name of Hateoas\Route must match the name of the API entity.)

      And for each field, @JMS\Type(...)

        Attachments

          Activity

            People

            • Assignee:
              timotten Tim Otten
              Reporter:
              timotten Tim Otten
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: