Issue #218 Added Requests API documentation by apex-omontgomery · Pull Request #229 · OperationCode/operationcode_backend

apex-omontgomery · 2018-01-04T02:47:51Z

Description of changes

Completes request for Issue #218 adds documentation for:
api/v1/requests_controller#index
api/v1/requests_controller#create
api/v1/requests_controller#show
api/v1/requests_controller#update

Issue Resolved

Fixes #218

hpjaj · 2018-01-04T22:35:30Z

            errors: "Some error message"
        }

+## Mentor Request | Create [/api/v1/requests{?user_id,details,language,service_id,requested_mentor_id,status,assigned_mentor_id}]


Since the model name is Request and the endpoint is also requests, can you please change this to "Request a Mentor", and then re-alphabetize all of the Request related endpoints accordingly.

hpjaj · 2018-01-04T22:45:38Z

+            }
+
+
+## Mentor Request | Update [/api/v1/requests{?user_id,details,language,service_id,requested_mentor_id,status,assigned_mentor_id}]


The update endpoint takes the request_id as a part of the url itself, not a parameter.

Here is an example from TeamMember#update.

hpjaj · 2018-01-04T22:50:41Z

+    + Body
+
+            {
+                "user_id": 4600,


This will also include the id: of the newly created Request db record.

hpjaj · 2018-01-04T22:52:56Z

+                errors: "Some error message"
+            }
+
+## Mentor Request | Show [/api/v1/requests{?user_id}]


The show endpoint takes the request_id as a part of the url itself, not a parameter.

Here is an example from CodeSchool#show.

hpjaj · 2018-01-04T22:54:34Z

+
+ Response 400 (application/json)
+
+## Mentor Requests Unclaimed | Show [/api/v1/requests]


This is actually "Collection" instead of a "Show"

hpjaj · 2018-01-04T22:55:07Z

+
+        [
+            {
+                "service_id": 223,


The id: will be included for each one of these records

hpjaj · 2018-01-04T22:56:20Z

+    + Body
+
+            {
+                "user_id": 5200,


The id: will be included for the record

I included the value, but I think because I did "id" and not "id:" github isn't registering correctly?

Yeah, force of (Ruby) habit. In this API documentation it is "id".

hpjaj · 2018-01-04T22:58:55Z

+
+## Scholarship Applications | Create [/api/v1/code_schools/{?scholarship_application,reason,terms_accepted,scholarship_id}]
+ Parameters
+


user_id is a required param

hpjaj · 2018-01-04T22:59:52Z

+            error: 'No such record'
+        }
+
+## Scholarship Applications | Create [/api/v1/code_schools/{?scholarship_application,reason,terms_accepted,scholarship_id}]


The URL is /api/v1/scholarship_applications

hpjaj · 2018-01-04T23:02:41Z

@wimo7083 - Can you please pull out the code changes for Issue #218 out of this PR, and create a dedicated PR for that issue. So that we have a 1:1 relationship, in that every issue has its own resolving PR.

apex-omontgomery · 2018-01-05T02:34:35Z

Updated, split PR, and renamed since you reviewed mentorships in this one.

hpjaj · 2018-01-05T18:43:53Z

            errors: "Some error message"
        }

+## Mentor Request | Create a New Mentor Request [/api/v1/requests{?user_id,details,language,service_id,requested_mentor_id,status,assigned_mentor_id}]


Since the model name is Request and the endpoint is also ../requests, can you please all of these endpoints to begin with "Request ....". For example, "Request a Mentor".

And then re-alphabetize all of the Request related endpoints accordingly.

I'll fix them to be like this:
## Mentor Request | Request .... r [/api/vi/....]

They'll need to go by their model, Request, so it would be:

## Request | Request a Mentor .... r [/api/vi/....]

hpjaj · 2018-01-05T18:47:48Z

+## Mentor Request | Create a New Mentor Request [/api/v1/requests{?user_id,details,language,service_id,requested_mentor_id,status,assigned_mentor_id}]
+ Parameters
+
+    + user_id (integer, required) - Identification of the User requesting a mentor in the form of an integer


Since the passed user must also be verified, perhaps also include that information in this description. i.e. "The passed in user must be a verified military veteran (i.e. user.verified == true)."

hpjaj · 2018-01-05T18:52:43Z

+                "assigned_mentor_id": 250
+            }
+
+ Response 422 (application/json)


