-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yml
154 lines (145 loc) · 4.82 KB
/
swagger.yml
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
swagger: "2.0"
info:
description: Description for the DevSpec Engine endpoints for DevSpec v1.0.0
version: "1.0.0"
title: DevSpec Core Engine API Description
consumes:
- application/json
produces:
- application/json
basePath: /v1
# Paths supported by the server application
paths:
/analysis:
get:
operationId: main.analyze
tags:
- Analyze
summary: Conduct the analysis and return the user the topic coherence details for each topic
description: Returns topic coherence details
parameters:
- name: start
in: query
type: integer
description: The name start time to analyze discussions
- name: end
in: query
type: integer
description: The name end time to analyze discussions
- name: topics
in: query
type: integer
description: The number of topics defined by user
- name: keywords
in: query
type: string
description: topic and keyword pairs
- name: discussions
in: query
type: integer
description: Number of individual discussions included in final summary per each topic
responses:
200:
description: Successful completed the analysis
schema:
type: string
/w2wmodel:
get:
operationId: main.w2wmodel
tags:
- Subreddits
summary: Check if the W2W model is trained for the given subreddit. IF not train the relavent W2W model.
description: Returns TRUE once the model is tranined or the model is already existing
parameters:
- name: game
in: query
type: string
description: The name of the subreddit that the word2vec model needs to be constructed
responses:
200:
description: Successful completed the analysis
schema:
type: string
/results:
get:
operationId: main.results
tags:
- Analyze
summary: Return the summary and the group of id's for each topic declared by the end user.
description: Returns TRUE once the model is tranined or the model is already existing
responses:
200:
description: Successful completed the analysis
schema:
type: array
items:
properties:
name:
type: string
description: the name of the category
ids:
type: array
description: the ids for each category
summary:
type: string
description: the summary of each category
# /subreddits:
# get:
# operationId: main.list
# tags:
# - Subreddits
# summary: This will search the GCP bucket to retrive all files and will list all the folders Note- all subreddits have a unique name hence no ID is required
# description: Returns a list of subreddits that are included in the system
# responses:
# 200:
# description: Successfully retrived the list of subreddits
# schema:
# type: array
# items:
# properties:
# name:
# type: string
# description: the name of the subreddit
# /categories:
# get:
# operationId: main.categories
# tags:
# - Analyze
# summary: return the categories defined by the user and the discussions that belong to those categories. the categories will be further devided into 5 sub categories according to user intention
# description: Return categories
# responses:
# 200:
# description: Successful retrived the list of categories
# schema:
# type: array
# items:
# properties:
# name:
# type: string
# description: the name of the category
# ids:
# type: array
# description: the ids for each category
# /summaries:
# get:
# operationId: main.summaries
# tags:
# - Analyze
# summary: return the summary for each sub category
# description: Return summaries
# responses:
# 200:
# description: Successful retrived the list of summaries
# schema:
# type: array
# items:
# properties:
# name:
# type: string
# description: the name of the category
# subname:
# type: string
# description: the name of the subcategory
# sumary:
# type: string
# description: the summary for each item