mod-inventory-storage/ramls/instance-type.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
#%RAML 1.0
title: Instance Types API
version: v2.0
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost

documentation:
  - title: Instance Types API
    content: This documents the API calls that can be made to query and manage instance resource types

types:
  instanceType: !include schemas/instance-types/instancetype.json
  instanceTypes: !include schemas/instance-types/instancetypes.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

/instance-types:
  type:
    collection:
      exampleCollection: !include examples/instancetypes.json
      exampleItem: !include examples/instancetype.json
      schemaCollection: instanceTypes
      schemaItem: instanceType
  get:
    is: [
      searchable: {description: "with valid searchable fields", example: "name=aaa"},
      pageable
    ]
    description: Return a list of instance types
  post:
    description: Create a new instance type
    is: [validate]
  /{instanceTypeId}:
    description: Pass in the instance type id
    type:
      collection-item:
        exampleItem: !include examples/instancetype.json
        schema: instanceType