Uploaded image for project: 'eZ Publish / Platform'
  1. eZ Publish / Platform
  2. EZP-21312

REST v2 lacks many paths necessary for self-description

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Medium Medium
    • Resolution: Fixed
    • Affects Version/s: 5.1, 5.2-dev, 5.2
    • Fix Version/s: 5.3
    • Component/s: Platform > REST API v2
    • Labels:

      Description

      ObjectStateGroup

      • /ObjectStateGroup/ObjectStates

      Content

      • /Content/ObjectStates

      Location

      • /Location/UrlAliases

      ContentType

      • /ContentType/Draft
      • /ContentType/Groups

      User

      • /User/Groups

        Issue Links

          Activity

          Hide
          Bertrand Dunogier added a comment -

          Resources listed in the description added to https://github.com/ezsystems/ezpublish-kernel/pull/480.

          Show
          Bertrand Dunogier added a comment - Resources listed in the description added to https://github.com/ezsystems/ezpublish-kernel/pull/480 .
          Hide
          Bertrand Dunogier added a comment -

          Examples in the REST spec might need to be updated...

          Show
          Bertrand Dunogier added a comment - Examples in the REST spec might need to be updated...
          Hide
          Bertrand Dunogier added a comment - - edited

          What I give is not the path... it's the XPath representation where the element can be found.

          Example with GET /api/ezp/v2/content/locations/1/2

          <?xml version="1.0" encoding="UTF-8"?>
          <Location media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2">
           <id>2</id>
           <priority>0</priority>
           <hidden>false</hidden>
           <invisible>false</invisible>
           <ParentLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1"/>
           <pathString>/1/2/</pathString>
           <depth>1</depth>
           <childCount>34</childCount>
           <remoteId>f3e90596361e31d496d4026eb624c983</remoteId>
           <Children media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/locations/1/2/children"/>
           <Content media-type="application/vnd.ez.api.Content+xml" href="/api/ezp/v2/content/objects/57"/>
           <sortField>PRIORITY</sortField>
           <sortOrder>ASC</sortOrder>
           <UrlAliases media-type="application/vnd.ez.api.UrlAliasRefList+xml" href="/api/ezp/v2/content/locations/1/2/urlaliases"/>
          </Location>
          

          /Location/UrlAliases refers to the <UrlAliases /> node within the <Location /> one.

          Does it make more sense ?

          Show
          Bertrand Dunogier added a comment - - edited What I give is not the path... it's the XPath representation where the element can be found. Example with GET /api/ezp/v2/content/locations/1/2 <?xml version="1.0" encoding="UTF-8"?> <Location media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1/2"> <id>2</id> <priority>0</priority> <hidden>false</hidden> <invisible>false</invisible> <ParentLocation media-type="application/vnd.ez.api.Location+xml" href="/api/ezp/v2/content/locations/1"/> <pathString>/1/2/</pathString> <depth>1</depth> <childCount>34</childCount> <remoteId>f3e90596361e31d496d4026eb624c983</remoteId> <Children media-type="application/vnd.ez.api.LocationList+xml" href="/api/ezp/v2/content/locations/1/2/children"/> <Content media-type="application/vnd.ez.api.Content+xml" href="/api/ezp/v2/content/objects/57"/> <sortField>PRIORITY</sortField> <sortOrder>ASC</sortOrder> <UrlAliases media-type="application/vnd.ez.api.UrlAliasRefList+xml" href="/api/ezp/v2/content/locations/1/2/urlaliases"/> </Location> /Location/UrlAliases refers to the <UrlAliases /> node within the <Location /> one. Does it make more sense ?
          Show
          Damien Pobel (Inactive) added a comment - Example updated in https://github.com/ezsystems/ezpublish-kernel/commit/8d32831effe08c69212eaa4f8ab40be338de1a39
          Hide
          Joao Pingo (Inactive) added a comment -

          Documentation Reviewed

          Show
          Joao Pingo (Inactive) added a comment - Documentation Reviewed

            People

            • Assignee:
              Unassigned
              Reporter:
              Anton Petrushenkov (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 7 hours, 30 minutes
                7h 30m