Permalink
July 29, 2020 13:04
July 29, 2020 13:09
July 29, 2020 13:04
Newer
100644
155 lines (143 sloc)
3.72 KB
1
openapi: 3.0.0
2
info:
3
version: 1.1.0
4
title: ID Match API
5
description:
6
7
ID Match API Specification from Internet2 Trust and Identity, and Spherical Cow Group
8
9
security:
10
- accessCode:
11
- read
12
- write
13
servers:
14
- description: SwaggerHub API Auto Mocking
15
url: https://virtserver.swaggerhub.com/I2_TrustAndIdentity/ID_Match/1.0.0
16
17
paths:
18
/sis:
19
20
get:
21
description: Returns a list of people
22
parameters:
23
- $ref: '#/components/parameters/PageLimit'
24
- $ref: '#/components/parameters/PageOffset'
25
responses:
26
'200':
27
description: Successfully returned a list of people
28
content:
29
application/json:
30
schema:
31
type: array
32
items:
33
$ref: '#/components/schemas/corePerson'
34
'400':
35
$ref: '#/components/responses/400Error'
36
37
post:
38
description: Get a reference ID for an SoR person
39
requestBody:
40
required: true
41
content:
42
application/json:
43
schema:
44
$ref: '#/components/schemas/corePerson'
45
responses:
46
'200':
47
description: Found (or added) person record
48
'400':
49
$ref: '#/components/responses/400Error'
50
51
/sis/{sorId}:
52
get:
53
description: Obtain information about an person from his or her sorId
54
parameters:
55
- name: sorId
56
in: path
57
required: true
58
schema:
59
type: string
60
61
responses:
62
'200':
63
description: Successfully returned the requested person record
64
content:
65
application/json:
66
schema:
67
type: object
68
properties:
69
artist_name:
70
type: string
71
artist_genre:
72
type: string
73
albums_recorded:
74
type: integer
75
76
'400':
77
$ref: '#/components/responses/400Error'
78
/example:
79
get:
80
summary: Server example operation
81
description: >-
82
This is an example operation to show how security is applied to the
83
call.
84
responses:
85
'200':
86
description: OK
87
/ping:
88
get:
89
summary: Server heartbeat operation
90
description: >-
91
This operation shows how to override the global security defined above,
92
as we want to open it up for all users.
93
security: []
94
responses:
95
'200':
96
description: OK
97
98
components:
99
securitySchemes:
100
accessCode:
101
type: oauth2
102
flows:
103
authorizationCode:
104
authorizationUrl: 'http://example.com/oauth/auth'
105
tokenUrl: 'http://example.com/oauth/token'
106
scopes:
107
write: allows modifying resources
108
read: allows reading resources
109
110
schemas:
111
corePerson:
112
required:
113
- sorId
114
type: object
115
properties:
116
sorId:
117
type: integer
118
dateOfBirth:
119
type: string
120
names:
121
type: array
122
items:
123
type: object
124
properties:
125
nameType:
126
type: string
127
givenName:
128
type: string
129
familyName:
130
type: string
131
parameters:
132
PageLimit:
133
name: limit
134
in: query
135
description: Limits the number of items on a page
136
schema:
137
type: integer
138
139
PageOffset:
140
name: offset
141
in: query
142
description: Specifies the page number of the artists to be displayed
143
schema:
144
type: integer
145
146
responses:
147
400Error:
148
description: Invalid request
149
content:
150
application/json:
151
schema:
152
type: object
153
properties:
154
message:
155
type: string