#37405551-docs(): Api design documentation

BuildForSDG / voxnostra

Making the fight against corruption which slows down the development of Cameroon a shared responsibility between a government and its citizens

MIT License

0 stars 3 forks source link

#37405551-docs(): Api design documentation #19

Closed tanerochris closed 4 years ago

tanerochris commented 4 years ago

Description

OpenAPI 3.0 design Yaml and JSON files

fixes #6

Checklist:

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[x] I have commented on my code, particularly in hard-to-understand areas
[ ] I have added necessary inline code documentation
[ ] I have added tests that prove my fix is effective and that this feature works
[ ] New and existing unit tests pass locally with my changes

mernxl commented 4 years ago

Please can we see a hosted version of this??

tanerochris commented 4 years ago

Please can we see a hosted version of this??

https://app.swaggerhub.com/apis/tanerochris/qpi/0.1-oas3

cliffordten commented 4 years ago

Are the endpoints complete @tanerochris ? I don't see organisations and comment endpoints?

tanerochris commented 4 years ago

Are the endpoints complete @tanerochris ? I don't see organisations and comment endpoints?

not, yet created the endpoints we needed to start with. When we done with that will add the other endpoints.

mernxl commented 4 years ago

hey, why can't you model the endpoints like #16, so we don't have to redo the authentication, also it hase more features.

tanerochris commented 4 years ago

hey, why can't you model the endpoints like #16, so we don't have to redo the authentication, also it has more features.

Renaming the endpoints to that designed is not a problem, however what I will change is the user password schema to match #16

mernxl commented 4 years ago

user password schema. ?? that isn't public, its not populated like ever.

tanerochris commented 4 years ago

user password schema. ?? that isn't public, its not populated like ever.

it's not public but is returned in response on user creation. Well I think that is the case, currently can't reproduce that, pulled latest updates on #16 and can no longer signup

mernxl commented 4 years ago

Actually its because you pass a null value for password.

Also the password is never going to show up in public, if you notices, when populated the password, when i want to set session, i get fresh record from the db

tanerochris commented 4 years ago

Actually its because you pass a null value for password.

Also the password is never going to show up in public, if you notices, when populated the password, when i want to set session, i get fresh record from the db

I pass a password, trying to signup but that's the error I get. About the password, the schema is not just for public purposes, I combined the modifications you did on #3 with @dherve19 for the overll mongodb schema not just for the api endpoint purposes. I think I requested somewhere that you follow the schemas when creating the mongo schemas. That's why you see password.

mernxl commented 4 years ago

Actually its because you pass a null value for password.

Was speaking out of context there, its a reply to your comment on #16 about null password.