Skip to content

fix(GraphQL): only mark types as nonNull if they are unconditional #778 #780

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 3 commits into from
Nov 13, 2025
Merged

fix(GraphQL): only mark types as nonNull if they are unconditional #778 #780

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
511e8f2
fix(GraphQL): only mark types as nonNull if they are unconditional #778
jaredhendrickson13 Nov 9, 2025
7856ae9
test(GraphQL): ensure conditionally required fields can always be que…
jaredhendrickson13 Nov 13, 2025
d5e28a3
style: run prettier on changed files
jaredhendrickson13 Nov 13, 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
4 changes: 2 additions & 2 deletions pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Schemas/GraphQLSchema.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,8 @@ class GraphQLSchema extends Schema {
$type = Type::listOf($type);
}

# Make this field non-nullable if it is required
if ($field->required and !$ignore_required) {
# Make this field non-nullable if it is required and unconditional
if ($field->required and !$field->conditions and !$ignore_required) {
$type = Type::nonNull($type);
}

Expand Down
13 changes: 13 additions & 0 deletions pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Tests/APIModelsGraphQLTestCase.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,4 +388,17 @@ class APIModelsGraphQLTestCase extends TestCase {
},
);
}

/**
* Ensure we can query for model fields that are conditionally required. Regression test for #778
*/
public function test_query_conditionally_required_field(): void {
# Query for interfaces including conditionally required fields and ensure no errors are returned.
$graphql = new GraphQL(
query: 'query {queryInterfaces {id ipaddr subnet descr typev4 track6_interface}}',
client: $this->auth,
);
$graphql->create();
$this->assert_is_empty($graphql->result->value['errors'] ?? []);
}
}