Skip to content

Commit

Permalink
Fix formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
kracekumar committed Jul 8, 2016
1 parent 08a617e commit 994a11e
Showing 1 changed file with 19 additions and 16 deletions.
35 changes: 19 additions & 16 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
### API


Junction provides API to access information about the conference, schedules, and feedback. The API is for mobile clients to assist conference attendees. All the response format is `application/json`.
Junction provides API to access information about the conference, schedule, and feedback. The API is for mobile clients to assist conference attendees. All the request and response format is `application/json`.

- Demo site: `http://junctiondemo.herokuapp.com/`


### Conference - List

- Endpoint: /api/v1/conferences/
- Endpoint: `/api/v1/conferences/`

- Allowed Method: `GET`.

- Endpoint yields all conferences available in the system. There is no pagination.
- Returns all conferences. There is no pagination.

- Sample:
- Sample Response:

```
Expand All @@ -23,13 +26,13 @@ Junction provides API to access information about the conference, schedules, and

### Venue - List

- `Endpoint: api/v1/venues/`
- Endpoint: `/api/v1/venues/`

- Allowed Methods: `GET`

- List all the venues in the system.
- List all the venues.

- Sample
- Sample Response:

```
Expand All @@ -43,9 +46,9 @@ Junction provides API to access information about the conference, schedules, and

- Allowed Method: `GET`

- Get specific venue details
- Return specific venue details.

- Sample
- Sample Response:

```
Expand All @@ -59,9 +62,9 @@ Junction provides API to access information about the conference, schedules, and

- Allowed Method: `GET`

- List all rooms in for all venues in the system.
- List all rooms of all venues..

- Sample
- Sample Response:

```
Expand All @@ -77,7 +80,7 @@ Junction provides API to access information about the conference, schedules, and

- Allowed Method: `GET`

- Sample
- Sample Response:

```
Expand All @@ -93,17 +96,17 @@ Junction provides API to access information about the conference, schedules, and

- All the schedule items of all conferences.

- Sample
- Sample Response:

```
{ "2015-10-04": { "08:30:00 - 09:15:00": [ { "conference": "http://in.pycon.org/cfp/api/v1/conferences/1/", "session": { "description": "" }, "room_id": 4, "end_time": "09:15:00", "event_date": "2015-10-04", "start_time": "08:30:00", "type": "Break", "id": 37, "name": "Registration & Breakfast" } ], "09:30:00 - 10:15:00": [ { "conference": "http://in.pycon.org/cfp/api/v1/conferences/1/", "session": { "description": "" }, "room_id": 1, "end_time": "10:15:00", "event_date": "2015-10-04", "start_time": "09:30:00", "type": "Talk", "id": 38, "name": "Keynote - Nicholas H.Tollervey" } ],
```

- Response data keys are conference day date and it's schedule grouped by time.
- Response data keys are conference day date and its schedule grouped by time.

- `2015-10-04` - Conference day date
- `2015-10-04` - Conference day date.

- `08:30:00 - 09:15:00` - Start of the session - End of the session.

Expand All @@ -121,7 +124,7 @@ Junction provides API to access information about the conference, schedules, and

- All the schedule items of the conference.

- Sample
- Sample Response:

```
Expand Down

0 comments on commit 994a11e

Please sign in to comment.