Uploaded image for project: 'Opencast'
  1. MH-12756

As an External API user, I need direct read access to metadata fields since issuing multiple requests per object doesn't scale

    Details

    • Type: Story Card
    • Status: Resolved
    • Resolution: Fixed and reviewed
    • Affects versions: 4.1
    • Fix versions: 6.0
    • Components: External API
    • Labels:
      None

      Description

      The following External API requests only return some hard-coded part of the metadata of the respective requests:

      /api/series
      /api/series/

      {id}
      /api/events
      /api/events/{id}

      For the requests returning lists of objects (/api/series and /api/events), this is problematic as the client is required to issue additional requests (/api/series/

      {id}/metadata and /api/events/{id}

      /metadata) to be able to retrieve all metadata fields. This, however, does not scale.

      To be consistent across the requests, the goal of this story is to add all metadata fields of the respective objects to all responses.

      Note:
      This is not as redundant as it looks at first glance: The /metadata requests are supposed to deliver self-describing metadata sets as required to build property sheets. Also, /metadata can contain additional fields that can be freely configured by the Opencast system administrator.

      The following fields need to be added to make the metadata complete:

      /api/series && /api/series/

      {id}

      * language
      * rightsholder
      * license

      /api/events && /api/events/{id}
      • language
      • rightsholder
      • license
      • is_part_of (note that the External API does not use camel case per convention)
      • duration
      • source

      Update:
      Also added the following fields:

      • status (the event status)
      • series (the name of the series)

        TestRail: Results

          Attachments

            Issue links

              Activity

                People

                • Assignee:
                  mstypa Michael Stypa
                  Reporter:
                  staubesv Sven Stauber
                • Watchers:
                  2 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    TestRail: Cases