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: added link for api reference #3233

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Tony133
Copy link
Contributor

@Tony133 Tony133 commented Mar 16, 2025

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Docs
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Proposal:

  • Added link for api reference

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

I opened the PR in draft so we can calmly consider how to proceed.

To date only these packages that do not have @publicapi:

  • @nestjs/elastisearch
  • @nestjs/sequelize
  • @nestjs/typeorm
  • @nestjs/mongoose
  • @nestjs/serve-static
  • @nestjs/axios
  • @nestjs/schedule
  • @nestjs/passport
  • @nestjs/bull
  • @nestjs/event-emitter
  • @nestjs/jwt

These are all wrapper packages, not sure if we should add these as well? 🤔

@kamilmysliwiec
Copy link
Member

These are all wrapper packages, not sure if we should add these as well? 🤔

I'd say typeorm, mongoose, bull, bullmq, jwt, passport at the very least. Everything else can be done at a later time

@Tony133
Copy link
Contributor Author

Tony133 commented Mar 19, 2025

I'd say typeorm, mongoose, bull, bullmq, jwt, passport at the very least. Everything else can be done at a later time

ok 😉 👍, as soon as I can I will prepare the PRs by adding the @publicApi tag in the other packages. I have sent you an invitation to access the repository for Api Docs of NestJS, both Livio and I would be very happy if you would accept the invitation 🙂

@kamilmysliwiec
Copy link
Member

Just accepted the invite @Tony133

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.

2 participants