Skip to content

Commit

Permalink
Update apib doc and add swagger doc along with swagger html UI
Browse files Browse the repository at this point in the history
  • Loading branch information
npendery committed Jan 31, 2017
1 parent 575134d commit 2bc4441
Show file tree
Hide file tree
Showing 3 changed files with 7,047 additions and 16 deletions.
32 changes: 16 additions & 16 deletions blueprint/api.apib
Original file line number Diff line number Diff line change
Expand Up @@ -181,13 +181,13 @@ You can list all comments or retrieve individual comments, as well as create and

+ Attributes (Unprocessable Entity Response)

### Filter comments by list of ids [GET /comments{?filter[id]}]
### Filter comments by list of ids [GET /comments{?filter_id}]

+ Request

+ Attributes

+ `filter[id]`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.
+ `filter_id`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.

+ Headers

Expand Down Expand Up @@ -277,13 +277,13 @@ To create a donation goal the user must be a site admin or the owner of the refe

+ Attributes (Donation Goals Response)

### Filter by id [GET /donation-goals{?filter[id]}]
### Filter by id [GET /donation-goals{?filter_id}]

+ Request

+ Attributes

+ `filter[id]`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.
+ `filter_id`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.

+ Headers

Expand Down Expand Up @@ -422,13 +422,13 @@ To delete a donation goal the user must be a site admin or the owner of the refe

+ Attributes (Organization Memberships Response)

### Filter by id [GET /organization-memberships{?filter[id]}]
### Filter by id [GET /organization-memberships{?filter_id}]

+ Request

+ Attributes

+ `filter[id]`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.
+ `filter_id`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.

+ Headers

Expand Down Expand Up @@ -537,13 +537,13 @@ Until the Code Corps platform is open to new organizations, only admin users can

+ Attributes (Unprocessable Entity Response)

### Filter by id [GET /organizations{?filter[id]}]
### Filter by id [GET /organizations{?filter_id}]

+ Request

+ Attributes

+ `filter[id]`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.
+ `filter_id`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.

+ Headers

Expand Down Expand Up @@ -1110,13 +1110,13 @@ This endpoint retrieves Skills that can relate to Projects, Roles, or Users. Thi

+ Attributes (Skills Response)

### Filter by id [GET /skills{?filter[id]}]
### Filter by id [GET /skills{?filter_id}]

+ Request

+ Attributes

+ `filter[id]`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.
+ `filter_id`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.

+ Headers

Expand Down Expand Up @@ -1691,13 +1691,13 @@ It may help to think of a User Category as an interest. A user may have interest

+ Attributes (User Categories Response)

### Filter by id [GET /user-categories{?filter[id]}}]
### Filter by id [GET /user-categories{?filter_id}]

+ Request

+ Attributes

+ `filter[id]`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.
+ `filter_id`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.

+ Headers

Expand Down Expand Up @@ -1871,13 +1871,13 @@ This resource identifies a relationship between a User and a Skill. For example,

+ Attributes (User Skills Response)

### Filter by id [GET /user-skills{?filter[id]}]
### Filter by id [GET /user-skills{?filter_id}]

+ Request

+ Attributes

+ `filter[id]`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.
+ `filter_id`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.

+ Headers

Expand Down Expand Up @@ -1977,13 +1977,13 @@ This endpoint handles the User resources for Code Corps.

+ Attributes (Users Response)

### Filter by id [GET /users{?filter[id]}]
### Filter by id [GET /users{?filter_id}]

+ Request

+ Attributes

+ `filter[id]`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.
+ `filter_id`: `1,2,3` (string, required) - Comma separated string of `ids` to filter by.

+ Headers

Expand Down

0 comments on commit 2bc4441

Please sign in to comment.