diff --git a/aws_lambda_powertools/utilities/parser/parser.py b/aws_lambda_powertools/utilities/parser/parser.py index 4f6115255a8..446209880fd 100644 --- a/aws_lambda_powertools/utilities/parser/parser.py +++ b/aws_lambda_powertools/utilities/parser/parser.py @@ -1,3 +1,10 @@ +""" +The Parser utility simplifies data parsing and validation using Pydantic. It allows you to define data models +in pure Python classes, parse and validate incoming events, and extract only the data you need. +!!! abstract "Usage Documentation" + [`Parser`](../utilities/parser.md) +""" + from __future__ import annotations import logging diff --git a/docs/api_doc/parser.md b/docs/api_doc/parser.md new file mode 100644 index 00000000000..be52cde0b7d --- /dev/null +++ b/docs/api_doc/parser.md @@ -0,0 +1,2 @@ + +::: aws_lambda_powertools.utilities.parser.parser diff --git a/mkdocs.yml b/mkdocs.yml index e16ffe33008..a83aad098a6 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: + - Parser: api_doc/parser.md - Streaming: api_doc/streaming.md - Typing: api_doc/typing.md - Validation: api_doc/validation.md