mod-inventory-storage/ramls/instance-reindex.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
#%RAML 1.0
title: Reindex instances
version: v0.1
protocols: [ HTTP, HTTPS ]
baseUri: http://localhost

documentation:
  - title: Instance reindex
    content: Reindex instances by generating domain events for them

types:
  reindexJob: !include schemas/reindex/get-job-by-id-response.json
  reindexJobs: !include schemas/reindex/reindex-jobs.json
  errors: !include raml-util/schemas/errors.schema

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

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

/instance-storage/reindex:
  displayName: Reindex instances
  post:
    description: Submit a reindex job
    responses:
      200:
        description: Reindex job has been submitted
        body:
          application/json:
            type: reindexJob
      500:
        description: Internal server error
        body:
          text/plain:
            example: Internal server error
  type:
    collection:
      exampleCollection: !include examples/reindexJobs.json
      exampleItem: !include examples/reindexJob.json
      schemaCollection: reindexJobs
      schemaItem: reindexJob
  get:
    is: [
      searchable: { description: "with valid searchable fields", example: "name=aaa" },
      pageable
    ]
    description: Get all reindex jobs
  /{id}:
    get:
      description: Get reindex job by id
      responses:
        200:
          description: Reindex job has returned
          body:
            application/json:
              type: reindexJob
        404:
          description: Reindex job with id not found
          body:
            text/plain:
              example: Not found
        500:
          description: Internal server error
          body:
            text/plain:
              example: Internal server error
    delete:
      description: Cancell reindex job by id
      responses:
        204:
          description: Reindex job has been cancelled
        404:
          description: Reindex job with id not found
          body:
            text/plain:
              example: Not found
        500:
          description: Internal server error
          body:
            text/plain:
              example: Internal server error