Skip to content

Commit

Permalink
docs(rest.network.configuration.provider): Added factory components l…
Browse files Browse the repository at this point in the history
…ist (#5006)

Signed-off-by: SimoneFiorani <[email protected]>
  • Loading branch information
sfiorani authored Nov 21, 2023
1 parent e8bc998 commit badd84c
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/references/rest-apis/rest-network-configuration-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ To access these REST APIs, an identity with `rest.network.configuration` permiss
- [POST/configurableComponents/configurations/byPid](#postconfigurablecomponentsconfigurationsbypid)
- [POST/configurableComponents/configurations/byPid/_default](#postconfigurablecomponentsconfigurationsbypid_default)
- [PUT/configurableComponents/configurations/_update](#putconfigurablecomponentsconfigurations_update)
- [GET/factoryComponents](#getfactorycomponents)
- [POST/factoryComponents](#postfactorycomponents)
- [DEL/factoryComponents/byPid](#delfactorycomponentsbypid)
- [GET/factoryComponents/ocd](#getfactorycomponentsocd)
- [POST/factoryComponents/ocd/byFactoryPid](#postfactorycomponentsocdbyfactorypid)
- [JSON definitions](#json-definitions)
- [BatchFailureReport](#batchfailurereport)
- [ComponentConfigurationList](#componentconfigurationlist)
Expand Down Expand Up @@ -129,7 +134,7 @@ To access these REST APIs, an identity with `rest.network.configuration` permiss
* **REST API path** : `/services/networkConfiguration/v1/factoryComponents`
* **description** : This is a batch request that allows to create one or more network factory component instances and optionally create a new snapshot.
* **request body** :
* [CreateFactoryComponentConfigurationsRequest](../../core-services/configuration-service-rest-v2.md#createfactorycomponentconfigurationsrequest)
* [CreateFactoryComponentConfigurationsRequest](./rest-configuration-service-v2.md#createfactorycomponentconfigurationsrequest)
* **responses** :
* **200**
* **description** : The request succeeded.
Expand All @@ -151,7 +156,7 @@ To access these REST APIs, an identity with `rest.network.configuration` permiss
* **REST API path** : `/services/networkConfiguration/v1/factoryComponents/byPid`
* **description** : This is a batch request that allows to delete one or more network factory component instances and optionally create a new snapshot.
* **request body** :
* [DeleteFactoryComponentConfigurationsRequest](../../core-services/configuration-service-rest-v2.md#deletefactorycomponentconfigurationsrequest)
* [DeleteFactoryComponentConfigurationsRequest](./rest-configuration-service-v2.md#deletefactorycomponentconfigurationsrequest)
* **responses** :
* **200**
* **description** : The request succeeded.
Expand Down Expand Up @@ -242,7 +247,7 @@ Represents a list of component configurations.
* **configs**: `array`
The component configurations
* array elements: `object`
* [ComponentConfiguration](../../core-services/configuration-service-rest-v2.md#componentconfiguration)
* [ComponentConfiguration](./rest-configuration-service-v2.md#componentconfiguration)

```json
{
Expand Down Expand Up @@ -408,7 +413,7 @@ An object that describes a set of configurations that need to be updated.
* **configs**: `array`
The configurations to be updated. The `ocd` field can be omitted, it will be ignored if specified.
* array elements: `object`
* [ComponentConfiguration](../../core-services/configuration-service-rest-v2.md#componentconfiguration)
* [ComponentConfiguration](./rest-configuration-service-v2.md#componentconfiguration)
* **takeSnapshot**: `bool`
* **optional** The `true` value will be used as default if not explicitly specified
Defines whether a new snapshot should be created after that the component configurations have been applied.
Expand Down

0 comments on commit badd84c

Please sign in to comment.