mod-orders-storage/ramls/titles.raml at master · folio-org/mod-orders-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
#%RAML 1.0
title: "Orders Storage"
baseUri: http://github.com/org/folio/mod-orders-storage
version: v1.0

documentation:
  - title: Titles
    content: <b>CRUD API to manage Titles.  This API is intended for internal use only.  Please use the /orders/titles, /orders/receiving, /orders/check-in, and /orders/receiving-history APIs provided by mod-orders instead.</b>

types:
    title: !include acq-models/mod-orders-storage/schemas/title.json
    title_collection: !include acq-models/mod-orders-storage/schemas/title_collection.json
    title-sequence-numbers: !include acq-models/common/schemas/sequence_numbers.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}$

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

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

/orders-storage/titles:
  type:
    collection:
      exampleCollection: !include acq-models/mod-orders-storage/examples/title_collection.sample
      exampleItem: !include acq-models/mod-orders-storage/examples/title_post.sample
      schemaCollection: title_collection
      schemaItem: title
  get:
    description: Get list of titles
    is: [
      searchable: {description: "with valid searchable fields: for example title", example: "[\"title\", \"TITLE\", \"=\"]"},
      pageable
    ]
  /{id}:
    uriParameters:
      id:
        description: The UUID of a Title
        type: UUID
    type:
      collection-item:
        exampleItem: !include acq-models/mod-orders-storage/examples/title_get.sample
        schema: title

    /sequence-numbers:
      uriParameters:
        id:
          description: The UUID of a Title
          type: UUID
      get:
        description: Get next sequence numbers for the title
        queryParameters:
          sequenceNumbers:
            description: Quantity of the next sequence numbers
            type: integer
            default: 1
            example: 1
        responses:
          200:
            body:
              application/json:
                type: title-sequence-numbers
          400:
            description: "Bad request, e.g. malformed request body or query parameter"
            body:
              text/plain:
                example: "Unable to generate sequence numbers"
          500:
            description: "Internal server error, e.g. due to misconfiguration"
            body:
              text/plain:
                example: "Internal server error, contact Administrator"