Options
All
  • Public
  • Public/Protected
  • All
Menu

ibm-security-advisor - v5.0.0

Index

Classes

Variables

Functions

Variables

Const pkg

pkg: any = require('../package.json')

Functions

getSdkHeaders

  • getSdkHeaders(serviceName: string, serviceVersion: string, operationId: string): SdkHeaders | __type
  • Get the request headers to be sent in requests by the SDK.

    If you plan to gather metrics for your SDK, the User-Agent header value must be a string similar to the following: my-node-sdk/0.0.1 (lang=node.js; os.name=Linux; os.version=19.3.0; node.version=v10.15.3)

    In the example above, the analytics tool will parse the user-agent header and use the following properties: "my-node-sdk" - the name of your sdk "0.0.1"- the version of your sdk "lang=node.js" - the language of the current sdk "os.name=Linux; os.version=19.3.0; node.version=v10.15.3" - system information

    Note: It is very important that the sdk name ends with the string -sdk, as the analytics data collector uses this to gather usage data.

    Parameters

    Name Type Attribute Description
    serviceName string

    serviceVersion string

    operationId string

    Returns SdkHeaders | __type

Generated using TypeDoc