Skip to content
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

Tdr 3490 update readme #54

Merged
merged 4 commits into from
Nov 1, 2023
Merged

Tdr 3490 update readme #54

merged 4 commits into from
Nov 1, 2023

Conversation

TomJKing
Copy link
Contributor

No description provided.

Copy link
Contributor

@vimleshtna vimleshtna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just a minor comment. Thanks

README.md Outdated
@@ -24,6 +24,14 @@ A 500 response body will be returned if any issues occur when calling the Lambda
* numberofrefs parameter isn't an int
* any dynamodb Exceptions (key not found, unable to update, etc)

The number of references that can be returned in a single call is limited, because:
* prevent a single call using up all possible reference;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A minor rewording here, change from all possible reference to all possible references

README.md Outdated

Calling clients will need to handle this limit by making multiple calls to retrieve the required number of references if it is greater than the limit.

The limit is store here for use by calling clients: [reference_generator_limit](https://github.com/nationalarchives/da-terraform-configurations/blob/main/tdr/main.tf)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A minor rewording here, change from The limit is store here to The limit is stored here

@TomJKing TomJKing requested a review from vimleshtna November 1, 2023 06:36
Copy link
Contributor

@vimleshtna vimleshtna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thanks

@TomJKing TomJKing merged commit 47b0686 into main Nov 1, 2023
4 checks passed
@TomJKing TomJKing deleted the TDR-3490-update-README branch November 1, 2023 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants