Skip to content

Allow optional 'rules' parameter for ruleset creation #53

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
SergkeiM merged 1 commit into from
Jul 28, 2026
Merged

Allow optional 'rules' parameter for ruleset creation #53

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
2 changes: 1 addition & 1 deletion src/Endpoints/Accounts/Rulesets.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public function get(string $accountId): ResponseInterface
public function create(string $accountId, array|Ruleset $values): ResponseInterface
{
if (is_array($values)) {
$this->requiredParams(['name', 'kind', 'phase', 'rules'], $values);
$this->requiredParams(['name', 'kind', 'phase'], $values);
} else {
$values = $values->toArray();
}
Expand Down
2 changes: 1 addition & 1 deletion src/Endpoints/Zones/Rulesets.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public function get(string $zoneId): ResponseInterface
public function create(string $zoneId, array|Ruleset $values): ResponseInterface
{
if (is_array($values)) {
$this->requiredParams(['name', 'kind', 'phase', 'rules'], $values);
$this->requiredParams(['name', 'kind', 'phase'], $values);
} else {
$values = $values->toArray();
}
Expand Down
35 changes: 35 additions & 0 deletions test/Tests/Endpoints/Accounts/RulesetsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,41 @@ public function shouldCreateWithArray()
$this->assertSame('/client/v4/accounts/account_id/rulesets', $this->lastRequest()->getUri()->getPath());
}

#[Test]
public function shouldCreateWithEmptyRulesArray()
{
$client = $this->mockClient([
new Response(200, [], json_encode(['success' => true, 'result' => ['id' => 'ruleset_id']])),
]);

$response = $client->accounts()->rulesets()->create('account_id', [
'name' => 'my ruleset',
'kind' => 'root',
'phase' => 'http_request_firewall_custom',
'rules' => [],
]);

$this->assertTrue($response->successful());
$this->assertSame('POST', $this->lastRequest()->getMethod());
}

#[Test]
public function shouldCreateWithoutRulesKey()
{
$client = $this->mockClient([
new Response(200, [], json_encode(['success' => true, 'result' => ['id' => 'ruleset_id']])),
]);

$response = $client->accounts()->rulesets()->create('account_id', [
'name' => 'my ruleset',
'kind' => 'root',
'phase' => 'http_request_firewall_custom',
]);

$this->assertTrue($response->successful());
$this->assertSame('POST', $this->lastRequest()->getMethod());
}

#[Test]
public function shouldCreateWithRulesetObject()
{
Expand Down
35 changes: 35 additions & 0 deletions test/Tests/Endpoints/Zones/RulesetsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,41 @@ public function shouldCreateWithArray()
$this->assertSame('/client/v4/zones/zone_id/rulesets', $this->lastRequest()->getUri()->getPath());
}

#[Test]
public function shouldCreateWithEmptyRulesArray()
{
$client = $this->mockClient([
new Response(200, [], json_encode(['success' => true, 'result' => ['id' => 'ruleset_id']])),
]);

$response = $client->zones()->rulesets()->create('zone_id', [
'name' => 'my ruleset',
'kind' => 'zone',
'phase' => 'http_request_firewall_custom',
'rules' => [],
]);

$this->assertTrue($response->successful());
$this->assertSame('POST', $this->lastRequest()->getMethod());
}

#[Test]
public function shouldCreateWithoutRulesKey()
{
$client = $this->mockClient([
new Response(200, [], json_encode(['success' => true, 'result' => ['id' => 'ruleset_id']])),
]);

$response = $client->zones()->rulesets()->create('zone_id', [
'name' => 'my ruleset',
'kind' => 'zone',
'phase' => 'http_request_firewall_custom',
]);

$this->assertTrue($response->successful());
$this->assertSame('POST', $this->lastRequest()->getMethod());
}

#[Test]
public function shouldCreateWithRulesetObject()
{
Expand Down
Loading