The create action is current not accounting for an error response.

Here is an example of a different controller method that is accounting for error handling.

As such, you can adjust this whole section to return a 401, like you did in the index action.

hpjaj · 2018-01-05T18:53:41Z

+    + Body
+
+            {
+                "request_id": 1234,


This attribute will just be "id"

hpjaj · 2018-01-05T18:55:53Z

+    + request_id (integer, required) - Indentification of mentor request in the form of an integer
+
+
+### Show an Exiting Request From User ID [POST]


This is a get request

hpjaj · 2018-01-05T18:57:22Z

+
+            Authorization: Bearer Access-Token
+
+    + Body


In this case, the id is supplied as part of the url itself, and there will be no body in the request.

I'm confused, so there's no body in the update of the request?

Frontend, to me this looks like it's passing the id in the url like you say, but there's a body in the request that contains status and mentor. But then here shows that the update takes in request params.

I compared the syntax for both update with Request controller and User controller and they both have the same type of input with params. The only difference is one uses obj.update and the other uses obj.update_attributes.

So i thought maybe this has to do with the difference. But this states that the only difference in behavior of the two functions it the return value for a success vs failure. update_attributes returns false if it fails validation, update returns the new object if it fails validation.

At this point I'm thorougly confused why there isn't a body in the request.

I also used a PUT here but changed it to PATCH based on the information provided in the frontend axios call.

@wimo7083 - Apologies, I miscommunicated that. My intent was to say that the id would not be in the body, rather in the url itself. And yes, you're correct, there is a body in the request with all the attributes you have below.

hpjaj · 2018-01-05T18:59:25Z

+            error: 'Unauthorized'
+        }
+
+## Mentor Request | Update [/api/v1/requests{user_id}{?details,language,service_id,requested_mentor_id,status,assigned_mentor_id}]


There will be a / after requests because the id is part of the url itself, i.e. /api/v1/requests/{user_id}{?details,language....

hpjaj self-requested a review January 4, 2018 02:49

hpjaj reviewed Jan 4, 2018

View reviewed changes

updated quotation mark

2441261

apex-omontgomery changed the title ~~Issue #219 more api documentation~~ Issue #218 Requests API documentation Jan 5, 2018

apex-omontgomery changed the title ~~Issue #218 Requests API documentation~~ Issue #218 Added Requests API documentation Jan 5, 2018

hpjaj reviewed Jan 5, 2018

View reviewed changes

wimo7 and others added 8 commits January 6, 2018 18:59

renamed to mimic controller

1861db6

updated to get, changed to 'id', removed body for show route

01e2a2d

updated required params

5013b1c

fixed request params for Show route

a81831b

can't spell good, I think there needs to be id for the request

74c6c47

thoroughly confused

2855cea

Merge branch 'master' into master

3010669

Merge branch 'master' into master

7e667a9

hpjaj approved these changes Jan 13, 2018

View reviewed changes

hpjaj merged commit 5938b91 into OperationCode:master Jan 13, 2018

hpjaj mentioned this pull request Jan 13, 2018

Add API Documentation for Resources and Sessions endpoints #220

Closed

2 tasks

apex-omontgomery mentioned this pull request Jan 28, 2018

mentor-request route needs some love OperationCode/operationcode_frontend#834

Closed

		}


		## Mentor Request \| Update [/api/v1/requests{?user_id,details,language,service_id,requested_mentor_id,status,assigned_mentor_id}]


		+ Response 400 (application/json)

		## Mentor Requests Unclaimed \| Show [/api/v1/requests]


		## Scholarship Applications \| Create [/api/v1/code_schools/{?scholarship_application,reason,terms_accepted,scholarship_id}]
		+ Parameters

		+ request_id (integer, required) - Indentification of mentor request in the form of an integer


		### Show an Exiting Request From User ID [POST]

Conversation

apex-omontgomery commented Jan 4, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of changes

Issue Resolved

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hpjaj commented Jan 4, 2018

Uh oh!

apex-omontgomery commented Jan 5, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

apex-omontgomery commented Jan 4, 2018 •

edited

Loading