diff --git a/aws_lambda_powertools/utilities/jmespath_utils/__init__.py b/aws_lambda_powertools/utilities/jmespath_utils/__init__.py index 1bdff7a12ce..231fb732c83 100644 --- a/aws_lambda_powertools/utilities/jmespath_utils/__init__.py +++ b/aws_lambda_powertools/utilities/jmespath_utils/__init__.py @@ -1,3 +1,8 @@ +""" +Built-in JMESPath Functions to easily deserialize common encoded JSON payloads in Lambda functions. +!!! abstract "Usage Documentation" + [`JMESPath Functions`](../utilities/jmespath_functions.md) +""" from __future__ import annotations import base64 @@ -42,7 +47,7 @@ def query(data: dict | str, envelope: str, jmespath_options: dict | None = None) Built-in JMESPath functions include: powertools_json, powertools_base64, powertools_base64_gzip - Examples + Example -------- **Deserialize JSON string and extracts data from body key** diff --git a/aws_lambda_powertools/utilities/parameters/base.py b/aws_lambda_powertools/utilities/parameters/base.py index 897cd4ace57..b92bfa19cb2 100644 --- a/aws_lambda_powertools/utilities/parameters/base.py +++ b/aws_lambda_powertools/utilities/parameters/base.py @@ -1,5 +1,7 @@ """ Base for Parameter providers +!!! abstract "Usage Documentation" + [`Parameters`](../utilities/parameters.md) """ from __future__ import annotations diff --git a/docs/api_doc/jmespath_functions.md b/docs/api_doc/jmespath_functions.md new file mode 100644 index 00000000000..c4e539faf13 --- /dev/null +++ b/docs/api_doc/jmespath_functions.md @@ -0,0 +1,2 @@ + +::: aws_lambda_powertools.utilities.jmespath_utils diff --git a/mkdocs.yml b/mkdocs.yml index 096173e5354..97fd2b8f04a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -63,6 +63,7 @@ nav: # - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md # - Customer to advocate: contributing/tracks/customer_advocate.md - API Documentation: + - JMESPath Functions: api_doc/jmespath_functions.md - Parameters: - Base: api_doc/parameters/base.md - AppConfig: api_doc/parameters/appconfig.md