mod-inventory-storage/ramls/instance-set.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
#%RAML 1.0
title: Instance Set API
version: v3.2
protocols: [ HTTP, HTTPS ]
baseUri: http://github.com/org/folio/mod-inventory-storage

documentation:
  - title: Instance Set
    content: Get instances, for each instance get related records

types:
  instanceSet: !include schemas/instance-sets/instance-set.json
  instanceSets: !include schemas/instance-sets/instance-sets.json
  errors: !include raml-util/schemas/errors.schema

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

resourceTypes:
  collection-stream: !include raml-util/rtypes/collection-stream.raml

/inventory-view/instance-set:
  type:
    collection-stream:
     schemaCollection: instanceSet
     exampleCollection: !include examples/instance-set.json
  get:
    description: Get instances, for each instance get related records
    is: [searchable: {description: "using CQL", example: "hrid==\"in007\""}]
    queryParameters:
      instance:
        description: Add "instance" property with the instance JSON
        type: boolean
        required: false
        default: false
      holdingsRecords:
        description: Add "holdingsRecords" array with all holdings record JSONs that belong to the instance
        type: boolean
        required: false
        default: false
      items:
        description: Add "items" array with all item JSONs that belong to the instance
        type: boolean
        required: false
        default: false
      precedingTitles:
        description: Add "precedingTitles" array with relationship records, each has a precedingInstanceId property
        type: boolean
        required: false
        default: false
      succeedingTitles:
        description: Add "succeedingTitles" array with relationship records, each has a succeedingInstanceId property
        type: boolean
        required: false
        default: false
      superInstanceRelationships:
        description: Add "superInstanceRelationships" array with relationship records, each has a superInstanceId property
        type: boolean
        required: false
        default: false
      subInstanceRelationships:
        description: Add "subInstanceRelationships" array with relationship records, each has a subInstanceId property
        type: boolean
        required: false
        default: false
      offset:
        description: Skip over a number of elements by specifying an offset value for the query
        type: integer
        required: false
        example: 0
        default: 0
        minimum: 0
        maximum: 2147483647
      limit:
        description: Limit the number of instance records to return data for; small maximum avoids out of memory
        type: integer
        required: true
        example: 1
        minimum: 1
        maximum: 10