Uploaded image for project: 'Automation Hub'
  1. Automation Hub
  2. AAH-2411

Collection version search API filter enhancements

Details

    Description

      Problem Description

      We are building a new landing page for Automation Hub using these designs from UXD. Based on the design the dashboard UI will contain sections representing prescribed categories of collections. The designs have categories such as:

      • Featured Collections
      • My Collections
      • Event-Driven Ansible Content
      • Storage Collections
      • System Collections

      As discussed in the notes here these categories can be supported using tags and  collection marks.

      We will need the search API to support the necessary filters so that the UI can access the list of categories and collections for each category.

      Filtering based on tags already exists, so we need new query params to support filtering by marks and by ownership.

      Proposed Solution:

      Enhancements to the collection version search API filter enhancements. See API Spec here: https://docs.google.com/document/d/1dUavgcFbdO_UIwbrsctEAIBuen2KGRJU1ep3l3_uY1M/edit#heading=h.k9amq7xu9o8c

      GET /api/galaxy/v3/plugin/ansible/search/collection-versions/

      • filter based on ownership (collections within namespaces that a user is the owner of)
      • filter based on collection marks

      New Query Params:

      • ?marks=foo: filter collection versions that have the mark ‘foo’.
      • ?my_permissions=galaxy.change_namespace: filter collection versions by a list of permissions that the current user has

      New Response Objects:

      • namespace_permissions
      • marks

      Attachments

        Activity

          People

            Unassigned Unassigned
            vnambiar@redhat.com Vidya Nambiar
            Apurva Bakshi Apurva Bakshi
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated: