Skip to content

Latest commit

 

History

History
371 lines (244 loc) · 16 KB

README.md

File metadata and controls

371 lines (244 loc) · 16 KB
Raw

Artifacts

(artifacts)

Overview

REST APIs for working with Registry artifacts

Available Operations

getBlob

Get blob for a particular digest

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\GetBlobRequest(
    digest: '<value>',
    namespaceName: '<value>',
    organizationSlug: '<value>',
    workspaceSlug: '<value>',
);

$response = $sdk->artifacts->getBlob(
    request: $request
);

if ($response->blob !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\GetBlobRequest ✔️ The request object to use for the request.

Response

?Operations\GetBlobResponse

Errors

Error Object Status Code Content Type
Errorors\Error 4XX application/json
Speakeasy\SpeakeasyClientSDK\Models\Errorors.SDKException 4xx-5xx /

getManifest

Get manifest for a particular reference

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\GetManifestRequest(
    namespaceName: '<value>',
    organizationSlug: '<value>',
    revisionReference: '<value>',
    workspaceSlug: '<value>',
);

$response = $sdk->artifacts->getManifest(
    request: $request
);

if ($response->manifest !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\GetManifestRequest ✔️ The request object to use for the request.

Response

?Operations\GetManifestResponse

Errors

Error Object Status Code Content Type
Errorors\Error 4XX application/json
Speakeasy\SpeakeasyClientSDK\Models\Errorors.SDKException 4xx-5xx /

getNamespaces

Each namespace contains many revisions.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();



$response = $sdk->artifacts->getNamespaces(

);

if ($response->getNamespacesResponse !== null) {
    // handle response
}

Response

?Operations\GetNamespacesResponse

Errors

Error Object Status Code Content Type
Errorors\Error 4XX application/json
Speakeasy\SpeakeasyClientSDK\Models\Errorors.SDKException 4xx-5xx /

getRevisions

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\GetRevisionsRequest(
    namespaceName: '<value>',
);

$response = $sdk->artifacts->getRevisions(
    request: $request
);

if ($response->getRevisionsResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\GetRevisionsRequest ✔️ The request object to use for the request.

Response

?Operations\GetRevisionsResponse

Errors

Error Object Status Code Content Type
Errorors\Error 4XX application/json
Speakeasy\SpeakeasyClientSDK\Models\Errorors.SDKException 4xx-5xx /

getTags

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\GetTagsRequest(
    namespaceName: '<value>',
);

$response = $sdk->artifacts->getTags(
    request: $request
);

if ($response->getTagsResponse !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\GetTagsRequest ✔️ The request object to use for the request.

Response

?Operations\GetTagsResponse

Errors

Error Object Status Code Content Type
Errorors\Error 4XX application/json
Speakeasy\SpeakeasyClientSDK\Models\Errorors.SDKException 4xx-5xx /

postTags

Add tags to an existing revision

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Operations;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Operations\PostTagsRequest(
    namespaceName: '<value>',
);

$response = $sdk->artifacts->postTags(
    request: $request
);

if ($response->statusCode === 200) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Operations\PostTagsRequest ✔️ The request object to use for the request.

Response

?Operations\PostTagsResponse

Errors

Error Object Status Code Content Type
Errorors\Error 4XX application/json
Speakeasy\SpeakeasyClientSDK\Models\Errorors.SDKException 4xx-5xx /

preflight

Get access token for communicating with OCI distribution endpoints

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Speakeasy\SpeakeasyClientSDK;
use Speakeasy\SpeakeasyClientSDK\Models\Shared;

$security = new Shared\Security(
    apiKey: '<YOUR_API_KEY_HERE>',
);

$sdk = SpeakeasyClientSDK\SDK::builder()->setSecurity($security)->build();

$request = new Shared\PreflightRequest(
    namespaceName: '<value>',
);

$response = $sdk->artifacts->preflight(
    request: $request
);

if ($response->preflightToken !== null) {
    // handle response
}

Parameters

Parameter Type Required Description
$request Shared\PreflightRequest ✔️ The request object to use for the request.

Response

?Operations\PreflightResponse

Errors

Error Object Status Code Content Type
Errorors\Error 4XX application/json
Speakeasy\SpeakeasyClientSDK\Models\Errorors.SDKException 4xx-5xx /