-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
163 lines (158 loc) · 4.08 KB
/
openapi.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
156
157
158
159
160
161
162
163
openapi: 3.0.3
info:
title: Faethm API
description: "API definitions for CobraKai project."
version: 0.1.0
paths:
/skills/extract:
post:
tags:
- skills
summary: Skill Exploder (API 1)
description: Return a set of skills identified from text input
requestBody:
description: Text that needs to be analyzed
content:
application/json:
schema:
type: object
properties:
description:
type: string
required: true
responses:
200:
description: List of extracted skills
content:
application/json:
schema:
type: object
properties:
skills:
type: array
items:
type: string
/skills/courses:
get:
tags:
- skills
summary: Skill Explorer (courses, API 3)
description: Return a set of courses identified from skill names
parameters:
- name: skills
in: query
description: Skills to find courses for
required: true
schema:
type: array
items:
type: string
responses:
200:
description: Best matched courses
content:
application/json:
schema:
type: object
properties:
courses:
type: array
items:
type: string
/skills/jobs:
get:
tags:
- skills
summary: Skill Explorer (jobs, API 4)
description: Return a set of jobs identified from skill names
parameters:
- name: skills
in: query
description: Skills to find jobs for
required: true
schema:
type: array
items:
type: string
responses:
200:
description: Best matched jobs
content:
application/json:
schema:
type: object
properties:
jobs:
type: array
items:
type: string
/skills/{skill}/insight:
get:
tags:
- skills
summary: Return insights from skill name (API 5)
parameters:
- name: skill
in: path
required: true
schema:
type: string
- name: region
in: query
schema:
type: string
responses:
200:
description: SCHEMA TBD; top jobs and mentions; monthly total mentions; related skills
content:
application/json:
schema: {}
/jobs/match:
post:
tags:
- jobs
summary: Job Expander (API 2)
description: Return a set of likely jobs from text input
requestBody:
description: Text that needs to be analyzed
content:
application/json:
schema:
type: object
properties:
title:
type: string
description:
type: string
required: true
responses:
200:
description: SCHEMA TBD List of jobs with descriptions and other data points
content:
application/json:
schema:
type: object
properties: {}
/jobs/{job}/insight:
get:
tags:
- jobs
summary: Return insights from job name (API 6)
parameters:
- name: job
in: path
required: true
schema:
type: string
- name: region
in: query
schema:
type: string
responses:
200:
description: SCHEMA TBD top skills by mentions; top skills by specificity; monthly total mentions; related jobs
content:
application/json:
schema:
type: object
properties: {}