Skip to content

Closes #252 - Add related Rule Queries to AccessListType #262

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.

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

Conversation

pheus
Copy link
Contributor

@pheus pheus commented May 17, 2025

Pull Request

Related Issue

Fixes: #252 [Feature] Allow Query for Related Rules of an AccessList in GraphQL

New Behavior

  • Enhances the GraphQL schema by introducing aclstandardrules and aclextendedrules as related fields to AccessListType.
  • Enables querying Standard and Extended ACL Rules directly from an AccessList object.

Contrast to Current Behavior

  • Previously, the GraphQL API did not expose any related rule sets for an AccessList.
  • With this change, related rules can be retrieved in a single GraphQL query, improving data accessibility and developer experience.

Discussion: Benefits and Drawbacks

Benefits:

  • Supports automation workflows that depend on a complete view of ACL configurations.
  • Reduces the need for multiple queries or relying solely on the REST API.
  • Aligns GraphQL capabilities with the existing REST functionality.

Drawbacks:

  • Minimal risk of GraphQL schema complexity, but mitigated by consistent design and naming.

Yes, the change is fully backwards-compatible.

Changes to the Documentation

  • No documentation changes required.
  • GraphQL schema will self-document via introspection.

Proposed Release Note Entry

  • Enhanced GraphQL schema to include related ACL rules (aclstandardrules and aclextendedrules) under AccessListType.

Double Check

  • I have explained my PR according to the information in the comments
    or in a linked issue.
  • My PR targets the dev branch.

Extends the GraphQL schema by adding `aclstandardrules` and
`aclextendedrules` as related fields to `AccessListType`. This enables
retrieving associated Standard and Extended Rules in a single query.
@pheus pheus changed the title feat(graphql): Add related rule queries to AccessListType Closes #252 - Add related Rule Queries to AccessListType May 17, 2025
@cruse1977 cruse1977 merged commit 3d34180 into netbox-community:dev May 19, 2025
6 checks passed
@pheus pheus deleted the feature/252-allow-query-for-related-rules-in-graphql branch May 20, 2025 04:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: Allow Query for Related Rules of an AccessList in GraphQL
2 participants