generated from peter-evans/swagger-github-pages
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
155 lines (155 loc) · 3.85 KB
/
swagger.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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
---
swagger: "2.0"
info:
description: "CBDB Swagger UI"
version: "1.0.5"
title: "Swagger CBDB"
termsOfService: "https://creativecommons.org/licenses/by-nc-sa/4.0/"
contact:
email: "[email protected]"
license:
name: "CC BY-NC-SA 4.0 DEED"
url: "https://creativecommons.org/licenses/by-nc-sa/4.0/"
host: "cbdb.fas.harvard.edu"
basePath: "/cbdbapi"
tags:
- name: "person"
description: "Query person information"
externalDocs:
description: "Find out more"
url: "cbdb.fas.harvard.edu/cbdbapi"
schemes:
- "https"
- "http"
paths:
/person.php?id={personid}&o=json:
get:
tags:
- "person"
summary: "Find person json data by ID"
description: "Returns a single person using json"
operationId: "getPersonJSONById"
produces:
- "application/json"
parameters:
- name: "personid"
in: "path"
description: "ID of person to return"
required: true
type: "integer"
format: "int64"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Person"
404:
description: "Person not found"
security:
- api_key: []
/person.php?id={personid}&o=xml:
get:
tags:
- "person"
summary: "Find person xml data by ID"
description: "Returns a single person using xml"
operationId: "getPersonXMLById"
produces:
- "application/xml"
parameters:
- name: "personid"
in: "path"
description: "ID of person to return"
required: true
type: "integer"
format: "int64"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Person"
404:
description: "Person not found"
security:
- api_key: []
/person.php?name={personname}&o=json:
get:
tags:
- "person"
summary: "Find person json data by name"
description: "Returns person json information by name"
operationId: "getPersonJSONByName"
produces:
- "application/json"
parameters:
- name: "personname"
in: "path"
description: "ID of person to return"
required: true
type: "string"
format: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Person"
404:
description: "Person not found"
security:
- api_key: []
/person.php?name={personname}&o=xml:
get:
tags:
- "person"
summary: "Find person xml data by name"
description: "Returns person xml information by name"
operationId: "getPersonXMLByName"
produces:
- "application/xml"
parameters:
- name: "personname"
in: "path"
description: "ID of person to return"
required: true
type: "string"
format: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Person"
404:
description: "Person not found"
security:
- api_key: []
securityDefinitions:
api_key:
type: "apiKey"
name: "api_key"
in: "header"
petstore_auth:
type: "oauth2"
authorizationUrl: "https://petstore.swagger.io/oauth/authorize"
flow: "implicit"
scopes:
read:pets: "read your pets"
write:pets: "modify pets in your account"
definitions:
Person:
type: "object"
required:
- "PersonInfo"
properties:
PersonInfo:
type: "array"
xml:
wrapped: true
items:
type: "string"
xml:
name: "PersonInfo"
xml:
name: "Person"
externalDocs:
description: "Find out more about CBDB"
url: "https://projects.iq.harvard.edu/cbdb"