Skip to content

v2.5.1 Fixes #712

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
jaredhendrickson13 merged 7 commits into from
Jun 11, 2025
Merged

v2.5.1 Fixes #712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0856ab9
fix: use replace strategy when updating RoutingGatewayGroupPriority o…
jaredhendrickson13 Jun 8, 2025
c37dce9
fix: don't restrict interface gateway assignment by id
jaredhendrickson13 Jun 8, 2025
a8679b5
tests: add test checking RoutingGatewayPriority tier change #707
jaredhendrickson13 Jun 9, 2025
f21aec8
docs(oas): include id fields in success response schemas #713
jaredhendrickson13 Jun 11, 2025
9f72a56
style: run prettier on changed files
jaredhendrickson13 Jun 11, 2025
70e2a09
tests: include missing parent_id in RoutingGatewayGroupPriority test
jaredhendrickson13 Jun 11, 2025
f88c932
tests: check for new response schema in ContentHandler tests
jaredhendrickson13 Jun 11, 2025
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
43 changes: 36 additions & 7 deletions pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Core/ContentHandler.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,17 +269,46 @@ class ContentHandler {
* @return array This ContentHandler as an OpenAPI 'content' schema for this MIME type in a given Response object.
*/
public function to_openapi_schema(Response $response, Endpoint $endpoint): array {
# Format the data schema based on the endpoint for successful responses
if ($response instanceof Success and $endpoint->many) {
# Default to an empty schema in the event we cannot determine the schema
$data_schema = [
'oneOf' => [['type' => 'array', 'items' => ['type' => 'object']], ['type' => 'object']],
];

# Ensure the 'id' field is included for success responses on many models without a parent
if ($response instanceof Success and $endpoint->model->many and !$endpoint->model->parent_model_class) {
$data_schema = [
'type' => 'array',
'items' => ['$ref' => "#/components/schemas/{$endpoint->model->get_class_shortname()}"],
'allOf' => [
['type' => 'object', 'properties' => ['id' => ['type' => $endpoint->model->id_type]]],
['$ref' => "#/components/schemas/{$endpoint->model->get_class_shortname()}"],
],
];
} elseif ($response instanceof Success and !$endpoint->many) {
}
# Ensure the 'parent_id' and 'id' fields are included for success responses on many models with a parent
elseif ($response instanceof Success and $endpoint->model->many and $endpoint->model->parent_model_class) {
$parent_type = $endpoint->model->get_parent_model()->id_type;
$data_schema = [
'allOf' => [
[
'type' => 'object',
'properties' => [
'parent_id' => ['type' => $parent_type],
'id' => ['type' => $endpoint->model->id_type],
],
],
['$ref' => "#/components/schemas/{$endpoint->model->get_class_shortname()}"],
],
];
}
# Do not include any extra fields for non many models
elseif ($response instanceof Success and !$endpoint->model->many) {
$data_schema = ['$ref' => "#/components/schemas/{$endpoint->model->get_class_shortname()}"];
} else {
}

# If this is a many endpoint, nest the data schema in an array
if ($response instanceof Success and $endpoint->many) {
$data_schema = [
'oneOf' => [['type' => 'array', 'items' => ['type' => 'object']], ['type' => 'object']],
'type' => 'array',
'items' => $data_schema,
];
}

Expand Down
4 changes: 2 additions & 2 deletions pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/NetworkInterface.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ class NetworkInterface extends Model {
$this->gateway = new ForeignModelField(
model_name: ['RoutingGateway', 'RoutingGatewayGroup'],
model_field: 'name',
model_query: ['ipprotocol' => 'inet', 'interface' => &$this->id],
model_query: ['ipprotocol' => 'inet'],
allow_null: true,
conditions: ['typev4' => 'static'],
help_text: 'Sets the upstream gateway this interface will use. This is only applicable for WAN-type interfaces.',
Expand Down Expand Up @@ -313,7 +313,7 @@ class NetworkInterface extends Model {
$this->gatewayv6 = new ForeignModelField(
model_name: ['RoutingGateway', 'RoutingGatewayGroup'],
model_field: 'name',
model_query: ['ipprotocol' => 'inet6', 'interface' => &$this->id],
model_query: ['ipprotocol' => 'inet6'],
allow_null: true,
conditions: ['typev6' => 'staticv6'],
help_text: 'Sets the upstream IPv6 gateway this interface will use. This is only applicable for WAN-type interfaces.',
Expand Down
1 change: 1 addition & 0 deletions pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Models/RoutingGatewayGroupPriority.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ class RoutingGatewayGroupPriority extends Model {
$this->parent_model_class = 'RoutingGatewayGroup';
$this->config_path = 'item';
$this->subsystem = 'staticroutes';
$this->update_strategy = 'replace';
$this->many = true;
$this->many_minimum = 1;

Expand Down
24 changes: 22 additions & 2 deletions pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Tests/APICoreContentHandlerTestCase.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,17 @@ class APICoreContentHandlerTestCase extends TestCase {
'data' => [
'type' => 'array',
'items' => [
'$ref' => "#/components/schemas/{$endpoint->model->get_class_shortname()}",
'allOf' => [
[
'type' => 'object',
'properties' => [
'id' => ['type' => $endpoint->model->id_type],
],
],
[
'$ref' => "#/components/schemas/{$endpoint->model->get_class_shortname()}",
],
],
],
],
],
Expand Down Expand Up @@ -165,7 +175,17 @@ class APICoreContentHandlerTestCase extends TestCase {
[
'type' => 'object',
'properties' => [
'data' => ['$ref' => "#/components/schemas/{$endpoint->model->get_class_shortname()}"],
'data' => [
'allOf' => [
[
'type' => 'object',
'properties' => [
'id' => ['type' => $endpoint->model->id_type],
],
],
['$ref' => "#/components/schemas/{$endpoint->model->get_class_shortname()}"],
],
],
],
],
],
Expand Down
7 changes: 7 additions & 0 deletions ...ESTAPI/files/usr/local/pkg/RESTAPI/Tests/APIModelsRoutingGatewayGroupPriorityTestCase.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,13 @@ class APIModelsRoutingGatewayGroupPriorityTestCase extends TestCase {
$gateway_prio->tier->value = 3;
$gateway_prio->update();

# Ensure the priority was actually updated
$this->assert_equals(
RoutingGatewayGroupPriority::query(parent_id: $gateway_group->id, id: $gateway_prio->id)->first()->tier
->value,
3,
);

# Delete the gateway group priority object and ensure it was deleted
$gateway_prio->delete();
$this->assert_equals(RoutingGatewayGroupPriority::read_all(parent_id: $gateway_group->id)->count(), 1);
Expand Down