docs(api): migrating the jmespath utility to mkdocstrings (#6006)

Mkdocstrings - JMESPath module

Author: leandrodamascena

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**

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

docs/api_doc/jmespath_functions.md

@@ -0,0 +1,2 @@
+<!-- markdownlint-disable MD043 MD041 -->
+::: aws_lambda_powertools.utilities.jmespath_utils

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