Skip to content

Docs: add API Docs & README for Validation utility #3712

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.

Sign up for GitHub

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

Jump to bottom
Closed
1 task done
dreamorosi opened this issue Mar 11, 2025 · 2 comments · Fixed by #3713
Closed
1 task done

Docs: add API Docs & README for Validation utility #3712

dreamorosi opened this issue Mar 11, 2025 · 2 comments · Fixed by #3713
Assignees
@dreamorosi
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation validation This item relates to the Validation Utility
Milestone
Validation utility

Comments

@dreamorosi
Copy link
Contributor

What were you searching in the docs?

We have recently completed the implementation for the upcoming Validation utility, but haven't written any API docs nor README yet.

Is this related to an existing documentation section?

No response

How can we improve?

We should write API docs in each public method/function/type/property, so that customers can have an idea of how to use the utility.

The actual utility docs will be reviewed in a separate issue.

Got a suggestion in mind?

No response

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@dreamorosi dreamorosi added confirmed The scope is clear, ready for implementation documentation Improvements or additions to documentation validation This item relates to the Validation Utility labels Mar 11, 2025
@dreamorosi dreamorosi added this to the Validation utility milestone Mar 11, 2025
@dreamorosi dreamorosi self-assigned this Mar 11, 2025
@dreamorosi dreamorosi moved this from Triage to Working on it in Powertools for AWS Lambda (TypeScript) Mar 11, 2025
@dreamorosi dreamorosi mentioned this issue Mar 11, 2025
Merged
@dreamorosi dreamorosi linked a pull request Mar 11, 2025 that will close this issue
docs(validation): api docs & minor fixes #3713
Merged
@github-project-automation github-project-automation bot moved this from Working on it to Coming soon in Powertools for AWS Lambda (TypeScript) Mar 12, 2025
@github-actions GitHub Actions
Copy link
Contributor

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot added pending-release This item has been merged and will be released soon and removed confirmed The scope is clear, ready for implementation labels Mar 12, 2025
@github-actions GitHub Actions
Copy link
Contributor

This is now released under v2.17.0 version!

@github-actions github-actions bot added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon labels Mar 25, 2025
@dreamorosi dreamorosi moved this from Coming soon to Shipped in Powertools for AWS Lambda (TypeScript) Mar 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dreamorosi dreamorosi

Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation validation This item relates to the Validation Utility
Projects
Powertools for AWS Lambda (TypeScript)
Status: Shipped
Milestone
Validation utility
Development

Successfully merging a pull request may close this issue.

docs(validation): api docs & minor fixes aws-powertools/powertools-lambda-typescript
1 participant
@dreamorosi