-
Notifications
You must be signed in to change notification settings - Fork 1
/
LocationType.raml
79 lines (79 loc) · 1.97 KB
/
LocationType.raml
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
71
72
73
74
75
76
77
78
79
#%RAML 1.0 Library
usage: Schema for a Location
uses:
api: jsonApiLibrary.raml
types:
locations:
description: A location response
type: locations_post
properties:
id:
required: true
example:
type: locations
id: "14"
attributes:
warehouse: NYC
aisle: "3"
shelf: "4"
bin: "22"
locations_post:
description: a POSTable warehouse location (id is optional, required attributes are indicated)
type: locations_patch
properties:
attributes:
required: false
properties:
warehouse:
required: true
type: string
description: warehouse identifier
aisle:
required: true
type: string
description: aisle in warehouse
shelf:
required: true
type: string
description: shelf in aisle
bin:
required: true
type: string
description: bin on shelf
example:
type: locations
attributes:
warehouse: NYC
aisle: "3"
shelf: "4"
bin: "22"
locations_patch:
description: a PATCHable warehouse location. Only supply attributes or relationships that are changed.
type: api.resource_post
properties:
attributes:
required: false
properties:
warehouse:
required: false
type: string
description: warehouse identifier
aisle:
required: false
type: string
description: aisle in warehouse
shelf:
required: false
type: string
description: shelf in aisle
bin:
required: false
type: string
description: bin on shelf
additionalProperties: false
example:
type: locations
id: "14"
attributes:
shelf: "4"
bin: "22"