Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.2k
[JsonPath] Add documentation#20974
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:7.3
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Overall, remember this is a documentation page about the component, but not the syntax itself. Remember to not write a whole tutorial on the syntax itself. 🙂 At least, that's what I could do. Ping @symfony/docs to confirm?
| Tests | ||
| ~~~~~~~~~~~~~~~~~~ | ||
| (show tests examples) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Here you can talk about the newly merged PR:#20977
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Awesome PR! Will be very useful, thanks
| Vestibulum id velit turpis. Sed vitae nisl placerat, rutrum ex nec, porta ante. | ||
| Maecenas condimentum cursus risus at fringilla. | ||
| Ready-to-use functions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
You may first introduce basic queries, then talk about built-in functions in the advanced usages part.
| The Symfony JsonPath component parses JSON strings to retrieve specifics values. | ||
| `JSON`_, *JavaScript Object Notation*, is a lightweight data-interchange format. | ||
| It is easy for humans to read and write. JSON is a widely used format in REST API and data manipulation. | ||
| .. tip:: | ||
| Learn more about `JSONPath`_ specifications. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I'm not sure you need to explain what JSON is, but rather explain what Json Path is, that it is defined in RFC9535, etc. It can be short and use the same description as the package itself (seehttps://packagist.org/packages/symfony/json-path).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Noted, it was a part I wasn't sure about, I'll update it
Hello!
This is the rough sketch of the structure of the documentation I plan to write? I will replace the lorem ipsum of the Why part during the week-end, for the rest, I'm open to suggestions on how to do since it's my first contribution of this size.
Thanks in advance for the time taken and your suggestions.
Willfix#20837