Skip to content

[JsonPath] Add documentation #21078

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

Jump to bottom
Merged
merged 1 commit into from
Jun 16, 2025
Merged

[JsonPath] Add documentation #21078

merged 1 commit into from
Jun 16, 2025
+246 −0

Conversation

vinceAmstoutz
Copy link
Contributor

@vinceAmstoutz vinceAmstoutz commented Jun 12, 2025 •
edited
Loading

Fixes #20977 by replacing the work started in PR #20974 by @RisingSunLight42

@vinceAmstoutz vinceAmstoutz force-pushed the docs/json-path/initiate-documentation-for-the-component branch 2 times, most recently from 828b6d1 to 4825f3d Compare June 13, 2025 08:32
alexandre-daubois
alexandre-daubois reviewed Jun 13, 2025
View reviewed changes
Copy link
Member

@alexandre-daubois alexandre-daubois left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quick first review, thank you for taking this over!

@vinceAmstoutz vinceAmstoutz force-pushed the docs/json-path/initiate-documentation-for-the-component branch from 4825f3d to b247407 Compare June 13, 2025 09:54
@vinceAmstoutz vinceAmstoutz marked this pull request as ready for review June 13, 2025 09:55
alamirault
alamirault reviewed Jun 15, 2025
View reviewed changes
components/json_path.rst
->key('book') // Then the 'book' key
->index(1); // Then the item at index 1 (the second book)

// The created $path object is equivalent to the string '$["store"]["book"][1]'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, however the only syntax we explained above is $.store.book[1]. We should maybe show this alternative first ? Maybe ~L94

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggested something, is that all right with you?

@alamirault alamirault mentioned this pull request Jun 15, 2025
Merged
alamirault
alamirault reviewed Jun 15, 2025
View reviewed changes
@OskarStark OskarStark closed this Jun 16, 2025
@OskarStark OskarStark reopened this Jun 16, 2025
@vinceAmstoutz vinceAmstoutz force-pushed the docs/json-path/initiate-documentation-for-the-component branch from b247407 to d4056c3 Compare June 16, 2025 09:26
alexandre-daubois
alexandre-daubois reviewed Jun 16, 2025
View reviewed changes
alexandre-daubois
alexandre-daubois reviewed Jun 16, 2025
View reviewed changes
@vinceAmstoutz vinceAmstoutz force-pushed the docs/json-path/initiate-documentation-for-the-component branch from d4056c3 to abc2df6 Compare June 16, 2025 11:08
@OskarStark OskarStark added this to the 7.3 milestone Jun 16, 2025
@OskarStark
Copy link
Contributor

Thanks @vinceAmstoutz for working on this feature, this is much appreciated.

@OskarStark OskarStark merged commit baaf33e into symfony:7.3 Jun 16, 2025
3 checks passed
@vinceAmstoutz vinceAmstoutz deleted the docs/json-path/initiate-documentation-for-the-component branch June 16, 2025 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@OskarStark OskarStark OskarStark approved these changes

@alexandre-daubois alexandre-daubois alexandre-daubois approved these changes

@alamirault alamirault Awaiting requested review from alamirault

Assignees
No one assigned
Labels
JsonPath Status: Reviewed
Projects
None yet
Milestone
7.3
Development

Successfully merging this pull request may close these issues.

[JsonPath] Add JsonPathAssertionsTrait and related constraints
5 participants
@vinceAmstoutz @OskarStark @alexandre-daubois @alamirault @carsonbot