Skip to content

Latest commit

 

History

History
332 lines (234 loc) · 14 KB

README.md

File metadata and controls

332 lines (234 loc) · 14 KB

Artifacts

(artifacts)

Available Operations

getBlob

Get blob for a particular digest

Example Usage

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

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

  const res = await sdk.artifacts.getBlob({
    digest: "<value>",
    namespaceName: "<value>",
    organizationSlug: "<value>",
    workspaceSlug: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GetBlobResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

getManifest

Get manifest for a particular reference

Example Usage

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

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

  const res = await sdk.artifacts.getManifest({
    namespaceName: "<value>",
    organizationSlug: "<value>",
    revisionReference: "<value>",
    workspaceSlug: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GetManifestResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

getNamespaces

Each namespace contains many revisions.

Example Usage

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

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

  const res = await sdk.artifacts.getNamespaces();

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

run();

Parameters

Parameter Type Required Description
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.GetNamespacesResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

getRevisions

Example Usage

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

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

  const res = await sdk.artifacts.getRevisions({
    namespaceName: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GetRevisionsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

getTags

Example Usage

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

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

  const res = await sdk.artifacts.getTags({
    namespaceName: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.GetTagsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

postTags

Add tags to an existing revision

Example Usage

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

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

  const res = await sdk.artifacts.postTags({
    addTags: {
      revisionDigest: "<value>",
      tags: [
        "<value>",
      ],
    },
    namespaceName: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.PostTagsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

preflight

Get access token for communicating with OCI distribution endpoints

Example Usage

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

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

  const res = await sdk.artifacts.preflight({
    namespaceName: "<value>",
  });

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

run();

Parameters

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

Response

Promise<operations.PreflightResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /