Skip to content

Commit dd14ffb

Browse files
committed
Add documentation for example services.
1 parent 4bc522d commit dd14ffb

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
RestaurantService = Example service based on MongoDB sample "restaurants" dataset.
2+
getRestaurants = Retreives a list of all restaurants in a given zip code.
3+
getRestaurants.zipCode = The zip code to search.
4+
getRestaurants.format = The response format (either "json", "csv", or "html"). The default is "json".
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
EmployeeService = Example service based on MySQL sample "employees" database.
2+
getEmployees = Returns a list of all employees in the database.
3+
getEmployees.name = Name filter. The "*" character is a wildcard that matches one or more characters.
4+
getEmployee = Returns a single employee.
5+
getEmployee.details = The employee details to include in the response. Valid options include "titles" and "salaries".
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
PetService = Example service based on MySQL sample "menagerie" database.
2+
getPets = Retreives a list of all pets belonging to a given owner.
3+
getPets.owner = The pet owner.
4+
getPets.format = The response format (either "json", "csv", or "html"). The default is "json".
5+
getAverageAge = Calculates the average age (in years) of all pets in the database.

0 commit comments

Comments
 (0)