README.md

Metadata

(metadata)

Overview

REST APIs for managing Version Metadata entities

Available Operations

• deleteVersionMetadata - Delete metadata for a particular apiID and versionID.
• getVersionMetadata - Get all metadata for a particular apiID and versionID.
• insertVersionMetadata - Insert metadata for a particular apiID and versionID.

deleteVersionMetadata

Delete metadata for a particular apiID and versionID.

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

(async() => {
  const sdk = new Speakeasy({
    security: {
      apiKey: "",
    },
  });

  const res = await sdk.metadata.deleteVersionMetadata({
    apiID: "string",
    metaKey: "string",
    metaValue: "string",
    versionID: "string",
  });

  if (res.statusCode == 200) {
    // handle response
  }
})();

Parameters

Parameter	Type	Required	Description
request	operations.DeleteVersionMetadataRequest	✔️	The request object to use for the request.
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.DeleteVersionMetadataResponse>

getVersionMetadata

Get all metadata for a particular apiID and versionID.

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

(async() => {
  const sdk = new Speakeasy({
    security: {
      apiKey: "",
    },
  });

  const res = await sdk.metadata.getVersionMetadata({
    apiID: "string",
    versionID: "string",
  });

  if (res.statusCode == 200) {
    // handle response
  }
})();

Parameters

Parameter	Type	Required	Description
request	operations.GetVersionMetadataRequest	✔️	The request object to use for the request.
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.GetVersionMetadataResponse>

insertVersionMetadata

Insert metadata for a particular apiID and versionID.

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

(async() => {
  const sdk = new Speakeasy({
    security: {
      apiKey: "",
    },
  });

  const res = await sdk.metadata.insertVersionMetadata({
    versionMetadataInput: {
      metaKey: "string",
      metaValue: "string",
    },
    apiID: "string",
    versionID: "string",
  });

  if (res.statusCode == 200) {
    // handle response
  }
})();

Parameters

Parameter	Type	Required	Description
request	operations.InsertVersionMetadataRequest	✔️	The request object to use for the request.
config	AxiosRequestConfig	➖	Available config options for making requests.

Response

Promise<operations.InsertVersionMetadataResponse>