mod-inventory-storage/ramls/locationunit.raml at master · folio-org/mod-inventory-storage · GitHub

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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
#%RAML 1.0
title: Institution level location unit
version: v2.0
protocols: [ HTTP, HTTPS ]
baseUri: http://github.com/org/folio/mod-inventory-storage

documentation:
  - title: Location units
    content: This documents the API calls that can be made to query and manage
      location units like institutions, campuses, and libraries

types:
  locationInstitution: !include schemas/location-units/locinst.json
  locationInstitutions: !include schemas/location-units/locinsts.json
  locationCampus: !include schemas/location-units/loccamp.json
  locationCampuses: !include schemas/location-units/loccamps.json
  locationLibrary: !include schemas/location-units/loclib.json
  locationLibraries: !include schemas/location-units/loclibs.json
  errors: !include raml-util/schemas/errors.schema

traits:
  pageable: !include raml-util/traits/pageable.raml
  searchable: !include raml-util/traits/searchable.raml
  validate: !include raml-util/traits/validation.raml

resourceTypes:
  collection: !include raml-util/rtypes/collection.raml
  collection-item: !include raml-util/rtypes/item-collection.raml
  get-delete-only: !include raml-util/rtypes/get-delete.raml

/location-units:
  /institutions:
    type:
      collection:
        exampleCollection: !include examples/locinsts.json
        exampleItem: !include examples/locinst.json
        schemaCollection: locationInstitutions
        schemaItem: locationInstitution
    get:
      is: [
        searchable: {description: "with valid searchable fields", example: "name=aaa"},
        pageable
      ]
      description: Return a list of institutions
      queryParameters:
        includeShadow:
          description: Whether to include shadow institutions in the response or not.
          type: boolean
          required: false
          default: false
    post:
      description: Create a new institution
      is: [validate]
    delete:
      description: "Delete all institutions"
      responses:
        204:
          description: "All institutions deleted"
        500:
          description: "Internal server error, e.g. due to misconfiguration"
          body:
            text/plain:
              example: "Internal server error, contact administrator"
    /{id}:
      description: "Pass in the institution id"
      type:
        collection-item:
          exampleItem: !include examples/locinst.json
          schema: locationInstitution
      get:
      put:
      delete:
  /campuses:
    type:
      collection:
        exampleCollection: !include examples/loccamps.json
        exampleItem: !include examples/loccamp.json
        schemaCollection: locationCampuses
        schemaItem: locationCampus
    get:
      is: [
        searchable: {description: "with valid searchable fields", example: "name=aaa"},
        pageable
      ]
      description: Return a list of campuses
      queryParameters:
        includeShadow:
          description: Whether to include shadow campuses in the response or not.
          type: boolean
          required: false
          default: false
    post:
      description: Create a new campus
      is: [validate]
    delete:
      description: "Delete all campuses"
      responses:
        204:
          description: "All campuses deleted"
        500:
          description: "Internal server error, e.g. due to misconfiguration"
          body:
            text/plain:
              example: "Internal server error, contact administrator"
    /{id}:
      description: "Pass in the campus id"
      type:
        collection-item:
          exampleItem: !include examples/loccamp.json
          schema: locationCampus
      get:
      put:
      delete:
  /libraries:
    type:
      collection:
        exampleCollection: !include examples/loclibs.json
        exampleItem: !include examples/loclib.json
        schemaCollection: locationLibraries
        schemaItem: locationLibrary
    get:
      is: [
        searchable: {description: "with valid searchable fields", example: "name=aaa"},
        pageable
      ]
      description: Return a list of libraries
      queryParameters:
        includeShadow:
          description: Whether to include shadow libraries in the response or not.
          type: boolean
          required: false
          default: false
    post:
      description: Create a new library
      is: [validate]
    delete:
      description: "Delete all libraries"
      responses:
        204:
          description: "All libraries deleted"
        500:
          description: "Internal server error, e.g. due to misconfiguration"
          body:
            text/plain:
              example: "Internal server error, contact administrator"
    /{id}:
      description: "Pass in the library id"
      type:
        collection-item:
          exampleItem: !include examples/loclib.json
          schema: locationLibrary
      get:
      put:
      delete: