-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: regenerated with OpenAPI Doc 0.3.0, Speakeay CLI 1.23.0
- Loading branch information
1 parent
7bc9329
commit 3b980cb
Showing
49 changed files
with
1,483 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # apiEndpoints | ||
|
|
||
| REST APIs for managing ApiEndpoint entities | ||
|
|
||
|
|
||
| * [deleteApiEndpoint](deleteapiendpoint.md) - Delete an ApiEndpoint. | ||
| * [findApiEndpoint](findapiendpoint.md) - Find an ApiEndpoint via its displayName. | ||
| * [generateOpenApiSpecForApiEndpoint](generateopenapispecforapiendpoint.md) - Generate an OpenAPI specification for a particular ApiEndpoint. | ||
| * [generatePostmanCollectionForApiEndpoint](generatepostmancollectionforapiendpoint.md) - Generate a Postman collection for a particular ApiEndpoint. | ||
| * [getAllApiEndpoints](getallapiendpoints.md) - Get all Api endpoints for a particular apiID. | ||
| * [getAllForVersionApiEndpoints](getallforversionapiendpoints.md) - Get all ApiEndpoints for a particular apiID and versionID. | ||
| * [getApiEndpoint](getapiendpoint.md) - Get an ApiEndpoint. | ||
| * [upsertApiEndpoint](upsertapiendpoint.md) - Upsert an ApiEndpoint. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # deleteApiEndpoint | ||
| Available in: `apiEndpoints` | ||
|
|
||
| Delete an ApiEndpoint. This will also delete all associated Request Logs (if using a Postgres datastore). | ||
|
|
||
| ## Example Usage | ||
| ```php | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| require_once 'vendor/autoload.php'; | ||
|
|
||
| use \Speakeasy\SpeakeasyClientSDK\SDK; | ||
| use \Speakeasy\SpeakeasyClientSDK\Models\Shared\Security; | ||
| use \Speakeasy\SpeakeasyClientSDK\Models\Operations\DeleteApiEndpointRequest; | ||
|
|
||
| $sdk = SDK::builder() | ||
| ->build(); | ||
|
|
||
| try { | ||
| $request = new DeleteApiEndpointRequest(); | ||
| $request->apiEndpointID = 'delectus'; | ||
| $request->apiID = 'tempora'; | ||
| $request->versionID = 'suscipit'; | ||
|
|
||
| $response = $sdk->apiEndpoints->deleteApiEndpoint($request); | ||
|
|
||
| if ($response->statusCode === 200) { | ||
| // handle response | ||
| } | ||
| } catch (Exception $e) { | ||
| // handle exception | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # findApiEndpoint | ||
| Available in: `apiEndpoints` | ||
|
|
||
| Find an ApiEndpoint via its displayName (set by operationId from a registered OpenAPI schema). | ||
| This is useful for finding the ID of an ApiEndpoint to use in the /v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID} endpoints. | ||
|
|
||
| ## Example Usage | ||
| ```php | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| require_once 'vendor/autoload.php'; | ||
|
|
||
| use \Speakeasy\SpeakeasyClientSDK\SDK; | ||
| use \Speakeasy\SpeakeasyClientSDK\Models\Shared\Security; | ||
| use \Speakeasy\SpeakeasyClientSDK\Models\Operations\FindApiEndpointRequest; | ||
|
|
||
| $sdk = SDK::builder() | ||
| ->build(); | ||
|
|
||
| try { | ||
| $request = new FindApiEndpointRequest(); | ||
| $request->apiID = 'molestiae'; | ||
| $request->displayName = 'minus'; | ||
| $request->versionID = 'placeat'; | ||
|
|
||
| $response = $sdk->apiEndpoints->findApiEndpoint($request); | ||
|
|
||
| if ($response->apiEndpoint !== null) { | ||
| // handle response | ||
| } | ||
| } catch (Exception $e) { | ||
| // handle exception | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # generateOpenApiSpecForApiEndpoint | ||
| Available in: `apiEndpoints` | ||
|
|
||
| This endpoint will generate a new operation 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 | ||
| ```php | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| require_once 'vendor/autoload.php'; | ||
|
|
||
| use \Speakeasy\SpeakeasyClientSDK\SDK; | ||
| use \Speakeasy\SpeakeasyClientSDK\Models\Shared\Security; | ||
| use \Speakeasy\SpeakeasyClientSDK\Models\Operations\GenerateOpenApiSpecForApiEndpointRequest; | ||
|
|
||
| $sdk = SDK::builder() | ||
| ->build(); | ||
|
|
||
| try { | ||
| $request = new GenerateOpenApiSpecForApiEndpointRequest(); | ||
| $request->apiEndpointID = 'voluptatum'; | ||
| $request->apiID = 'iusto'; | ||
| $request->versionID = 'excepturi'; | ||
|
|
||
| $response = $sdk->apiEndpoints->generateOpenApiSpecForApiEndpoint($request); | ||
|
|
||
| if ($response->generateOpenApiSpecDiff !== null) { | ||
| // handle response | ||
| } | ||
| } catch (Exception $e) { | ||
| // handle exception | ||
| } | ||
| ``` |
34 changes: 34 additions & 0 deletions
34
docs/apiendpoints/generatepostmancollectionforapiendpoint.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # generatePostmanCollectionForApiEndpoint | ||
| Available in: `apiEndpoints` | ||
|
|
||
| Generates a postman collection that allows the endpoint to be called from postman variables produced for any path/query/header parameters included in the OpenAPI document. | ||
|
|
||
| ## Example Usage | ||
| ```php | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| require_once 'vendor/autoload.php'; | ||
|
|
||
| use \Speakeasy\SpeakeasyClientSDK\SDK; | ||
| use \Speakeasy\SpeakeasyClientSDK\Models\Shared\Security; | ||
| use \Speakeasy\SpeakeasyClientSDK\Models\Operations\GeneratePostmanCollectionForApiEndpointRequest; | ||
|
|
||
| $sdk = SDK::builder() | ||
| ->build(); | ||
|
|
||
| try { | ||
| $request = new GeneratePostmanCollectionForApiEndpointRequest(); | ||
| $request->apiEndpointID = 'nisi'; | ||
| $request->apiID = 'recusandae'; | ||
| $request->versionID = 'temporibus'; | ||
|
|
||
| $response = $sdk->apiEndpoints->generatePostmanCollectionForApiEndpoint($request); | ||
|
|
||
| if ($response->postmanCollection !== null) { | ||
| // handle response | ||
| } | ||
| } catch (Exception $e) { | ||
| // handle exception | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # getAllApiEndpoints | ||
| Available in: `apiEndpoints` | ||
|
|
||
| Get all Api endpoints for a particular apiID. | ||
|
|
||
| ## Example Usage | ||
| ```php | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| require_once 'vendor/autoload.php'; | ||
|
|
||
| use \Speakeasy\SpeakeasyClientSDK\SDK; | ||
| use \Speakeasy\SpeakeasyClientSDK\Models\Shared\Security; | ||
| use \Speakeasy\SpeakeasyClientSDK\Models\Operations\GetAllApiEndpointsRequest; | ||
|
|
||
| $sdk = SDK::builder() | ||
| ->build(); | ||
|
|
||
| try { | ||
| $request = new GetAllApiEndpointsRequest(); | ||
| $request->apiID = 'ab'; | ||
|
|
||
| $response = $sdk->apiEndpoints->getAllApiEndpoints($request); | ||
|
|
||
| if ($response->apiEndpoints !== null) { | ||
| // handle response | ||
| } | ||
| } catch (Exception $e) { | ||
| // handle exception | ||
| } | ||
| ``` |
Oops, something went wrong.