blob: 79edd409d5d55f925aff19f310803f8e100e1d83 (
plain)
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
swagger: "2.0"
info:
description: "These are the APIs for the ONAP VNFSDK Marketplace. VNFSDK helps to package and validate VNFs for onboarding into ONAP. You can find out more about VNFSDK at [http://onap.readthedocs.io](http://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.html)."
version: "1.0.0"
title: "ONAP VNFSDK"
contact:
email: "onap-discuss@lists.onap.org"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "onap.readthedocs.io"
basePath: "/onapapi/marketplace/v1"
tags:
- name: "csars"
description: "VNF CSAR information"
externalDocs:
description: "Find out more"
url: "http://wiki.onap.org"
schemes:
- "http"
paths:
/csars:
get:
summary: "Query VNF Package by conditions"
description: "Query VNF package"
operationId: "queryVnf"
produces:
- "application/json"
tags:
- "VNF package"
parameters:
- name: "conditions"
in: "query"
description: "Conditions that need to be considered for filter"
required: true
type: "array"
items:
type: "string"
collectionFormat: "multi"
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/Csars"
400:
description: "Invalid status value"
post:
summary: "Upload/Re-Upload VNF Package"
description: ""
operationId: "addVnf"
consumes:
- "multipart/form-data"
produces:
- "application/json"
tags:
- "VNF package"
parameters:
- in: "body"
name: "body"
description: "VNF objects to add to the Marketplace"
required: true
schema:
$ref: "#/definitions/Csars"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/ApiResponse"
/csars/{csarId}:
get:
tags:
- "csarId"
summary: "Find vnf by CSAR ID"
description: "Returns a single vnf"
operationId: "getVnfByCsarId"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "csarId"
in: "path"
description: "CSAR ID of VNF to return"
required: true
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Csars"
400:
description: "Invalid ID supplied"
404:
description: "VNF not found"
post:
tags:
- "csarId"
summary: "Updates a VNF in the Marketplace with form data"
description: ""
operationId: "updateCsar"
consumes:
- "application/x-www-form-urlencoded"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "csarId"
in: "path"
description: "CSAR ID of VNF that needs to be updated"
required: true
type: "string"
- name: "name"
in: "formData"
description: "Updated name of the VNF"
required: false
type: "string"
- name: "fileNamee"
in: "formData"
description: "Updated filename of the csar"
required: false
type: "string"
responses:
405:
description: "Invalid input"
delete:
tags:
- "csarId"
summary: "Deletes a VNF"
description: ""
operationId: "deleteVnf"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "csarId"
in: "path"
description: "VNF CSAR ID to delete"
required: true
type: "string"
responses:
400:
description: "Invalid ID supplied"
/csars/{csarId}/files:
get:
tags:
- "csarId"
summary: "Download vnf"
description: "Download a single vnf"
operationId: "downloadVnf"
produces:
- "application/xml"
- "application/json"
parameters:
- name: "csarId"
in: "path"
description: "CSAR ID of VNF to return"
required: true
type: "string"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/Csars"
400:
description: "Invalid ID supplied"
404:
description: "VNF not found"
definitions:
Csars:
type: "object"
required:
- "csarId"
properties:
type:
type: "string"
example: "CSAR"
name:
type: "string"
example: "NanocellGateway"
fileName:
type: "string"
creationDate:
type: "string"
modificationDate:
type: "string"
readDate:
type: "string"
size:
type: "string"
example: "37 MB"
provider:
type: "string"
example: "XYZ"
version:
type: "string"
example: "v1.0.0"
createTime:
type: "string"
modifyTime:
type: "string"
downloadUri:
type: "string"
example: "http://msb_ip:msb_port/files/marketplace/CSAR/XYZ/NanocellGW/v1.0"
shortdesc:
type: "string"
example: "XYZ Nanocell Gateway VNF"
details:
type: "string"
csarId:
type: "string"
example: "78ede6f3-66cc-46ab-b748-38a6c010d272"
parameters:
type: "array"
xml:
name: "parameters"
wrapped: true
items:
type: "string"
xml:
name: "Csars"
ApiResponse:
type: "object"
properties:
code:
type: "integer"
format: "int32"
type:
type: "string"
message:
type: "string"
externalDocs:
description: "Find out more about VNFSDK"
url: "https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/index.html"
|
