mod-orders/ramls/wrapper-pieces.raml at master · folio-org/mod-orders · 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
#%RAML 1.0
title: "Wrapper Pieces"
baseUri: https://github.com/folio-org/mod-orders
version: v4

documentation:
  - title: "Wrapper Pieces"
    content: <b>Read API to manage Wrapper Pieces.</b>

types:
  errors: !include raml-util/schemas/errors.schema
  wrapper_piece: !include acq-models/mod-orders-storage/schemas/wrapper_piece.json
  wrapper_piece_collection: !include acq-models/mod-orders-storage/schemas/wrapper_piece_collection.json
  UUID:
    type: string
    pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

# workaround to prevent api-lint errors for FQM vendor extensions
# see https://github.com/folio-org/fqm-tools/blob/main/docs/generation/field-schema.md#raml-validation-errors
annotationTypes:
  fqm-essential:
    type: boolean
  fqm-visibility:
    type: string
  fqm-visible-by-default:
    type: boolean
  fqm-value-getter:
    type: string

traits:
  orderable: !include raml-util/traits/orderable.raml
  pageable:  !include raml-util/traits/pageable.raml
  searchable: !include raml-util/traits/searchable.raml

resourceTypes:
  collection-get: !include raml-util/rtypes/collection-get.raml
  collection-item-get: !include raml-util/rtypes/item-collection-get-with-json-response.raml

/orders/wrapper-pieces:
  type:
    collection-get:
      exampleCollection: !include acq-models/mod-orders-storage/examples/wrapper_piece_collection.sample
      schemaCollection: wrapper_piece_collection
  get:
    description: Get list of Wrapper Pieces
    is: [
      searchable: {description: "with valid searchable fields: for example code", example: "[\"code\", \"MEDGRANT\", \"=\"]"},
      pageable
    ]
  /{id}:
    uriParameters:
      id:
        description: The UUID of a Wrapper Piece
        type: UUID
    type:
      collection-item-get:
        exampleItem: !include acq-models/mod-orders-storage/examples/wrapper_piece_get.sample
        schema: wrapper_piece