-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathedge-fqm.yaml
94 lines (91 loc) · 2.43 KB
/
edge-fqm.yaml
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
openapi: 3.0.0
info:
title: edge-fqm API
version: v1
description: edge-fqm API
servers:
- url: https://falcon.ci.folio.org/fqm/
paths:
/entity-types:
get:
operationId: getEntityTypeSummary
tags:
- entityTypes
description: Get names for a list of entity type ids.
parameters:
- $ref: '#/components/parameters/entity-type-ids'
- $ref: '#/components/parameters/include-inaccessible'
responses:
'200':
description: 'Entity type summaries'
content:
application/json:
schema:
$ref: '#/components/schemas/entityTypeSummaries'
'400':
$ref: '#/components/responses/badRequestResponse'
'500':
$ref: '#/components/responses/internalServerErrorResponse'
components:
parameters:
entity-type-id:
name: entity-type-id
in: path
required: true
description: Name of the derived table
schema:
type: string
format: UUID
entity-type-ids:
name: ids
in: query
required: false
description: List of entity type ids
schema:
type: array
items:
type: string
format: UUID
include-inaccessible:
name: includeInaccessible
in: query
required: false
description: Include inaccessible entity types in the result
schema:
type: boolean
schemas:
errorResponse:
$ref: schemas/errors.json
contents:
type: array
items:
$ref: '#/components/schemas/contentItem'
contentItem:
type: object
additionalProperties:
type: object
entityTypeSummaries:
$ref: schemas/EntityTypeSummaries.json
responses:
badRequestResponse:
description: Validation errors
content:
application/json:
example:
errors:
- message: Request is invalid
code: invalid.request
total_records: 1
schema:
$ref: "#/components/schemas/errorResponse"
internalServerErrorResponse:
description: When unhandled exception occurred during code execution, e.g. NullPointerException
content:
application/json:
example:
errors:
- message: Unexpected error
code: unexpected.error
total_records: 1
schema:
$ref: "#/components/schemas/errorResponse"