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

[DOCS]: Enhance Swagger Docs with Auth & Examples for Waitlist & Newsletter Endpoints #1333

Open
wants to merge 10 commits into
base: dev
Choose a base branch
from

Conversation

na-cho-dev
Copy link

@na-cho-dev na-cho-dev commented Mar 1, 2025

Pull Request

Description

The Swagger documentation for the waitlist module does not include proper authorization details for the createWaitlistDocs function. Additionally, provide better docs response for both waitlist and newsletter subscription module.

Related Issue

Fixes #1325

Type of Change

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation updates
  • style: Code style/formatting changes
  • refactor: Code refactoring
  • perf: Performance improvements
  • test: Test additions/updates
  • chore: Build process or tooling changes
  • ci: CI configuration changes
  • other:

How Has This Been Tested?

  • Unit tests
  • Integration tests
  • Manual tests

Test Evidence

Screenshots (if applicable)

Documentation Screenshots (if applicable)

Checklist

  • My code follows the project's coding style
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published
  • I have included a screenshot showing all tests passing
  • I have included documentation screenshots (if applicable)

Additional Notes

@na-cho-dev na-cho-dev reopened this Mar 2, 2025
@na-cho-dev na-cho-dev changed the title [docs]: Enhance Swagger docs with auth and examples for Waitlist endpoint [DOCS]: Enhance Swagger Docs with Auth and Examples for Waitlist and Newsletter Subscription Endpoint Mar 2, 2025
Copy link
Contributor

@TheCodeGhinux TheCodeGhinux left a comment

Choose a reason for hiding this comment

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

Check the comments

@na-cho-dev na-cho-dev reopened this Mar 2, 2025
@na-cho-dev na-cho-dev changed the title [DOCS]: Enhance Swagger Docs with Auth and Examples for Waitlist and Newsletter Subscription Endpoint [DOCS]: Enhance Swagger Docs with Auth & Examples for Waitlist & Newsletter Endpoints Mar 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants