symfony-docs icon indicating copy to clipboard operation
symfony-docs copied to clipboard

[JsonPath] Add the component

Open fabpot opened this issue 9 months ago • 10 comments

Q A
Feature PR symfony/symfony#59655
PR author(s) @alexandre-daubois
Merged in 7.3

We created this issue to not forget to document this new feature. We would really appreciate if you can help us with this task. If you are not sure how to do it, please ask us and we will help you.

To fix this issue, please create a PR against the 7.3 branch in the symfony-docs repository.

Thank you! :smiley:

fabpot avatar Mar 28 '25 12:03 fabpot

I just leaned about the component at Symfony Live, I'm going to look into it and if I feel confident enough I'll try to do the doc 😊 Would be my first contribution!

RisingSunLight42 avatar Mar 28 '25 15:03 RisingSunLight42

Thank you for your interest on this @RisingSunLight42. Feel free to ping me on the Symfony Slack if you need any information/support, I'll be happy to help 🙂

alexandre-daubois avatar Mar 28 '25 18:03 alexandre-daubois

Hello @RisingSunLight42, did you have time to check this issue? The component will be officially released at the end of May with Symfony 7.3, it would be nice to have the documentation ready (or almost ready) in the next few weeks 🙂

alexandre-daubois avatar Apr 14 '25 08:04 alexandre-daubois

Hi @alexandre-daubois! I started looking into it, as a warmup into writing doc for Symfony I was taking less time consuming issues before, but I'll work on it during the next weeks. I'll also open a draft PR so everyone can see how it's going.

RisingSunLight42 avatar Apr 14 '25 09:04 RisingSunLight42

Great news, thank you!

alexandre-daubois avatar Apr 14 '25 09:04 alexandre-daubois

This should also cover the first and last methods introduced by symfony/symfony#60188.

GromNaN avatar Apr 16 '25 07:04 GromNaN

This should also cover the first and last methods introduced by symfony/symfony#60188.

Noted, thank you!

RisingSunLight42 avatar Apr 16 '25 18:04 RisingSunLight42

Hi @RisingSunLight42, Symfony 7.3 is just around the corner as well as the first release of the component. Did you have time to start the work? 🙂 If you don't, please tell me if I can take over. Thanks!

alexandre-daubois avatar May 14 '25 08:05 alexandre-daubois

Hi @RisingSunLight42, Symfony 7.3 is just around the corner as well as the first release of the component. Did you have time to start the work? 🙂 If you don't, please tell me if I can take over. Thanks!

I started a rough thinking of it (nothing written, just plan and how organizing everything). I plan on opening a draft PR in the next days (probably today or tomorrow) with the basic structure and wording. I'm fine with you taking over if you want, I got unexpectedly busy the last weeks so everything did not flow as I planned 😕.

For the plan, I was planning to do something similar to the YAML Component doc, obviously with adaptations for the JsonPath component. So something to explain why using it instead of json_decode for example, then the basic uses (mostly what was detailed in the PR) and the a more in-depth explanation method by method.

RisingSunLight42 avatar May 14 '25 09:05 RisingSunLight42

If you have a draft PR, let's not lose your work and iterate on it. Docs core team and contributors will be able to give you feedback and get this to the finish line 👍

alexandre-daubois avatar May 14 '25 09:05 alexandre-daubois

Can be closed due to #21078?

mttsch avatar Jul 01 '25 18:07 mttsch