restconf: Add simple "fields" query parameter support (RFC 8040 Sec 4.8.3)#656
Open
dima1308 wants to merge 1 commit intoclicon:masterfrom
Open
restconf: Add simple "fields" query parameter support (RFC 8040 Sec 4.8.3)#656dima1308 wants to merge 1 commit intoclicon:masterfrom
dima1308 wants to merge 1 commit intoclicon:masterfrom
Conversation
….8.3) Implement top-level module filtering for GET /restconf/data via the "fields" query parameter as specified in RFC 8040 Section 4.8.3. This simple implementation supports selecting root-level data nodes by module name and node name at the datastore root, separated by semicolons. For example: GET /restconf/data?fields=ietf-interfaces:interfaces%3Bietf-system:system The filter is applied as a post-processing step on the XML tree returned by the backend, removing children that do not match any entry in the fields list. It only takes effect when the request targets the data root (i.e. no api-path is given). Changes: - apps/restconf/restconf_methods_get.c: Add restconf_fields_filter() helper and wire up "fields" query parameter parsing in api_data_get2() - apps/backend/backend_state.c: Advertise urn:ietf:params:restconf:capability:fields:1.0 capability - test/test_restconf_jukebox.sh: Implement RFC 8040 B.3.3 "fields" parameter tests (was previously commented out) - test/test_yang_with_defaults.sh: Update capability assertions to include the new fields:1.0 capability
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implement top-level module filtering for GET /restconf/data via the "fields" query parameter as specified in RFC 8040 Section 4.8.3.
This simple implementation supports selecting root-level data nodes by module name and node name at the datastore root, separated by semicolons. For example:
The filter is applied as a post-processing step on the XML tree returned by the backend, removing children that do not match any entry in the fields list. It only takes effect when the request targets the data root (i.e. no api-path is given).