Skip to content

feat: Clean up the endpoints list #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
erichare wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: Clean up the endpoints list #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4bb999d
feat: Clean up the endpoints list
erichare Mar 17, 2026
9bbdf6e
Alias curl to data-api for backwards compat
erichare Mar 17, 2026
a7b62b2
Feedback on naming scheme
erichare Mar 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions src/main/java/com/dtsx/astra/cli/commands/db/endpoints/Endpoint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@
@RequiredArgsConstructor
public enum Endpoint {
API("api", (result, env) -> {
val db = result.database();
return apiBaseUrl(result, env);
}),

return (db.getInfo().getDbType() == null)
? ApiLocator.getApiRestEndpoint(env, db.getId(), result.region())
: ApiLocator.getApiEndpoint(env, db.getId(), result.region());
DATA_API("data-api", (result, env) -> {
return apiBaseUrl(result, env) + "/api/v1/json";
}),

PLAYGROUND("playground", (result, env) -> {
return ApiLocator.getApiGraphQLEndPoint(env, result.database().getId(), result.region()) + "/playground";
}),

SWAGGER("swagger", (result, env) -> {
Expand All @@ -25,14 +29,6 @@ public enum Endpoint {
return (db.getInfo().getDbType() == null)
? ApiLocator.getApiRestEndpoint(env, db.getId(), result.region()) + "/swagger-ui"
: ApiLocator.getApiEndpoint(env, db.getId(), result.region()) + "/api/json/swagger-ui";
}),

PLAYGROUND("playground", (result, env) -> {
return ApiLocator.getApiGraphQLEndPoint(env, result.database().getId(), result.region()) + "/playground";
}),

DATA_API("data-api", (result, env) -> {
return API.mkUrl.apply(result, env) + "/api/v1/json";
});

@Getter
Expand All @@ -42,4 +38,12 @@ public enum Endpoint {
public String mkUrl(EndpointGetResponse result, AstraEnvironment env) {
return mkUrl.apply(result, env);
}

private static String apiBaseUrl(EndpointGetResponse result, AstraEnvironment env) {
val db = result.database();

return (db.getInfo().getDbType() == null)
? ApiLocator.getApiRestEndpoint(env, db.getId(), result.region())
: ApiLocator.getApiEndpoint(env, db.getId(), result.region());
}
}
1 change: 1 addition & 0 deletions src/main/java/com/dtsx/astra/cli/commands/db/endpoints/EndpointsApiCmd.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

@Command(
name = "api",
aliases = {"data-api-client"},
description = "Get the API endpoint to interact with the specified database"
)
@Example(
Expand Down
4 changes: 2 additions & 2 deletions src/test/resources/snapshots/_db/_endpoints/EndpointsListCmd/endpoint_found.csv.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ exit_code: 0
---- output ----
stdout: code,message,endpoint,url
stdout: OK,,api,https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com
stdout: OK,,swagger,https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/json/swagger-ui
stdout: OK,,playground,https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/playground
stdout: OK,,data-api,https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/v1/json
stdout: OK,,playground,https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/playground
stdout: OK,,swagger,https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/json/swagger-ui
---- end ----
4 changes: 2 additions & 2 deletions ...est/resources/snapshots/_db/_endpoints/EndpointsListCmd/endpoint_found.human.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ stdout: ┌────────────┬──────────
stdout: │ Endpoint │ URL │
stdout: ├────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────┤
stdout: │ api │ https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com │
stdout: │ swagger │ https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/json/swagger-ui │
stdout: │ playground │ https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/playground │
stdout: │ data-api │ https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/v1/json │
stdout: │ playground │ https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/playground │
stdout: │ swagger │ https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/json/swagger-ui │
stdout: └────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────┘
---- end ----
8 changes: 4 additions & 4 deletions ...test/resources/snapshots/_db/_endpoints/EndpointsListCmd/endpoint_found.json.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ stdout: "data" : [ {
stdout: "endpoint" : "api",
stdout: "url" : "https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com"
stdout: }, {
stdout: "endpoint" : "swagger",
stdout: "url" : "https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/json/swagger-ui"
stdout: "endpoint" : "data-api",
stdout: "url" : "https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/v1/json"
stdout: }, {
stdout: "endpoint" : "playground",
stdout: "url" : "https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/playground"
stdout: }, {
stdout: "endpoint" : "data-api",
stdout: "url" : "https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/v1/json"
stdout: "endpoint" : "swagger",
stdout: "url" : "https://822b0fff-6a73-4322-a8ec-09832b075287-us-east-2.apps.astra-dev.datastax.com/api/json/swagger-ui"
stdout: } ]
stdout: }
---- end ----
4 changes: 2 additions & 2 deletions ...es/snapshots/_db/_endpoints/EndpointsListCmd/endpoint_found_for_region.human.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ stdout: ┌────────────┬──────────
stdout: │ Endpoint │ URL │
stdout: ├────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────┤
stdout: │ api │ https://822b0fff-6a73-4322-a8ec-09832b075287-ap-south-1.apps.astra-dev.datastax.com │
stdout: │ swagger │ https://822b0fff-6a73-4322-a8ec-09832b075287-ap-south-1.apps.astra-dev.datastax.com/api/json/swagger-ui │
stdout: │ playground │ https://822b0fff-6a73-4322-a8ec-09832b075287-ap-south-1.apps.astra-dev.datastax.com/api/playground │
stdout: │ data-api │ https://822b0fff-6a73-4322-a8ec-09832b075287-ap-south-1.apps.astra-dev.datastax.com/api/v1/json │
stdout: │ playground │ https://822b0fff-6a73-4322-a8ec-09832b075287-ap-south-1.apps.astra-dev.datastax.com/api/playground │
stdout: │ swagger │ https://822b0fff-6a73-4322-a8ec-09832b075287-ap-south-1.apps.astra-dev.datastax.com/api/json/swagger-ui │
stdout: └────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────────┘
---- end ----
8 changes: 4 additions & 4 deletions ...ces/snapshots/_db/_endpoints/EndpointsListCmd/endpoint_found_for_region.json.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ stdout: "data" : [ {
stdout: "endpoint" : "api",
stdout: "url" : "https://822b0fff-6a73-4322-a8ec-09832b075287-ap-south-1.apps.astra-dev.datastax.com"
stdout: }, {
stdout: "endpoint" : "swagger",
stdout: "url" : "https://822b0fff-6a73-4322-a8ec-09832b075287-ap-south-1.apps.astra-dev.datastax.com/api/json/swagger-ui"
stdout: "endpoint" : "data-api",
stdout: "url" : "https://822b0fff-6a73-4322-a8ec-09832b075287-ap-south-1.apps.astra-dev.datastax.com/api/v1/json"
stdout: }, {
stdout: "endpoint" : "playground",
stdout: "url" : "https://822b0fff-6a73-4322-a8ec-09832b075287-ap-south-1.apps.astra-dev.datastax.com/api/playground"
stdout: }, {
stdout: "endpoint" : "data-api",
stdout: "url" : "https://822b0fff-6a73-4322-a8ec-09832b075287-ap-south-1.apps.astra-dev.datastax.com/api/v1/json"
stdout: "endpoint" : "swagger",
stdout: "url" : "https://822b0fff-6a73-4322-a8ec-09832b075287-ap-south-1.apps.astra-dev.datastax.com/api/json/swagger-ui"
stdout: } ]
stdout: }
---- end ----