-
Notifications
You must be signed in to change notification settings - Fork 2
/
swagger.yaml
155 lines (154 loc) · 3.89 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: "This is the OpenAPI spec for Training Provider Outcomes Toolkit API."
version: "1.0.0"
title: "TPOT-API"
contact:
email: "[email protected]"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
basePath: "/api/v0"
host: tpot-etp-api.herokuapp.com
schemes:
- "https"
paths:
/provider:
get:
tags:
- "provider"
summary: "Get all training providers"
description: "Return a list of all training providers"
operationId: apis.provider.ProviderList
produces:
- "application/json"
parameters:
- in: "header"
name: "X-Fields"
required: false
description: "An optional fields mask"
type: "string"
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/Provider"
/provider/{provider_id}:
get:
tags:
- "provider"
summary: "Find a provider by ID"
description: "Returns a single provider"
operationId: apis.provider.Provider
produces:
- "application/json"
parameters:
- name: provider_id
in: path
description: "ID of provider to return"
required: true
type: "integer"
format: "int64"
- name: "X-Fields"
in: header
required: false
description: "An optional fields mask"
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Provider"
400:
description: "Invalid ID supplied"
404:
description: "Provider not found"
/program/{provider_id}:
get:
tags:
- "program"
summary: "Get all programs given a provider ID"
description: "Returns all programs given the provider's identifier"
operationId: apis.program.Program
produces:
- "application/json"
parameters:
- name: provider_id
in: path
description: "ID of provider to which the programs belong"
required: true
type: "integer"
format: "int64"
- name: "X-Fields"
in: header
required: false
description: "An optional fields mask"
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Program"
400:
description: "Invalid ID supplied"
404:
description: "Program not found"
/outcome/{provider_id}/{program_id}:
get:
tags:
- "outcome"
summary: "Get all programs given the provider ID"
description: "Returns all programs given the provider's identifier"
operationId: apis.outcome.Program
produces:
- "application/json"
parameters:
- name: provider_id
in: path
description: "The provider identifier"
required: true
type: "integer"
format: "int64"
- name: program_id
in: path
description: "The program CIP code"
required: true
type: "integer"
format: "int64"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Provider"
400:
description: "Invalid ID supplied"
404:
description: "Program not found"
definitions:
Provider:
type: "object"
required:
- "provider_name"
properties:
provider_id:
type: "integer"
format: "int64"
provider_name:
type: "string"
provider_type:
type: "string"
xml:
name: "Provider"
Program:
type: "object"
required:
- "program_type"
properties:
program_cip:
type: "string"
program_type:
type: "string"
xml:
name: "Program"