-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
162 lines (162 loc) · 4.57 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
156
157
158
159
160
161
162
swagger: '2.0'
info:
description: 'A REST API used to identify dependencies from requirements. Requirements are stored in a JSON file. The dependencies are detailed in an input ontology, which is used to support the detection.'
version: '1.0'
title: Dependency detection RESTful API
contact:
name: UPC-GESSI (OpenReq)
url: 'http://openreq.eu/'
license:
name: EPL-v1.0
url: 'https://www.eclipse.org/legal/epl-v10.html'
host: api.openreq.eu
basePath: /dependency-detection
tags:
- name: Cross-reference detection Service
description: API related to cross-reference detection
- name: controller
description: Controller
paths:
'/upc/dependency-detection/json/ontology/{projectId}':
post:
tags:
- controller
summary: Uploads JSON and Ontology files to detect dependencies
description: 'Uploads an ontology (in RDF/XML language) and a JSON Object to the server, extracts the dependencies of all the project''s requirements stored in JSON by the support of the ontology and finally removes the uploaded files.'
operationId: uploadJSONFileUsingPOST
consumes:
- multipart/form-data
produces:
- '*/*'
parameters:
- name: ontology
in: formData
description: The Ontology file to upload (RDF/XML lang.)
required: true
type: file
- name: json
in: formData
description: The JSON file to upload
required: true
type: string
- name: projectId
in: path
description: Id of the project where the requirements to analize are.
required: true
type: string
- name: synonymy
in: query
description: 'If true, semantic similarity (synonymy) detection is applied to improve the detection algorithm.'
required: false
type: boolean
default: false
- name: threshold
in: query
description: Threshold of semantic similarity to detect synonyms (included).
required: false
type: number
format: double
- name: keywordTool
in: query
description: Keyword extraction tool (RULE_BASED or TFIDF_BASED)
required: false
type: string
default: RULE_BASED
enum:
- RULE_BASED
- TFIDF_BASED
responses:
'400':
description: 'Non content: There is no content to submit.'
'200':
description: 'OK: The request has succeeded.'
schema:
type: string
'201':
description: 'Created: The request has been fulfilled and has resulted in one or more new resources being created.'
schema:
type: string
'401':
description: 'Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.'
'403':
description: 'Forbidden: The server understood the request but refuses to authorize it.'
'404':
description: 'Not Found: The server could not find what was requested by the client.'
'500':
description: Internal Server Error. For more information see ‘message’ in the Response Body.
definitions:
ResponseEntity:
type: object
properties:
body:
type: object
statusCode:
type: string
enum:
- '100'
- '101'
- '102'
- '103'
- '200'
- '201'
- '202'
- '203'
- '204'
- '205'
- '206'
- '207'
- '208'
- '226'
- '300'
- '301'
- '302'
- '303'
- '304'
- '305'
- '307'
- '308'
- '400'
- '401'
- '402'
- '403'
- '404'
- '405'
- '406'
- '407'
- '408'
- '409'
- '410'
- '411'
- '412'
- '413'
- '414'
- '415'
- '416'
- '417'
- '418'
- '419'
- '420'
- '421'
- '422'
- '423'
- '424'
- '426'
- '428'
- '429'
- '431'
- '451'
- '500'
- '501'
- '502'
- '503'
- '504'
- '505'
- '506'
- '507'
- '508'
- '509'
- '510'
- '511'
statusCodeValue:
type: integer
format: int32