Uploaded image for project: 'Hybrid Cloud Console'
  1. Hybrid Cloud Console
  2. RHCLOUD-28020

[TECH DEBT] Update docs generating in JS clients

XMLWordPrintable

    • 2
    • Plat-Ex Services Sprint 4, Plat-Ex Services Sprint 7, Plat-Ex Services Sprint 8

      The current docs we generate in JS clients are obsolete, let's change that. 
      https://github.com/RedHatInsights/javascript-clients

      For example in RBAC:

      methods are available in the new location
      https://github.com/RedHatInsights/javascript-clients/tree/42b6973ff077edc24e5cf737782916b5bde0ff8e/packages/notifications/utils

      API usage should look like this:

      import APIFactory from '@redhat-cloud-services/rbac-client/utils'; 
      import listGroups from '@redhat-cloud-services/rbac-client/ListGroups';
      import createGroup from '@redhat-cloud-services/rbac-client/CreateGroup';
      import updateGroup from '@redhat-cloud-services/rbac-client/UpdateGroup';
      
      const groupApi = APIFactory(RBAC_API_BASE, undefined, { listGroups, createGroup, updateGroup }); 

              apinkert-insights Austin Pinkerton
              fhlavac Filip Hlavac
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: