Chore: document exposed interop functions

[thewahome]

Overview

Closes #6085

Notes

Sample from readme:

Kiota Interop Library

This library provides various functions to interact with Kiota, a client generator for HTTP REST APIs described by OpenAPI.

Installation

Provide instructions on how to install the project.

npm install kiota-Interop

Usage

getKiotaTree

Returns a tree of the open api description.

generateClient

Generates a client based on the provided client generation options.

generatePlugin

The function connects to Kiota and sends a request to generate a plugin using the provided options.
It handles the response and checks for success, returning the result or throwing an error if one occurs.

getKiotaVersion

Retrieves the version of Kiota by connecting to the Kiota service.

getManifestDetails

Retrieves the manifest details for a given API.

getLanguageInformationInternal

Retrieves language information by connecting to Kiota

getLanguageInformationForDescription

Retrieves language information based on the provided description URL.

migrateFromLockFile

Migrates data from a lock file located in the specified directory.

removePlugin

Removes a plugin from the Kiota environment.

removeClient

Removes a client using the provided configuration.

searchDescription

Searches for a description based on the provided search term and cache settings.

updateClients

Updates the clients in the Kiota environment.

[thewahome]

Thinking of changing the function names to be more descriptive. For example showKiotaResult is vague