README.md

ApiEndpoints

(apiEndpoints())

Overview

REST APIs for managing ApiEndpoint entities

Available Operations

• deleteApiEndpoint - Delete an ApiEndpoint.
• findApiEndpoint - Find an ApiEndpoint via its displayName.
• generateOpenApiSpecForApiEndpoint - Generate an OpenAPI specification for a particular ApiEndpoint.
• generatePostmanCollectionForApiEndpoint - Generate a Postman collection for a particular ApiEndpoint.
• getAllApiEndpoints - Get all Api endpoints for a particular apiID.
• getAllForVersionApiEndpoints - Get all ApiEndpoints for a particular apiID and versionID.
• getApiEndpoint - Get an ApiEndpoint.
• upsertApiEndpoint - Upsert an ApiEndpoint.

deleteApiEndpoint

Delete an ApiEndpoint. This will also delete all associated Request Logs (if using a Postgres datastore).

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.operations.DeleteApiEndpointRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.DeleteApiEndpointResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        DeleteApiEndpointRequest req = DeleteApiEndpointRequest.builder()
                .apiEndpointID("<id>")
                .apiID("<id>")
                .versionID("<id>")
                .build();

        DeleteApiEndpointResponse res = sdk.apiEndpoints().deleteApiEndpoint()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	DeleteApiEndpointRequest	✔️	The request object to use for the request.

Response

DeleteApiEndpointResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

findApiEndpoint

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

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.operations.FindApiEndpointRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.FindApiEndpointResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        FindApiEndpointRequest req = FindApiEndpointRequest.builder()
                .apiID("<id>")
                .displayName("Don_Kihn39")
                .versionID("<id>")
                .build();

        FindApiEndpointResponse res = sdk.apiEndpoints().findApiEndpoint()
                .request(req)
                .call();

        if (res.apiEndpoint().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	FindApiEndpointRequest	✔️	The request object to use for the request.

Response

FindApiEndpointResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

generateOpenApiSpecForApiEndpoint

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

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.operations.GenerateOpenApiSpecForApiEndpointRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.GenerateOpenApiSpecForApiEndpointResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GenerateOpenApiSpecForApiEndpointRequest req = GenerateOpenApiSpecForApiEndpointRequest.builder()
                .apiEndpointID("<id>")
                .apiID("<id>")
                .versionID("<id>")
                .build();

        GenerateOpenApiSpecForApiEndpointResponse res = sdk.apiEndpoints().generateOpenApiSpecForApiEndpoint()
                .request(req)
                .call();

        if (res.generateOpenApiSpecDiff().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	GenerateOpenApiSpecForApiEndpointRequest	✔️	The request object to use for the request.

Response

GenerateOpenApiSpecForApiEndpointResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

generatePostmanCollectionForApiEndpoint

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

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.operations.GeneratePostmanCollectionForApiEndpointRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.GeneratePostmanCollectionForApiEndpointResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GeneratePostmanCollectionForApiEndpointRequest req = GeneratePostmanCollectionForApiEndpointRequest.builder()
                .apiEndpointID("<id>")
                .apiID("<id>")
                .versionID("<id>")
                .build();

        GeneratePostmanCollectionForApiEndpointResponse res = sdk.apiEndpoints().generatePostmanCollectionForApiEndpoint()
                .request(req)
                .call();

        if (res.postmanCollection().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	GeneratePostmanCollectionForApiEndpointRequest	✔️	The request object to use for the request.

Response

GeneratePostmanCollectionForApiEndpointResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

getAllApiEndpoints

Get all Api endpoints for a particular apiID.

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetAllApiEndpointsRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetAllApiEndpointsResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GetAllApiEndpointsRequest req = GetAllApiEndpointsRequest.builder()
                .apiID("<id>")
                .build();

        GetAllApiEndpointsResponse res = sdk.apiEndpoints().getAllApiEndpoints()
                .request(req)
                .call();

        if (res.apiEndpoints().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	GetAllApiEndpointsRequest	✔️	The request object to use for the request.

Response

GetAllApiEndpointsResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

getAllForVersionApiEndpoints

Get all ApiEndpoints for a particular apiID and versionID.

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetAllForVersionApiEndpointsRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetAllForVersionApiEndpointsResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GetAllForVersionApiEndpointsRequest req = GetAllForVersionApiEndpointsRequest.builder()
                .apiID("<id>")
                .versionID("<id>")
                .build();

        GetAllForVersionApiEndpointsResponse res = sdk.apiEndpoints().getAllForVersionApiEndpoints()
                .request(req)
                .call();

        if (res.apiEndpoints().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	GetAllForVersionApiEndpointsRequest	✔️	The request object to use for the request.

Response

GetAllForVersionApiEndpointsResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

getApiEndpoint

Get an ApiEndpoint.

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetApiEndpointRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.GetApiEndpointResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        GetApiEndpointRequest req = GetApiEndpointRequest.builder()
                .apiEndpointID("<id>")
                .apiID("<id>")
                .versionID("<id>")
                .build();

        GetApiEndpointResponse res = sdk.apiEndpoints().getApiEndpoint()
                .request(req)
                .call();

        if (res.apiEndpoint().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	GetApiEndpointRequest	✔️	The request object to use for the request.

Response

GetApiEndpointResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

upsertApiEndpoint

Upsert an ApiEndpoint. If the ApiEndpoint does not exist it will be created, otherwise it will be updated.

Example Usage

package hello.world;

import dev.speakeasyapi.javaclientsdk.RyanTest;
import dev.speakeasyapi.javaclientsdk.models.operations.UpsertApiEndpointRequest;
import dev.speakeasyapi.javaclientsdk.models.operations.UpsertApiEndpointResponse;
import dev.speakeasyapi.javaclientsdk.models.shared.ApiEndpointInput;
import dev.speakeasyapi.javaclientsdk.models.shared.Security;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        RyanTest sdk = RyanTest.builder()
                .security(Security.builder()
                    .apiKey("<YOUR_API_KEY_HERE>")
                    .build())
            .build();

        UpsertApiEndpointRequest req = UpsertApiEndpointRequest.builder()
                .apiEndpoint(ApiEndpointInput.builder()
                    .apiEndpointId("<id>")
                    .description("commandeer equate pish psst hoot ugh frankly supposing")
                    .displayName("Eliseo.Little15")
                    .method("<value>")
                    .path("/etc/defaults")
                    .versionId("<id>")
                    .build())
                .apiEndpointID("<id>")
                .apiID("<id>")
                .versionID("<id>")
                .build();

        UpsertApiEndpointResponse res = sdk.apiEndpoints().upsertApiEndpoint()
                .request(req)
                .call();

        if (res.apiEndpoint().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	UpsertApiEndpointRequest	✔️	The request object to use for the request.

Response

UpsertApiEndpointResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*