Skip to content

Commit f00b0b7

Browse files
keharperkeharper
committed
Editorial updates
1 parent 5cd1d55 commit f00b0b7

File tree

3 files changed

+105
-88
lines changed

3 files changed

+105
-88
lines changed

‎src/pages/events/api.md

Lines changed: 87 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -274,81 +274,13 @@ curl -i -X PUT \
274274
'<ADOBE_COMMERCE_URL>/rest/all/V1/eventing/updateConfiguration'
275275
```
276276

277-
## Event providers management
277+
## Event provider management
278278

279-
### Get list of all event providers
280-
281-
The `GET /rest/<store_view_code>/V1/eventing/eventProvider` endpoint returns a list of all event providers configured for the Commerce instance.
282-
283-
**Headers:**
279+
The event provider management endpoints allow you to create, update, and delete event providers. The event provider must be created in the Adobe Developer Console before registering it in Adobe Commerce.
284280

285-
`Authorization: Bearer <administrator token>`
286-
287-
The administrator must be granted access to the `Magento_AdobeIoEventsClient::event_provider_list` resource.
288-
289-
**Example usage:**
290-
291-
The following cURL command retrieves information about all configured event providers:
292-
293-
```bash
294-
curl -H "Authorization:Bearer <AUTH_TOKEN>" \
295-
'<ADOBE_COMMERCE_URL>/rest/all/V1/eventing/eventProvider'
296-
```
297-
298-
**Example response:**
281+
### Create an event provider
299282

300-
```json
301-
[
302-
{
303-
"provider_id": "ad667bc6-1678-49ff-99fc-215d71ebf82f",
304-
"instance_id": "my_instance",
305-
"label": "my_provider",
306-
"description": "Provides out-of-process extensibility for Adobe Commerce",
307-
"workspace_configuration": "******"
308-
},
309-
{
310-
"provider_id": "1902bc50-12345-41e8-955b-af4a9667823f",
311-
"instance_id": "my_instance_id",
312-
"label": "my_provider_2",
313-
"description": "Additional event provider",
314-
"workspace_configuration": "******"
315-
}
316-
]
317-
```
318-
319-
### Get event provider by ID
320-
321-
The `GET /rest/<store_view_code>/V1/eventing/eventProvider/<provider_id>` endpoint returns the event provider with the specified ID. If the provider ID is not found, a 404 error is returned.
322-
323-
**Headers:**
324-
325-
`Authorization: Bearer <administrator token>`
326-
327-
The administrator must be granted access to the `Magento_AdobeIoEventsClient::event_provider_list` resource.
328-
329-
The following cURL command retrieves information about the configured event provider:
330-
331-
```bash
332-
curl -H "Authorization:Bearer <AUTH_TOKEN>" \
333-
'<ADOBE_COMMERCE_URL>/rest/all/V1/eventing/eventProvider/1902bc50-12345-41e8-955b-af4a9667823f'
334-
```
335-
336-
**Example response:**
337-
338-
```json
339-
{
340-
"id": "3",
341-
"provider_id": "1902bc50-12345-41e8-955b-af4a9667823f",
342-
"instance_id": "my_instance_id",
343-
"label": "my_provider_2",
344-
"description": "Additional event provider",
345-
"workspace_configuration": "******"
346-
}
347-
```
348-
349-
### Create event provider
350-
351-
The `POST /rest/<store_view_code>/V1/eventing/eventProvider` endpoint register a new event provider in Adobe Commerce. This endpoint is used to register the event provider in Adobe Commerce instance. The event provider must be created in the Adobe Developer Console before registering it in Adobe Commerce.
283+
The `POST /rest/<store_view_code>/V1/eventing/eventProvider` endpoint registers a new event provider in an Adobe Commerce instance. The event provider must be created in the Adobe Developer Console before it can be registered in Adobe Commerce.
352284

353285
**Headers:**
354286

@@ -400,7 +332,7 @@ curl -i -X POST \
400332
}
401333
```
402334

403-
### Update event provider
335+
### Update an event provider
404336

405337
The `PUT /rest/<store_view_code>/V1/eventing/eventProvider/<provider_id>` endpoint updates the event provider with the specified ID. The request body has the same format as the `POST` request except that `id` must be provided.
406338

@@ -410,6 +342,17 @@ The `PUT /rest/<store_view_code>/V1/eventing/eventProvider/<provider_id>` endpoi
410342

