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

fix(api-service): Nv 5379 refinements needed for sdks and api documentation #7835

Merged

Conversation

tatarco
Copy link
Contributor

@tatarco tatarco commented Mar 3, 2025

What changed? Why was the change needed?

the following represent the code portion in novu

  • Ask Mintlify why the order of endpoints groups (tags) is different than the source OpenAPI spec by Speakeasy.

  • Massage Swagger in Novu API to place all V2 endpoints above V1.
    Done Here

  • Fix cancel trigger response on the SDK
    Done Here

  • Refine autogenerated SDK repositories to have Novu description, tags, and updated README.md.

  • Set description, website, author, license, bugs, fundingInfo to package.json of @novu/api

  • Add the same branded header to all README files across all packages.

  • Deprecate @novu/node using npm deprecate. Update readme https://www.npmjs.com/package/@novu/node to point to @novu/api

  • [ ]Update the docs to point to the new SDKs https://docs.novu.co/platform/sdks/server. ||| Nothing to be done, already done by emil

Screenshots

Expand for optional sections

Related enterprise PR

Special notes for your reviewer

Copy link

linear bot commented Mar 3, 2025

Copy link

netlify bot commented Mar 3, 2025

Deploy Preview for dev-web-novu ready!

Name Link
🔨 Latest commit 49c5699
🔍 Latest deploy log https://app.netlify.com/sites/dev-web-novu/deploys/67c5b38b03d7300008ebac02
😎 Deploy Preview https://deploy-preview-7835.dashboard.novu-staging.co
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Mar 3, 2025

Deploy Preview for dashboard-v2-novu-staging ready!

Name Link
🔨 Latest commit efa70c5
🔍 Latest deploy log https://app.netlify.com/sites/dashboard-v2-novu-staging/deploys/67cff249a5702600080a0fec
😎 Deploy Preview https://deploy-preview-7835.dashboard-v2.novu-staging.co
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@tatarco tatarco changed the title Nv 5379 refinements needed for sdks and api documentation fix(api-service): Nv 5379 refinements needed for sdks and api documentation Mar 3, 2025
@tatarco tatarco force-pushed the nv-5379-refinements-needed-for-sdks-and-api-documentation branch from 49c5699 to 42fd2de Compare March 10, 2025 14:09
@tatarco tatarco merged commit c0c4057 into next Mar 11, 2025
25 of 26 checks passed
@tatarco tatarco deleted the nv-5379-refinements-needed-for-sdks-and-api-documentation branch March 11, 2025 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants