Skip to content

Commit abaa606

Browse files
Fix subscription documentation (#287)
* Fix subscription documentation for 3.0.0 API * Update version in pom.xml
1 parent 71c6001 commit abaa606

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<modelVersion>4.0.0</modelVersion>
77
<groupId>com.github.ericsson</groupId>
88
<artifactId>eiffel-intelligence-frontend</artifactId>
9-
<version>3.0.0</version>
9+
<version>3.0.1-SNAPSHOT</version>
1010
<packaging>war</packaging>
1111

1212
<parent>

wiki/curl-examples.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,16 @@ Example curl commands to these endpoints [can be found here](https://github.com/
331331
</td>
332332
</tr>
333333
<tr>
334-
<td>/subscriptions/{subscriptionName}</td>
334+
<td>/subscriptions?subscriptionNames={name1},{name2}</td>
335+
<td>GET</td>
336+
<td>
337+
Fetches information about one or more subscriptions from the back-end. The parameter
338+
subscriptionNames can take a comma separated list of names.
339+
</td>
340+
</tr>
341+
</tr>
342+
<tr>
343+
<td>/subscriptions/{name}</td>
335344
<td>GET</td>
336345
<td>Fetches information about a single subscription from the back-end</td>
337346
</tr>
@@ -345,18 +354,18 @@ Example curl commands to these endpoints [can be found here](https://github.com/
345354
<td>PUT</td>
346355
<td>Request to update one (or more) subscription object(s) included in JSON format</td>
347356
</tr>
348-
<tr>
349-
<td>/subscriptions</td>
357+
<tr>
358+
<td>/subscriptions?subscriptionNames={name1}</td>
350359
<td>DELETE</td>
351360
<td>
352-
Selected subscriptions can be deleted by using the required subscriptionNames parameter
361+
One (or more) subscription(s) can be deleted by using the required subscriptionNames parameter
353362
and a comma separated list e.g. subscriptionNames={name1},{name2}
354363
</td>
355364
</tr>
356365
<tr>
357-
<td>/subscriptions/{subscriptionName}</td>
366+
<td>/subscriptions/{name}</td>
358367
<td>DELETE</td>
359-
<td>Deletes a single (or multiple) subscription(s) from the back-end</td>
368+
<td>Deletes a single subscription from the back-end</td>
360369
</tr>
361370
</table>
362371

@@ -374,7 +383,7 @@ The `backendurl` parameters is passed in to use a specified instance instead of
374383

375384
curl -X GET http://localhost:8080/subscriptions?backendurl="http://127.0.0.1:8090/"
376385

377-
The back-end used is running on localhost and port 8080. EI front-end forwards the request to 127.0.0.1
386+
The front-end used is running on localhost and port 8080. EI front-end forwards the request to 127.0.0.1
378387
and port 8090 as requested in the query parameters and the result is a list of existing subscriptions:
379388

380389
[

0 commit comments

Comments
 (0)