411343
The administrator must be granted access to the `Magento_AdobeIoEventsClient::event_provider_edit` resource.
412344

345+
**Payload Parameters:**
346+
347+
Name | Format | Required | Description
348+
--- |--------| --- | ---
349+
`id` | integer | required | The ID assigned to the registered event provider.
350+
`provider_id` | string | required | The event provider ID.
351+
`instance_id` | string | required | The instance ID of event provider.
352+
`label` | string | optional | A label of the event provider.
353+
`description` | string | optional | A description of the event provider.
354+
`workspace_configuration` | string | optional | The contents of the workspace configuration file downloaded from the Adobe Developer Console associated with the event provider.
355+
413356
**Example usage:**
414357

415358
The following cURL command updates an event provider:
@@ -446,7 +389,7 @@ curl -i -X PUT \
446389

447390
### Delete event provider
448391

449-
The `DELETE /rest/<store_view_code>/V1/eventing/eventProvider/<provider_id>` endpoint deletes the event provider with the specified ID. The event provider would be removed only from the Adobe Commerce instance. If needed the event provider must be removed from the Adobe Developer Console separately.
392+
The `DELETE /rest/<store_view_code>/V1/eventing/eventProvider/<provider_id>` endpoint deletes the event provider with the specified ID from the Adobe Commerce instance. The event provider is not removed from the Adobe Developer Console.
450393

451394
**Headers:**
452395

@@ -465,3 +408,73 @@ curl -i -X DELETE \
465408
```
466409

467410
The response will return a 200 status code if the event provider was deleted successfully. If the provider ID is not found, an appropriate error is returned.
411+
412+
### Get list of all event providers
413+
414+
The `GET /rest/<store_view_code>/V1/eventing/eventProvider` endpoint returns a list of all event providers configured for the Commerce instance.
415+
416+
**Headers:**
417+
418+
`Authorization: Bearer <administrator token>`
419+
420+
The administrator must be granted access to the `Magento_AdobeIoEventsClient::event_provider_list` resource.
421+
422+
**Example usage:**
423+
424+
The following cURL command retrieves information about all configured event providers:
425+
426+
```bash
427+
curl -H "Authorization:Bearer <AUTH_TOKEN>" \
428+
'<ADOBE_COMMERCE_URL>/rest/all/V1/eventing/eventProvider'
429+
```
430+
431+
**Example response:**
432+
433+
```json
434+
[
435+
{
436+
"provider_id": "ad667bc6-1678-49ff-99fc-215d71ebf82f",
437+
"instance_id": "my_instance",
438+
"label": "my_provider",
439+
"description": "Provides out-of-process extensibility for Adobe Commerce",
440+
"workspace_configuration": "******"
441+
},
442+
{
443+
"provider_id": "1902bc50-12345-41e8-955b-af4a9667823f",
444+
"instance_id": "my_instance_id",
445+
"label": "my_provider_2",
446+
"description": "Additional event provider",
447+
"workspace_configuration": "******"
448+
}
449+
]
450+
```
451+
452+
### Get event provider by ID
453+
454+
The `GET /rest/<store_view_code>/V1/eventing/eventProvider/<provider_id>` endpoint returns the event provider with the specified ID. If the provider ID is not found, a 404 error is returned.
455+
456+
**Headers:**
457+
458+
`Authorization: Bearer <administrator token>`
459+
460+
The administrator must be granted access to the `Magento_AdobeIoEventsClient::event_provider_list` resource.
461+
462+
The following cURL command retrieves information about the configured event provider:
463+
464+
```bash
465+
curl -H "Authorization:Bearer <AUTH_TOKEN>" \
466+
'<ADOBE_COMMERCE_URL>/rest/all/V1/eventing/eventProvider/1902bc50-12345-41e8-955b-af4a9667823f'
467+
```
468+
469+
**Example response:**
470+
471+
```json
472+
{
473+
"id": "3",
474+
"provider_id": "1902bc50-12345-41e8-955b-af4a9667823f",
475+
"instance_id": "my_instance_id",
476+
"label": "my_provider_2",
477+
"description": "Additional event provider",
478+
"workspace_configuration": "******"
479+
}
480+
```

‎src/pages/events/commands.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,18 @@ The `events:provider:info` command returns details about a configured event prov
7777

7878
### Usage
7979

80-
`events:provider:info`
80+
`events:provider:info` --provider-id <provider-id>
81+
82+
### Options
83+
84+
`--provider-id` The ID of the event provider to query. If not provided, the command returns details about the default event provider.
8185

8286
### Example
8387

88+
The following example returns details about the provider with the ID `abcdef12-e499-5a0a-a683-1234567890ab`.
89+
8490
```bash
85-
bin/magento events:provider:info
91+
bin/magento events:provider:info --provider-id abcdef12-e499-5a0a-a683-1234567890ab
8692
```
8793

8894
### Response
@@ -94,12 +100,6 @@ Configured event provider details:
94100
- description: testing local provider creation (Instance docs-stage-testing)
95101
```
96102

