-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathplugin.yaml
More file actions
100 lines (97 loc) · 2.67 KB
/
plugin.yaml
File metadata and controls
100 lines (97 loc) · 2.67 KB
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
---
# This is a sample Swagger spec, describing a simple API as a starting point.
swagger: "2.0"
info:
description: "This is an example of a simple API"
version: "1.0.0"
title: "Swagger Example"
host: localhost:8080
basePath: /api
# Tags organize operations into groups for presentation in the Swagger UI.
# Each tag has an optional description, which the Swagger UI will display in
# the tag group header.
tags:
- name: "Plugin"
description: "the Plugin to use for data processing"
paths:
/Plugin:
post:
tags:
- Plugin
summary: Upload Plugin
description: This can only be done by the logged in user.
operationId: createPlugin
consumes:
- "application/x-www-form-urlencoded"
produces:
- application/json
- application/xml
- application/avro
parameters:
- in: formData
name: json
description: Uploaded Plugin
required: true
type: string
- in: formData
name: jarFile
description: Jar File to upload
required: true
type: file
- in: formData
name: configFile
description: config File to upload
required: true
type: file
responses:
default:
description: successful operation
/Plugin/{pluginID}:
get:
tags:
- Plugin
summary: Get Plugin by Plugin ID
description: ""
operationId: getPluginByID
produces:
- application/json
- application/xml
- application/avro
parameters:
- in: path
name: pluginID
description: The ID for the Plugin that needs to be fetched.
required: true
type: string
- in: query
name: datatype
description: The type of data to return.
required: false
type: string
responses:
"404":
description: Plugin not found
"200":
description: successful operation
schema:
$ref: "#/definitions/Plugin"
"400":
description: Invalid Plugin ID supplied
# The definitions section contains a set of named Schema Objects. Each schema
# object describes a reusable data type, which can be reference by name.
definitions:
Plugin:
type: object
properties:
analyticID:
type: string
status:
type: string
format: enum
description: Plugin Status
schemaID:
type: string
jarFileName:
type: string
configFileName:
type: string