Skip to content

Commit

Permalink
fix(web-modeler): remove mention of 8.4 features (#3349)
Browse files Browse the repository at this point in the history
  • Loading branch information
wollefitz authored Feb 16, 2024
1 parent ebb9b40 commit b1bd4b4
Showing 1 changed file with 30 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,25 @@ Synchronize files between Web Modeler and version control systems (VCS) and vice

For automatic file synchronization, consider maintaining a secondary system of record for mapping Web Modeler projects to VCS repositories. This system also monitors the project-to-repository mapping and update timestamps.

To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to identify files updated after the last sync date:
To listen to changes in Web Modeler, you currently need to implement a polling approach that compares the update dates with the last sync dates recorded. Use the `POST /api/v1/files/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Files/searchFiles) with this payload to identify recently updated files:

```json title="POST /api/v1/files/search"
{
"filter": {
"projectId": "(PROJECT TO SYNC)",
"updated": ">(LAST SYNC DATE)"
"projectId": "<PROJECT TO SYNC>",
"updated": "<LAST SYNC DATE>"
},
"page": 0,
"size": 50
}
```

For real-time synchronization, employ a polling approach comparing update dates with last sync dates. Use the `POST /api/v1/files/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Files/searchFiles) with the following payload to discover recently updated files, and compare the `updated` date with your last sync date:

```json title="POST /api/v1/files/search"
{
"filter": {
"projectId": "<PROJECT TO SYNC>"
},
"page": 0,
"size": 50
Expand All @@ -103,12 +115,12 @@ Real-time synchronization isn't always what you need. Consider Web Modeler as a

A milestone reflects a state of a file in Web Modeler with a certain level of qualification, such as being ready for deployment. You can use this property to trigger deployments when a certain milestone is created.

Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to identify milestones created after the last sync date:
Currently, you have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) with the following payload to find recently created milestones:

```json title="POST /api/v1/milestones/search"
{
"filter": {
"created": ">(YOUR LAST SYNC DATE)"
"created": "<YOUR LAST SYNC DATE>"
},
"page": 0,
"size": 50
Expand All @@ -131,6 +143,18 @@ You will receive a response similar to this, where the `fileId` indicates the fi
}
```

You have to poll for milestones to listen to new ones created. Use the `POST /api/v1/milestones/search` [endpoint](https://modeler.cloud.camunda.io/swagger-ui/index.html#/Milestones/searchMilestones) and compare the `created` date with your last sync date to identify recent additions:

```json title="POST /api/v1/milestones/search"
{
"filter": {
"fileId": "<FILE YOU ARE INTERESTED IN>"
},
"page": 0,
"size": 50
}
```

To retrieve the content of this particular milestone, use the `GET /api/v1/milestones/:id` endpoint. To obtain the latest edit state of the file, use the `GET /api/v1/files/:id` endpoint. This endpoint also provides the `projectId` necessary for the `POST /api/v1/projects/search` endpoint if you want to push the full project via the pipeline.

Progress is underway to introduce webhook registration or event subscription for milestone creation monitoring.
Expand Down Expand Up @@ -176,7 +200,7 @@ Pipeline-driven deployment can be executed for a single file or an entire projec
```json title="POST /api/v1/files/search"
{
"filter": {
"projectId": "(PROJECT ID)"
"projectId": "<PROJECT ID>"
},
"page": 0,
"size": 50
Expand Down

0 comments on commit b1bd4b4

Please sign in to comment.