Skip to content

Validate API key and endpoint before making requests #1251

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

Merged
josephjclark merged 2 commits into from
Feb 17, 2026
Merged

Validate API key and endpoint before making requests #1251

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
586e5d5
Validate API key and endpoint before making requests
elias-ba Feb 15, 2026
0ee819c
Move endpoint validation to getLightningUrl
elias-ba Feb 15, 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
13 changes: 11 additions & 2 deletions packages/cli/src/projects/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,11 @@ export const loadAppAuthConfig = (
config.endpoint = OPENFN_ENDPOINT;
}

// TODO probably need to throw

if (!config.apiKey) {
throw new CLIError(
'OPENFN_API_KEY is required. Set it in .env, pass --api-key, or set the environment variable.'
);
}
return config as Required<AuthOptions>;
};

Expand Down Expand Up @@ -93,6 +96,12 @@ export const getLightningUrl = (
path: string = '',
snapshots?: string[]
) => {
if (!endpoint) {
throw new CLIError(
'OPENFN_ENDPOINT is required. Set it in .env, pass --endpoint, or set the environment variable.\n' +
'Example: OPENFN_ENDPOINT=https://app.openfn.org'
);
}
const params = new URLSearchParams();
snapshots?.forEach((snapshot) => params.append('snapshots[]', snapshot));
return new URL(`/api/provision/${path}?${params.toString()}`, endpoint);
Expand Down