/
request-metadata.raml
103 lines (94 loc) · 3.33 KB
/
request-metadata.raml
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
#%RAML 1.0
title: "Request Metadata"
baseUri: https://github.com/folio-org/mod-oai-pmh
version: v1.1
documentation:
- title: Request Metadata API
content: |
API for retrieving MARC21_WITHHOLDINGS harvesting request metadata.
types:
request_metadata: !include schemas/dto/requestMetadata.json
request_metadata_collection: !include schemas/dto/requestMetadataCollection.json
uuid: !include schemas/common/uuid.json
uuid_collection: !include schemas/dto/uuidCollection.json
errors: !include raml-util/schemas/errors.schema
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
language: !include raml-util/traits/language.raml
validate: !include raml-util/traits/validation.raml
resourceTypes:
collection-get: !include raml-util/rtypes/collection-get.raml
get-only: !include raml-util/rtypes/get-only.raml
/oai/request-metadata:
displayName: OAIPMH Request Metadata API
description: Service that allows to retrieve Request Metadata Collection
type:
collection-get:
exampleCollection: !include examples/requestMetadata.sample
exampleItem: !include examples/requestMetadataCollection.sample
schemaCollection: request_metadata_collection
schemaItem: request_metadata
is: [validate]
get:
description: Get list of request metadata
is: [pageable]
/{requestId}/failed-to-save-instances:
description: Service that allows to retrieve UUIDs of failed to save instances
type:
get-only:
exampleCollection: !include examples/uuidCollection.sample
schema: uuid_collection
is: [ validate ]
get:
description: Get list of failed to save instances UUIDs
is: [ pageable ]
/{requestId}/skipped-instances:
description: Service that allows to retrieve UUIDs of skipped instances
type:
get-only:
exampleCollection: !include examples/uuidCollection.sample
schema: uuid_collection
is: [ validate ]
get:
description: Get list of skipped instances UUIDs
is: [ pageable ]
/{requestId}/failed-instances:
description: Service that allows to retrieve UUIDs of failed instances
type:
get-only:
exampleCollection: !include examples/uuidCollection.sample
schema: uuid_collection
is: [ validate ]
get:
description: Get list of failed instances UUIDs
is: [ pageable ]
/{requestId}/suppressed-from-discovery-instances:
description: Service that allows to retrieve UUIDs of suppressed from discovery instances
type:
get-only:
exampleCollection: !include examples/uuidCollection.sample
schema: uuid_collection
is: [ validate ]
get:
description: Get list of suppressed from discovery instances UUIDs
is: [ pageable ]
/{requestId}/logs:
description: Service that allows to retrieve error log by request id
get:
responses:
200:
body:
binary/octet-stream:
404:
description: "Not found"
body:
text/plain:
example: "Not found"
500:
description: "Internal server error, e.g. due to misconfiguration"
body:
text/plain:
example: "Internal server error, contact administrator"