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

association request & response format TBD #7

Open
SamNormcoreWayne opened this issue Sep 23, 2019 · 1 comment
Open

association request & response format TBD #7

SamNormcoreWayne opened this issue Sep 23, 2019 · 1 comment
Assignees
Labels
API documentation Improvements or additions to documentation

Comments

@SamNormcoreWayne
Copy link
Collaborator

/**
 * @typedef CategoryRequest
 * @property {{zzhan26@test.com}} username - username (zzhan26)
 * @property {{Stevens}} faculty - faculty (Stevens)
 * @property {{}} timerange - timerange (TBD)
 */

/**
 * @typedef CategoryResponse
 * @property {{zzhan26@test.com}} username - username (zzhan26)
 * @property {{Stevens}} faculty - faculty (Stevens)
 * @property {{courses}} courseList - courseList ()
 */

/**
 * @route GET /association/associate_category
 * @group association - Category
 * @param {timerange}
 * @returns {CategoryResponse.model}
 * @returns {ErrorResponse.model}
 */

https://github.com/CCorrado/Cooper2.0/blob/feature/backend_create_usr/backend/routes/users/association/associate_category.js

require for some suggestions

And sorry guys I cannot help to code this part.
for my current branch, I will finish creatre_user, get_user, login_user and associate_category and then make a PR.
Sorry, but I always forgot to make PR. And, I do not want master like a mess so I will finish those ASAP and make a PR.

@SamNormcoreWayne SamNormcoreWayne added documentation Improvements or additions to documentation API labels Sep 23, 2019
@SamNormcoreWayne SamNormcoreWayne self-assigned this Sep 23, 2019
@SamNormcoreWayne SamNormcoreWayne added this to the Sprint 1 milestone Sep 23, 2019
@CCorrado CCorrado modified the milestones: Sprint 1, Sprint 2 Oct 3, 2019
@CCorrado CCorrado modified the milestones: Sprint 2, Sprint 3 Oct 17, 2019
@SamNormcoreWayne
Copy link
Collaborator Author

SamNormcoreWayne commented Oct 23, 2019

/**
 * @typedef CatalogueRequest
 * @property {{zzhan26@test.com}} username - username (zzhan26)
 * @property {{Stevens}} faculty - faculty (Stevens)
 * @property {{}} timerange - timerange (TBD)
 */

/**
 * @typedef CatalogueResponse
 * @property {{zzhan26@test.com}} username - username (zzhan26)
 * @property {{Stevens}} faculty - faculty (Stevens)
 * @property {{courses}} courseList - courseList ()
 */

/**
 * @route GET /association/associate_catalogue
 * @group association - catalogue
 * @param {timerange}
 * @returns {CategoryResponse.model}
 * @returns {ErrorResponse.model}
 */

I found a not-so-proper expression that in our document the "category" is supposed to be catalogue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants