Swagger specification for AI feedback component

[alasali1]

Rough swagger specification defining feedback resource, and paths for HTTP requests.
Closes #5

[dale108]

This will have to change once Cyrus and other finish their work (for instance, I think that we will want to keep track of tags) but for an initial pass, this looks good.

[alasali1]

This will have to change once Cyrus and other finish their work (for instance, I think that we will want to keep track of tags) but for an initial pass, this looks good.

Got it. Thank you for feedback.

[alasali1]

User Story:

Create a Swagger specification for AI feedback component, feedback resource
Estimating Time:

2 hours
Acceptance Criteria:

Create a YAML document with POST and GET requests
Return 200 for GET and 201 for POST on Postman

[CourtneyHoppus]

I don't think the host and the basepath are correct, this looks like something from the swagger editor.
I do not understand the purpose of the get request.
My understanding is that we are only posting feedback to the assignment. The response to that request will be the coaching on that feedback or an error.
I am also a little confused on the seen property being required.

[alasali1]

I don't think the host and the basepath are correct, this looks like something from the swagger editor. I do not understand the purpose of the get request. My understanding is that we are only posting feedback to the assignment. The response to that request will be the coaching on that feedback or an error. I am also a little confused on the seen property being required.

Thank you for the feedback. I am going to fix the seen property and ID being required, because the ID should be generated by POST, and the seen property does not need to be required. The get request is more like a rough draft test to see that the feedback endpoint is working properly it will be removed and I will add more endpoints as the project moves along. I was not sure which host/basepath to point the API. So for testing purposes I kept the one generated from the swagger editor.