Skip to content

CHA-1708 - add options object in concepts #1194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sarah-zatar wants to merge 1 commit into
base: master
Choose a base branch
from
Open

CHA-1708 - add options object in concepts #1194

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 24 additions & 8 deletions content/event-platform/concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,15 @@ The following properties represent a subscription:
| `events` | Populated by the user at creation | A list of events that the subscription is tracking |
| `status` | Automatically populated | The subscription status |
| `config` | Populated by the user at creation | The subscription configuration is based on the subscription type. See below for further details. |
| `send_product_identifier` | Optional, default: `false` | If set to `true`, includes the product identifier in product events when available. This field only applies to product events (`com.akeneo.pim.v1.product.*`), not product-model events. |
| `options` | Optional | An object containing optional settings for the subscription. See [Subscription Options](#subscription-options) below. |

### Subscription Options

The `options` object supports the following properties:

| Property | Default | Description |
| --- | --- | --- |
| `send_product_identifier` | `false` | If set to `true`, includes the product identifier in product events when available. This field only applies to product events (`com.akeneo.pim.v1.product.*`), not product-model events. |

The statuses for a subscription are:

Expand Down Expand Up @@ -80,7 +88,9 @@ For the `pubsub` subscription type, the `config` property needed when creating t
"com.akeneo.pim.v1.product.updated"
],
"type": "pubsub",
"send_product_identifier": false,
"options": {
"send_product_identifier": false
},
"config": {
"project_id": "your_google_project_id",
"topic_id": "your_google_pubsub_topic_id"
Expand Down Expand Up @@ -142,7 +152,9 @@ Additionally, it requires at least a primary secret (with an optional secondary
"com.akeneo.pim.v1.product.updated"
],
"type": "https",
"send_product_identifier": false,
"options": {
"send_product_identifier": false
},
"config": {
"url": "https://your_webhook_url",
"secret": {
Expand Down Expand Up @@ -226,7 +238,9 @@ For the `kafka` subscription type, the `config` property requires the Kafka clus
"com.akeneo.pim.v1.product.updated"
],
"type": "kafka",
"send_product_identifier": false,
"options": {
"send_product_identifier": false
},
"config": {
"broker": "kafka-cluster.example.com:9092",
"topic": "pim-events",
Expand Down Expand Up @@ -317,10 +331,12 @@ You can configure your subscription with the following filter:
"com.akeneo.pim.v1.product.updated"
],
"type": "https",
"send_product_identifier": false,
"options": {
"send_product_identifier": false
},
"config": {
"url": "https://your_webhook_url",
}
"url": "https://your_webhook_url"
},
"filter": "user=\"ea0fe94f-417e-4078-a40b-38645ba90ebe\""
}
```
Expand Down Expand Up @@ -359,7 +375,7 @@ Example of an event payload for a productDeleted event
```

::: info
The `identifier` field in product events is only included when the subscription has `send_product_identifier` set to `true`. If `send_product_identifier` is `false` or not set, only the `uuid` field will be present in the product object.
The `identifier` field in product events is only included when the subscription has `options.send_product_identifier` set to `true`. If `options.send_product_identifier` is `false` or not set, only the `uuid` field will be present in the product object.
:::

| | |
Expand Down