Skip to content

docs(api): migrating the data masking utility to mkdocstrings #6013

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

Merged
merged 2 commits into from
Feb 3, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions aws_lambda_powertools/utilities/data_masking/base.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
"""
Base class for Data Masking
!!! abstract "Usage Documentation"
[`Data masking`](../../utilities/data_masking.md)
"""

from __future__ import annotations

import functools
@@ -24,8 +30,9 @@ class DataMasking:
The DataMasking class orchestrates erasing, encrypting, and decrypting
for the base provider.

Example:
```
Example
-------
```python
from aws_lambda_powertools.utilities.data_masking.base import DataMasking

def lambda_handler(event, context):
Original file line number Diff line number Diff line change
@@ -11,9 +11,9 @@ class BaseProvider:
"""
The BaseProvider class serves as an abstract base class for data masking providers.

Examples
Example
--------
```
```python
from aws_lambda_powertools.utilities._data_masking.provider import BaseProvider
from aws_lambda_powertools.utilities.data_masking import DataMasking

Original file line number Diff line number Diff line change
@@ -48,9 +48,9 @@ class AWSEncryptionSDKProvider(BaseProvider):
"""
The AWSEncryptionSDKProvider is used as a provider for the DataMasking class.

Usage
Example
-------
```
```python
from aws_lambda_powertools.utilities.data_masking import DataMasking
from aws_lambda_powertools.utilities.data_masking.providers.kms.aws_encryption_sdk import (
AWSEncryptionSDKProvider,
2 changes: 2 additions & 0 deletions docs/api_doc/data_masking/base.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!-- markdownlint-disable MD043 MD041 -->
::: aws_lambda_powertools.utilities.data_masking.base
2 changes: 2 additions & 0 deletions docs/api_doc/data_masking/exceptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!-- markdownlint-disable MD043 MD041 -->
::: aws_lambda_powertools.utilities.data_masking.exceptions
2 changes: 2 additions & 0 deletions docs/api_doc/data_masking/provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!-- markdownlint-disable MD043 MD041 -->
::: aws_lambda_powertools.utilities.data_masking.provider
8 changes: 6 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -63,14 +63,18 @@ nav:
# - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md
# - Customer to advocate: contributing/tracks/customer_advocate.md
- API Documentation:
- Feature Flags:
- Data Masking:
- Base: api_doc/data_masking/base.md
- Exception: api_doc/data_masking/exceptions.md
- Provider: api_doc/data_masking/provider.md
- Feature Flags:
- AppConfig: api_doc/feature_flags/appconfig.md
- Base: api_doc/feature_flags/base.md
- Comparators: api_doc/feature_flags/comparators.md
- Exceptions: api_doc/feature_flags/exceptions.md
- Feature flags: api_doc/feature_flags/feature_flags.md
- Schema: api_doc/feature_flags/schema.md
- Idempotency:
- Idempotency:
- Base: api_doc/idempotency/base.md
- Config: api_doc/idempotency/config.md
- Exceptions: api_doc/idempotency/exceptions.md