Issue #221 added api/v1/users documentation by apex-omontgomery · Pull Request #224 · OperationCode/operationcode_backend

apex-omontgomery · 2017-12-27T23:10:40Z

Description of changes

Included 3 new Apiary API routes.
POST api/v1/users_controller#create
PATCH api/v1/users_controller#update
POST for api/v1/users_controller#verify

Issue Resolved

Resolved issue of lacking API docs for users.
Fixes #221

added api/v1/users documentation

hpjaj

Coming along really nicely 👍

hpjaj · 2017-12-28T16:27:07Z


 API endpoints that Operation Code's Rails backend makes available to its React frontend.

+## Users | Create [/api/v1/users{?first_name,last_name,email,zip,password,mentor}]


Can you please alphabetize the placement of these in the file. First by model (i.e. User), then by action (i.e. create)

Done, also adjusted Location

hpjaj · 2017-12-28T16:27:54Z

+    + Body
+
+            {            
+            first_name: "Mike",


Can you pls add indenting in keeping with other Body hashes

hpjaj · 2017-12-28T16:28:02Z

+ Response 201 (application/json)
+
+        {
+        token: Bearer Access-Token


hpjaj · 2017-12-28T16:28:11Z

+ Response 422 (application/json)
+
+        {
+        errors: "Some error message"


hpjaj · 2017-12-28T16:31:12Z

+    + Body
+
+            {
+            verified: true


See above re: access_token

Removed verified from both header and body, and fixed indentation.

hpjaj · 2017-12-28T16:37:41Z

+
+ Parameters
+
+  + education_level (string, required) - Users highest level of education in the form of a string


These are all optional (vs. required)

So if they submit no params it returns a 422 or 200?

hpjaj · 2017-12-28T16:40:26Z

+            last_name: "Johnson",
+            email: "dreams@operationcode.org",     
+            zip: "80020",        
+            password: "hunter2",    


Technically encrypted_password is what is returned, but you can leave it out all together.

hpjaj · 2017-12-28T16:43:46Z

+
+  + verified (boolean, required) - Users verified veteran status in the form of a boolean
+
+### Modify User record verified status [POST]


Perhaps something like, "Verifies a user's military affiliation status through ID.me"

hpjaj · 2017-12-28T16:44:58Z

+  + email (string, required) - Email of the User in the form of a string
+  + zip (string, required) - Zipcode of the User in the form of a string
+  + password (string, required) - Password of the User in the form on a string
+  + mentor (boolean, required) - Is User requesting mentor in the form of a boolean


I believe mentor is optional

I think you're right from a front end perspective.

…removed verified in header.

apex-omontgomery · 2017-12-28T23:22:29Z

Completed changes you requested. One thing I noticed was how some of the endpoints had combined grouping. Codeschool | Show or Delete is one example.

There's inconsistent use of Body in the previous documentation. But apiary doesn't seem to mind. Not sure of your thoughts.

## User | Reset Password [/api/v1/users/passwords/reset{?email}]

+ Parameters

    + email (string, required) - The email address of the requesting User

### Reset the User's Password  [POST]

+ Request (application/json)

    + Body

            {
                "email": "frank@example.com"
            }

+ Response 200 (application/json)

    + Body

            {
                status: "ok"
            }

+ Response 422 (application/json)

        {
            errors: "Some error message"
        }

### Delete an Existing CodeSchool [DELETE]

  + Request (application/json)

      + Headers

              Authorization: Bearer Access-Token

      + Body

              {
                  "id": 1
              }

  + Response 200 (application/json)

      + Body

              {
                  status: "ok"
              }

  + Response 422 (application/json)

      + Body

              {
                  errors: "Some error message"
              }

hpjaj · 2017-12-29T19:00:33Z

+    + Body
+
+            {
+            first_name: "Mike",


hpjaj · 2017-12-29T19:03:18Z

+
+ Parameters
+
+  + verified (boolean, required) - User has verified military affiliation status through ID.me


The param here is only access_token

hpjaj · 2017-12-29T19:03:41Z

+    + Body
+
+            {
+                verified: true


Body is only the access_token

hpjaj · 2017-12-29T19:05:48Z

+
+## Location | Delete [/api/v1/code_schools/:code_school_id/locations/:id]
+
+### Delete an Existing Location [DELETE]


hpjaj · 2017-12-29T19:19:19Z

+
+    + Headers
+
+            Authorization: Bearer Access-Token


This method actually does not require authorization. Only the update method does.

apex-omontgomery · 2017-12-31T19:08:00Z

Made some changes, also found some instances where Param items only had 2 spaces.

hpjaj

Nice work, @wimo7083

wimo7083 and others added 2 commits December 27, 2017 15:55

added api/v1/users documentation

879687f

Merge pull request #1 from wimo7083/apiary_docs

0480c9d

added api/v1/users documentation

hpjaj reviewed Dec 28, 2017

View reviewed changes

wimo7083 added 5 commits December 28, 2017 15:46

updated alphabetical ordering removed trailing whitespace.

b6a6283

removed leading space and changed mentor to be optional

0d27001

more whitespace fixes, indentation fix, updated verified descriptor, …

0c9e07f

…removed verified in header.

changed update to all optional

700ca3f

removed hunter2 from create response

5054b64

hpjaj reviewed Dec 29, 2017

View reviewed changes

fixed indentation, changed params to access_token for verify

0725d47

hpjaj approved these changes Dec 31, 2017

View reviewed changes

hpjaj merged commit d5779f4 into OperationCode:master Dec 31, 2017

hpjaj mentioned this pull request Jan 13, 2018

Add API Documentation for Resources and Sessions endpoints #220

Closed

2 tasks


		API endpoints that Operation Code's Rails backend makes available to its React frontend.

		## Users \| Create [/api/v1/users{?first_name,last_name,email,zip,password,mentor}]


		+ Parameters

		+ education_level (string, required) - Users highest level of education in the form of a string


		+ verified (boolean, required) - Users verified veteran status in the form of a boolean

		### Modify User record verified status [POST]


		+ Parameters

		+ verified (boolean, required) - User has verified military affiliation status through ID.me


		## Location \| Delete [/api/v1/code_schools/:code_school_id/locations/:id]

		### Delete an Existing Location [DELETE]

Conversation

apex-omontgomery commented Dec 27, 2017

Description of changes

Issue Resolved

Uh oh!

hpjaj left a comment

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!

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!

apex-omontgomery commented Dec 28, 2017

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 Dec 29, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

apex-omontgomery commented Dec 31, 2017

Uh oh!

hpjaj left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

hpjaj Dec 29, 2017 •

edited

Loading