Skip to content

Commit d9a5d74

Browse files
jgabrielsjgabriels
committed
restlet2repo: saving modified files
1 parent fe381db commit d9a5d74

2 files changed

Lines changed: 123 additions & 0 deletions

File tree

‎spec/definitions/boards_saved_lanes_response.yaml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
description: Each saved lane entry is a key/value object in the list.
2+
example:
3+
list:
4+
- destination_city: Atlanta
5+
destination_metro_id: 987
6+
destination_state: GA
7+
distance: 456
8+
flat_gross: 111
9+
flat_per_mile: 1.11
10+
lane_id: 123
11+
origin_city: Dallas
12+
origin_metro_id: 123
13+
origin_state: TX
14+
reefer_gross: 333
15+
reefer_per_mile: 3.33
16+
van_gross: 222
17+
van_per_mile: 2.22
18+
properties:
19+
list:
20+
properties:
21+
payrate:
22+
description: 'This will return a list of dates, single key of newest_payrate'
23+
properties:
24+
destination_city:
25+
type: string
26+
destination_metro_id:
27+
type: integer
28+
destination_state:
29+
type: string
30+
distance:
31+
type: integer
32+
flat_gross:
33+
type: number
34+
flat_per_mile:
35+
type: number
36+
lane_id:
37+
type: integer
38+
origin_city:
39+
type: string
40+
origin_metro_id:
41+
type: integer
42+
origin_state:
43+
type: string
44+
reefer_gross:
45+
type: number
46+
reefer_per_mile:
47+
type: number
48+
van_gross:
49+
type: number
50+
van_per_mile:
51+
type: number
52+
type: object
53+
type: object
54+
x-restlet:
55+
section: BOARDS

‎spec/paths/boards@freight_rates@saved_lanes.yaml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
delete:
2+
parameters:
3+
- in: header
4+
name: end-user-token
5+
required: true
6+
type: string
7+
- in: query
8+
name: lane_id
9+
required: true
10+
type: integer
11+
responses:
12+
'204':
13+
description: Will not have a return body.
14+
summary: Remove a Saved lane
15+
tags:
16+
- boards
17+
get:
18+
description: Get all saved lanes for logged in user.
19+
parameters:
20+
- in: header
21+
name: end-user-token
22+
required: true
23+
type: string
24+
responses:
25+
'200':
26+
description: Will return an object containing a list of saved lanes.
27+
schema:
28+
$ref: '#/definitions/boards_saved_lanes_response'
29+
tags:
30+
- boards
31+
post:
32+
description: Save a lane.
33+
parameters:
34+
- in: header
35+
name: end-user-token
36+
required: true
37+
type: string
38+
- in: body
39+
name: body
40+
required: false
41+
schema:
42+
properties:
43+
destinaition_city:
44+
description: A valid city or INBOUND
45+
type: string
46+
destination_state:
47+
description: A valid State abbrevitaino or blank when using INBOUND.
48+
type: string
49+
origin_city:
50+
description: A valid city or OUTBOUND
51+
type: string
52+
origin_state:
53+
description: A valid State abbrevitaino or blank when using OUTBOUND.
54+
type: string
55+
required:
56+
- destination_state
57+
- origin_city
58+
- origin_state
59+
type: object
60+
responses:
61+
'200':
62+
description: Will return an object containing a list of saved lanes.
63+
schema:
64+
$ref: '#/definitions/boards_saved_lanes_response'
65+
tags:
66+
- boards
67+
x-restlet:
68+
section: BOARDS

0 commit comments

Comments
 (0)