97-
In case you have configured additional event providers the `--provider-id` option can be used to get details about a specific event provider.
98-
99-
```bash
100-
bin/magento events:provider:info --provider-id <provider-id>
101-
```
102-
103103
## Get details about configured event registrations in your App Builder application
104104

105105
The `bin/magento events:registrations:list` command returns details about configured event registrations.

‎src/pages/events/configure-additional-event-providers.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,26 @@ keywords:
88

99
# Configure additional event providers in Adobe Commerce
1010

11-
This guide provides information on how to configure additional event providers in Adobe Commerce. You may need to connect your Adobe Commerce instance to other event providers besides the [default Commerce event provider](configure-commerce.md#create-an-event-provider) registered in system configuration.
11+
You might need to connect your Adobe Commerce instance to other event providers besides the [default Commerce event provider](configure-commerce.md#create-an-event-provider) registered in the system configuration.
1212

13-
To link your event subscriptions to an additional event provider, this provider must be registered in Adobe Commerce instance. The additional events provider can be configured in the Adobe Commerce admin or [through the API](api.md#event-providers-management)
13+
To link your event subscriptions to an additional event provider, the provider must be registered in the Adobe Commerce instance. You can configure the provider from the Adobe Commerce Admin or [through the API](api.md#event-providers-management).
1414

15-
## Configure event providers in the admin
15+
## Configure event providers in the Admin
1616

17-
To manage event providers in the Adobe Commerce admin, go to **System** > **Events** > **Event Providers**. The Event Providers page lists all additional event providers configured in your Adobe Commerce instance.
17+
To manage event providers in the Adobe Commerce Admin, go to **System** > **Events** > **Event Providers**. The Event Providers page lists all additional event providers configured in your Adobe Commerce instance.
1818

1919
![Event Providers](../_images/events/multiprovider-grid.png)
2020

2121
To add a new event provider, click **Add New Provider**. Keep in mind that the event provider must be created in the Adobe I/O Events before you can add it to your Commerce instance. You can create the event provider the using [`aio` CLI tool](https://developer.adobe.com/events/docs/guides/cli/#provider-commands) or to use the [Adobe I/O Events API](https://developer.adobe.com/events/docs/api/#tag/Providers/operation/createProvider).
2222

2323
![Add New Provider](../_images/events/multiprovider-create.png)
2424

25-
The required fields are `Provider ID` and `Instance ID`. The `Workspace Configuration` field is optional, if provided, it will be used to synchronize the event metadata registered with this provider, otherwise the creation of event metadata will be skipped. The `Workspace Configuration` must be provided from the workspace where the event provider was created. You can [download the workspace configuration from the Adobe Developer Console](./project-setup.md#download-the-workspace-configuration-file).
25+
`Provider ID` and `Instance ID` are required fields, while the `Workspace Configuration` field is optional. If provided, it synchronizes the event metadata registered with this provider. Otherwise, the creation of event metadata will be skipped. The `Workspace Configuration` must be provided from the workspace where the event provider was created. You can [download the workspace configuration from the Adobe Developer Console](./project-setup.md#download-the-workspace-configuration-file).
2626

2727
### Delete an event provider
2828

29-
To delete an event provider, select the action next to the provider you want to delete and click **Delete**. A confirmation dialog appears. Click **OK** to confirm the deletion. The event provider can not be deleted if it is used in any event subscriptions. You must first delete the event subscriptions that use this provider.
29+
To delete an event provider, select the action next to the provider you want to delete and click **Delete**. A confirmation dialog appears. Click **OK** to confirm the deletion.
30+
31+
<InlineAlert variant="info" slots="text1" />
32+
33+
The event provider cannot be deleted if it is used in any event subscriptions. You must first delete the event subscriptions that use this provider.

0 commit comments

Comments
 (0)