Node Packaged Modules

    @redhat-cloud-services/rbac-client
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.116 • Public • Published

    Javascript client for Inventory API

    If you want to use RedHatInsights/insights-host-inventory you shouldn't use get requests directly, but rather use this client to integrate with this service.

    Install

    NPM

    npm install --save @redhat-cloud-services/host-inventory-client

    Or Yarn

    yarn add @redhat-cloud-services/host-inventory-client

    Usage

    This client is using typescript and axios. Types are distributed with this package, so no need to define or install them separately.

    To correctly bootstrap this API you should use this config (no need to define it multiple times, just one config and reimport it anywhere you want to use it).

    // api.js
    import axios from 'axios';
    import { GroupApi } from '@redhat-cloud-services/rbac-client';
    const instance = axios.create();
    
    // BASE_PATH should be set in your constants file
    const groupApi = new GroupApi(undefined, BASE_PATH, instance);
    export groupApi;

    If you want to add some interceptors you can use axios build in interceptors

    // api.js
    import axios from 'axios';
    import { GroupApi } from '@redhat-cloud-services/rbac-client';
    const instance = axios.create();
    
    // Request interceptor
    instance.interceptors.request.use((request) => {
        // some logic to do with request
    });
    
    // Response interceptor
    instance.interceptors.response.use((response) => {
        // some logic to do with request
    });
    
    // Error interceptor
    instance.interceptors.response.use(null, (error) => {
        // some logic to do with error
    });
    
    // BASE_PATH should be set in your constants file
    const groupApi = new HostsApi(undefined, BASE_PATH, instance);
    export groupApi;

    API documentation

    Keywords

    none

    Install

    npm i @redhat-cloud-services/rbac-client

    DownloadsWeekly Downloads

    1,388

    Version

    1.0.116

    License

    Apache-2.0

    Unpacked Size

    907 kB

    Total Files

    112

    Last publish

    Collaborators

    • lesamo
    • jozefhartinger
    • karelhala
    • ryelo
    • kruai
    • hyperkid