plugin.adoc 2.75 KB
Newer Older
1
= Rest API Documentation - Plugins
Piotr Gawron's avatar
Piotr Gawron committed
2
minerva
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
v{project-version} {build-time}
:toc: left
:sectnums:

== List registered plugins on the server
=== CURL sample
include::{snippets}/plugin/list_plugins/curl-request.adoc[]

=== Response Fields
include::{snippets}/plugin/list_plugins/response-fields.adoc[]

=== Sample Response
include::{snippets}/plugin/list_plugins/response-body.adoc[]


== Register new plugin on the server
=== CURL sample
include::{snippets}/plugin/create_plugin/curl-request.adoc[]

=== Request Parameters
include::{snippets}/plugin/create_plugin/request-parameters.adoc[]

=== Response Fields
include::{snippets}/plugin/create_plugin/response-fields.adoc[]

=== Sample Response
include::{snippets}/plugin/create_plugin/response-body.adoc[]


== Access information about plugin
=== CURL sample
include::{snippets}/plugin/get_plugin/curl-request.adoc[]

=== Path Parameters
include::{snippets}/plugin/get_plugin/path-parameters.adoc[]

=== Response Fields
include::{snippets}/plugin/get_plugin/response-fields.adoc[]

=== Sample Response
include::{snippets}/plugin/get_plugin/response-body.adoc[]


== Set global plugin parameter
=== CURL sample
include::{snippets}/plugin/set_plugin_data/curl-request.adoc[]

=== Path Parameters
include::{snippets}/plugin/set_plugin_data/path-parameters.adoc[]

=== Request Parameters
include::{snippets}/plugin/set_plugin_data/request-parameters.adoc[]

=== Response Fields
include::{snippets}/plugin/set_plugin_data/response-fields.adoc[]

=== Sample Response
include::{snippets}/plugin/set_plugin_data/response-body.adoc[]

== Get global plugin parameter
=== Path Parameters
include::{snippets}/plugin/get_plugin_data/path-parameters.adoc[]

=== Response Fields
include::{snippets}/plugin/get_plugin_data/response-fields.adoc[]

=== CURL sample
include::{snippets}/plugin/get_plugin_data/curl-request.adoc[]

=== Sample Response
include::{snippets}/plugin/get_plugin_data/response-body.adoc[]

== Set user plugin parameter
=== CURL sample
include::{snippets}/plugin/set_user_plugin_data/curl-request.adoc[]

=== Path Parameters
include::{snippets}/plugin/set_user_plugin_data/path-parameters.adoc[]

=== Request Parameters
include::{snippets}/plugin/set_user_plugin_data/request-parameters.adoc[]

=== Response Fields
include::{snippets}/plugin/set_user_plugin_data/response-fields.adoc[]

=== Sample Response
include::{snippets}/plugin/set_user_plugin_data/response-body.adoc[]

== Get user plugin parameter
=== Path Parameters
include::{snippets}/plugin/get_user_plugin_data/path-parameters.adoc[]

=== Response Fields
include::{snippets}/plugin/get_user_plugin_data/response-fields.adoc[]

=== CURL sample
include::{snippets}/plugin/get_user_plugin_data/curl-request.adoc[]

=== Sample Response
include::{snippets}/plugin/get_user_plugin_data/response-body.adoc[]