Skip to content

Rename getScriptExecution() to scriptExecution() and document API limits #90

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
Cannonb4ll merged 1 commit into from
Aug 24, 2026
Merged

Rename getScriptExecution() to scriptExecution() and document API limits #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,12 @@ $ploi->servers(123)->opcache()->disable();
// Refresh opcache
$ploi->servers(123)->opcache()->refresh();

// Run a one-off script on a server
// Run a one-off script on a server, $content is max 7500 characters and $user defaults to "ploi"
$response = $ploi->servers(123)->runOneOffScript('npm install -g pm2', $user = 'deployer');
$executionId = $response->getData()->id;

// Poll one-off script execution status and output
$ploi->servers(123)->getScriptExecution($executionId);
$ploi->servers(123)->scriptExecution($executionId);
```

### Sites
Expand Down Expand Up @@ -644,7 +644,7 @@ $ploi->scripts(123)->run($id = null, $serverIds = []);
$ploi->servers(123)->runOneOffScript($content, $user = null);

// Get one-off script execution status
$ploi->servers(123)->getScriptExecution($executionId);
$ploi->servers(123)->scriptExecution($executionId);
```

### Daemons
Expand Down
2 changes: 1 addition & 1 deletion src/Ploi/Resources/Server.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ public function runOneOffScript(string $content, ?string $user = null): Response
]);
}

public function getScriptExecution(string $executionId): Response
public function scriptExecution(string $executionId): Response
{
$this->setIdOrFail();

Expand Down
4 changes: 4 additions & 0 deletions tests/Ploi/Resources/ServerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ public function testBuildsUrlCorrectly()
$this->assertEquals('servers/1/endpoint', $server->buildEndpoint('endpoint'));
$this->assertEquals('servers/1/endpoint', $server->buildEndpoint('/endpoint'));

$execution = '3f4c9e9a-8b4e-4f0e-9d3b-2f6f2c1a7d42';
$this->assertEquals('servers/1/scripts/run', $server->buildEndpoint('scripts/run'));
$this->assertEquals("servers/1/scripts/run/{$execution}", $server->buildEndpoint("scripts/run/{$execution}"));

$server->setId();
$this->assertEquals('servers/different-endpoint', $server->buildEndpoint('/different-endpoint'));
}
Expand Down