Skip to content

Commit ef208ef

Browse files
committed
Updates README for clarity and consistency
Updates the README file to improve readability and ensure consistency in formatting and content. Specifically, this commit: - Changes a level 1 heading to a level 2 heading for better structure. - Adds a comment to the required_body example to clarify its usage.
1 parent 2b9e84a commit ef208ef

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 🫐 Acai AWS
22

3-
**Auto-loading, self-validating, minimalist Python framework for Amazon Web Service Lambdas**
3+
## Auto-loading, self-validating, minimalist Python framework for Amazon Web Service Lambdas
44

55
[![CircleCI](https://circleci.com/gh/syngenta/acai-python.svg?style=shield)](https://circleci.com/gh/syngenta/acai-python)
66
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=syngenta_acai-python&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=syngenta_acai-python)
@@ -112,7 +112,7 @@ from acai_aws.apigateway.requirements import requirements
112112

113113
@requirements(
114114
auth_required=True,
115-
required_body={
115+
required_body={ # can be a dataclass or reference to a schema in openapi.yml
116116
'type': 'object',
117117
'required': ['email', 'name'],
118118
'properties': {

0 commit comments

Comments
 (0)