Skip to content
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

docs(parser): highlight JSONStringify helper #3158

Merged
merged 2 commits into from
Oct 4, 2024
Merged

Conversation

dreamorosi
Copy link
Contributor

Summary

Changes

Please provide a summary of what's being changed

This PR updates the docs for the Parser utility to better highlight the JSONStrinfied helper we added a few releases ago. Based on customers opening issues to ask for the same functionality, I assume it's hard to discover in the docs.

The PR breaks down the utility into its own section giving it a header in the navbar (see image below) and also adds the file to the API docs (this was a mistake on our side).

Screenshot 2024-10-04 at 15 34 35

The PR also slightly updates the API docs description and adds a code sample for API Gateway, since it's arguably the most common case where customers might want to use this.

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: closes #3154


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi self-assigned this Oct 4, 2024
@dreamorosi dreamorosi requested review from a team as code owners October 4, 2024 14:03
@boring-cyborg boring-cyborg bot added documentation Improvements or additions to documentation parser This item relates to the Parser Utility labels Oct 4, 2024
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label Oct 4, 2024
Copy link

sonarqubecloud bot commented Oct 4, 2024

@dreamorosi dreamorosi merged commit 0c44517 into main Oct 4, 2024
21 checks passed
@dreamorosi dreamorosi deleted the docs/parser_helper branch October 4, 2024 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation parser This item relates to the Parser Utility size/L PRs between 100-499 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature request: Enhance Parser Utility with JSON String Handling
2 participants