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

chore(api-docs): enable allow_reuse to fix the docs #612

Merged
merged 2 commits into from Aug 19, 2021

Conversation

michaelbrewer
Copy link
Contributor

@michaelbrewer michaelbrewer commented Aug 15, 2021

Issue #, if available:

Description of changes:

Set allow_reuse=True for all of the pydantic validators, so the docs can render.

Checklist

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 15, 2021
@codecov-commenter
Copy link

codecov-commenter commented Aug 15, 2021

Codecov Report

Merging #612 (125b9c7) into develop (61e7f2d) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #612   +/-   ##
========================================
  Coverage    99.95%   99.95%           
========================================
  Files          114      114           
  Lines         4581     4581           
  Branches       249      249           
========================================
  Hits          4579     4579           
  Partials         2        2           
Impacted Files Coverage Δ
...lambda_powertools/utilities/parser/models/apigw.py 100.00% <100.00%> (ø)
...a_powertools/utilities/parser/models/cloudwatch.py 100.00% <100.00%> (ø)
...mbda_powertools/utilities/parser/models/kinesis.py 100.00% <100.00%> (ø)
...s_lambda_powertools/utilities/parser/models/sns.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 61e7f2d...125b9c7. Read the comment docs.

@heitorlessa
Copy link
Contributor

Just hit the issue - it happens only when I open utilities.

@heitorlessa heitorlessa added the internal Maintenance changes label Aug 19, 2021
@heitorlessa heitorlessa added this to the 1.20.0 milestone Aug 19, 2021
@heitorlessa heitorlessa changed the title fix(docs): enable allow_reuse to fix the docs chore(api-docs): enable allow_reuse to fix the docs Aug 19, 2021
@heitorlessa
Copy link
Contributor

turns out it's due to the import system as Pydantic somehow believes it's a duplicate. Let's keep as is, if it happens again then we take time to investigate down the stack.

@heitorlessa heitorlessa merged commit 4745070 into aws-powertools:develop Aug 19, 2021
@michaelbrewer michaelbrewer deleted the fix-api-docs-parser branch August 19, 2021 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Maintenance changes size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants