-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathdoc.go
70 lines (49 loc) · 2.52 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/*
Author: Bruce Jagid
Created On: Aug 12, 2023
**********************************************************************
General Purpose:
The api pkg is the abstraction layer for interacting with
external reservation services, such as resy and opentable.
All services implementing the API interface
are sub-pkgs of api
**********************************************************************
API:
The API interface specifies 3 methods:
Login(params LoginParam) (*LoginResponse, error)
Reserve(params ReserveParam) (*ReserveResponse, error)
Search(params SearchParam) (*SearchResponse, error)
**********************************************************************
Login:
The Login function takes in a set of login credentials and returns
a response. The login credentials vary by external service, with
each defining its own set of necessary fields in each sub-pkg.
The output of the Login function is a LoginResponse, which should
be used as a token in the input params to a Reserve function
call. Login should always be used before a set of reservation
calls and is only used for the purpose of making reservations.
**********************************************************************
Reserve:
The Reserve function takes in a set of reserve parameters which
specify the date and a priority list of times to try and reserve
at and produces a response indicating the time made or an error.
This function's input parameters specifies a 'LoginResp' which
must be obtained by a 'Login' api function call, though such a
value only needs to be obtained before a series of Reserve calls.
**********************************************************************
Search:
The Search function takes in a set of query parameters which
specify the name of a restaurant and limit on responses and
produces a response with a slice of search results. These results
contain necessary and helpful data both for identifying the
intended restaurant to reserve at and also for making a
reservation request.
**********************************************************************
AuthMinExpire:
The AuthMinExpire function provides the minimum time irresepective
of time zone that a login token from the Login function is valid.
This function returns a constant value. If a null value is
returned, the login token is valid indefinitely.
**********************************************************************
*/
package api