@redhat-cloud-services/compliance-client

Javascript client for the compliance API

If you want to use RedHatInsights/compliance 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/compliance-client

Or Yarn

yarn add @redhat-cloud-services/compliance-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 { Configuration } from '@redhat-cloud-services/compliance-client';
const instance = axios.create();

// BASE_PATH should be set in your constants file
const configApi = new Configuration(undefined, BASE_PATH, instance);
export configApi;

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

// api.js
import axios from 'axios';
import { Configuration } from '@redhat-cloud-services/compliance-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 configApi = new Configuration(undefined, BASE_PATH, instance);
export configApi;

Building

Run nx build @redhat-cloud-services/compliance-client to build the library.

Running unit tests

Run nx test @redhat-cloud-services/compliance-client to execute the unit tests via Jest.

API documentation

• README