Skip to content

Docs: cleanup api docs for parser utility #2640

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
am29d opened this issue Jun 13, 2024 · 2 comments · Fixed by #2685
Closed
1 task done

Docs: cleanup api docs for parser utility #2640

am29d opened this issue Jun 13, 2024 · 2 comments · Fixed by #2685
Assignees
@am29d
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation good-first-issue Something that is suitable for those who want to start contributing parser This item relates to the Parser Utility
Milestone
Parser - GA Release

Comments

@am29d
Copy link
Contributor

am29d commented Jun 13, 2024

What were you searching in the docs?

Parser API docs are not up to date and there are missing types, functions and classes.

Is this related to an existing documentation section?

No response

How can we improve?

Add types, decorator, middleware, envelopes and schemas.

Got a suggestion in mind?

No response

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@am29d am29d added documentation Improvements or additions to documentation triage This item has not been triaged by a maintainer, please wait labels Jun 13, 2024
@am29d am29d self-assigned this Jun 13, 2024
@am29d am29d moved this from Triage to Backlog in Powertools for AWS Lambda (TypeScript) Jun 13, 2024
@am29d am29d added this to the Parser - GA Release milestone Jun 13, 2024
@am29d am29d removed their assignment Jun 13, 2024
@am29d am29d added good-first-issue Something that is suitable for those who want to start contributing parser This item relates to the Parser Utility confirmed The scope is clear, ready for implementation and removed triage This item has not been triaged by a maintainer, please wait labels Jun 13, 2024
@am29d am29d self-assigned this Jun 14, 2024
@am29d am29d moved this from Backlog to Working on it in Powertools for AWS Lambda (TypeScript) Jun 14, 2024
@am29d am29d moved this from Working on it to Next iteration in Powertools for AWS Lambda (TypeScript) Jun 20, 2024
@am29d am29d moved this from Next iteration to Working on it in Powertools for AWS Lambda (TypeScript) Jun 20, 2024
@am29d am29d mentioned this issue Jun 21, 2024
Merged
@github-project-automation github-project-automation bot moved this from Working on it to Coming soon in Powertools for AWS Lambda (TypeScript) Jun 26, 2024
@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 Jun 26, 2024
@github-actions GitHub Actions
Copy link
Contributor

This is now released under v2.3.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 Jun 27, 2024
@dreamorosi dreamorosi moved this from Coming soon to Shipped in Powertools for AWS Lambda (TypeScript) Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@am29d am29d

Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation good-first-issue Something that is suitable for those who want to start contributing parser This item relates to the Parser Utility
Projects
Powertools for AWS Lambda (TypeScript)
Status: Shipped
Milestone
Parser - GA Release
Development

Successfully merging a pull request may close this issue.

docs(parser): add api docs aws-powertools/powertools-lambda-typescript
1 participant
@am29d