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

Add SWAG documentation site for API. #91

Open
1 of 2 tasks
mattrltrent opened this issue Jul 4, 2023 · 2 comments
Open
1 of 2 tasks

Add SWAG documentation site for API. #91

mattrltrent opened this issue Jul 4, 2023 · 2 comments
Labels
deferred feature feature to be deferred after beta docs Improvements or additions to documentation help wanted Extra attention is needed to continue something that needs to be modified to work properly

Comments

@mattrltrent
Copy link
Member

mattrltrent commented Jul 4, 2023 •
edited
Loading

Would look something like this.

  • creating site template
  • adding all endpoints
@mattrltrent mattrltrent added the docs Improvements or additions to documentation label Jul 4, 2023
@mattrltrent mattrltrent added the deferred feature feature to be deferred after beta label Jul 10, 2023
@TalentedB TalentedB self-assigned this Jul 16, 2023
@TalentedB
Copy link
Contributor

TalentedB commented Jul 19, 2023 •
edited
Loading

END POINTS COMPLETED IN SWAGGER

  • Admin
  • Feedback by ID
  • Get Ran Cron Jobs
  • List Feedback
  • Manually Trigger Clear Expired FCM Tokens
  • Manually Trigger Dailly Hottest Cron
  • User Standing
  • Posts
  • Create
  • Get Hottest
  • Get Post By ID
  • Get Posts
  • Get Your Posts
  • Hide
  • Purge Cache
  • Sentiment Anaylsis
  • Auth
  • Register
  • Comments
  • Create
  • Get Comment By ID
  • Get your comments
  • Hide
  • Load Initial Comments
  • Load Reply Comments
  • Purge Cache
  • Feedback
  • Create
  • Notifications
  • Add Token
  • Get Topic Prefs
  • Remove Token
  • Set Topic Prefs
  • Saves
  • Get Saved Comments
  • Get Saved Posts
  • Save
  • Unsave
  • Schools
  • Get Ranked
  • Get Schools Test
  • Get Schools
  • Get Watched Schools
  • Purge Ranked Cache
  • Unwatch School
  • Watch School
  • User
  • Get User
  • Votes
  • Vote

@TalentedB TalentedB added the help wanted Extra attention is needed label Aug 2, 2023
@TalentedB
Copy link
Contributor

With so many endpoints already existing and being added, this job requires assistance.

@TalentedB TalentedB added the to continue something that needs to be modified to work properly label Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
deferred feature feature to be deferred after beta docs Improvements or additions to documentation help wanted Extra attention is needed to continue something that needs to be modified to work properly
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mattrltrent @TalentedB