search

North-Seattle-College / ad440-winter2021-thursday-repo

NSC AD 440 Winter 2021 Thursday cohort practicum repo
Apache License 2.0
2 stars 27 forks source link

As/swagger documentation #269

Closed AlexSuth closed 3 years ago

AlexSuth commented 3 years ago

Version 1 of my Swagger API Documentation. Includes all the paths and I think I got all the http methods that are required. I am a little iffy on the http responses, though.

unicornsleuth commented 3 years ago

I'm not sure what the convention is for objects that are different in their input than their output - like, the Task contains references to the userId, user, taskId, but none of those are supposed to be input - they're generated automatically. My idea (not sure if it's the right solution) is to have alternative Objects that are CreateUser and CreateTask, and then you can clarify in descriptions that the fields are optional in PATCH but required in PUT. And use User and Task for the return values.