@@ -7,34 +7,40 @@ description of the elements available on this form.
7
7
<img style="border:1px solid black" src="images/subscription_add_part1.png"></img>
8
8
</kbd >
9
9
10
- ** Load Subscription Template:** In this dropdown list, options are given to
10
+ ## Load Subscription Template
11
+ In this dropdown list, options are given to
11
12
select a specific template for the subscription form. Currently, the following
12
13
options are listed: Jenkins Pipeline Parametrized Job Trigger, REST POST and
13
14
Mail Trigger.
14
15
15
- ** SubscriptionName:** A field to give a name to the current subscription. Only
16
+ ## SubscriptionName
17
+ A field to give a name to the current subscription. Only
16
18
letters, underscore and numbers are allowed in this field.
17
19
18
20
<kbd >
19
21
<img style="border:1px solid black" src="images/subscription_add_part2.png"></img>
20
22
</kbd >
21
23
22
- ** NotificationType:** There are two options: REST POST and
24
+ ## NotificationType
25
+ There are two options: REST POST and
23
26
Mail Trigger, depending on how a subscriber want to be notified when a
24
27
subscription is fulfilled. If Notification type MAIL is selected an email
25
28
subject may be entered, but it is optional.
26
29
27
- ** RestPostMediaType:** Options for selecting a
30
+ ## RestPostMediaType
31
+ Options for selecting a
28
32
specific form content type. The options available in the list depends on the
29
33
selected template type.
30
34
31
- ** NotificationMessage:** It is used to send a message to a specific client. The
35
+ ## NotificationMessage
36
+ It is used to send a message to a specific client. The
32
37
format of the message depends on the options selected in the NotificationMessage
33
38
and RestPostMediaType. A button, “Add Key/Value pair”, in this field may be
34
39
used to add more messages, if the selected RestPostBodyMediaType is FORM/POST
35
40
parameters.
36
41
37
- ** NotificationMeta:** Is the selected subscriber to notify when a subscription
42
+ ## NotificationMeta
43
+ Is the selected subscriber to notify when a subscription
38
44
is triggered. It could be an email address such as ` example@mail.com ` or a url
39
45
like ` host.com/endpoint ` . If you wish to trigger Jenkins job when a subscription
40
46
is fulfilled then the url for the job could be set as the notificationMeta.
@@ -46,10 +52,11 @@ used as a password for authentication against the entire jenkins instance.
46
52
<img style="border:1px solid black" src="images/subscription_add_part3.png"></img>
47
53
</kbd >
48
54
49
- ** Authentication:** A list to select authentication type.
55
+ ## Authentication
56
+ A list to select authentication type.
50
57
* NO_AUTH: _ No Authentication used_
51
58
* BASIC_AUTH: _ Username and password will be Base 64 encoded_
52
- * BASIC_AUTH Jenkins CSRF Protection (crumb): _ Username and password will
59
+ * BASIC_AUTH_JENKINS_CSRF: Jenkins CSRF Protection (crumb), _ Username and password will
53
60
be Base 64 encoded. A crumb will be fetched automatically before request is made.
54
61
(Currently default in many Jenkins instances). ** Note** : Will work even when CSRF
55
62
is disabled in Jenkins._
@@ -58,12 +65,14 @@ is disabled in Jenkins._
58
65
<img style="border:1px solid black" src="images/subscription_add_part4.png"></img>
59
66
</kbd >
60
67
61
- ** Repeat:** It is possible to enable repeat, e.g. whether same subscription
68
+ ## Repeat
69
+ It is possible to enable repeat, e.g. whether same subscription
62
70
should be re-triggered for new additions to the aggregated object. If disabled,
63
71
the notification will be triggered only the first time when requirements are
64
72
fulfilled. It doesn't matter if you have multiple requirements, it will only be triggered once.
65
73
66
- ** Requirement and Conditions:** It is used to add a requirement, which need to
74
+ ## Requirement and Conditions
75
+ It is used to add a requirement, which need to
67
76
be fulfilled before a subscription is triggered. Requirement is added in the form
68
77
of a condition (with a specific format). More than one conditions may be added
69
78
under one requirement by using “Add Condition” button. It should be noted
0 commit comments