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

hub api abstraction over differences in list api conventions

    • Icon: Task Task
    • Resolution: Done
    • Icon: Undefined Undefined
    • None
    • None
    • UI

      Figure out a good way to reduce the mental load of having to remember which API endpoint uses which convention and having to spell it out on every use.
      This should probably live outside use*View, to be usable with useGet/requestGet as well.

      Either a hardcoded lookup table, or a function wrapping each call (or returning the right splattable params) should work.

      url page/offset page_size/limit sort/order_by/ordering results count
      _ui/v1/ai_deny_index/ offset limit sort results count
      _ui/v1/controllers/ offset limit sort data meta.count
      _ui/v1/execution-environments/registries/ offset limit sort data meta.count
      _ui/v1/execution-environments/remotes/ offset limit sort data meta.count
      _ui/v1/groups/ offset limit sort data meta.count
      _ui/v1/imports/collections/ offset limit sort data meta.count
      _ui/v1/my-distributions/ offset limit sort data meta.count
      _ui/v1/my-namespaces/ offset limit sort data meta.count
      _ui/v1/my-synclists/ offset limit sort data meta.count
      _ui/v1/namespaces/ offset limit sort data meta.count
      _ui/v1/tags/ offset limit sort data meta.count
      _ui/v1/users/ offset limit sort data meta.count
      pulp/api/v3/content/ansible/collection_signatures/ offset limit ordering results count
      pulp/api/v3/distributions/ansible/ansible/ offset limit ordering results count
      pulp/api/v3/distributions/container/container/ offset limit ordering results count
      pulp/api/v3/groups/ offset limit ordering results count
      pulp/api/v3/pulp_container/namespaces/ offset limit sort results count
      pulp/api/v3/remotes/ansible/collection/ offset limit ordering results count
      pulp/api/v3/repositories/ansible/ansible/ offset limit ordering results count
      pulp/api/v3/repositories/container/container-push/ offset limit ordering results count
      pulp/api/v3/roles/ offset limit ordering results count
      pulp/api/v3/signing-services/ offset limit ordering results count
      pulp/api/v3/tasks/ offset limit ordering results count
      v1/imports/ page page_size order_by results count
      v1/namespaces/ page page_size sort results count
      v1/roles/ page page_size order_by results count
      v3/plugin/ansible/search/collection-versions/ offset limit order_by data meta.count
      v3/plugin/execution-environments/repositories/ offset limit sort data meta.count
      v3/tasks/ offset limit sort data meta.count

      (table also in https://github.com/ansible/ansible-ui/wiki/Hub-API)

            mhradil-1 Martin Hradil
            mhradil-1 Martin Hradil
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved: