Skip to content

Latest commit

 

History

History
305 lines (279 loc) · 7.02 KB

File metadata and controls

305 lines (279 loc) · 7.02 KB
description API Documentation for Eatery

Eatery

Campus Eateries

{% api-method method="get" host="http://eatery-backend.cornellappdev.com" path="/graphQL" %} {% api-method-summary %} Get all campus eateries {% endapi-method-summary %}

{% api-method-description %}

{% endapi-method-description %}

{% api-method-spec %} {% api-method-request %} {% api-method-path-parameters %} {% api-method-parameter name="GraphQL Query" type="integer" required=false %} id for a specific eatery. No argument will result in a get all request
example query{
campusEateries {
about
coordinates {
latitude
longitude
}
eateryType
id
imageUrl
location
name
operatingHours {
date
events {
calSummary
description
startTime
endTime
menu {
itemCount
items {
healthy
item
}
}
}
}
paymentMethods {
brbs
cash
cornellCard
credit
mobile
swipes
}
phone
slug
swipeData {
startTime
endTime
swipeDensity
waitTimeLow
waitTimeHigh
}
}
} {% endapi-method-parameter %} {% endapi-method-path-parameters %} {% endapi-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{
  "data": {
    "campusEateries": [
      {
        "about": "<text>",
        "coordinates": {
          "latitude": 42.444266,
          "longitude": -76.487598
        },
        "eateryType": "All You Care To Eat Dining Room",
        "id": 31,
        "imageUrl": "https://raw.githubusercontent.com/cuappdev/assets/master/eatery/eatery-images/104-West.jpg",
        "location": "104 West Avenue",
        "name": "104West!",
        "operatingHours": [
          {
            "date": "2018-12-04",
            "events": [
              {
                "calSummary": "Lunch",
                "description": "Lunch",
                "startTime": "2018-12-04:11:00am"
                "endTime": "2018-12-04:02:00pm",
                "menu": [
                  {
                    "category": "Salad Bar Station",
                    "items": [
                      {
                        "healthy": true,
                        "item": "Fresh Cut Fruit Salad"
                      },
                      {
                        "healthy": true,
                        "item": "Healthy Style Salad Bar"
                      }
                    ]
                  },
                  ...  # more stations
                ]
              },
              ...  # more events
            ]
          },
          ...  # more operating hours
        ],
        "paymentMethods": {
          "brbs": true,
          "cash": true,
          "cornellCard": true,
          "credit": true,
          "mobile": true,
          "swipes": true
        },
        "phone": "607-272-6907",
        "slug": "104-West"
        "swipeData": {
          "sessionType": "regular",
          "startTime": "04:30 PM",
          "endTime": "05:00 PM",
          "swipeDensity": .767,  # 3 decimal number in range [0,1]
          "waitTimeLow": 1,  # min value is 0
          "waitTimeHigh": 4
      },
      ...  # more eateries
    ]
  }
}

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

Collegetown Eateries

{% api-method method="get" host="http://eatery-backend.cornellappdev.com" path="/graphQL" %} {% api-method-summary %} Get all collegetown eateries {% endapi-method-summary %}

{% api-method-description %}

{% endapi-method-description %}

{% api-method-spec %} {% api-method-request %} {% api-method-path-parameters %} {% api-method-parameter name="GraphQL Query" type="integer" required=false %} id for a specific collegetown eatery. No argument will default to a get all request.{
collegetownEateries(id: <eatery_id>) {
address
categories
coordinates {
latitude
longitude
}
eateryType
id
imageUrl
name
paymentMethods {
brbs
cash
cornellCard
credit
mobile
swipes
}
phone
price
rating
url
}
} {% endapi-method-parameter %} {% endapi-method-path-parameters %} {% endapi-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{
  "data": {
    "collegetownEateries": [
      {
        "address": "415 College Ave",
        "categories": [
          "Bagels",
          "Sandwiches",
          "Coffee & Tea"
        ],
        "coordinates": {
          "latitude": 42.44234,
          "longitude": -76.48508
        },
        "eateryType": "Collegetown Restaurant",
        "id": -7,
        "imageUrl": "https://s3-media1.fl.yelpcdn.com/bphoto/hRhu1aRzEmV12yYYXeteAw/o.jpg",
        "name": "Collegetown Bagels",
        "operatingHours": [
          {
            "date": "2018-12-05",
            "events": [
              {
                "description": "General",
                "endTime": "2018-12-06:02:00AM",
                "startTime": "2018-12-05:06:30AM"
              }
            ]
          },
          ...  # more operating hours
        ],
        "paymentMethods": {
          "brbs": false,
          "cash": true,
          "cornellCard": false,
          "credit": true,
          "mobile": false,
          "swipes": false
        },
        "phone": "+16072730982",
        "price": "$",
        "rating": "4.0",
        "url": "https://www.yelp.com/biz/collegetown-bagels-ithaca?adjust_creative=ye2EvJ4Kp2xkdMHg9ZpbXA&utm_campaign=yelp_api_v3&utm_medium=api_v3_business_lookup&utm_source=ye2EvJ4Kp2xkdMHg9ZpbXA"
      },
      ...  # more collegetown eateries
    ]
  }
}

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

GET Login

{% api-method method="get" host="http://eatery-backend.cornellappdev.com" path="/graphQL" %} {% api-method-summary %} Get user GET information {% endapi-method-summary %}

{% api-method-description %} Gathers user account information from GET (laundry, brb, city bucks) {% endapi-method-description %}

{% api-method-spec %} {% api-method-request %} {% api-method-path-parameters %} {% api-method-parameter name="GraphQL Query" type="string" required=true %} GET session id for a user.{
accountInfo(id: <session_id>) {
brb
cityBucks
history {
amount
name
timestamp
}
laundry
swipes
}
} {% endapi-method-parameter %} {% endapi-method-path-parameters %} {% endapi-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}


{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}