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.

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

chore: add TSDocs to the API Key Module #6785

Merged
merged 3 commits into from
Mar 22, 2024
Merged

chore: add TSDocs to the API Key Module #6785

merged 3 commits into from
Mar 22, 2024

Conversation

shahednasser
Copy link
Member

Add TSDocs to the API Key Module's resources

@shahednasser shahednasser requested a review from a team as a code owner March 22, 2024 08:10
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Mar 22, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: a2b0324

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel Vercel
Copy link

vercel bot commented Mar 22, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
medusa-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 22, 2024 11:34am
3 Ignored Deployments
Name Status Preview Comments Updated (UTC)
api-reference ⬜️ Ignored (Inspect) Mar 22, 2024 11:34am
docs-ui ⬜️ Ignored (Inspect) Visit Preview Mar 22, 2024 11:34am
medusa-docs ⬜️ Ignored (Inspect) Visit Preview Mar 22, 2024 11:34am

sradevski
sradevski approved these changes Mar 22, 2024
View reviewed changes
packages/types/src/api-key/common/api-key.ts Outdated
created_at: Date

/**
* Who revoked the API key.
Copy link
Member

Choose a reason for hiding this comment

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

NIT: I think it's nice to specify what exactly this points to (eg. "the ID of the user that revoked the API key")

Copy link
Member Author

Choose a reason for hiding this comment

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

I was thinking of that too, but also felt like it's somewhat limiting. i.e. if someone is using the module on their own, they can use something other than user ID such as email. However, it makes sense to add an example so I'll do that 👍🏻

packages/types/src/api-key/mutations/api-key.ts Outdated

/**
* The type of the API key. It's only
* usable and required when creating an API key.
Copy link
Member

Choose a reason for hiding this comment

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

Can we rephrase this to Required only when creating an API key? I think the usable part is implied

@kodiakhq kodiakhq bot merged commit bb3cace into develop Mar 22, 2024
24 checks passed
@kodiakhq kodiakhq bot deleted the tsdoc/api-key-add-tsdocs branch March 22, 2024 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sradevski sradevski sradevski approved these changes

@adrien2p adrien2p Awaiting requested review from adrien2p adrien2p is a code owner automatically assigned from medusajs/engineering

@kasperkristensen kasperkristensen Awaiting requested review from kasperkristensen kasperkristensen is a code owner automatically assigned from medusajs/engineering

Assignees
No one assigned
Labels
automerge team: medusa
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@shahednasser @sradevski @riqwan