Skip to content

Commit 624541d

Browse files
shubhamkumarguptaTCSShubham Gupta C
andauthored
Update documentation for curl commands (#187)
* Updated documentation for ER lookup retry strategy * Remrem generate curl commands documentation updated Co-authored-by: Shubham Gupta C <shubham.c.gupta@ericsson.com>
1 parent 571038c commit 624541d

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
## 2.1.5
22
- Introduced new (/message_protocols) Endpoint which returns the available message protocols list and their respective edition names.
3+
- Updated all curl commands in documentation
34

45
## 2.1.4
56
- Fixed issue related to ER lookup strategy in REMReM-generate.

wiki/markdown/usage/service.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ You can use command line tools like [curl](https://curl.haxx.se/) or some plugin
4949
#### Given one message in file _body-single.json_:
5050

5151
```
52-
curl -XPOST -H "Content-Type: application/json" --data @body-single.json http://localhost:8080/generate-service/eiffelsemantics?msgType=eiffelactivityfinished
52+
curl -XPOST -H "Content-Type: application/json" --data @body-single.json 'http://localhost:8080/generate-service/eiffelsemantics?msgType=EiffelActivityFinishedEvent&failIfMultipleFound=false&failIfNoneFound=false&lookupInExternalERs=false&lookupLimit=1&okToLeaveOutInvalidOptionalFields=false'
5353
```
5454

5555
Result:
@@ -61,12 +61,12 @@ Result:
6161
#### Example with event body passed to service:
6262

6363
```
64-
curl -H "Content-Type: application/json" -X POST -d '{"msgParams": {"meta": {"type": "EiffelActivityFinishedEvent", "tags": ["tag1","tag2"], "source": {"domainId": "example.domain", "host": "host", "name": "name", "uri":http://java.sun.com/j2se/1.3/"}}}, "eventParams": {"data": {"outcome": {"conclusion": "SUCCESSFUL"}, "persistentLogs": [], "links": [{"type": "ACTIVITY_EXECUTION", "target": "69538470-4c3f-4c16-b84e-64ff0275f6fc"}]}}' http://localhost:8080/generate-service/eiffelsemantics?msgType=eiffelactivityfinished
64+
curl -H "Content-Type: application/json" -X POST -d '{"msgParams": {"meta": {"type": "EiffelActivityFinishedEvent","tags": ["tag1", "tag2"],"source": {"domainId": "example.domain","host": "host","name": "name","uri": "http://java.sun.com/j2se/1.3/"}}},"eventParams": {"data": {"outcome": {"conclusion": "SUCCESSFUL","description": ""},"persistentLogs": [],"customData": []},"links": [{"type": "ACTIVITY_EXECUTION","target": "8b360a88-ae8e-4aec-811f-3017119a4acc"}]}}' 'http://localhost:8080/generate-service/eiffelsemantics?msgType=EiffelActivityFinishedEvent&failIfMultipleFound=false&failIfNoneFound=false&lookupInExternalERs=false&lookupLimit=1&okToLeaveOutInvalidOptionalFields=false'
6565
```
6666
Result:
6767

6868
```
69-
{"meta":{"id":"29f9b8b1-9d4b-41cf-9f42-4e6157850757","type":"EiffelActivityFinishedEvent","version":"3.0.0","time":1499076743638,"tags":["tag1","tag2"],"source":{"domainId":"example.domain","host":"host","name":"name","serializer":"pkg:maven/com.github.eiffel-community/eiffel-remrem-semantics@2.0.4","uri":http://java.sun.com/j2se/1.3/"}}"data":{"outcome":{"conclusion":"SUCCESSFUL","description":"The Result was Successful"},"persistentLogs":[],"customData":[{"key":"translatedSourceID","value":"29f9b8b1-9d4b-41cf-9f42-4e6157850757"}]},"links":[{"type":"ACTIVITY_EXECUTION","target":"69538470-4c3f-4c16-b84e-64ff0275f6fc"},{"type":"FLOW_CONTEXT","target":"ea82a50c-53bb-4d0c-8f03-b50fb83feb16"}]}
69+
{"meta":{"id":"abae00be-352b-40ed-9b51-4fb01c610a81","type":"EiffelActivityFinishedEvent","version":"3.0.0","time":1638505573517,"tags":["tag1","tag2"],"source":{"domainId":"example.domain","host":"host","name":"name","serializer":"pkg:maven/com.github.eiffel-community/eiffel-remrem-semantics@2.1.0","uri":"http://java.sun.com/j2se/1.3/"}},"data":{"outcome":{"conclusion":"SUCCESSFUL","description":""},"persistentLogs":[],"customData":[]},"links":[{"type":"ACTIVITY_EXECUTION","target":"8b360a88-ae8e-4aec-811f-3017119a4acc"}]}
7070
```
7171

7272
### Examples for `/event_types/{mp}` endpoint
@@ -80,7 +80,7 @@ curl -X GET --header 'Accept: application/json' 'http://localhost:8080/generate-
8080
Result:
8181

8282
```
83-
["EiffelArtifactPublishedEvent","EiffelActivityFinishedEvent","EiffelActivityCanceledEvent","EiffelArtifactCreatedEvent","EiffelActivityTriggeredEvent","EiffelConfidenceLevelModifiedEvent","EiffelActivityStartedEvent","EiffelAnnouncementPublishedEvent","EiffelCompositionDefinedEvent","EiffelTestCaseCanceledEvent","EiffelTestCaseTriggeredEvent","EiffelTestExecutionRecipeCollectionCreatedEvent","EiffelEnvironmentDefinedEvent","EiffelFlowContextDefinedEvent","EiffelSourceChangeCreatedEvent","EiffelSourceChangeSubmittedEvent","EiffelTestCaseFinishedEvent","EiffelTestCaseStartedEvent","EiffelTestSuiteFinishedEvent","EiffelTestSuiteStartedEvent","EiffelIssueVerifiedEvent","EiffelArtifactReusedEvent","EiffelServiceStoppedEvent","EiffelServiceStartedEvent","EiffelServiceReturnedEvent","EiffelServiceDiscontinuedEvent","EiffelServiceDeployedEvent","EiffelServiceAllocatedEvent","EiffelArtifactDeployedEvent","EiffelAlertAcknowledgedEvent","EiffelAlertCeasedEvent","EiffelAlertRaisedEvent"]
83+
["EiffelArtifactPublishedEvent","EiffelActivityFinishedEvent","EiffelActivityCanceledEvent","EiffelArtifactCreatedEvent","EiffelActivityTriggeredEvent","EiffelConfidenceLevelModifiedEvent","EiffelActivityStartedEvent","EiffelAnnouncementPublishedEvent","EiffelCompositionDefinedEvent","EiffelTestCaseCanceledEvent","EiffelTestCaseTriggeredEvent","EiffelTestExecutionRecipeCollectionCreatedEvent","EiffelEnvironmentDefinedEvent","EiffelFlowContextDefinedEvent","EiffelSourceChangeCreatedEvent","EiffelSourceChangeSubmittedEvent","EiffelTestCaseFinishedEvent","EiffelTestCaseStartedEvent","EiffelTestSuiteFinishedEvent","EiffelTestSuiteStartedEvent","EiffelIssueVerifiedEvent","EiffelArtifactReusedEvent","EiffelServiceStoppedEvent","EiffelServiceStartedEvent","EiffelServiceReturnedEvent","EiffelServiceDiscontinuedEvent","EiffelServiceDeployedEvent","EiffelServiceAllocatedEvent","EiffelArtifactDeployedEvent","EiffelAlertAcknowledgedEvent","EiffelAlertCeasedEvent","EiffelAlertRaisedEvent","EiffelIssueDefinedEvent"]
8484
```
8585

8686
### Examples for `/template/{type}/{mp}` endpoint
@@ -94,7 +94,7 @@ curl -X GET --header 'Accept: application/json' 'http://localhost:8080/generate-
9494
Result:
9595

9696
```
97-
{"msgParams": {"meta": {"type": "EiffelActivityFinishedEvent","version": "3.0.0","tags": [""],"source": {"domainId": "","host": "","name": "","uri": ""}}},"eventParams": {"data": {"outcome": {"conclusion": "required if outcome present, can be one of SUCCESSFUL,UNSUCCESSFUL,FAILED,ABORTED,TIMED_OUT,INCONCLUSIVE","description": ""},"persistentLogs": [{"name": "required if persistentLogs present","uri": "required if persistentLogs present"}],"customData": [{"key": "required if customData present","value": "required if customData present"}]},"links": [{"type": "ACTIVITY_EXECUTION","target": "required - UUID of EiffelActivityTriggeredEvent"},{"type": "CAUSE or CONTEXT or FLOW_CONTEXT - optional","target": "required - UUID if type is present"}]}}
97+
{"msgParams":{"meta":{"type":"EiffelArtifactPublishedEvent","version":"3.0.0","tags":[""],"source":{"domainId":"","host":"","name":"","uri":""}}},"eventParams":{"data":{"locations":[{"type":"required if locations present,can be anyone of ARTIFACTORY,NEXUS,PLAIN,OTHER","uri":"required"}],"customData":[{"key":"required if customData present","value":"required if customData present"}]},"links":[{"type":"ARTIFACT","target":"required - UUID of EiffelArtifactCreatedEvent"},{"type":"CAUSE or CONTEXT or FLOW_CONTEXT - optional","target":"required - UUID if type is present"}]}}
9898
```
9999

100100
### Examples for `/versions` endpoint

0 commit comments

Comments
 (0)