File tree 4 files changed +14
-11
lines changed
aws_lambda_powertools/utilities/validation
4 files changed +14
-11
lines changed Original file line number Diff line number Diff line change 1
1
"""
2
2
Simple validator to enforce incoming/outgoing event conforms with JSON Schema
3
+ !!! abstract "Usage Documentation"
4
+ [`Validation`](../utilities/validation.md)
3
5
"""
4
6
5
7
from .exceptions import (
Original file line number Diff line number Diff line change @@ -19,7 +19,7 @@ def __init__(
19
19
rule : str | None = None ,
20
20
rule_definition : Any | None = None ,
21
21
):
22
- """
22
+ """When serialization fail schema validation
23
23
24
24
Parameters
25
25
----------
Original file line number Diff line number Diff line change
1
+ <!-- markdownlint-disable MD043 MD041 -->
2
+ ::: aws_lambda_powertools.utilities.validation
Original file line number Diff line number Diff line change 62
62
# - Overview: contributing/tracks/overview.md
63
63
# - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md
64
64
# - Customer to advocate: contributing/tracks/customer_advocate.md
65
+ - API Documentation :
66
+ - Validation : api_doc/validation.md
65
67
66
68
theme :
67
69
name : material
@@ -144,22 +146,19 @@ plugins:
144
146
import :
145
147
- https://docs.python.org/3/objects.inv
146
148
options :
147
- # General
148
- allow_inspection : true
149
- show_source : true
150
- show_bases : true
151
149
# Headings
152
- heading_level : 2
153
- # show_root_heading: false
150
+ # heading_level: 2
151
+ # show_root_heading: true
154
152
# show_root_toc_entry: true
155
153
# show_root_full_path: true
156
154
# show_root_members_full_path: false
157
155
# show_object_full_path: false
158
- # show_category_heading: true
156
+ show_category_heading : false
159
157
# Members
160
- filters : ["!^_[^_] "]
158
+ filters : ["!^_"]
161
159
group_by_category : true
162
- show_submodules : false
160
+ members_order : alphabetical
161
+ show_submodules : true
163
162
# Docstrings
164
163
docstring_style : numpy
165
164
docstring_options :
@@ -168,10 +167,10 @@ plugins:
168
167
merge_init_into_class : true
169
168
show_if_no_docstring : false
170
169
# Signature
171
- annotations_path : brief
172
170
show_signature : true
173
171
show_signature_annotations : true
174
172
separate_signature : true
173
+ summary : true
175
174
176
175
extra_css :
177
176
- stylesheets/extra.css
You can’t perform that action at this time.
0 commit comments