Skip to content

add KinesisClient documentation for k6-jslib-aws #1980

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

oleiade
Copy link
Contributor

@oleiade oleiade commented Jul 4, 2025

What?

Add comprehensive documentation for KinesisClient including all methods:

  • createStream, deleteStream, listStreams
  • putRecords, getRecords, listShards, getShardIterator
  • Include examples for stream management and record operations
  • Add KinesisClient to AWS services index

Checklist

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the npm start command locally and verified that the changes look good.
  • I have made my changes in the docs/sources/k6/next folder of the documentation.

Related PR(s)/Issue(s)

Add comprehensive documentation for KinesisClient including all methods:
- createStream, deleteStream, listStreams
- putRecords, getRecords, listShards, getShardIterator
- Include examples for stream management and record operations
- Add KinesisClient to AWS services index
@oleiade oleiade requested review from heitortsergent and a team as code owners July 4, 2025 12:00
@oleiade oleiade requested review from inancgumus and AgnesToulet and removed request for a team July 4, 2025 12:00
@CLAassistant
Copy link

CLAassistant commented Jul 4, 2025

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

- Add skip directives to prevent CI from running AWS API calls
- JavaScript examples require valid AWS credentials and resources
- Follows same pattern as other AWS client documentation
@oleiade oleiade requested review from joanlopez and removed request for inancgumus July 8, 2025 07:53
Copy link
Contributor

@joanlopez joanlopez left a comment

Choose a reason for hiding this comment

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

Should we also add these for older versions of k6? 🤔

PS: Note this is kinda related to the open question I left in the other PR for jslib docs.

oleiade and others added 2 commits July 9, 2025 10:39
…stShards.md

Co-authored-by: Joan López de la Franca Beltran <[email protected]>
…stStreams.md

Co-authored-by: Joan López de la Franca Beltran <[email protected]>
Copy link
Collaborator

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

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

Left some suggestions, mostly removing some unnecessary lines. 🤓 I think the main content looks good!

oleiade and others added 3 commits July 11, 2025 15:11
@oleiade
Copy link
Contributor Author

oleiade commented Jul 11, 2025

@joanlopez I gave it a shot, but it feels more like a burden than anything else. If you don't mind, I would like for us to elaborate a more robust solution for jslibs documentation versioning in general first, and keep the PR as-is 🙇🏻

@heitortsergent
Copy link
Collaborator

@oleiade if this applies to latest, I can port those changes over and commit directly here if you don't mind.

@oleiade
Copy link
Contributor Author

oleiade commented Jul 14, 2025

@heitortsergent If you have the mental space for it, that would be very much appreciated 🙏🏻 🙇🏻

@heitortsergent
Copy link
Collaborator

@oleiade I applied the changes to latest. :shipit:

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.

4 participants