README.md

Apis

(apis)

Overview

REST APIs for managing Api entities

Available Operations

• deleteApi - Delete an Api.
• generateOpenApiSpec - Generate an OpenAPI specification for a particular Api.
• generatePostmanCollection - Generate a Postman collection for a particular Api.
• getAllApiVersions - Get all Api versions for a particular ApiEndpoint.
• getApis - Get a list of Apis for a given workspace
• upsertApi - Upsert an Api

deleteApi

Delete a particular version of an Api. The will also delete all associated ApiEndpoints, Metadata, Schemas & Request Logs (if using a Postgres datastore).

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\DeleteApiRequest(
    apiID: '<id>',
    versionID: '<id>',
);

$response = $sdk->apis->deleteApi(
    request: $request
);

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

Parameters

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

Response

?Operations\DeleteApiResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

generateOpenApiSpec

This endpoint will generate any missing operations in any registered OpenAPI document if the operation does not already exist in the document. Returns the original document and the newly generated document allowing a diff to be performed to see what has changed.

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\GenerateOpenApiSpecRequest(
    apiID: '<id>',
    versionID: '<id>',
);

$response = $sdk->apis->generateOpenApiSpec(
    request: $request
);

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

Parameters

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

Response

?Operations\GenerateOpenApiSpecResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

generatePostmanCollection

Generates a postman collection containing all endpoints for a particular API. Includes variables produced for any path/query/header parameters included in the OpenAPI document.

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\GeneratePostmanCollectionRequest(
    apiID: '<id>',
    versionID: '<id>',
);

$response = $sdk->apis->generatePostmanCollection(
    request: $request
);

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

Parameters

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

Response

?Operations\GeneratePostmanCollectionResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

getAllApiVersions

Get all Api versions for a particular ApiEndpoint. Supports filtering the versions based on metadata attributes.

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\GetAllApiVersionsRequest(
    apiID: '<id>',
);

$response = $sdk->apis->getAllApiVersions(
    request: $request
);

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

Parameters

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

Response

?Operations\GetAllApiVersionsResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

getApis

Get a list of all Apis and their versions for a given workspace. Supports filtering the APIs based on metadata attributes.

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\GetApisRequest();

$response = $sdk->apis->getApis(
    request: $request
);

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

Parameters

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

Response

?Operations\GetApisResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*

upsertApi

Upsert an Api. If the Api does not exist, it will be created. If the Api exists, it will be updated.

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\UpsertApiRequest(
    api: new Shared\ApiInput(
        apiId: '<id>',
        description: 'consequently brr happily yowza however gosh investigate joyfully direct',
        versionId: '<id>',
    ),
    apiID: '<id>',
);

$response = $sdk->apis->upsertApi(
    request: $request
);

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

Parameters

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

Response

?Operations\UpsertApiResponse

Errors

Error Type	Status Code	Content Type
Errorors\Error	4XX	application/json
Errorors\SDKException	5XX	*/*