Skip to content

Commit b7edb8c

Browse files
Update subscription API documentation (#418)
Add missing API description in table. Rearranged order of GET and POST operations. Add info on mongodb database.
1 parent ca327a8 commit b7edb8c

File tree

2 files changed

+31
-28
lines changed

2 files changed

+31
-28
lines changed

wiki/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,8 @@ If encryption of the MongoDB password is desired there is information [here](con
173173
* spring.data.mongodb.uri
174174
* spring.data.mongodb.database
175175

176+
The second property **spring.data.mongodb.database** defines a name for the database.
177+
176178
## RabbitMQ
177179

178180
You can configure the RabbitMQ settings using the rabbitmq.* properties.

wiki/subscription-API.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,14 @@
22

33
|Method|Endpoint |Authentication|
44
|------|----------------------------------------|--------------|
5-
|POST |/subscriptions |yes |
65
|GET |/subscriptions |no |
76
|GET |/subscriptions/\<name\> |no |
7+
|GET |/subscriptions?subscriptionNames=\<name\> |no |
8+
|POST |/subscriptions |yes |
89
|PUT |/subscriptions |yes |
910
|DELETE|/subscriptions |yes |
1011
|DELETE|/subscriptions/\<name\> |yes |
1112

12-
## Create Subscriptions
13-
14-
Takes one or several subscriptions in a JSON array as input. If LDAP is
15-
activated, the username of the person registering this subscription is
16-
included when saving the subscription in the database. The subscription
17-
name needs to be unique.
18-
19-
POST /subscriptions
20-
21-
### Curl Command Example
22-
23-
curl -X POST -H "Content-type: application/json" --data @<path to file> http://<host>:8090/subscriptions
24-
25-
Eiffel Intelligence takes a JSON list of one or several subscription objects.
26-
Example of a subscription array input:
27-
28-
[
29-
{
30-
..Subscription 1..
31-
},
32-
{
33-
..Subscription 2..
34-
}
35-
]
36-
37-
Guidelines for writing requirements and conditions for creating subscriptions can be found [here](subscriptions.md#writing-requirements-and-conditions)
38-
3913
## Get All subscriptions
4014

4115
Retrieves all the subscriptions
@@ -66,6 +40,33 @@ Curl command example
6640

6741
curl -X GET -H "Content-type: application/json" http://<host>:8090/subscriptions/<name>
6842

43+
## Create Subscriptions
44+
45+
Takes one or several subscriptions in a JSON array as input. If LDAP is
46+
activated, the username of the person registering this subscription is
47+
included when saving the subscription in the database. The subscription
48+
name needs to be unique.
49+
50+
POST /subscriptions
51+
52+
### Curl Command Example
53+
54+
curl -X POST -H "Content-type: application/json" --data @<path to file> http://<host>:8090/subscriptions
55+
56+
Eiffel Intelligence takes a JSON list of one or several subscription objects.
57+
Example of a subscription array input:
58+
59+
[
60+
{
61+
..Subscription 1..
62+
},
63+
{
64+
..Subscription 2..
65+
}
66+
]
67+
68+
Guidelines for writing requirements and conditions for creating subscriptions can be found [here](subscriptions.md#writing-requirements-and-conditions)
69+
6970
## Update Subscriptions
7071

7172
Modify existing Subscriptions based on subscriptionName. Multiple subscriptions

0 commit comments

Comments
 (0)